Struct DB

pub struct DB { /* private fields */ }

This DB is a schematized RocksDB wrapper where all data passed in and out are typed according to Schemas.

Implementations

impl DB

pub fn open( path: impl AsRef<Path>, name: &'static str, column_families: impl IntoIterator<Item = impl Into<String>>, db_opts: &Options, ) -> Result<Self>

Opens a database backed by RocksDB, using the provided column family names and default column family options.

pub fn open_with_cfds( db_opts: &Options, path: impl AsRef<Path>, name: &'static str, cfds: impl IntoIterator<Item = ColumnFamilyDescriptor>, ) -> Result<DB>

Open RocksDB with the provided column family descriptors. This allows to configure options for each column family.

pub fn open_cf_readonly( opts: &Options, path: impl AsRef<Path>, name: &'static str, cfs: Vec<ColumnFamilyName>, ) -> Result<DB>

Open db in readonly mode. This db is completely static, so any writes that occur on the primary after it has been opened will not be visible to the readonly instance.

pub fn open_cf_as_secondary<P: AsRef<Path>>( opts: &Options, primary_path: P, secondary_path: P, name: &'static str, cfs: Vec<ColumnFamilyName>, ) -> Result<DB>

Open db in secondary mode. A secondary db is does not support writes, but can be dynamically caught up to the primary instance by a manual call. See https://github.com/facebook/rocksdb/wiki/Read-only-and-Secondary-instances for more details.

pub fn get<S: Schema>( &self, schema_key: &impl KeyCodec<S>, ) -> Result<Option<S::Value>>

Reads single record by key.

pub fn put<S: Schema>( &self, key: &impl KeyCodec<S>, value: &impl ValueCodec<S>, ) -> Result<()>

Writes single record.

pub fn iter<S: Schema>(&self) -> Result<SchemaIterator<'_, S>>

Returns a forward SchemaIterator on a certain schema with the default read options.

pub fn iter_with_opts<S: Schema>( &self, opts: ReadOptions, ) -> Result<SchemaIterator<'_, S>>

Returns a forward SchemaIterator on a certain schema with the provided read options.

pub fn rev_iter<S: Schema>(&self) -> Result<SchemaIterator<'_, S>>

Returns a backward SchemaIterator on a certain schema with the default read options.

pub fn rev_iter_with_opts<S: Schema>( &self, opts: ReadOptions, ) -> Result<SchemaIterator<'_, S>>

Returns a backward SchemaIterator on a certain schema with the provided read options.

pub fn write_schemas(&self, batch: SchemaBatch) -> Result<()>

Writes a group of records wrapped in a SchemaBatch.

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

Flushes MemTable data. This is only used for testing get_approximate_sizes_cf in unit tests.

pub fn get_property(&self, cf_name: &str, property_name: &str) -> Result<u64>

Returns the current RocksDB property value for the provided column family name and property name.

pub fn create_checkpoint<P: AsRef<Path>>(&self, path: P) -> Result<()>

Creates new physical DB checkpoint in directory specified by path.

Trait Implementations

impl Debug for DB

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

Formats the value using the given formatter.