Struct Client

pub struct Client {
    build_info: &'static BuildInfo,
    inner_cmd_tx: UnboundedSender<(OpenTelemetryContext, Command)>,
    id_alloc: IdAllocator<IdAllocatorInnerBitSet>,
    now: NowFn,
    metrics: Metrics,
    environment_id: EnvironmentId,
    segment_client: Option<Client>,
}

A coordinator client.

A coordinator client is a simple handle to a communication channel with the coordinator. It can be cheaply cloned.

Clients keep the coordinator alive. The coordinator will not exit until all outstanding clients have dropped.

Fields

build_info: &'static BuildInfo

inner_cmd_tx: UnboundedSender<(OpenTelemetryContext, Command)>

id_alloc: IdAllocator<IdAllocatorInnerBitSet>

now: NowFn

metrics: Metrics

environment_id: EnvironmentId

segment_client: Option<Client>

Implementations

impl Client

pub(crate) fn new( build_info: &'static BuildInfo, cmd_tx: UnboundedSender<(OpenTelemetryContext, Command)>, metrics: Metrics, now: NowFn, environment_id: EnvironmentId, segment_client: Option<Client>, ) -> Client

pub fn new_conn_id(&self) -> Result<ConnectionId, AdapterError>

Allocates a client for an incoming connection.

pub fn new_session(&self, config: SessionConfig) -> Session

Creates a new session associated with this client for the given user.

It is the caller’s responsibility to have authenticated the user.

pub async fn authenticate( &self, user: &String, password: &Password, ) -> Result<AuthResponse, AdapterError>

Preforms an authentication check for the given user.

pub async fn startup( &self, session: Session, ) -> Result<SessionClient, AdapterError>

Upgrades this client to a session client.

A session is a connection that has successfully negotiated parameters, like the user. Most coordinator operations are available only after upgrading a connection to a session.

Returns a new client that is bound to the session and a response containing various details about the startup.

pub fn cancel_request(&self, conn_id: ConnectionIdType, secret_key: u32)

Cancels the query currently running on the specified connection.

pub async fn support_execute_one( &self, sql: &str, ) -> Result<Pin<Box<dyn Stream<Item = PeekResponseUnary> + Send + Sync>>, Error>

Executes a single SQL statement that returns rows as the mz_support user.

pub fn metrics(&self) -> &Metrics

Returns the metrics associated with the adapter layer.

pub fn now(&self) -> DateTime<Utc>

The current time according to the Client.

pub async fn get_webhook_appender( &self, database: String, schema: String, name: String, ) -> Result<AppendWebhookResponse, AppendWebhookError>

Get a metadata and a channel that can be used to append to a webhook source.

pub async fn get_system_vars(&self) -> SystemVars

Gets the current value of all system variables.

fn send(&self, cmd: Command)

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.