Struct parity_db::Db

pub struct Db { /* private fields */ }

Implementations

impl Db

pub fn with_columns(path: &Path, num_columns: u8) -> Result<Db>

pub fn open(options: &Options) -> Result<Db>

Open the database with given options.

pub fn open_or_create(options: &Options) -> Result<Db>

Create the database using given options.

pub fn open_read_only(options: &Options) -> Result<Db>

Read the database using given options

pub fn get(&self, col: ColId, key: &[u8]) -> Result<Option<Value>>

Get a value in a specified column by key. Returns None if the key does not exist.

pub fn get_size(&self, col: ColId, key: &[u8]) -> Result<Option<u32>>

Get value size by key. Returns None if the key does not exist.

pub fn iter(&self, col: ColId) -> Result<BTreeIterator<'_>>

Iterate over all ordered key-value pairs. Only supported for columns configured with btree_indexed.

pub fn commit<I, K>(&self, tx: I) -> Result<()>where
    I: IntoIterator<Item = (ColId, K, Option<Value>)>,
    K: AsRef<[u8]>,

Commit a set of changes to the database.

pub fn commit_changes<I>(&self, tx: I) -> Result<()>where
    I: IntoIterator<Item = (ColId, Operation<Vec<u8>, Vec<u8>>)>,

Commit a set of changes to the database.

pub fn num_columns(&self) -> u8

Returns the number of columns in the database.

pub fn iter_column_while(
    &self,
    c: ColId,
    f: impl FnMut(IterState) -> bool
) -> Result<()>

Iterate a column and call a function for each value. This is only supported for columns with btree_index set to false. Iteration order is unspecified. Note that the key field in the state is the hash of the original key. Unlinke get the iteration may not include changes made in recent commit calls.

pub fn write_stats_text(
    &self,
    writer: &mut impl Write,
    column: Option<u8>
) -> Result<()>

pub fn clear_stats(&self, column: Option<u8>) -> Result<()>

pub fn dump(&self, check_param: CheckOptions) -> Result<()>

Print database contents in text form to stderr.

pub fn stats(&self) -> StatSummary

Get database statistics.

pub fn add_column(
    options: &mut Options,
    new_column_options: ColumnOptions
) -> Result<()>

Add a new column with options specified by new_column_options.

Trait Implementations

impl Drop for Db

fn drop(&mut self)

Executes the destructor for this type.