Struct mz_adapter::client::SessionClient

pub struct SessionClient {
    inner: Option<ConnClient>,
    session: Option<Session>,
    cancel_tx: Arc<Sender<Canceled>>,
    cancel_rx: Receiver<Canceled>,
    timeouts: Timeout,
}

A coordinator client that is bound to a connection.

See also Client.

Fields

inner: Option<ConnClient>

session: Option<Session>

cancel_tx: Arc<Sender<Canceled>>

cancel_rx: Receiver<Canceled>

timeouts: Timeout

Implementations

impl SessionClient

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

pub fn reset_canceled(&mut self)

pub async fn get_prepared_statement( &mut self, name: &str ) -> Result<&PreparedStatement, AdapterError>

pub async fn prepare( &mut self, name: String, stmt: Option<Statement<Raw>>, param_types: Vec<Option<ScalarType>> ) -> Result<(), AdapterError>

Saves the parsed statement as a prepared statement.

The prepared statement is saved in the connection’s crate::session::Session under the specified name.

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

Binds a statement to a portal.

pub async fn execute( &mut self, portal_name: String, cancel_future: impl Future<Output = Error> + Send ) -> Result<ExecuteResponse, AdapterError>

Executes a previously-bound portal.

fn now(&self) -> EpochMillis

fn now_datetime(&self) -> DateTime<Utc>

pub fn start_transaction( &mut self, implicit: Option<usize> ) -> Result<(), AdapterError>

Starts a transaction based on implicit:

• None: InTransaction
• Some(1): Started
• Some(n > 1): InTransactionImplicit
• Some(0): no change

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

Ends a transaction.

pub fn fail_transaction(&mut self)

Fails a transaction.

pub async fn dump_catalog(&mut self) -> Result<CatalogDump, AdapterError>

Dumps the catalog to a JSON string.

pub async fn insert_rows( &mut self, id: GlobalId, columns: Vec<usize>, rows: Vec<Row> ) -> Result<ExecuteResponse, AdapterError>

Inserts a set of rows into the given table.

The rows only contain the columns positions in columns, so they must be re-encoded for adding the default values for the remaining ones.

pub async fn get_system_vars( &mut self ) -> Result<GetVariablesResponse, AdapterError>

Gets the current value of all system variables.

pub async fn set_system_vars( &mut self, vars: BTreeMap<String, String> ) -> Result<(), AdapterError>

Updates the specified system variables to the specified values.

pub async fn terminate(&mut self)

Terminates the client session.

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

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

pub fn inner(&self) -> &ConnClient

Returns a reference to the inner client.

pub fn inner_mut(&mut self) -> &mut ConnClient

Returns a mutable reference to the inner client.

async fn send<T, F>(&mut self, f: F) -> Result<T, AdapterError>where F: FnOnce(Sender<Response<T>>, Session) -> Command,

async fn send_with_cancel<T, F>( &mut self, f: F, cancel_future: impl Future<Output = Error> + Send ) -> Result<T, AdapterError>where F: FnOnce(Sender<Response<T>>, Session) -> Command,

pub fn add_idle_in_transaction_session_timeout(&mut self)

pub fn remove_idle_in_transaction_session_timeout(&mut self)

pub async fn recv_timeout(&mut self) -> Option<TimeoutType>

Cancel safety

This method is cancel safe. If recv is used as the event in a tokio::select! statement and some other branch completes first, it is guaranteed that no messages were received on this channel.

Trait Implementations

impl Drop for SessionClient

fn drop(&mut self)

Executes the destructor for this type.