Skip to main content

Db

Struct Db 

Source
pub struct Db { /* private fields */ }
Expand description

An immutable database value.

A Db names a snapshot to read from; Db::as_of, Db::since, and Db::history derive new views cheaply. Every read method is async because the remote backend may need a round trip; the local backend resolves in-process.

Implementations§

Source§

impl Db

Source

pub fn db_name(&self) -> &str

The database name.

Source

pub fn view(&self) -> View

This value’s time view.

Source

pub fn as_of(&self, t: u64) -> Self

The value as of transaction t (inclusive).

Source

pub fn since(&self, t: u64) -> Self

The value including only assertions since transaction t.

Source

pub fn history(&self) -> Self

The full history view, including retractions.

Source

pub async fn query( &self, query: &Query, args: Args, ) -> Result<QueryResult, ClientError>

Runs a typed Query with input arguments.

The receiver binds the query’s default $ source; additional non-database :in inputs are supplied positionally by args.

§Errors

Returns ClientError for malformed queries or execution failures.

Source

pub async fn query_edn( &self, query: Edn, args: Vec<Edn>, ) -> Result<QueryResult, ClientError>

Runs a raw boundary-Edn query with positional argument forms — an escape hatch for queries not built through Query.

§Errors

Returns ClientError for malformed queries or execution failures.

Source

pub async fn pull( &self, pattern: &Pull, entity: impl IntoEdn, ) -> Result<Edn, ClientError>

Pulls a typed Pull specification for one entity.

The entity is named by any IntoEdn value the boundary accepts: an entity id (long), an ident keyword, or a lookup ref (tx::lookup(...)).

§Errors

Returns ClientError for malformed patterns or unknown idents.

Source

pub async fn datoms( &self, index: Index, components: Vec<Edn>, limit: usize, ) -> Result<Vec<DatomRow>, ClientError>

Scans datoms from a covering index, binding components as a leading prefix in the index’s order.

§Errors

Returns ClientError on bad components or transport failure.

Source

pub async fn stats(&self) -> Result<DbStats, ClientError>

Coarse statistics for this view.

§Errors

Returns ClientError on transport failure.

Source

pub async fn basis_t(&self) -> Result<u64, ClientError>

The basis transaction of this view.

§Errors

Returns ClientError on transport failure.

Trait Implementations§

Source§

impl Clone for Db

Source§

fn clone(&self) -> Db

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Db

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl !RefUnwindSafe for Db

§

impl !UnwindSafe for Db

§

impl Freeze for Db

§

impl Send for Db

§

impl Sync for Db

§

impl Unpin for Db

§

impl UnsafeUnpin for Db

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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<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