Struct AsyncClient 

pub struct AsyncClient<S = TcpStream> { /* private fields */ }

Asynchronous ClickHouse native protocol client.

Client accepts any AsyncTransport. connect creates a TCP connection. connect_tls creates a rustls connection when tls feature is enabled. boxed erases transport type.

Implementations

impl AsyncClient<TcpStream>

pub async fn connect<A>( addr: A, opts: ClientOpts, codec: Option<Pin<Box<Codec>>>, ) -> Result<Self>

where A: ToSocketAddrs,

Connects over TCP and completes Hello handshake.

Socket uses TCP_NODELAY.

impl AsyncClient<TlsStream<TcpStream>>

pub async fn connect_tls<A>( addr: A, domain: &str, opts: ClientOpts, codec: Option<Pin<Box<Codec>>>, config: Arc<ClientConfig>, ) -> Result<Self>

where A: ToSocketAddrs,

Connects over TCP and TLS, then completes Hello handshake.

TLS verifies peer using config and domain. Domain is also sent as SNI. Default configuration is available from tls::default_config.

impl<S: AsyncTransport> AsyncClient<S>

pub async fn handshake_on( stream: S, opts: ClientOpts, codec: Option<Pin<Box<Codec>>>, ) -> Result<Self>

Completes Hello handshake over an existing transport.

pub async fn send_query( &mut self, sql: &str, query_id: Option<&str>, ) -> Result<()>

pub async fn send_data( &mut self, builder: Option<&BlockBuilder<'_>>, ) -> Result<()>

Sends a Data block, or empty terminator when builder is None.

pub async fn send_data_end(&mut self) -> Result<()>

Sends empty Data block that ends INSERT input.

pub async fn recv_event(&mut self) -> Result<Event>

Waits for next server event.

Returned event owns block or exception payload.

pub fn server_info(&self) -> Option<ServerInfo>

Returns server identity received during handshake.

pub fn boxed(self) -> BoxedAsyncClient

where S: 'static,

Erases transport type without changing connection state.

pub fn core(&mut self) -> &mut IolessClient

Returns mutable access to transport-independent protocol client.