Skip to main content

Database

Struct Database 

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

A cloneable handle to an embedded Basalt database.

Implementations§

Source§

impl Database

Source

pub fn in_memory() -> Database

Create an empty, non-durable database.

Source

pub fn open(path: impl AsRef<Path>) -> Result<Database, DbError>

Open or create a durable database at path.

Source

pub fn begin(&self) -> Result<Transaction, DbError>

Begin an optimistic snapshot transaction.

Source

pub fn transaction(&self) -> Result<Transaction, DbError>

Alias for Database::begin using the conventional transaction name.

Source

pub fn connect(&self) -> Connection

Create a stateful connection. Connections are useful when SQL BEGIN, COMMIT, and ROLLBACK statements span multiple calls.

Source

pub fn execute(&self, stmt: &Statement) -> Result<StatementResult, DbError>

Execute one statement as an autocommit operation.

Source

pub fn execute_sql(&self, sql: &str) -> Result<Vec<StatementResult>, DbError>

Parse and execute all statements through a fresh autocommit connection.

Source

pub fn checkpoint(&self) -> Result<(), DbError>

Flush the current state into the page file and clear committed WAL frames. Checkpointing is safe while readers are active.

Source

pub fn generation(&self) -> u64

Current committed generation, useful for diagnostics and tests.

Source

pub fn table_names(&self) -> Result<Vec<String>, DbError>

Return table names in deterministic order for schema discovery tools.

Source

pub fn columns(&self, table: &str) -> Result<Vec<Column>, DbError>

Return a table’s column metadata for migrations and introspection.

Source

pub fn row_count(&self, table: &str) -> Result<usize, DbError>

Return the number of live rows in a table without materializing them.

Trait Implementations§

Source§

impl Clone for Database

Source§

fn clone(&self) -> Database

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

Auto Trait Implementations§

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> Same for T

Source§

type Output = T

Should always be Self
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 = !

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

fn try_from(value: U) -> Result<T, !>

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