Struct klickhouse::Client

pub struct Client { /* fields omitted */ }

Client handle for a Clickhouse connection, has internal reference to connection, and can be freely cloned and sent across threads.

Implementations

impl Client

pub fn connect_stream(
    read: impl AsyncRead + Unpin + Send + Sync + 'static,
    writer: impl AsyncWrite + Unpin + Send + Sync + 'static,
    options: ClientOptions
) -> Self

Consumes a reader and writer to connect to Klickhouse. To be used for exotic setups or TLS. Generally prefer Client::connect()

pub async fn connect<A: ToSocketAddrs>(
    destination: A,
    options: ClientOptions
) -> Result<Self>

Connects to a specific socket address over plaintext TCP for Clickhouse.

pub async fn query_raw(&self, query: &str) -> Result<impl Stream<Item = Block>>

Sends a query string and read column blocks over a stream. You probably want Client::query()

pub async fn insert_native_raw(
    &self,
    query: &str,
    blocks: impl Stream<Item = Block> + Send + Sync + Unpin + 'static
) -> Result<impl Stream<Item = Block>>

Sends a query string with streaming associated data (i.e. insert) over native protocol. Once all outgoing blocks are written (EOF of blocks stream), then any response blocks from Clickhouse are read. You probably want Client::insert_native.

pub async fn insert_native<T: Row + Send + Sync + 'static>(
    &self,
    query: &str,
    blocks: impl Stream<Item = Vec<T>> + Send + Sync + Unpin + 'static
) -> Result<()>

Sends a query string with streaming associated data (i.e. insert) over native protocol. Once all outgoing blocks are written (EOF of blocks stream), then any response blocks from Clickhouse are read and DISCARDED. Make sure any query you send native data with has a format native suffix.

pub async fn insert_native_block<T: Row + Send + Sync + 'static>(
    &self,
    query: &str,
    blocks: Vec<T>
) -> Result<()>

Wrapper over Client::insert_native to send a single block. Make sure any query you send native data with has a format native suffix.

pub async fn query<T: Row>(
    &self,
    query: &str
) -> Result<impl Stream<Item = Result<T>>>

Runs a query against Clickhouse, returning a stream of deserialized rows. Note that no rows are returned until Clickhouse sends a full block (but it usually sends more than one block).

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

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

Performs copy-assignment from source.