Struct engine_rocks::RocksEngine

pub struct RocksEngine {
    db: Arc<DB>,
    shared_block_cache: bool,
}

Fields

db: Arc<DB>

shared_block_cache: bool

Implementations

impl RocksEngine

pub fn from_db(db: Arc<DB>) -> Self

pub fn from_ref(db: &Arc<DB>) -> &Self

pub fn as_inner(&self) -> &Arc<DB>

pub fn get_sync_db(&self) -> Arc<DB>

pub fn exists(path: &str) -> bool

pub fn set_shared_block_cache(&mut self, enable: bool)

impl RocksEngine

fn is_titan(&self) -> bool

fn delete_all_in_range_cf_by_ingest(
    &self,
    cf: &str,
    sst_path: String,
    ranges: &[Range<'_>]
) -> Result<()>

fn delete_all_in_range_cf_by_key(
    &self,
    cf: &str,
    range: &Range<'_>
) -> Result<()>

Trait Implementations

impl CFNamesExt for RocksEngine

fn cf_names(&self) -> Vec<&str>

impl CFOptionsExt for RocksEngine

type ColumnFamilyOptions = RocksColumnFamilyOptions

fn get_options_cf(&self, cf: &str) -> Result<Self::ColumnFamilyOptions>

fn set_options_cf(&self, cf: &str, options: &[(&str, &str)]) -> Result<()>

impl Clone for RocksEngine

fn clone(&self) -> RocksEngine

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl CompactExt for RocksEngine

type CompactedEvent = RocksCompactedEvent

fn auto_compactions_is_disabled(&self) -> Result<bool>

Checks whether any column family sets disable_auto_compactions to True or not.

fn compact_range(
    &self,
    cf: &str,
    start_key: Option<&[u8]>,
    end_key: Option<&[u8]>,
    exclusive_manual: bool,
    max_subcompactions: u32
) -> Result<()>

Compacts the column families in the specified range by manual or not.

fn compact_files_in_range(
    &self,
    start: Option<&[u8]>,
    end: Option<&[u8]>,
    output_level: Option<i32>
) -> Result<()>

Compacts files in the range and above the output level. Compacts all files if the range is not specified. Compacts all files to the bottommost level if the output level is not specified.

fn compact_files_in_range_cf(
    &self,
    cf: &str,
    start: Option<&[u8]>,
    end: Option<&[u8]>,
    output_level: Option<i32>
) -> Result<()>

Compacts files in the range and above the output level of the given column family. Compacts all files to the bottommost level if the output level is not specified.

fn compact_files_cf(
    &self,
    cf: &str,
    files: Vec<String>,
    output_level: Option<i32>,
    max_subcompactions: u32,
    exclude_l0: bool
) -> Result<()>

impl DBOptionsExt for RocksEngine

type DBOptions = RocksDBOptions

fn get_db_options(&self) -> Self::DBOptions

fn set_db_options(&self, options: &[(&str, &str)]) -> Result<()>

impl Debug for RocksEngine

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl ImportExt for RocksEngine

type IngestExternalFileOptions = RocksIngestExternalFileOptions

fn ingest_external_file_cf(
    &self,
    cf: &str,
    opts: &Self::IngestExternalFileOptions,
    files: &[&str]
) -> Result<()>

fn reset_global_seq<P: AsRef<Path>>(&self, cf: &str, path: P) -> Result<()>

impl Iterable for RocksEngine

type Iterator = RocksEngineIterator

fn iterator_opt(&self, opts: IterOptions) -> Result<Self::Iterator>

fn iterator_cf_opt(&self, cf: &str, opts: IterOptions) -> Result<Self::Iterator>

pub fn iterator(&self) -> Result<Self::Iterator, Error>

pub fn iterator_cf(&self, cf: &str) -> Result<Self::Iterator, Error>

pub fn scan<F>(
    &self,
    start_key: &[u8],
    end_key: &[u8],
    fill_cache: bool,
    f: F
) -> Result<(), Error> where
    F: FnMut(&[u8], &[u8]) -> Result<bool, Error>, 

pub fn scan_cf<F>(
    &self,
    cf: &str,
    start_key: &[u8],
    end_key: &[u8],
    fill_cache: bool,
    f: F
) -> Result<(), Error> where
    F: FnMut(&[u8], &[u8]) -> Result<bool, Error>, 

pub fn seek(
    &self,
    key: &[u8]
) -> Result<Option<(Vec<u8, Global>, Vec<u8, Global>)>, Error>

pub fn seek_cf(
    &self,
    cf: &str,
    key: &[u8]
) -> Result<Option<(Vec<u8, Global>, Vec<u8, Global>)>, Error>

impl KvEngine for RocksEngine

type Snapshot = RocksSnapshot

A consistent read-only snapshot of the database

fn snapshot(&self) -> RocksSnapshot

Create a snapshot

fn sync(&self) -> Result<()>

Syncs any writes to disk

fn flush_metrics(&self, instance: &str)

Flush metrics to prometheus

fn reset_statistics(&self)

Reset internal statistics

fn bad_downcast<T: 'static>(&self) -> &T

Cast to a concrete engine type

impl MiscExt for RocksEngine

fn flush(&self, sync: bool) -> Result<()>

fn flush_cf(&self, cf: &str, sync: bool) -> Result<()>

fn delete_ranges_cf(
    &self,
    cf: &str,
    strategy: DeleteStrategy,
    ranges: &[Range<'_>]
) -> Result<()>

fn get_approximate_memtable_stats_cf(
    &self,
    cf: &str,
    range: &Range<'_>
) -> Result<(u64, u64)>

Return the approximate number of records and size in the range of memtables of the cf.

fn ingest_maybe_slowdown_writes(&self, cf: &str) -> Result<bool>

fn get_engine_used_size(&self) -> Result<u64>

Gets total used size of rocksdb engine, including:

fn roughly_cleanup_ranges(&self, ranges: &[(Vec<u8>, Vec<u8>)]) -> Result<()>

Roughly deletes files in multiple ranges.

fn path(&self) -> &str

The path to the directory on the filesystem where the database is stored

fn sync_wal(&self) -> Result<()>

fn exists(path: &str) -> bool

Check whether a database exists at a given path

fn dump_stats(&self) -> Result<String>

Dump stats about the database into a string.

fn get_latest_sequence_number(&self) -> u64

fn get_oldest_snapshot_sequence_number(&self) -> Option<u64>

fn get_total_sst_files_size_cf(&self, cf: &str) -> Result<Option<u64>>

fn get_range_entries_and_versions(
    &self,
    cf: &str,
    start: &[u8],
    end: &[u8]
) -> Result<Option<(u64, u64)>>

fn get_cf_num_files_at_level(
    &self,
    cf: &str,
    level: usize
) -> Result<Option<u64>>

fn get_cf_num_immutable_mem_table(&self, cf: &str) -> Result<Option<u64>>

fn get_cf_compaction_pending_bytes(&self, cf: &str) -> Result<Option<u64>>

fn is_stalled_or_stopped(&self) -> bool

pub fn delete_all_in_range(
    &self,
    strategy: DeleteStrategy,
    ranges: &[Range<'_>]
) -> Result<(), Error>

impl MvccPropertiesExt for RocksEngine

fn get_mvcc_properties_cf(
    &self,
    cf: &str,
    safe_point: TimeStamp,
    start_key: &[u8],
    end_key: &[u8]
) -> Option<MvccProperties>

impl Peekable for RocksEngine

type DBVector = RocksDBVector

The byte-vector type through which the database returns read values.

fn get_value_opt(
    &self,
    opts: &ReadOptions,
    key: &[u8]
) -> Result<Option<RocksDBVector>>

Read a value for a key, given a set of options.

fn get_value_cf_opt(
    &self,
    opts: &ReadOptions,
    cf: &str,
    key: &[u8]
) -> Result<Option<RocksDBVector>>

Read a value for a key from a given column family, given a set of options.

pub fn get_value(&self, key: &[u8]) -> Result<Option<Self::DBVector>, Error>

Read a value for a key.

pub fn get_value_cf(
    &self,
    cf: &str,
    key: &[u8]
) -> Result<Option<Self::DBVector>, Error>

Read a value for a key from a given column family.

pub fn get_msg<M>(&self, key: &[u8]) -> Result<Option<M>, Error> where
    M: Message + Default, 

Read a value and return it as a protobuf message.

pub fn get_msg_cf<M>(&self, cf: &str, key: &[u8]) -> Result<Option<M>, Error> where
    M: Message + Default, 

Read a value and return it as a protobuf message.

impl PerfContextExt for RocksEngine

type PerfContext = RocksPerfContext

fn get_perf_context(
    &self,
    level: PerfLevel,
    kind: PerfContextKind
) -> Self::PerfContext

impl RaftEngine for RocksEngine

type LogBatch = RocksWriteBatch

fn log_batch(&self, capacity: usize) -> Self::LogBatch

fn sync(&self) -> Result<()>

Synchronize the Raft engine.

fn get_raft_state(&self, raft_group_id: u64) -> Result<Option<RaftLocalState>>

fn get_entry(&self, raft_group_id: u64, index: u64) -> Result<Option<Entry>>

fn fetch_entries_to(
    &self,
    region_id: u64,
    low: u64,
    high: u64,
    max_size: Option<usize>,
    buf: &mut Vec<Entry>
) -> Result<usize>

Return count of fetched entries.

fn consume(&self, batch: &mut Self::LogBatch, sync_log: bool) -> Result<usize>

Consume the write batch by moving the content into the engine itself and return written bytes.

fn consume_and_shrink(
    &self,
    batch: &mut Self::LogBatch,
    sync_log: bool,
    max_capacity: usize,
    shrink_to: usize
) -> Result<usize>

Like consume but shrink batch if need.

fn clean(
    &self,
    raft_group_id: u64,
    state: &RaftLocalState,
    batch: &mut Self::LogBatch
) -> Result<()>

fn append(&self, raft_group_id: u64, entries: Vec<Entry>) -> Result<usize>

Append some log entries and return written bytes.

fn put_raft_state(
    &self,
    raft_group_id: u64,
    state: &RaftLocalState
) -> Result<()>

fn gc(&self, raft_group_id: u64, from: u64, to: u64) -> Result<usize>

Like cut_logs but the range could be very large. Return the deleted count. Generally, from can be passed in 0.

fn purge_expired_files(&self) -> Result<Vec<u64>>

Purge expired logs files and return a set of Raft group ids which needs to be compacted ASAP.

fn has_builtin_entry_cache(&self) -> bool

The RaftEngine has a builtin entry cache or not.

fn flush_metrics(&self, instance: &str)

fn reset_statistics(&self)

fn dump_stats(&self) -> Result<String>

pub fn gc_entry_cache(&self, _raft_group_id: u64, _to: u64)

GC the builtin entry cache.

pub fn flush_stats(&self) -> Option<CacheStats>

pub fn stop(&self)

impl RangePropertiesExt for RocksEngine

fn get_range_approximate_keys(
    &self,
    range: Range<'_>,
    large_threshold: u64
) -> Result<u64>

Gets the number of keys in a range.

fn get_range_approximate_keys_cf(
    &self,
    cfname: &str,
    range: Range<'_>,
    large_threshold: u64
) -> Result<u64>

fn get_range_approximate_size(
    &self,
    range: Range<'_>,
    large_threshold: u64
) -> Result<u64>

Get the approximate size of the range

fn get_range_approximate_size_cf(
    &self,
    cfname: &str,
    range: Range<'_>,
    large_threshold: u64
) -> Result<u64>

fn get_range_approximate_split_keys(
    &self,
    range: Range<'_>,
    key_count: usize
) -> Result<Vec<Vec<u8>>>

Get range approximate split keys to split range evenly into key_count + 1 parts .

fn get_range_approximate_split_keys_cf(
    &self,
    cfname: &str,
    range: Range<'_>,
    key_count: usize
) -> Result<Vec<Vec<u8>>>

impl SstExt for RocksEngine

type SstReader = RocksSstReader

type SstWriter = RocksSstWriter

type SstWriterBuilder = RocksSstWriterBuilder

impl SstWriterBuilder<RocksEngine> for RocksSstWriterBuilder

fn new() -> Self

Create a new SstWriterBuilder.

fn set_db(self, db: &RocksEngine) -> Self

Set DB for the builder. The builder may need some config from the DB.

fn set_cf(self, cf: &str) -> Self

Set CF for the builder. The builder may need some config from the CF.

fn set_in_memory(self, in_memory: bool) -> Self

Set it to true, the builder builds a in-memory SST builder.

fn set_compression_type(self, compression: Option<SstCompressionType>) -> Self

set other config specified by writer

fn set_compression_level(self, level: i32) -> Self

fn build(self, path: &str) -> Result<RocksSstWriter>

Builder a SstWriter.

impl SyncMutable for RocksEngine

fn put(&self, key: &[u8], value: &[u8]) -> Result<()>

fn put_cf(&self, cf: &str, key: &[u8], value: &[u8]) -> Result<()>

fn delete(&self, key: &[u8]) -> Result<()>

fn delete_cf(&self, cf: &str, key: &[u8]) -> Result<()>

fn delete_range(&self, begin_key: &[u8], end_key: &[u8]) -> Result<()>

fn delete_range_cf(
    &self,
    cf: &str,
    begin_key: &[u8],
    end_key: &[u8]
) -> Result<()>

pub fn put_msg<M>(&self, key: &[u8], m: &M) -> Result<(), Error> where
    M: Message, 

pub fn put_msg_cf<M>(&self, cf: &str, key: &[u8], m: &M) -> Result<(), Error> where
    M: Message, 

impl TablePropertiesExt for RocksEngine

type TablePropertiesCollection = RocksTablePropertiesCollection

type TablePropertiesCollectionIter = RocksTablePropertiesCollectionIter

type TablePropertiesKey = RocksTablePropertiesKey

type TableProperties = RocksTableProperties

type UserCollectedProperties = RocksUserCollectedProperties

fn get_properties_of_tables_in_range(
    &self,
    cf: &str,
    ranges: &[Range<'_>]
) -> Result<Self::TablePropertiesCollection>

pub fn get_range_properties_cf(
    &self,
    cfname: &str,
    start_key: &[u8],
    end_key: &[u8]
) -> Result<Self::TablePropertiesCollection, Error>

impl TtlPropertiesExt for RocksEngine

fn get_range_ttl_properties_cf(
    &self,
    cf: &str,
    start_key: &[u8],
    end_key: &[u8]
) -> Result<Vec<(String, TtlProperties)>>

impl WriteBatch<RocksEngine> for RocksWriteBatch

fn with_capacity(e: &RocksEngine, cap: usize) -> RocksWriteBatch

Create a WriteBatch with a given command capacity

fn write_opt(&self, opts: &WriteOptions) -> Result<()>

Commit the WriteBatch to disk with the given options

fn data_size(&self) -> usize

The data size of a write batch

fn count(&self) -> usize

The number of commands in this batch

fn is_empty(&self) -> bool

Whether any commands have been issued to this batch

fn should_write_to_engine(&self) -> bool

Whether the number of commands exceeds WRITE_BATCH_MAX_KEYS

fn clear(&mut self)

Clears the WriteBatch of all commands

fn set_save_point(&mut self)

Push a save point onto the save point stack

fn pop_save_point(&mut self) -> Result<()>

Pop a save point from the save point stack

fn rollback_to_save_point(&mut self) -> Result<()>

Revert all commands issued since the last save point

pub fn write(&self) -> Result<(), Error>

Commit the WriteBatch to disk atomically

impl WriteBatch<RocksEngine> for RocksWriteBatchVec

fn with_capacity(e: &RocksEngine, cap: usize) -> RocksWriteBatchVec

Create a WriteBatch with a given command capacity

fn write_opt(&self, opts: &WriteOptions) -> Result<()>

Commit the WriteBatch to disk with the given options

fn data_size(&self) -> usize

The data size of a write batch

fn count(&self) -> usize

The number of commands in this batch

fn is_empty(&self) -> bool

Whether any commands have been issued to this batch

fn should_write_to_engine(&self) -> bool

Whether the number of commands exceeds WRITE_BATCH_MAX_KEYS

fn clear(&mut self)

Clears the WriteBatch of all commands

fn set_save_point(&mut self)

Push a save point onto the save point stack

fn pop_save_point(&mut self) -> Result<()>

Pop a save point from the save point stack

fn rollback_to_save_point(&mut self) -> Result<()>

Revert all commands issued since the last save point

pub fn write(&self) -> Result<(), Error>

Commit the WriteBatch to disk atomically

impl WriteBatchExt for RocksEngine

type WriteBatch = RocksWriteBatch

type WriteBatchVec = RocksWriteBatchVec

WriteBatchVec is used for multi_batch_write of RocksEngine and other Engine could also implement another kind of WriteBatch according to their needs.

const WRITE_BATCH_MAX_KEYS: usize

The number of puts/deletes made to a write batch before the batch should be committed with write. More entries than this will cause should_write_to_engine to return true.

fn support_write_batch_vec(&self) -> bool

Indicates whether the WriteBatchVec type can be created and works as expected.

fn write_batch(&self) -> Self::WriteBatch

fn write_batch_with_cap(&self, cap: usize) -> Self::WriteBatch