Crate rocksdb[][src]

Re-exports

pub extern crate librocksdb_sys;
pub use librocksdb_sys as crocksdb_ffi;
pub use logger::Logger;
pub use merge_operator::MergeOperands;
pub use rocksdb::load_latest_options;
pub use rocksdb::run_ldb_tool;
pub use rocksdb::run_sst_dump_tool;
pub use rocksdb::set_external_sst_file_global_seq_no;
pub use rocksdb::BackupEngine;
pub use rocksdb::CFHandle;
pub use rocksdb::Cache;
pub use rocksdb::DBIterator;
pub use rocksdb::DBVector;
pub use rocksdb::Env;
pub use rocksdb::ExternalSstFileInfo;
pub use rocksdb::MapProperty;
pub use rocksdb::MemoryAllocator;
pub use rocksdb::Range;
pub use rocksdb::SeekKey;
pub use rocksdb::SequentialFile;
pub use rocksdb::SstFileReader;
pub use rocksdb::SstFileWriter;
pub use rocksdb::Writable;
pub use rocksdb::DB;
pub use rocksdb_options::BlockBasedOptions;
pub use rocksdb_options::CColumnFamilyDescriptor;
pub use rocksdb_options::ColumnFamilyOptions;
pub use rocksdb_options::CompactOptions;
pub use rocksdb_options::CompactionOptions;
pub use rocksdb_options::DBOptions;
pub use rocksdb_options::EnvOptions;
pub use rocksdb_options::FifoCompactionOptions;
pub use rocksdb_options::HistogramData;
pub use rocksdb_options::IngestExternalFileOptions;
pub use rocksdb_options::LRUCacheOptions;
pub use rocksdb_options::RateLimiter;
pub use rocksdb_options::ReadOptions;
pub use rocksdb_options::RestoreOptions;
pub use rocksdb_options::WriteOptions;
pub use sst_partitioner::SstPartitioner;
pub use sst_partitioner::SstPartitionerContext;
pub use sst_partitioner::SstPartitionerFactory;
pub use sst_partitioner::SstPartitionerRequest;
pub use rocksdb::Kv;

Modules

comparator
logger
merge_operator
rocksdb
rocksdb_options
sst_partitioner
table_properties_rc

This provides reference-counted abstractions around table properties collections. It is used by tikv in its own engine abstractions, to avoid the complexities of lifetimes in associated types.

Structs

ColumnFamilyMetaData
CompactionFilterContext
CompactionFilterFactoryHandle
CompactionFilterHandle
CompactionJobInfo
DBCompactionFilter
DBStatusPtr
FileEncryptionInfo
FlushJobInfo
IOStatsContext
IngestionInfo
LevelMetaData
PerfContext
SstFileMetaData
SubcompactionJobInfo
TableProperties
TablePropertiesCollection
TablePropertiesCollectionView
TitanBlobIndex
TitanDBOptions
UserCollectedProperties
WriteBatch
WriteBatchIter
WriteBatchRef
WriteStallInfo

Enums

CompactionFilterDecision

Decision used in CompactionFilter::filter.

CompactionFilterValueType
CompactionPriority
CompactionReason
DBBackgroundErrorReason
DBBottommostLevelCompaction
DBCompactionStyle
DBCompressionType
DBEncryptionMethod
DBEntryType
DBInfoLogLevel
DBRateLimiterMode
DBRecoveryMode
DBStatisticsHistogramType
DBStatisticsTickerType

This file is generated from generate.py. Re-generate it if you upgrade to a new version of RocksDB.

DBTitanDBBlobRunMode
DBValueType
IndexType
PerfLevel
SstPartitionerResult
WriteStallCondition

Traits

CompactionFilter

CompactionFilter allows an application to modify/delete a key-value at the time of compaction. For more details, Please checkout rocksdb’s documentation.

CompactionFilterFactory
EncryptionKeyManager
EventListener

EventListener trait contains a set of call-back functions that will be called when specific RocksDB event happens such as flush. It can be used as a building block for developing custom features such as stats-collector or external compaction algorithm.

FileSystemInspector
SliceTransform
TableFilter
TablePropertiesCollector

TablePropertiesCollector provides the mechanism for users to collect their own properties that they are interested in. This class is essentially a collection of callback functions that will be invoked during table building. It is constructed with TablePropertiesCollectorFactory. The methods don’t need to be thread-safe, as we will create exactly one TablePropertiesCollector object per table and then call it sequentially

TablePropertiesCollectorFactory

Constructs TablePropertiesCollector. Internals create a new TablePropertiesCollector for each new table.

Functions

get_perf_level
new_bloom_filter
new_compaction_filter
new_compaction_filter_factory
new_compaction_filter_raw

Just like new_compaction_filter, but returns a raw pointer instead of a RAII struct. Generally used in CompactionFilterFactory::create_compaction_filter.

set_perf_level