Package org.apache.flink.state.forst

Class ForStOperationUtils

java.lang.Object

org.apache.flink.state.forst.ForStOperationUtils

public class ForStOperationUtils
extends Object

Utils for ForSt Operations.

Field Summary

Fields

Modifier and Type	Field	Description
static String	MERGE_OPERATOR_NAME	The name of the merge operator in ForSt.

Constructor Summary

Constructors

Constructor	Description
ForStOperationUtils()

Method Summary

Modifier and Type	Method	Description
static org.apache.flink.runtime.memory.OpaqueMemoryResource<org.apache.flink.state.forst.ForStSharedResources>	allocateSharedCachesIfConfigured(ForStMemoryConfiguration jobMemoryConfig, org.apache.flink.runtime.execution.Environment env, double memoryFraction, org.slf4j.Logger logger, ForStMemoryControllerUtils.ForStMemoryFactory forStMemoryFactory)
static org.rocksdb.ColumnFamilyDescriptor	createColumnFamilyDescriptor(String stateId, java.util.function.Function<String,org.rocksdb.ColumnFamilyOptions> columnFamilyOptionsFactory)	Creates a column descriptor for a state column family.
static org.rocksdb.ColumnFamilyHandle	createColumnFamilyHandle(String stateId, org.rocksdb.RocksDB db, java.util.function.Function<String,org.rocksdb.ColumnFamilyOptions> columnFamilyOptionsFactory)	Creates a column family handle from a state id.
static org.rocksdb.ColumnFamilyOptions	createColumnFamilyOptions(java.util.function.Function<String,org.rocksdb.ColumnFamilyOptions> columnFamilyOptionsFactory, String stateName)
static org.rocksdb.RocksDB	openDB(String path, List<org.rocksdb.ColumnFamilyDescriptor> stateColumnFamilyDescriptors, List<org.rocksdb.ColumnFamilyHandle> stateColumnFamilyHandles, org.rocksdb.ColumnFamilyOptions columnFamilyOptions, org.rocksdb.DBOptions dbOptions)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MERGE_OPERATOR_NAME

public static final String MERGE_OPERATOR_NAME

The name of the merge operator in ForSt. Do not change except you know exactly what you do.

See Also:

Constant Field Values

Constructor Detail

ForStOperationUtils

public ForStOperationUtils()

Method Detail

openDB

public static org.rocksdb.RocksDB openDB(String path,
                                         List<org.rocksdb.ColumnFamilyDescriptor> stateColumnFamilyDescriptors,
                                         List<org.rocksdb.ColumnFamilyHandle> stateColumnFamilyHandles,
                                         org.rocksdb.ColumnFamilyOptions columnFamilyOptions,
                                         org.rocksdb.DBOptions dbOptions)
                                  throws IOException

Throws:

IOException

createColumnFamilyHandle

public static org.rocksdb.ColumnFamilyHandle createColumnFamilyHandle(String stateId,
                                                                      org.rocksdb.RocksDB db,
                                                                      java.util.function.Function<String,org.rocksdb.ColumnFamilyOptions> columnFamilyOptionsFactory)

Creates a column family handle from a state id.

createColumnFamilyDescriptor

public static org.rocksdb.ColumnFamilyDescriptor createColumnFamilyDescriptor(String stateId,
                                                                              java.util.function.Function<String,org.rocksdb.ColumnFamilyOptions> columnFamilyOptionsFactory)

Creates a column descriptor for a state column family.

createColumnFamilyOptions

public static org.rocksdb.ColumnFamilyOptions createColumnFamilyOptions(java.util.function.Function<String,org.rocksdb.ColumnFamilyOptions> columnFamilyOptionsFactory,
                                                                        String stateName)

allocateSharedCachesIfConfigured

@Nullable
public static org.apache.flink.runtime.memory.OpaqueMemoryResource<org.apache.flink.state.forst.ForStSharedResources> allocateSharedCachesIfConfigured(ForStMemoryConfiguration jobMemoryConfig,
                                                                                                                                                       org.apache.flink.runtime.execution.Environment env,
                                                                                                                                                       double memoryFraction,
                                                                                                                                                       org.slf4j.Logger logger,
                                                                                                                                                       ForStMemoryControllerUtils.ForStMemoryFactory forStMemoryFactory)
                                                                                                                                                throws IOException

Throws:

IOException