Struct mz_adapter::client::SessionClient

pub struct SessionClient {
    inner: Option<Client>,
    session: Option<Session>,
    timeouts: Timeout,
    segment_client: Option<Client>,
    environment_id: EnvironmentId,
}

A coordinator client that is bound to a connection.

See also Client.

Fields

inner: Option<Client>

session: Option<Session>

timeouts: Timeout

segment_client: Option<Client>

environment_id: EnvironmentId

Implementations

impl SessionClient

pub fn parse<'a>( &self, sql: &'a str, ) -> Result<Result<Vec<StatementParseResult<'a>>, ParserStatementError>, String>

Parses a SQL expression, reporting failures as a telemetry event if possible.

fn track_statement_parse_failure(&self, parse_error: &ParserStatementError)

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>>, sql: String, 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>, sql: String, ) -> Result<(), AdapterError>

Binds a statement to a portal.

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

Executes a previously-bound portal.

Note: the provided cancel_future must be cancel-safe as it’s polled in a select! loop.

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. Even if an error is returned, guarantees that the transaction in the session and Coordinator has cleared its state.

pub fn fail_transaction(&mut self)

Fails a transaction.

pub async fn catalog_snapshot(&self) -> Arc<Catalog>

Fetches the catalog.

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

Dumps the catalog to a JSON string.

No authorization is performed, so access to this function must be limited to internal servers or superusers.

pub async fn check_catalog(&self) -> Result<(), Value>

Checks the catalog for internal consistency, returning a JSON object describing the inconsistencies, if there are any.

No authorization is performed, so access to this function must be limited to internal servers or superusers.

pub async fn check_coordinator(&self) -> Result<(), Value>

Checks the coordinator for internal consistency, returning a JSON object describing the inconsistencies, if there are any. This is a superset of checks that check_catalog performs,

No authorization is performed, so access to this function must be limited to internal servers or superusers.

pub async fn dump_coordinator_state(&self) -> Result<Value, Error>

pub fn retire_execute( &self, data: ExecuteContextExtra, reason: StatementEndedExecutionReason, )

Tells the coordinator a statement has finished execution, in the cases where we have no other reason to communicate with the coordinator.

pub async fn insert_rows( &mut self, id: CatalogItemId, columns: Vec<usize>, rows: Vec<Row>, ctx_extra: ExecuteContextExtra, ) -> 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) -> &Client

Returns a reference to the inner client.

async fn send_without_session<T, F>(&self, f: F) -> T

where F: FnOnce(Sender<T>) -> Command,

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,

Send a Command to the Coordinator, with the ability to cancel the command.

Note: the provided cancel_future must be cancel-safe as it’s polled in a select! loop.

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.