Struct b_table::Table

pub struct Table<S, IS, C, G> { /* private fields */ }

A database table with support for multiple indices

Implementations

impl<S, C, FE, G> Table<S, S::Index, C, G>

where S: Schema, C: Collate<Value = S::Value> + 'static, FE: AsType<Node<S::Value>> + Send + Sync + 'static, G: DirDeref<Entry = FE> + 'static, Node<S::Value>: FileLoad, Range<S::Id, S::Value>: Debug,

pub async fn contains(&self, key: &[S::Value]) -> Result<bool, Error>

Return true if the given key is present in this Table.

pub async fn first( &self, range: Range<S::Id, S::Value>, order: &[S::Id], select: Option<&[S::Id]> ) -> Result<Option<Row<S::Value>>, Error>

Return the first row in the given range using the given order.

pub async fn get_row( &self, key: &[S::Value] ) -> Result<Option<Row<S::Value>>, Error>

Look up a row by its key.

pub async fn get_value( &self, key: &[S::Value] ) -> Result<Option<Row<S::Value>>, Error>

Look up a value by its key.

impl<S, C, FE, G> Table<S, S::Index, C, G>

where S: Schema, C: Collate<Value = S::Value> + Clone + Send + Sync + 'static, FE: AsType<Node<S::Value>> + Send + Sync + 'static, G: DirDeref<Entry = FE> + Clone + Send + Sync + 'static, Node<S::Value>: FileLoad, Range<S::Id, S::Value>: Debug,

pub async fn count(&self, range: Range<S::Id, S::Value>) -> Result<u64, Error>

Count how many rows in this Table lie within the given range.

pub async fn is_empty( &self, range: Range<S::Id, S::Value> ) -> Result<bool, Error>

Return true if the given Range of this Table does not contain any rows.

pub async fn rows<'a>( &'a self, range: Range<S::Id, S::Value>, order: &'a [S::Id], reverse: bool, select: Option<&'a [S::Id]> ) -> Result<Rows<S::Value>, Error>

Construct a [Stream] of the selected columns of the Rows within the given range.

pub async fn into_rows(self) -> Result<Rows<S::Value>, Error>

Consume this TableReadGuard to construct a [Stream] of all the rows in the Table.

impl<S, IS, C, FE> Table<S, IS, C, DirWriteGuardOwned<FE>>

pub fn downgrade(self) -> Table<S, IS, C, Arc<DirReadGuardOwned<FE>>>

Downgrade this write lock to a read lock.

impl<S, C, FE> Table<S, S::Index, C, DirWriteGuardOwned<FE>>

where S: Schema + Send + Sync, C: Collate<Value = S::Value> + Clone + Send + Sync + 'static, FE: AsType<Node<S::Value>> + Send + Sync + 'static, <S as Schema>::Index: Send + Sync, Node<S::Value>: FileLoad,

pub async fn delete_row(&mut self, key: &[S::Value]) -> Result<bool, Error>

Delete a row from this Table by its key. Returns true if the given key was present.

pub async fn delete_range( &mut self, range: Range<S::Id, S::Value> ) -> Result<usize, Error>

Delete all rows in the given range from this Table.

pub async fn delete_all( &mut self, other: TableReadGuard<S, S::Index, C, FE> ) -> Result<(), Error>

Delete all rows from the other table from this one. The other table must have an identical schema and collation.

pub async fn merge( &mut self, other: TableReadGuard<S, S::Index, C, FE> ) -> Result<(), Error>

Insert all rows from the other table into this one. The other table must have an identical schema and collation.

pub async fn upsert( &mut self, key: Vec<S::Value>, values: Vec<S::Value> ) -> Result<bool, S::Error>

Insert or update a row in this Table. Returns true if a new row was inserted.

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

Delete all rows from this Table.

Trait Implementations

impl<S, IS, C, G> Clone for Table<S, IS, C, G>

where C: Clone, G: Clone,

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: Debug, IS, C, G> Debug for Table<S, IS, C, G>

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

Formats the value using the given formatter.