Skip to main content

Db

commonware_storage::qmdb::current::db

Struct Db 

Source 
pub struct Db<E: Storage + Clock + Metrics, C: Contiguous<Item: CodecShared>, I: UnorderedIndex<Value = Location>, H: Hasher, U: Send + Sync, const N: usize> { /* private fields */ }
Expand description

A Current QMDB implementation generic over ordered/unordered keys and variable/fixed values.

Implementations§

Source§

impl<E, K, V, C, I, H, U, const N: usize> Db<E, C, I, H, U, N>
where E: Storage + Clock + Metrics, K: Key, V: ValueEncoding, U: Update<K, V>, C: Contiguous<Item = Operation<K, V, U>>, I: UnorderedIndex<Value = Location>, H: Hasher, Operation<K, V, U>: Codec,

Source

pub const fn inactivity_floor_loc(&self) -> Location

Return the inactivity floor location. This is the location before which all operations are known to be inactive. Operations before this point can be safely pruned.

Source

pub const fn is_empty(&self) -> bool

Whether the snapshot currently has no active keys.

Source

pub async fn get_metadata(&self) -> Result<Option<V::Value>, Error>

Get the metadata associated with the last commit.

Source

pub fn verify_range_proof( hasher: &mut H, proof: &RangeProof<H::Digest>, start_loc: Location, ops: &[Operation<K, V, U>], chunks: &[[u8; N]], root: &H::Digest, ) -> bool

Return true if the given sequence of ops were applied starting at location start_loc in the log with the provided root, having the activity status described by chunks.

Source§

impl<E, K, V, U, C, I, H, const N: usize> Db<E, C, I, H, U, N>
where E: Storage + Clock + Metrics, K: Key, V: ValueEncoding, U: Update<K, V>, C: Contiguous<Item = Operation<K, V, U>>, I: UnorderedIndex<Value = Location>, H: Hasher, Operation<K, V, U>: Codec,

Source

pub const fn root(&self) -> H::Digest

Returns the canonical root. See the Root structure section in the module documentation.

Source

pub fn ops_root(&self) -> H::Digest

Returns the ops MMR root.

This is the root of the raw operations log, without the activity bitmap. It is used as the sync target because the sync engine verifies batches against the ops MMR, not the canonical root.

See the Root structure section in the module documentation.

Source

pub fn new_batch( &self, ) -> UnmerkleizedBatch<'_, E, K, V, C, I, H, U, Mmr<E, H::Digest>, Mmr<H::Digest>, BitMap<N>, N>

Create a new speculative batch of operations with this database as its parent.

Source

pub async fn range_proof( &self, hasher: &mut H, start_loc: Location, max_ops: NonZeroU64, ) -> Result<(RangeProof<H::Digest>, Vec<Operation<K, V, U>>, Vec<[u8; N]>), Error>

Returns a proof that the specified range of operations are part of the database, along with the operations from the range. A truncated range (from hitting the max) can be detected by looking at the length of the returned operations vector. Also returns the bitmap chunks required to verify the proof.

§Errors

Returns Error::OperationPruned if start_loc falls in a pruned bitmap chunk. Returns mmr::Error::LocationOverflow if start_loc > mmr::MAX_LOCATION. Returns mmr::Error::RangeOutOfBounds if start_loc >= number of leaves in the MMR.

Source§

impl<E, K, V, U, C, I, H, const N: usize> Db<E, C, I, H, U, N>
where E: Storage + Clock + Metrics, K: Key, V: ValueEncoding, U: Update<K, V>, C: Mutable<Item = Operation<K, V, U>>, I: UnorderedIndex<Value = Location>, H: Hasher, Operation<K, V, U>: Codec,

Source

pub async fn ops_historical_proof( &self, historical_size: Location, start_loc: Location, max_ops: NonZeroU64, ) -> Result<(Proof<H::Digest>, Vec<Operation<K, V, U>>), Error>

Returns an ops-level historical proof for the specified range.

Unlike range_proof which returns grafted proofs incorporating the activity bitmap, this returns standard MMR proofs suitable for state sync.

Source

pub async fn prune(&mut self, prune_loc: Location) -> Result<(), Error>

Prunes historical operations prior to prune_loc. This does not affect the db’s root or snapshot.

§Errors
Source§

impl<E, K, V, U, C, I, H, const N: usize> Db<E, C, I, H, U, N>
where E: Storage + Clock + Metrics, K: Key, V: ValueEncoding, U: Update<K, V>, C: Mutable<Item = Operation<K, V, U>> + Persistable<Error = Error>, I: UnorderedIndex<Value = Location>, H: Hasher, Operation<K, V, U>: Codec,

Source

pub async fn sync(&self) -> Result<(), Error>

Sync all database state to disk.

Source

pub async fn destroy(self) -> Result<(), Error>

Destroy the db, removing all data from disk.

Source§

impl<E, K, V, U, C, I, H, const N: usize> Db<E, C, I, H, U, N>
where E: Storage + Clock + Metrics, K: Key, V: ValueEncoding, U: Update<K, V> + 'static, C: Mutable<Item = Operation<K, V, U>> + Persistable<Error = Error>, I: UnorderedIndex<Value = Location>, H: Hasher, Operation<K, V, U>: Codec,

Source

pub async fn apply_batch( &mut self, batch: Changeset<K, H::Digest, Operation<K, V, U>, N>, ) -> Result<Range<Location>, Error>

Apply a changeset to the database.

A changeset is only valid if the database has not been modified since the batch that produced it was created. Multiple batches can be forked from the same parent for speculative execution, but only one may be applied. Applying a stale changeset returns Error::StaleChangeset.

Returns the range of locations written.

Source§

impl<E: Storage + Clock + Metrics, C: Contiguous<Item = Operation<K, V>>, K: Key, V: ValueEncoding, I: OrderedIndex<Value = Location>, H: Hasher, const N: usize> Db<E, C, I, H, Update<K, V>, N>
where Operation<K, V>: Codec, V::Value: Send + Sync,

Source

pub async fn get(&self, key: &K) -> Result<Option<V::Value>, Error>

Get the value of key in the db, or None if it has no value.

Source

pub fn verify_key_value_proof( hasher: &mut H, key: K, value: V::Value, proof: &KeyValueProof<K, H::Digest, N>, root: &H::Digest, ) -> bool

Return true if the proof authenticates that key currently has value value in the db with the provided root.

Source

pub async fn get_span( &self, key: &K, ) -> Result<Option<(Location, Update<K, V>)>, Error>

Get the operation that currently defines the span whose range contains key, or None if the DB is empty.

Source

pub async fn stream_range<'a>( &'a self, start: K, ) -> Result<impl Stream<Item = Result<(K, V::Value), Error>> + 'a, Error>
where V: 'a,

Streams all active (key, value) pairs in the database in key order, starting from the first active key greater than or equal to start.

Source

pub fn verify_exclusion_proof( hasher: &mut H, key: &K, proof: &ExclusionProof<K, V, H::Digest, N>, root: &H::Digest, ) -> bool

Return true if the proof authenticates that key does not exist in the db with the provided root.

Source§

impl<E: Storage + Clock + Metrics, C: Mutable<Item = Operation<K, V>>, K: Key, V: ValueEncoding, I: OrderedIndex<Value = Location>, H: Hasher, const N: usize> Db<E, C, I, H, Update<K, V>, N>
where Operation<K, V>: Codec, V::Value: Send + Sync,

Source

pub async fn key_value_proof( &self, hasher: &mut H, key: K, ) -> Result<KeyValueProof<K, H::Digest, N>, Error>

Generate and return a proof of the current value of key, along with the other KeyValueProof required to verify the proof. Returns KeyNotFound error if the key is not currently assigned any value.

§Errors

Returns Error::KeyNotFound if the key is not currently assigned any value.

Source

pub async fn exclusion_proof( &self, hasher: &mut H, key: &K, ) -> Result<ExclusionProof<K, V, H::Digest, N>, Error>

Generate and return a proof that the specified key does not exist in the db.

§Errors

Returns Error::KeyExists if the key exists in the db.

Source§

impl<E: RStorage + Clock + Metrics, K: Array, V: FixedValue, H: Hasher, T: Translator, const P: usize, const N: usize> Db<E, Journal<E, Operation<K, FixedEncoding<V>, Update<K, FixedEncoding<V>>>>, Index<T, Location, P>, H, Update<K, FixedEncoding<V>>, N>

Source

pub async fn init(context: E, config: Config<T>) -> Result<Self, Error>

Initializes a Db authenticated database from the given config. Leverages parallel Merkleization to initialize the bitmap MMR if a thread pool is provided.

Source§

impl<E: RStorage + Clock + Metrics, K: Array, V: FixedValue, H: Hasher, T: Translator, const N: usize> Db<E, Journal<E, Operation<K, FixedEncoding<V>, Update<K, FixedEncoding<V>>>>, Index<T, Location>, H, Update<K, FixedEncoding<V>>, N>

Source

pub async fn init(context: E, config: Config<T>) -> Result<Self, Error>

Initializes a Db from the given config. Leverages parallel Merkleization to initialize the bitmap MMR if a thread pool is provided.

Source§

impl<E: RStorage + Clock + Metrics, K: Key, V: VariableValue, H: Hasher, T: Translator, const P: usize, const N: usize> Db<E, Journal<E, Operation<K, VariableEncoding<V>, Update<K, VariableEncoding<V>>>>, Index<T, Location, P>, H, Update<K, VariableEncoding<V>>, N>
where Operation<K, V>: Codec,

Source

pub async fn init( context: E, config: Config<T, <Operation<K, V> as Read>::Cfg>, ) -> Result<Self, Error>

Initializes a Db from the given config. Leverages parallel Merkleization to initialize the bitmap MMR if a thread pool is provided.

Source§

impl<E: RStorage + Clock + Metrics, K: Key, V: VariableValue, H: Hasher, T: Translator, const N: usize> Db<E, Journal<E, Operation<K, VariableEncoding<V>, Update<K, VariableEncoding<V>>>>, Index<T, Location>, H, Update<K, VariableEncoding<V>>, N>
where Operation<K, V>: Codec,

Source

pub async fn init( context: E, config: Config<T, <Operation<K, V> as Read>::Cfg>, ) -> Result<Self, Error>

Initializes a Db from the given config. Leverages parallel Merkleization to initialize the bitmap MMR if a thread pool is provided.

Source§

impl<E: Storage + Clock + Metrics, C: Contiguous<Item = Operation<K, V>>, K: Array, V: ValueEncoding, I: UnorderedIndex<Value = Location>, H: Hasher, const N: usize> Db<E, C, I, H, Update<K, V>, N>
where Operation<K, V>: Codec, V::Value: Send + Sync,

Source

pub async fn get(&self, key: &K) -> Result<Option<V::Value>, Error>

Get the value of key in the db, or None if it has no value.

Source

pub fn verify_key_value_proof( hasher: &mut H, key: K, value: V::Value, proof: &KeyValueProof<H::Digest, N>, root: &H::Digest, ) -> bool

Return true if the proof authenticates that key currently has value value in the db with the provided root.

Source§

impl<E: Storage + Clock + Metrics, C: Mutable<Item = Operation<K, V>>, K: Array, V: ValueEncoding, I: UnorderedIndex<Value = Location>, H: Hasher, const N: usize> Db<E, C, I, H, Update<K, V>, N>
where Operation<K, V>: Codec, V::Value: Send + Sync,

Source

pub async fn key_value_proof( &self, hasher: &mut H, key: K, ) -> Result<KeyValueProof<H::Digest, N>, Error>

Generate and return a proof of the current value of key, along with the other KeyValueProof required to verify the proof. Returns KeyNotFound error if the key is not currently assigned any value.

§Errors

Returns Error::KeyNotFound if the key is not currently assigned any value.

Source§

impl<E: RStorage + Clock + Metrics, K: Array, V: FixedValue, H: Hasher, T: Translator, const P: usize, const N: usize> Db<E, Journal<E, Operation<K, FixedEncoding<V>, Update<K, FixedEncoding<V>>>>, Index<T, Location, P>, H, Update<K, FixedEncoding<V>>, N>

Source

pub async fn init(context: E, config: Config<T>) -> Result<Self, Error>

Initializes a Db authenticated database from the given config. Leverages parallel Merkleization to initialize the bitmap MMR if a thread pool is provided.

Source§

impl<E: RStorage + Clock + Metrics, K: Array, V: FixedValue, H: Hasher, T: Translator, const N: usize> Db<E, Journal<E, Operation<K, FixedEncoding<V>, Update<K, FixedEncoding<V>>>>, Index<T, Location>, H, Update<K, FixedEncoding<V>>, N>

Source

pub async fn init(context: E, config: Config<T>) -> Result<Self, Error>

Initializes a Db authenticated database from the given config. Leverages parallel Merkleization to initialize the bitmap MMR if a thread pool is provided.

Source§

impl<E: RStorage + Clock + Metrics, K: Array, V: VariableValue, H: Hasher, T: Translator, const P: usize, const N: usize> Db<E, Journal<E, Operation<K, VariableEncoding<V>, Update<K, VariableEncoding<V>>>>, Index<T, Location, P>, H, Update<K, VariableEncoding<V>>, N>
where Operation<K, V>: Read,

Source

pub async fn init( context: E, config: Config<T, <Operation<K, V> as Read>::Cfg>, ) -> Result<Self, Error>

Initializes a Db from the given config. Leverages parallel Merkleization to initialize the bitmap MMR if a thread pool is provided.

Source§

impl<E: RStorage + Clock + Metrics, K: Array, V: VariableValue, H: Hasher, T: Translator, const N: usize> Db<E, Journal<E, Operation<K, VariableEncoding<V>, Update<K, VariableEncoding<V>>>>, Index<T, Location>, H, Update<K, VariableEncoding<V>>, N>
where Operation<K, V>: Read,

Source

pub async fn init( context: E, config: Config<T, <Operation<K, V> as Read>::Cfg>, ) -> Result<Self, Error>

Initializes a Db from the given config. Leverages parallel Merkleization to initialize the bitmap MMR if a thread pool is provided.

Trait Implementations§

Source§

impl<E, K, V, U, C, I, H, const N: usize> LogStore for Db<E, C, I, H, U, N>
where E: Storage + Clock + Metrics, K: Key, V: ValueEncoding, U: Update<K, V>, C: Contiguous<Item = Operation<K, V, U>>, I: UnorderedIndex<Value = Location>, H: Hasher, Operation<K, V, U>: Codec,

Source§

type Value = <V as ValueEncoding>::Value

Source§

async fn bounds(&self) -> Range<Location>

Return [start, end) where start and end - 1 are the Locations of the oldest and newest retained operations respectively.
Source§

async fn get_metadata(&self) -> Result<Option<V::Value>, Error>

Get the metadata associated with the last commit.
Source§

fn size(&self) -> impl Future<Output = Location> + Send

Return the Location of the next operation appended to this db.
Source§

impl<E, K, V, U, C, I, H, const N: usize> MerkleizedStore for Db<E, C, I, H, U, N>
where E: Storage + Clock + Metrics, K: Key, V: ValueEncoding, U: Update<K, V>, C: Mutable<Item = Operation<K, V, U>>, I: UnorderedIndex<Value = Location>, H: Hasher, Operation<K, V, U>: Codec,

Source§

type Digest = <H as Hasher>::Digest

The digest type used for authentication.
Source§

type Operation = Operation<K, V, U>

The operation type stored in the log.
Source§

fn root(&self) -> H::Digest

Returns the root digest of the authenticated store.
Source§

async fn historical_proof( &self, historical_size: Location, start_loc: Location, max_ops: NonZeroU64, ) -> Result<(Proof<Self::Digest>, Vec<Self::Operation>), Error>

Generate and return: Read more
Source§

fn proof( &self, start_loc: Location, max_ops: NonZeroU64, ) -> impl Future<Output = Result<(Proof<Self::Digest>, Vec<Self::Operation>), Error>> + Send

Generate and return: Read more
Source§

impl<E, K, V, U, C, I, H, const N: usize> Persistable for Db<E, C, I, H, U, N>
where E: Storage + Clock + Metrics, K: Key, V: ValueEncoding, U: Update<K, V>, C: Mutable<Item = Operation<K, V, U>> + Persistable<Error = Error>, I: UnorderedIndex<Value = Location>, H: Hasher, Operation<K, V, U>: Codec,

Source§

type Error = Error

The error type returned when there is a failure from the underlying storage system.
Source§

async fn commit(&self) -> Result<(), Error>

Durably persist the structure, guaranteeing the current state will survive a crash. Read more
Source§

async fn sync(&self) -> Result<(), Error>

Durably persist the structure, guaranteeing the current state will survive a crash, and that no recovery will be needed on startup. Read more
Source§

async fn destroy(self) -> Result<(), Error>

Destroy the structure, removing all associated storage. Read more
Source§

impl<E, K, V, U, C, I, H, const N: usize> PrunableStore for Db<E, C, I, H, U, N>
where E: Storage + Clock + Metrics, K: Key, V: ValueEncoding, U: Update<K, V>, C: Mutable<Item = Operation<K, V, U>>, I: UnorderedIndex<Value = Location>, H: Hasher, Operation<K, V, U>: Codec,

Source§

async fn prune(&mut self, prune_loc: Location) -> Result<(), Error>

Prune historical operations prior to loc.
Source§

async fn inactivity_floor_loc(&self) -> Location

The location before which all operations can be pruned without affecting the state of the database.

Auto Trait Implementations§

§

impl<E, C, I, H, U, const N: usize> !Freeze for Db<E, C, I, H, U, N>

§

impl<E, C, I, H, U, const N: usize> !RefUnwindSafe for Db<E, C, I, H, U, N>

§

impl<E, C, I, H, U, const N: usize> Send for Db<E, C, I, H, U, N>
where <C as Contiguous>::Item: Sized,

§

impl<E, C, I, H, U, const N: usize> Sync for Db<E, C, I, H, U, N>
where <C as Contiguous>::Item: Sized,

§

impl<E, C, I, H, U, const N: usize> Unpin for Db<E, C, I, H, U, N>
where <C as Contiguous>::Item: Sized, <H as Hasher>::Digest: Unpin, I: Unpin, C: Unpin, U: Unpin, H: Unpin, E: Unpin, <E as Storage>::Blob: Unpin,

§

impl<E, C, I, H, U, const N: usize> UnsafeUnpin for Db<E, C, I, H, U, N>
where <C as Contiguous>::Item: Sized, <H as Hasher>::Digest: UnsafeUnpin, I: UnsafeUnpin, C: UnsafeUnpin, H: UnsafeUnpin, E: UnsafeUnpin, <E as Storage>::Blob: UnsafeUnpin,

§

impl<E, C, I, H, U, const N: usize> !UnwindSafe for Db<E, C, I, H, U, N>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,