Struct RocksDBProvider 

pub struct RocksDBProvider(/* private fields */);

RocksDB provider for auxiliary storage layer beside main database MDBX.

Implementations

impl RocksDBProvider

pub fn check_consistency<Provider>( &self, provider: &Provider, ) -> ProviderResult<Option<BlockNumber>>

where Provider: DBProvider + StageCheckpointReader + StorageSettingsCache + StaticFileProviderFactory + TransactionsProvider<Transaction: Encodable2718>,

Checks consistency of RocksDB tables against MDBX stage checkpoints.

Returns an unwind target block number if the pipeline needs to unwind to rebuild RocksDB data. Returns None if all invariants pass or if inconsistencies were healed.

Invariants checked

For TransactionHashNumbers:

• The maximum TxNumber value should not exceed what the TransactionLookup stage checkpoint indicates has been processed.
• If RocksDB is ahead, excess entries are pruned (healed).
• If RocksDB is behind, an unwind is required.

For StoragesHistory:

• The maximum block number in shards should not exceed the IndexStorageHistory stage checkpoint.
• Similar healing/unwind logic applies.

Requirements

For pruning TransactionHashNumbers, the provider must be able to supply transaction data (typically from static files) so that transaction hashes can be computed. This implies that static files should be ahead of or in sync with RocksDB.

impl RocksDBProvider

pub fn new(path: impl AsRef<Path>) -> ProviderResult<Self>

Creates a new RocksDB provider.

pub fn builder(path: impl AsRef<Path>) -> RocksDBBuilder

Creates a new RocksDB provider builder.

pub fn tx(&self) -> RocksTx<'_>

Creates a new transaction with MDBX-like semantics (read-your-writes, rollback).

pub fn batch(&self) -> RocksDBBatch<'_>

Creates a new batch for atomic writes.

Use Self::write_batch for closure-based atomic writes. Use this method when the batch needs to be held by crate::EitherWriter.

pub fn get<T: Table>(&self, key: T::Key) -> ProviderResult<Option<T::Value>>

Gets a value from the specified table.

pub fn get_encoded<T: Table>( &self, key: &<T::Key as Encode>::Encoded, ) -> ProviderResult<Option<T::Value>>

Gets a value from the specified table using pre-encoded key.

pub fn put<T: Table>(&self, key: T::Key, value: &T::Value) -> ProviderResult<()>

Puts upsert a value into the specified table with the given key.

pub fn put_encoded<T: Table>( &self, key: &<T::Key as Encode>::Encoded, value: &T::Value, ) -> ProviderResult<()>

Puts a value into the specified table using pre-encoded key.

pub fn delete<T: Table>(&self, key: T::Key) -> ProviderResult<()>

Deletes a value from the specified table.

pub fn first<T: Table>(&self) -> ProviderResult<Option<(T::Key, T::Value)>>

Gets the first (smallest key) entry from the specified table.

pub fn last<T: Table>(&self) -> ProviderResult<Option<(T::Key, T::Value)>>

Gets the last (largest key) entry from the specified table.

pub fn iter<T: Table>(&self) -> ProviderResult<RocksDBIter<'_, T>>

Creates an iterator over all entries in the specified table.

Returns decoded (Key, Value) pairs in key order.

pub fn write_batch<F>(&self, f: F) -> ProviderResult<()>

where F: FnOnce(&mut RocksDBBatch<'_>) -> ProviderResult<()>,

Writes a batch of operations atomically.

pub fn commit_batch( &self, batch: WriteBatchWithTransaction<true>, ) -> ProviderResult<()>

Commits a raw WriteBatchWithTransaction to RocksDB.

This is used when the batch was extracted via RocksDBBatch::into_inner and needs to be committed at a later point (e.g., at provider commit time).

Trait Implementations

impl Clone for RocksDBProvider

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RocksDBProvider

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

Formats the value using the given formatter.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 8 bytes