com.alipay.sofa.jraft.util

Class StorageOptionsFactory

java.lang.Object

com.alipay.sofa.jraft.util.StorageOptionsFactory

public final class StorageOptionsFactory
extends Object

Author:

jiachun.fjc

Method Summary

Modifier and Type	Method and Description
static org.rocksdb.ColumnFamilyOptions	getDefaultRocksDBColumnFamilyOptions()
static org.rocksdb.DBOptions	getDefaultRocksDBOptions()
static org.rocksdb.BlockBasedTableConfig	getDefaultRocksDBTableConfig()
static org.rocksdb.ColumnFamilyOptions	getRocksDBColumnFamilyOptions(String groupId, Class<?> cls) Get a new default ColumnFamilyOptions or a copy of the exist ColumnFamilyOptions.
static org.rocksdb.DBOptions	getRocksDBOptions(String groupId, Class<?> cls) Get a new default DBOptions or a copy of the exist DBOptions.
static org.rocksdb.BlockBasedTableConfig	getRocksDBTableFormatConfig(String groupId, Class<?> cls) Get a new default TableFormatConfig or a copy of the exist ableFormatConfig.
static void	registerRocksDBColumnFamilyOptions(Class<?> cls, org.rocksdb.ColumnFamilyOptions opts) Users can register a custom rocksdb ColumnFamilyOptions, then the related classes will get their options by the key of their own class name.
static void	registerRocksDBColumnFamilyOptions(String groupId, Class<?> cls, org.rocksdb.ColumnFamilyOptions opts) Users can register a custom rocksdb ColumnFamilyOptions, then the related classes will get their options by the key of their own class name.
static void	registerRocksDBOptions(Class<?> cls, org.rocksdb.DBOptions opts) Users can register a custom rocksdb dboptions, then the related classes will get their options by the key of their own class name.
static void	registerRocksDBOptions(String groupId, Class<?> cls, org.rocksdb.DBOptions opts) Users can register a custom rocksdb dboptions, then the related classes will get their options by the key of their own class name.
static void	registerRocksDBTableFormatConfig(Class<?> cls, org.rocksdb.BlockBasedTableConfig cfg) Users can register a custom rocksdb BlockBasedTableConfig, then the related classes will get their options by the key of their own class name.
static void	registerRocksDBTableFormatConfig(String groupId, Class<?> cls, org.rocksdb.BlockBasedTableConfig cfg) Users can register a custom rocksdb BlockBasedTableConfig, then the related classes will get their options by the key of their own class name.
static void	releaseAllOptions() Releases all storage options from the responsibility of freeing the underlying native C++ object.

Methods inherited from class java.lang.Object

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

Method Detail

releaseAllOptions

public static void releaseAllOptions()

Releases all storage options from the responsibility of freeing the underlying native C++ object. Note, that once an instance of options has been released, calling any of its functions will lead to undefined behavior.

registerRocksDBOptions

public static void registerRocksDBOptions(String groupId,
                                          Class<?> cls,
                                          org.rocksdb.DBOptions opts)

Users can register a custom rocksdb dboptions, then the related classes will get their options by the key of their own class name. If the user does not register an options, a default options will be provided.

Parameters:

groupId - raft group id

cls - the key of DBOptions

opts - the DBOptions

registerRocksDBOptions

public static void registerRocksDBOptions(Class<?> cls,
                                          org.rocksdb.DBOptions opts)

Users can register a custom rocksdb dboptions, then the related classes will get their options by the key of their own class name. If the user does not register an options, a default options will be provided.

Parameters:

cls - the key of DBOptions

opts - the DBOptions

getRocksDBOptions

public static org.rocksdb.DBOptions getRocksDBOptions(String groupId,
                                                      Class<?> cls)

Get a new default DBOptions or a copy of the exist DBOptions. Users should call DBOptions#close() to release resources themselves.

Parameters:

groupId - raft group id

cls - the key of DBOptions

Returns:

new default DBOptions or a copy of the exist DBOptions

getDefaultRocksDBOptions

public static org.rocksdb.DBOptions getDefaultRocksDBOptions()

registerRocksDBColumnFamilyOptions

public static void registerRocksDBColumnFamilyOptions(String groupId,
                                                      Class<?> cls,
                                                      org.rocksdb.ColumnFamilyOptions opts)

Users can register a custom rocksdb ColumnFamilyOptions, then the related classes will get their options by the key of their own class name. If the user does not register an options, a default options will be provided.

Parameters:

groupId - raft group id

cls - the key of ColumnFamilyOptions

opts - the ColumnFamilyOptions

registerRocksDBColumnFamilyOptions

public static void registerRocksDBColumnFamilyOptions(Class<?> cls,
                                                      org.rocksdb.ColumnFamilyOptions opts)

Users can register a custom rocksdb ColumnFamilyOptions, then the related classes will get their options by the key of their own class name. If the user does not register an options, a default options will be provided.

Parameters:

cls - the key of ColumnFamilyOptions

opts - the ColumnFamilyOptions

getRocksDBColumnFamilyOptions

public static org.rocksdb.ColumnFamilyOptions getRocksDBColumnFamilyOptions(String groupId,
                                                                            Class<?> cls)

Get a new default ColumnFamilyOptions or a copy of the exist ColumnFamilyOptions. Users should call ColumnFamilyOptions#close() to release resources themselves.

Parameters:

groupId - raft group id

cls - the key of ColumnFamilyOptions

Returns:

new default ColumnFamilyOptions or a copy of the exist ColumnFamilyOptions

getDefaultRocksDBColumnFamilyOptions

public static org.rocksdb.ColumnFamilyOptions getDefaultRocksDBColumnFamilyOptions()

registerRocksDBTableFormatConfig

public static void registerRocksDBTableFormatConfig(String groupId,
                                                    Class<?> cls,
                                                    org.rocksdb.BlockBasedTableConfig cfg)

Users can register a custom rocksdb BlockBasedTableConfig, then the related classes will get their options by the key of their own class name. If the user does not register a config, a default config will be provided.

Parameters:

groupId - raft group id

cls - the key of BlockBasedTableConfig

cfg - the BlockBasedTableConfig

registerRocksDBTableFormatConfig

public static void registerRocksDBTableFormatConfig(Class<?> cls,
                                                    org.rocksdb.BlockBasedTableConfig cfg)

Users can register a custom rocksdb BlockBasedTableConfig, then the related classes will get their options by the key of their own class name. If the user does not register a config, a default config will be provided.

Parameters:

cls - the key of BlockBasedTableConfig

cfg - the BlockBasedTableConfig

getRocksDBTableFormatConfig

public static org.rocksdb.BlockBasedTableConfig getRocksDBTableFormatConfig(String groupId,
                                                                            Class<?> cls)

Get a new default TableFormatConfig or a copy of the exist ableFormatConfig.

Parameters:

groupId - raft group id

cls - the key of TableFormatConfig

Returns:

new default TableFormatConfig or a copy of the exist TableFormatConfig

getDefaultRocksDBTableConfig

public static org.rocksdb.BlockBasedTableConfig getDefaultRocksDBTableConfig()