Struct tc_table::TableIndex

pub struct TableIndex<F, D, Txn> { /* fields omitted */ }

The base type of a Table.

Implementations

impl<F: File<Node>, D: Dir, Txn: Transaction<D>> TableIndex<F, D, Txn>

pub async fn create(
    context: &D,
    schema: TableSchema,
    txn_id: TxnId
) -> TCResult<TableIndex<F, D, Txn>> where
    F: TryFrom<D::File, Error = TCError>,
    D::FileClass: From<BTreeType>, 

Create a new TableIndex with the given TableSchema.

pub async fn is_empty(&self, txn: &Txn) -> TCResult<bool>

Return true if this table has zero rows.

pub fn merge_bounds(&self, all_bounds: Vec<Bounds>) -> TCResult<Bounds>

Merge the given list of Bounds into a single Bounds instance.

Returns an error in the case that later Bounds are larger than earlier Bounds.

pub fn primary(&self) -> &Index<F, D, Txn>

Borrow the primary Index of this TableIndex.

pub fn supporting_index(&self, bounds: &Bounds) -> TCResult<Index<F, D, Txn>>

Return an index which supports the given Bounds, or an error if there is none.

pub async fn get(
    &self,
    txn_id: TxnId,
    key: Vec<Value>
) -> TCResult<Option<Vec<Value>>>

Return a single row in this table with the given primary key, or None if there is none.

pub async fn upsert(
    &self,
    txn_id: TxnId,
    key: Vec<Value>,
    values: Vec<Value>
) -> TCResult<()>

Insert a new row into this TableIndex, or update the row at the given key with values.

pub async fn slice_rows<'a>(
    self,
    txn_id: TxnId,
    bounds: Bounds,
    reverse: bool
) -> TCResult<TCTryStream<'a, Vec<Value>>>

Stream the rows within the given Bounds from the primary index of this TableIndex.

Trait Implementations

impl<F: Clone, D: Clone, Txn: Clone> Clone for TableIndex<F, D, Txn>

fn clone(&self) -> TableIndex<F, D, Txn>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: File<Node>, D: Dir, Txn: Transaction<D>, I: TableInstance<F, D, Txn> + 'static> CopyFrom<D, I> for TableIndex<F, D, Txn> where
    F: TryFrom<D::File, Error = TCError>,
    <D as Dir>::FileClass: From<BTreeType> + Send, 

fn copy_from<'async_trait>(
    source: I,
    dir: D,
    txn: Txn
) -> Pin<Box<dyn Future<Output = TCResult<Self>> + Send + 'async_trait>> where
    Self: 'async_trait, 

Copy a new instance of Self from an existing instance.

impl<F: File<Node>, D: Dir, Txn: Transaction<D>> Display for TableIndex<F, D, Txn>

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

Formats the value using the given formatter.

impl<F: File<Node>, D: Dir, Txn: Transaction<D>> From<TableIndex<F, D, Txn>> for Table<F, D, Txn>

fn from(table: TableIndex<F, D, Txn>) -> Self

Performs the conversion.

impl<F: File<Node>, D: Dir, Txn: Transaction<D>> Instance for TableIndex<F, D, Txn>

type Class = TableType

The Class type of this instance

fn class(&self) -> TableType

Returns the [Class] of this instance.

impl<F: File<Node>, D: Dir, Txn: Transaction<D>> Persist<D> for TableIndex<F, D, Txn> where
    F: TryFrom<D::File, Error = TCError>,
    <D as Dir>::FileClass: From<BTreeType> + Send, 

type Schema = TableSchema

type Store = D

type Txn = Txn

fn schema(&self) -> &Self::Schema

Return the schema of this persistent state.

fn load<'life0, 'async_trait>(
    txn: &'life0 Txn,
    schema: Self::Schema,
    store: Self::Store
) -> Pin<Box<dyn Future<Output = TCResult<Self>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Load a saved state from persistent storage.

impl<F: File<Node>, D: Dir, Txn: Transaction<D>> Restore<D> for TableIndex<F, D, Txn> where
    F: TryFrom<D::File, Error = TCError>,
    <D as Dir>::FileClass: From<BTreeType> + Send, 

fn restore<'life0, 'life1, 'async_trait>(
    &'life0 self,
    backup: &'life1 Self,
    txn_id: TxnId
) -> Pin<Box<dyn Future<Output = TCResult<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

impl<F: File<Node>, D: Dir, Txn: Transaction<D>> TableInstance<F, D, Txn> for TableIndex<F, D, Txn>

type OrderBy = Merged<F, D, Txn>

The type of Table returned by this instance’s order_by method.

type Reverse = Merged<F, D, Txn>

The type of Table returned by this instance’s reversed method.

type Slice = Merged<F, D, Txn>

The type of Table returned by this instance’s slice method.

fn count<'async_trait>(
    self,
    txn_id: TxnId
) -> Pin<Box<dyn Future<Output = TCResult<u64>> + Send + 'async_trait>> where
    Self: 'async_trait, 

Return the number of rows in this Table.

fn delete<'life0, 'async_trait>(
    &'life0 self,
    txn_id: TxnId
) -> Pin<Box<dyn Future<Output = TCResult<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Delete all rows in this Table.

fn delete_row<'life0, 'async_trait>(
    &'life0 self,
    txn_id: TxnId,
    row: Row
) -> Pin<Box<dyn Future<Output = TCResult<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Delete the given Row from this table, if present.

fn key(&self) -> &[Column]

Return the schema of this Table’s key.

fn values(&self) -> &[Column]

Return the schema of this Table’s values.

fn schema(&self) -> TableSchema

Return the schema of this Table.

fn order_by(self, columns: Vec<Id>, reverse: bool) -> TCResult<Self::OrderBy>

Set the order returned by rows.

fn reversed(self) -> TCResult<Self::Reverse>

Reverse the order returned by rows.

fn slice(self, bounds: Bounds) -> TCResult<Merged<F, D, Txn>>

Limit the returned rows to the given Bounds.

fn rows<'a, 'async_trait>(
    self,
    txn_id: TxnId
) -> Pin<Box<dyn Future<Output = TCResult<TCTryStream<'a, Vec<Value>>>> + Send + 'async_trait>> where
    'a: 'async_trait,
    Self: 'async_trait, 

Return a stream of the rows in this Table.

fn validate_bounds(&self, bounds: &Bounds) -> TCResult<()>

Return an error if this table does not support the given Bounds.

fn validate_order(&self, order: &[Id]) -> TCResult<()>

Return an error if this table does not support ordering by the given columns.

fn update<'life0, 'life1, 'async_trait>(
    &'life0 self,
    txn: &'life1 Txn,
    update: Row
) -> Pin<Box<dyn Future<Output = TCResult<()>> + Send + 'async_trait>> where
    F: TryFrom<D::File, Error = TCError>,
    D::FileClass: From<BTreeType>,
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Update the values of the columns in this Table to match the given Row.

fn update_row<'life0, 'async_trait>(
    &'life0 self,
    txn_id: TxnId,
    row: Row,
    update: Row
) -> Pin<Box<dyn Future<Output = TCResult<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Update one row of this Table.

fn upsert<'life0, 'async_trait>(
    &'life0 self,
    txn_id: TxnId,
    key: Vec<Value>,
    values: Vec<Value>
) -> Pin<Box<dyn Future<Output = TCResult<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Insert or update the given row.

fn group_by(
    self,
    columns: Vec<Id>
) -> TCResult<Aggregate<F, D, Txn, Self::OrderBy>>

Group this Table by the given columns.

fn index<'async_trait>(
    self,
    txn: Txn,
    columns: Option<Vec<Id>>
) -> Pin<Box<dyn Future<Output = TCResult<ReadOnly<F, D, Txn>>> + Send + 'async_trait>> where
    F: TryFrom<D::File, Error = TCError>,
    D::FileClass: From<BTreeType>,
    Self: Send + 'async_trait, 

Construct and return a temporary index of the given columns.

fn limit(self, limit: u64) -> Limited<F, D, Txn>

Limit the number of rows returned by rows.

fn select(self, columns: Vec<Id>) -> TCResult<Selection<F, D, Txn, Self>>

Limit the columns returned by rows.

impl<F: File<Node> + Transact, D: Dir, Txn: Transaction<D>> Transact for TableIndex<F, D, Txn>

fn commit<'life0, 'life1, 'async_trait>(
    &'life0 self,
    txn_id: &'life1 TxnId
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Commit this transaction.

fn finalize<'life0, 'life1, 'async_trait>(
    &'life0 self,
    txn_id: &'life1 TxnId
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Delete any version data specific to this transaction.