Struct Database 

pub struct Database { /* private fields */ }

Implementations

impl Database

pub fn close_handle(&self) -> DatabaseClose

A handle for wait_for_database_close. Take it while the database is still open, before its last handle is dropped.

pub fn cf_handle(&self, name: &str) -> Option<()>

pub fn create_cf( &self, name: &str, options: &Options, ) -> Result<(), TypedStoreError>

Creates a new column family at runtime. Fails if a column family with this name already exists.

options hold until the database is next opened, after which a column family the caller does not declare is opened with the crate’s options instead. Declare it to keep them.

pub fn drop_cf(&self, name: &str) -> Result<(), TypedStoreError>

Maps still holding the column family keep working but report TypedStoreError::UnregisteredColumn on every operation.

pub fn path_for_pruning(&self) -> &Path

pub fn flush_all(&self) -> Result<(), TypedStoreError>

Flush the memtables of every column family of the database to SST files on disk.

pub fn write_opt( &self, batch: StorageWriteBatch, write_options: &WriteOptions, ) -> Result<(), TypedStoreError>

pub fn sorted_runs(&self, cf_name: &str) -> Result<u64, TypedStoreError>

How many sorted runs a point lookup in the column family cf_name may probe: one per level-0 file and one per other level holding files. 0 for a column family that does not exist and on the in-memory backend.

pub fn sst_file_count(&self, cf_name: &str) -> Result<u64, TypedStoreError>

How many SST files the column family cf_name has. 0 for a column family that does not exist and on the in-memory backend.

pub fn sst_files_size(&self, cf_name: &str) -> Result<u64, TypedStoreError>

The size of the SST files of the column family cf_name, which a compaction of all of them needs again in free disk space while it runs. 0 for a column family that does not exist and on the in-memory backend.

pub fn compact_cf(&self, cf_name: &str) -> Result<(), TypedStoreError>

Compacts the whole column family cf_name into a single sorted run, flushing its memtable first. Blocks until done. Other column families keep compacting meanwhile. Does nothing on the in-memory backend.

pub fn snapshot(&self) -> DbSnapshot<'_>

A point-in-time snapshot of this database. See DbSnapshot for what holding one costs.

Panics

Panics on the in-memory backend, which has no point-in-time reads.

pub fn get_sampling_interval(&self) -> SamplingInterval

pub fn multiget_sampling_interval(&self) -> SamplingInterval

pub fn write_sampling_interval(&self) -> SamplingInterval

pub fn iter_sampling_interval(&self) -> SamplingInterval

pub fn live_files(&self) -> Result<Vec<LiveFile>, Error>

Trait Implementations

impl Debug for Database

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

Formats the value using the given formatter.

impl Drop for Database

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.