Struct coord::SessionClient

pub struct SessionClient { /* fields omitted */ }

A coordinator client that is bound to a connection.

You must call SessionClient::terminate rather than dropping a session client directly. Dropping an unterminated SessionClient will panic.

See also Client.

Implementations

impl SessionClient

pub fn canceled(&self) -> impl Future<Output = ()> + Send

pub fn reset_canceled(&mut self)

pub async fn describe(
    &mut self,
    name: String,
    stmt: Option<Statement<Raw>>,
    param_types: Vec<Option<Type>>
) -> Result<(), CoordError>

Saves the specified statement as a prepared statement.

The prepared statement is saved in the connection's [sql::Session] under the specified name.

pub async fn declare(
    &mut self,
    name: String,
    stmt: Statement<Raw>,
    param_types: Vec<Option<Type>>
) -> Result<(), CoordError>

Binds a statement to a portal.

pub async fn execute(
    &mut self,
    portal_name: String
) -> Result<ExecuteResponse, CoordError>

Executes a previously-bound portal.

pub async fn end_transaction(
    &mut self,
    action: EndTransactionAction
) -> Result<ExecuteResponse, CoordError>

Ends a transaction.

pub async fn dump_catalog(&mut self) -> Result<String, CoordError>

Dumps the catalog to a JSON string.

pub async fn terminate(self)

Terminates this client session.

This method cleans up any coordinator state associated with the session before consuming the `SessionClient. Call this method instead of dropping the object directly.

pub fn session(&mut self) -> &mut Session

Returns a mutable reference to the session bound to this client.

Trait Implementations

impl Drop for SessionClient

fn drop(&mut self)

Executes the destructor for this type.