A B C D F G I K L M N O P R S T V W

A

AbstractRocksDBState<K,N,V,S extends org.apache.flink.api.common.state.State> - Class in org.apache.flink.contrib.streaming.state

Base class for State implementations that store state in a RocksDB database.

AbstractRocksDBState(ColumnFamilyHandle, TypeSerializer<N>, TypeSerializer<V>, V, RocksDBKeyedStateBackend<K>) - Constructor for class org.apache.flink.contrib.streaming.state.AbstractRocksDBState

Creates a new RocksDB backed state.

add(E) - Method in class org.apache.flink.contrib.streaming.state.RocksDBCachingPriorityQueueSet

add(byte[]) - Method in interface org.apache.flink.contrib.streaming.state.RocksDBCachingPriorityQueueSet.OrderedByteArraySetCache

Adds the given element, if it was not already contained.

add(byte[]) - Method in class org.apache.flink.contrib.streaming.state.TreeOrderedSetCache

addAll(Collection<? extends E>) - Method in class org.apache.flink.contrib.streaming.state.RocksDBCachingPriorityQueueSet

B

backend - Variable in class org.apache.flink.contrib.streaming.state.AbstractRocksDBState

Backend that holds the actual RocksDB instance where we store state.

bulkLoadFromOrderedIterator(Iterator<byte[]>) - Method in interface org.apache.flink.contrib.streaming.state.RocksDBCachingPriorityQueueSet.OrderedByteArraySetCache

Clears the cache and adds up to maxSize() elements from the iterator to the cache.

bulkLoadFromOrderedIterator(Iterator<byte[]>) - Method in class org.apache.flink.contrib.streaming.state.TreeOrderedSetCache

C

clear() - Method in class org.apache.flink.contrib.streaming.state.AbstractRocksDBState

close() - Method in class org.apache.flink.contrib.streaming.state.RocksDBKeyedStateBackend.MergeIterator

close() - Method in class org.apache.flink.contrib.streaming.state.RocksDBWriteBatchWrapper

close() - Method in class org.apache.flink.contrib.streaming.state.RocksIteratorWrapper

columnFamily - Variable in class org.apache.flink.contrib.streaming.state.AbstractRocksDBState

The column family of this particular instance of state.

configure(Configuration) - Method in class org.apache.flink.contrib.streaming.state.RocksDBStateBackend

Creates a copy of this state backend that uses the values defined in the configuration for fields where that were not yet specified in this state backend.

create(String, TypeSerializer<T>) - Method in class org.apache.flink.contrib.streaming.state.RocksDBKeyedStateBackend

createCheckpointStorage(JobID) - Method in class org.apache.flink.contrib.streaming.state.RocksDBStateBackend

createColumnOptions(ColumnFamilyOptions) - Method in interface org.apache.flink.contrib.streaming.state.OptionsFactory

This method should set the additional options on top of the current options object.

createColumnOptions() - Method in enum org.apache.flink.contrib.streaming.state.PredefinedOptions

Creates the ColumnFamilyOptionsfor this pre-defined setting.

createDBOptions(DBOptions) - Method in interface org.apache.flink.contrib.streaming.state.OptionsFactory

This method should set the additional options on top of the current options object.

createDBOptions() - Method in enum org.apache.flink.contrib.streaming.state.PredefinedOptions

Creates the DBOptionsfor this pre-defined setting.

createFromConfig(Configuration) - Method in class org.apache.flink.contrib.streaming.state.RocksDBStateBackendFactory

createInternalState(TypeSerializer<N>, StateDescriptor<S, SV>, StateSnapshotTransformer.StateSnapshotTransformFactory<SEV>) - Method in class org.apache.flink.contrib.streaming.state.RocksDBKeyedStateBackend

createKeyedStateBackend(Environment, JobID, String, TypeSerializer<K>, int, KeyGroupRange, TaskKvStateRegistry, TtlTimeProvider) - Method in class org.apache.flink.contrib.streaming.state.RocksDBStateBackend

createOperatorStateBackend(Environment, String) - Method in class org.apache.flink.contrib.streaming.state.RocksDBStateBackend

D

db - Variable in class org.apache.flink.contrib.streaming.state.RocksDBKeyedStateBackend

Our RocksDB database, this is used by the actual subclasses of AbstractRocksDBState to store state.

defaultValue - Variable in class org.apache.flink.contrib.streaming.state.AbstractRocksDBState

dispose() - Method in class org.apache.flink.contrib.streaming.state.RocksDBKeyedStateBackend

Should only be called by one thread, and only after all accesses to the DB happened.

F

flush() - Method in class org.apache.flink.contrib.streaming.state.RocksDBWriteBatchWrapper

G

getCheckpointBackend() - Method in class org.apache.flink.contrib.streaming.state.RocksDBStateBackend

Gets the state backend that this RocksDB state backend uses to persist its bytes to.

getColumnOptions() - Method in class org.apache.flink.contrib.streaming.state.RocksDBStateBackend

Gets the RocksDB ColumnFamilyOptions to be used for all RocksDB instances.

getCurrentKey() - Method in class org.apache.flink.contrib.streaming.state.RocksDBKeyedStateBackend.MergeIterator

getDbOptions() - Method in class org.apache.flink.contrib.streaming.state.RocksDBStateBackend

Gets the RocksDB DBOptions to be used for all RocksDB instances.

getDbStoragePaths() - Method in class org.apache.flink.contrib.streaming.state.RocksDBStateBackend

Gets the configured local DB storage paths, or null, if none were configured.

getDefaultValue() - Method in class org.apache.flink.contrib.streaming.state.AbstractRocksDBState

getInstanceBasePath() - Method in class org.apache.flink.contrib.streaming.state.RocksDBKeyedStateBackend

Only visible for testing, DO NOT USE.

getInternalIndex() - Method in class org.apache.flink.contrib.streaming.state.RocksDBCachingPriorityQueueSet

getIterator() - Method in class org.apache.flink.contrib.streaming.state.RocksDBKeyedStateBackend.MergeIterator

getKeyGroupPrefixBytes() - Method in class org.apache.flink.contrib.streaming.state.RocksDBKeyedStateBackend

getKeys(String, N) - Method in class org.apache.flink.contrib.streaming.state.RocksDBKeyedStateBackend

getKvStateId() - Method in class org.apache.flink.contrib.streaming.state.RocksDBKeyedStateBackend.MergeIterator

getOptions() - Method in class org.apache.flink.contrib.streaming.state.RocksDBStateBackend

Gets the options factory that lazily creates the RocksDB options.

getOptions() - Method in class org.apache.flink.contrib.streaming.state.RocksDBWriteBatchWrapper

getPredefinedOptions() - Method in class org.apache.flink.contrib.streaming.state.RocksDBStateBackend

Gets the currently set predefined options for RocksDB.

getRocksIterator(RocksDB) - Static method in class org.apache.flink.contrib.streaming.state.RocksDBKeyedStateBackend

getRocksIterator(RocksDB, ColumnFamilyHandle) - Static method in class org.apache.flink.contrib.streaming.state.RocksDBKeyedStateBackend

getSerializedValue(byte[], TypeSerializer<K>, TypeSerializer<N>, TypeSerializer<V>) - Method in class org.apache.flink.contrib.streaming.state.AbstractRocksDBState

getWriteOptions() - Method in class org.apache.flink.contrib.streaming.state.RocksDBKeyedStateBackend

I

isEmpty() - Method in class org.apache.flink.contrib.streaming.state.RocksDBCachingPriorityQueueSet

isEmpty() - Method in interface org.apache.flink.contrib.streaming.state.RocksDBCachingPriorityQueueSet.OrderedByteArraySetCache

Returns size() == 0.

isEmpty() - Method in class org.apache.flink.contrib.streaming.state.TreeOrderedSetCache

isFull() - Method in interface org.apache.flink.contrib.streaming.state.RocksDBCachingPriorityQueueSet.OrderedByteArraySetCache

Returns size() == maxSize().

isFull() - Method in class org.apache.flink.contrib.streaming.state.TreeOrderedSetCache

isIncrementalCheckpointsEnabled() - Method in class org.apache.flink.contrib.streaming.state.RocksDBStateBackend

Gets whether incremental checkpoints are enabled for this state backend.

isValid() - Method in class org.apache.flink.contrib.streaming.state.RocksIteratorWrapper

iterator() - Method in class org.apache.flink.contrib.streaming.state.RocksDBCachingPriorityQueueSet

K

key() - Method in class org.apache.flink.contrib.streaming.state.RocksIteratorWrapper

keySerializationDataOutputView - Variable in class org.apache.flink.contrib.streaming.state.AbstractRocksDBState

keySerializationStream - Variable in class org.apache.flink.contrib.streaming.state.AbstractRocksDBState

L

LEXICOGRAPHIC_BYTE_COMPARATOR - Static variable in interface org.apache.flink.contrib.streaming.state.RocksDBCachingPriorityQueueSet.OrderedByteArraySetCache

Comparator for byte arrays.

LOCAL_DIRECTORIES - Static variable in class org.apache.flink.contrib.streaming.state.RocksDBOptions

The local directory (on the TaskManager) where RocksDB puts its files.

M

maxSize() - Method in interface org.apache.flink.contrib.streaming.state.RocksDBCachingPriorityQueueSet.OrderedByteArraySetCache

Returns the maximum number of elements that can be stored in the cache.

maxSize() - Method in class org.apache.flink.contrib.streaming.state.TreeOrderedSetCache

MERGE_OPERATOR_NAME - Static variable in class org.apache.flink.contrib.streaming.state.RocksDBKeyedStateBackend

The name of the merge operator in RocksDB.

N

next() - Method in class org.apache.flink.contrib.streaming.state.RocksIteratorWrapper

notifyCheckpointComplete(long) - Method in class org.apache.flink.contrib.streaming.state.RocksDBKeyedStateBackend

numKeyValueStateEntries() - Method in class org.apache.flink.contrib.streaming.state.RocksDBKeyedStateBackend

O

OptionsFactory - Interface in org.apache.flink.contrib.streaming.state

A factory for DBOptions and ColumnFamilyOptions to be passed to the RocksDBStateBackend.

org.apache.flink.contrib.streaming.state - package org.apache.flink.contrib.streaming.state

P

peek() - Method in class org.apache.flink.contrib.streaming.state.RocksDBCachingPriorityQueueSet

peekFirst() - Method in interface org.apache.flink.contrib.streaming.state.RocksDBCachingPriorityQueueSet.OrderedByteArraySetCache

Returns the first element or null if empty.

peekFirst() - Method in class org.apache.flink.contrib.streaming.state.TreeOrderedSetCache

peekLast() - Method in interface org.apache.flink.contrib.streaming.state.RocksDBCachingPriorityQueueSet.OrderedByteArraySetCache

Returns the last element or null if empty.

peekLast() - Method in class org.apache.flink.contrib.streaming.state.TreeOrderedSetCache

poll() - Method in class org.apache.flink.contrib.streaming.state.RocksDBCachingPriorityQueueSet

pollFirst() - Method in interface org.apache.flink.contrib.streaming.state.RocksDBCachingPriorityQueueSet.OrderedByteArraySetCache

Returns and removes the first element or returns null if empty.

pollFirst() - Method in class org.apache.flink.contrib.streaming.state.TreeOrderedSetCache

pollLast() - Method in interface org.apache.flink.contrib.streaming.state.RocksDBCachingPriorityQueueSet.OrderedByteArraySetCache

Returns and removes the last element or returns null if empty.

pollLast() - Method in class org.apache.flink.contrib.streaming.state.TreeOrderedSetCache

PredefinedOptions - Enum in org.apache.flink.contrib.streaming.state

The PredefinedOptions are configuration settings for the RocksDBStateBackend.

prev() - Method in class org.apache.flink.contrib.streaming.state.RocksIteratorWrapper

put(ColumnFamilyHandle, byte[], byte[]) - Method in class org.apache.flink.contrib.streaming.state.RocksDBWriteBatchWrapper

R

remove(byte[]) - Method in interface org.apache.flink.contrib.streaming.state.RocksDBCachingPriorityQueueSet.OrderedByteArraySetCache

Removes the given element, if it is contained.

remove(E) - Method in class org.apache.flink.contrib.streaming.state.RocksDBCachingPriorityQueueSet

remove(ColumnFamilyHandle, byte[]) - Method in class org.apache.flink.contrib.streaming.state.RocksDBWriteBatchWrapper

remove(byte[]) - Method in class org.apache.flink.contrib.streaming.state.TreeOrderedSetCache

requiresLegacySynchronousTimerSnapshots() - Method in class org.apache.flink.contrib.streaming.state.RocksDBKeyedStateBackend

resolveCheckpoint(String) - Method in class org.apache.flink.contrib.streaming.state.RocksDBStateBackend

restore(Collection<KeyedStateHandle>) - Method in class org.apache.flink.contrib.streaming.state.RocksDBKeyedStateBackend

RocksDBCachingPriorityQueueSet<E extends org.apache.flink.runtime.state.heap.HeapPriorityQueueElement> - Class in org.apache.flink.contrib.streaming.state

A priority queue with set semantics, implemented on top of RocksDB.

RocksDBCachingPriorityQueueSet.OrderedByteArraySetCache - Interface in org.apache.flink.contrib.streaming.state

Cache that is organized as an ordered set for byte-arrays.

RocksDBIncrementalCheckpointUtils - Class in org.apache.flink.contrib.streaming.state

Utils for RocksDB Incremental Checkpoint.

RocksDBIncrementalCheckpointUtils() - Constructor for class org.apache.flink.contrib.streaming.state.RocksDBIncrementalCheckpointUtils

RocksDBKeyedStateBackend<K> - Class in org.apache.flink.contrib.streaming.state

An AbstractKeyedStateBackend that stores its state in RocksDB and serializes state to streams provided by a CheckpointStreamFactory upon checkpointing.

RocksDBKeyedStateBackend(String, ClassLoader, File, DBOptions, ColumnFamilyOptions, TaskKvStateRegistry, TypeSerializer<K>, int, KeyGroupRange, ExecutionConfig, boolean, LocalRecoveryConfig, RocksDBStateBackend.PriorityQueueStateType, TtlTimeProvider) - Constructor for class org.apache.flink.contrib.streaming.state.RocksDBKeyedStateBackend

RocksDBKeyedStateBackend.MergeIterator - Class in org.apache.flink.contrib.streaming.state

Wraps a RocksDB iterator to cache it's current key and assigns an id for the key/value state to the iterator.

RocksDBOptions - Class in org.apache.flink.contrib.streaming.state

Configuration options for the RocksDB backend.

RocksDBOptions() - Constructor for class org.apache.flink.contrib.streaming.state.RocksDBOptions

RocksDBStateBackend - Class in org.apache.flink.contrib.streaming.state

A State Backend that stores its state in RocksDB.

RocksDBStateBackend(String) - Constructor for class org.apache.flink.contrib.streaming.state.RocksDBStateBackend

Creates a new RocksDBStateBackend that stores its checkpoint data in the file system and location defined by the given URI.

RocksDBStateBackend(String, boolean) - Constructor for class org.apache.flink.contrib.streaming.state.RocksDBStateBackend

Creates a new RocksDBStateBackend that stores its checkpoint data in the file system and location defined by the given URI.

RocksDBStateBackend(URI) - Constructor for class org.apache.flink.contrib.streaming.state.RocksDBStateBackend

Creates a new RocksDBStateBackend that stores its checkpoint data in the file system and location defined by the given URI.

RocksDBStateBackend(URI, boolean) - Constructor for class org.apache.flink.contrib.streaming.state.RocksDBStateBackend

Creates a new RocksDBStateBackend that stores its checkpoint data in the file system and location defined by the given URI.

RocksDBStateBackend(StateBackend) - Constructor for class org.apache.flink.contrib.streaming.state.RocksDBStateBackend

Creates a new RocksDBStateBackend that uses the given state backend to store its checkpoint data streams.

RocksDBStateBackend(StateBackend, TernaryBoolean) - Constructor for class org.apache.flink.contrib.streaming.state.RocksDBStateBackend

Creates a new RocksDBStateBackend that uses the given state backend to store its checkpoint data streams.

RocksDBStateBackend(AbstractStateBackend) - Constructor for class org.apache.flink.contrib.streaming.state.RocksDBStateBackend

Deprecated.

Use RocksDBStateBackend.RocksDBStateBackend(StateBackend) instead.

RocksDBStateBackend(AbstractStateBackend, boolean) - Constructor for class org.apache.flink.contrib.streaming.state.RocksDBStateBackend

Deprecated.

Use RocksDBStateBackend.RocksDBStateBackend(StateBackend, TernaryBoolean) instead.

RocksDBStateBackend.PriorityQueueStateType - Enum in org.apache.flink.contrib.streaming.state

The options to chose for the type of priority queue state.

RocksDBStateBackendFactory - Class in org.apache.flink.contrib.streaming.state

A factory that creates an RocksDBStateBackend from a configuration.

RocksDBStateBackendFactory() - Constructor for class org.apache.flink.contrib.streaming.state.RocksDBStateBackendFactory

RocksDBWriteBatchWrapper - Class in org.apache.flink.contrib.streaming.state

It's a wrapper class around RocksDB's WriteBatch for writing in bulk.

RocksDBWriteBatchWrapper(RocksDB) - Constructor for class org.apache.flink.contrib.streaming.state.RocksDBWriteBatchWrapper

RocksDBWriteBatchWrapper(RocksDB, WriteOptions) - Constructor for class org.apache.flink.contrib.streaming.state.RocksDBWriteBatchWrapper

RocksDBWriteBatchWrapper(RocksDB, WriteOptions, int) - Constructor for class org.apache.flink.contrib.streaming.state.RocksDBWriteBatchWrapper

RocksIteratorWrapper - Class in org.apache.flink.contrib.streaming.state

This is a wrapper around RocksIterator to check the iterator status for all the methods mentioned to require this check in the wiki documentation: seek, next, seekToFirst, seekToLast, seekForPrev, and prev.

RocksIteratorWrapper(RocksIterator) - Constructor for class org.apache.flink.contrib.streaming.state.RocksIteratorWrapper

S

seek(byte[]) - Method in class org.apache.flink.contrib.streaming.state.RocksIteratorWrapper

seekToFirst() - Method in class org.apache.flink.contrib.streaming.state.RocksIteratorWrapper

seekToLast() - Method in class org.apache.flink.contrib.streaming.state.RocksIteratorWrapper

setCurrentKey(byte[]) - Method in class org.apache.flink.contrib.streaming.state.RocksDBKeyedStateBackend.MergeIterator

setCurrentNamespace(N) - Method in class org.apache.flink.contrib.streaming.state.AbstractRocksDBState

setDbStoragePath(String) - Method in class org.apache.flink.contrib.streaming.state.RocksDBStateBackend

Sets the path where the RocksDB local database files should be stored on the local file system.

setDbStoragePaths(String...) - Method in class org.apache.flink.contrib.streaming.state.RocksDBStateBackend

Sets the directories in which the local RocksDB database puts its files (like SST and metadata files).

setInternalIndex(int) - Method in class org.apache.flink.contrib.streaming.state.RocksDBCachingPriorityQueueSet

setOptions(OptionsFactory) - Method in class org.apache.flink.contrib.streaming.state.RocksDBStateBackend

Sets Options for the RocksDB instances.

setPredefinedOptions(PredefinedOptions) - Method in class org.apache.flink.contrib.streaming.state.RocksDBStateBackend

Sets the predefined options for RocksDB.

size() - Method in interface org.apache.flink.contrib.streaming.state.RocksDBCachingPriorityQueueSet.OrderedByteArraySetCache

Returns the number of contained elements.

size() - Method in class org.apache.flink.contrib.streaming.state.RocksDBCachingPriorityQueueSet

This implementation comes at a relatively high cost per invocation.

size() - Method in class org.apache.flink.contrib.streaming.state.TreeOrderedSetCache

snapshot(long, long, CheckpointStreamFactory, CheckpointOptions) - Method in class org.apache.flink.contrib.streaming.state.RocksDBKeyedStateBackend

Triggers an asynchronous snapshot of the keyed state backend from RocksDB.

status() - Method in class org.apache.flink.contrib.streaming.state.RocksIteratorWrapper

supportsAsynchronousSnapshots() - Method in class org.apache.flink.contrib.streaming.state.RocksDBKeyedStateBackend

T

TIMER_SERVICE_FACTORY - Static variable in class org.apache.flink.contrib.streaming.state.RocksDBOptions

Choice of timer service implementation.

toString() - Method in class org.apache.flink.contrib.streaming.state.RocksDBStateBackend

TreeOrderedSetCache - Class in org.apache.flink.contrib.streaming.state

Implementation of a lexicographically ordered set of byte-arrays, based on a TreeSet.

V

value() - Method in class org.apache.flink.contrib.streaming.state.RocksIteratorWrapper

valueOf(String) - Static method in enum org.apache.flink.contrib.streaming.state.PredefinedOptions

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.apache.flink.contrib.streaming.state.RocksDBStateBackend.PriorityQueueStateType

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.apache.flink.contrib.streaming.state.PredefinedOptions

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.apache.flink.contrib.streaming.state.RocksDBStateBackend.PriorityQueueStateType

Returns an array containing the constants of this enum type, in the order they are declared.

W

writeCurrentKeyWithGroupAndNamespace() - Method in class org.apache.flink.contrib.streaming.state.AbstractRocksDBState

writeKeyWithGroupAndNamespace(int, K, N, ByteArrayOutputStreamWithPos, DataOutputView) - Method in class org.apache.flink.contrib.streaming.state.AbstractRocksDBState

writeKeyWithGroupAndNamespace(int, K, TypeSerializer<K>, N, TypeSerializer<N>, ByteArrayOutputStreamWithPos, DataOutputView) - Method in class org.apache.flink.contrib.streaming.state.AbstractRocksDBState

writeOptions - Variable in class org.apache.flink.contrib.streaming.state.AbstractRocksDBState

A B C D F G I K L M N O P R S T V W