Struct RocksDBStore 

pub struct RocksDBStore { /* private fields */ }

Persistent storage with RocksDB.

Implementations

impl RocksDBStore

pub fn describe_tables() -> BTreeMap<String, (String, String)>

Returns a list of the tables name and type pairs

impl RocksDBStore

pub fn open_tables_read_write( path: PathBuf, metric_conf: MetricConf, global_db_options_override: Option<Options>, tables_db_options_override: Option<DBMapTableConfigMap>, ) -> Self

Opens a set of tables in read-write mode Only one process is allowed to do this at a time global_db_options_override apply to the whole DB tables_db_options_override apply to each table. If None, the attributes from default_options_override_fn are used if any

pub fn open_tables_read_write_with_deprecation_option( path: PathBuf, metric_conf: MetricConf, global_db_options_override: Option<Options>, tables_db_options_override: Option<DBMapTableConfigMap>, remove_deprecated_tables: bool, ) -> Self

pub fn get_read_only_handle( primary_path: PathBuf, with_secondary_path: Option<PathBuf>, global_db_options_override: Option<Options>, metric_conf: MetricConf, ) -> RocksDBStoreReadOnly

This opens the DB in read only mode and returns a struct which exposes debug features

impl RocksDBStore

pub fn new(path: &str) -> Self

Creates a new instance of RocksDB storage.

Trait Implementations

impl Store for RocksDBStore

fn write(&self, write_batch: WriteBatch) -> Result<(), ConsensusError>

Writes blocks, consensus commits and other data to store atomically.

fn read_blocks( &self, refs: &[BlockRef], ) -> Result<Vec<Option<VerifiedBlock>>, ConsensusError>

Reads blocks for the given refs.

fn contains_blocks( &self, refs: &[BlockRef], ) -> Result<Vec<bool>, ConsensusError>

Checks if blocks exist in the store.

fn scan_blocks_by_author( &self, author: AuthorityIndex, start_round: Round, ) -> Result<Vec<VerifiedBlock>, ConsensusError>

Reads blocks for an authority, from start_round.

fn scan_blocks_by_author_in_range( &self, author: AuthorityIndex, start_round: Round, end_round: Round, limit: usize, ) -> Result<Vec<VerifiedBlock>, ConsensusError>

Reads blocks for an authority in [start_round, end_round), up to limit.

fn scan_last_blocks_by_author( &self, author: AuthorityIndex, num_of_rounds: u64, before_round: Option<Round>, ) -> Result<Vec<VerifiedBlock>, ConsensusError>

fn read_last_commit(&self) -> Result<Option<TrustedCommit>, ConsensusError>

Reads the last commit.

fn scan_commits( &self, range: CommitRange, ) -> Result<Vec<TrustedCommit>, ConsensusError>

Reads all commits from start (inclusive) until end (inclusive).

fn read_commit_votes( &self, commit_index: CommitIndex, ) -> Result<Vec<BlockRef>, ConsensusError>

Reads all blocks voting on a particular commit.

fn read_last_commit_info( &self, ) -> Result<Option<(CommitRef, CommitInfo)>, ConsensusError>

Reads the last commit info, written atomically with the last commit.

fn read_last_finalized_commit( &self, ) -> Result<Option<CommitRef>, ConsensusError>

Reads the last finalized commit.

fn read_rejected_transactions( &self, commit_ref: CommitRef, ) -> Result<Option<BTreeMap<BlockRef, Vec<TransactionIndex>>>, ConsensusError>