Struct test_sst_importer::TestEngine

pub struct TestEngine {
    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>) -> RocksEngine

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

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)

Trait Implementations

impl CFNamesExt for RocksEngine

pub fn cf_names(&self) -> Vec<&str, Global>

impl CFOptionsExt for RocksEngine

type ColumnFamilyOptions = RocksColumnFamilyOptions

pub fn get_options_cf(
    &self,
    cf: &str
) -> Result<<RocksEngine as CFOptionsExt>::ColumnFamilyOptions, Error>

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

impl Clone for RocksEngine

pub 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

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

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

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

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

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

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.

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

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.

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

impl DBOptionsExt for RocksEngine

type DBOptions = RocksDBOptions

pub fn get_db_options(&self) -> <RocksEngine as DBOptionsExt>::DBOptions

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

impl Debug for RocksEngine

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

Formats the value using the given formatter.

impl ImportExt for RocksEngine

type IngestExternalFileOptions = RocksIngestExternalFileOptions

pub fn ingest_external_file_cf(
    &self,
    cf: &str,
    opts: &<RocksEngine as ImportExt>::IngestExternalFileOptions,
    files: &[&str]
) -> Result<(), Error>

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

impl Iterable for RocksEngine

type Iterator = RocksEngineIterator

pub fn iterator_opt(
    &self,
    opts: IterOptions
) -> Result<<RocksEngine as Iterable>::Iterator, Error>

pub fn iterator_cf_opt(
    &self,
    cf: &str,
    opts: IterOptions
) -> Result<<RocksEngine as Iterable>::Iterator, Error>

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

pub fn snapshot(&self) -> RocksSnapshot

Create a snapshot

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

Syncs any writes to disk

pub fn flush_metrics(&self, instance: &str)

Flush metrics to prometheus

pub fn reset_statistics(&self)

Reset internal statistics

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

Cast to a concrete engine type

impl MiscExt for RocksEngine

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

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

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

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

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

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

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

Gets total used size of rocksdb engine, including:

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

Roughly deletes files in multiple ranges.

pub fn path(&self) -> &str

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

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

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

Check whether a database exists at a given path

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

Dump stats about the database into a string.

pub fn get_latest_sequence_number(&self) -> u64

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

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

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

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

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

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

pub fn is_stalled_or_stopped(&self) -> bool

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

impl MvccPropertiesExt for RocksEngine

pub 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.

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

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

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

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

pub fn get_perf_context(
    &self,
    level: PerfLevel,
    kind: PerfContextKind
) -> <RocksEngine as PerfContextExt>::PerfContext

impl RaftEngine for RocksEngine

type LogBatch = RocksWriteBatch

pub fn log_batch(
    &self,
    capacity: usize
) -> <RocksEngine as RaftEngine>::LogBatch

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

Synchronize the Raft engine.

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

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

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

Return count of fetched entries.

pub fn consume(
    &self,
    batch: &mut <RocksEngine as RaftEngine>::LogBatch,
    sync_log: bool
) -> Result<usize, Error>

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

pub fn consume_and_shrink(
    &self,
    batch: &mut <RocksEngine as RaftEngine>::LogBatch,
    sync_log: bool,
    max_capacity: usize,
    shrink_to: usize
) -> Result<usize, Error>

Like consume but shrink batch if need.

pub fn clean(
    &self,
    raft_group_id: u64,
    state: &RaftLocalState,
    batch: &mut <RocksEngine as RaftEngine>::LogBatch
) -> Result<(), Error>

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

Append some log entries and return written bytes.

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

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

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

pub fn purge_expired_files(&self) -> Result<Vec<u64, Global>, Error>

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

pub fn has_builtin_entry_cache(&self) -> bool

The RaftEngine has a builtin entry cache or not.

pub fn flush_metrics(&self, instance: &str)

pub fn reset_statistics(&self)

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

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

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

Gets the number of keys in a range.

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

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

Get the approximate size of the range

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

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

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

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

impl SstExt for RocksEngine

type SstReader = RocksSstReader

type SstWriter = RocksSstWriter

type SstWriterBuilder = RocksSstWriterBuilder

impl SyncMutable for RocksEngine

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

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

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

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

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

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

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

pub fn get_properties_of_tables_in_range(
    &self,
    cf: &str,
    ranges: &[Range<'_>]
) -> Result<<RocksEngine as TablePropertiesExt>::TablePropertiesCollection, Error>

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

impl TtlPropertiesExt for RocksEngine

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

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.

pub 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.

pub fn support_write_batch_vec(&self) -> bool

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

pub fn write_batch(&self) -> <RocksEngine as WriteBatchExt>::WriteBatch

pub fn write_batch_with_cap(
    &self,
    cap: usize
) -> <RocksEngine as WriteBatchExt>::WriteBatch