Struct Table

pub struct Table { /* private fields */ }

A Table is used to perform writes, deletes, and other operations to data in base tables.

If you create multiple Table handles from a single ControllerHandle, they may share connections to the Soup workers. For this reason, Table is not Send or Sync. To get a handle that can be sent to a different thread (i.e., one with its own dedicated connections), call Table::into_exclusive.

Implementations

impl Table

pub fn table_name(&self) -> &str

Get the name of this base table.

pub fn columns(&self) -> &[String]

Get the list of columns in this base table.

Note that this will not be updated if the underlying recipe changes and adds or removes columns!

pub fn schema(&self) -> Option<&CreateTableStatement>

Get the schema that was used to create this base table.

Note that this will not be updated if the underlying recipe changes and adds or removes columns!

pub async fn insert<V>(&mut self, u: V) -> Result<(), TableError>

where V: Into<Vec<DataType>>,

Insert a single row of data into this base table.

pub async fn perform_all<I, V>(&mut self, i: I) -> Result<(), TableError>

where I: IntoIterator<Item = V>, V: Into<TableOperation>,

Perform multiple operation on this base table.

pub async fn delete<I>(&mut self, key: I) -> Result<(), TableError>

where I: Into<Vec<DataType>>,

Delete the row with the given key from this base table.

pub async fn update<V>( &mut self, key: Vec<DataType>, u: V, ) -> Result<(), TableError>

where V: IntoIterator<Item = (usize, Modification)>,

Update the row with the given key in this base table.

u is a set of column-modification pairs, where for each pair (i, m), the modification m will be applied to column i of the record with key key.

pub async fn insert_or_update<V>( &mut self, insert: Vec<DataType>, update: V, ) -> Result<(), TableError>

where V: IntoIterator<Item = (usize, Modification)>,

Perform a insert-or-update on this base table.

If a row already exists for the key in insert, the existing row will instead be updated with the modifications in u (as documented in Table::update).

Trait Implementations

impl Clone for Table

fn clone(&self) -> Table

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Table

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

Formats the value using the given formatter.

impl Service<Vec<TableOperation>> for Table

type Error = TableError

Errors produced by the service.

type Response = <Buffer<ConcurrencyLimit<Balance<Discover<Client<MultiplexTransport<AsyncBincodeStream<TcpStream, Tagged<()>, Tagged<LocalOrNot<Input>>, AsyncDestination>, Tagger>, Error<MultiplexTransport<AsyncBincodeStream<TcpStream, Tagged<()>, Tagged<LocalOrNot<Input>>, AsyncDestination>, Tagger>, Tagged<LocalOrNot<Input>>>, Tagged<LocalOrNot<Input>>>>, Tagged<LocalOrNot<Input>>>>, Tagged<LocalOrNot<Input>>> as Service<Tagged<LocalOrNot<Input>>>>::Response

Responses given by the service.

type Future = Future<Result<Tagged<()>, TableError>>

The future response value.

fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>

Returns Poll::Ready(Ok(())) when the service is able to process requests.

fn call(&mut self, ops: Vec<TableOperation>) -> Self::Future

Process the request and return the response asynchronously.