Struct Client

pub struct Client { /* private fields */ }

A client containing HTTP pool.

Implementations

impl Client

pub fn with_http_client(client: impl HttpClient) -> Self

Creates a new client with a specified underlying HTTP client.

See HttpClient for details.

pub fn with_url(self, url: impl Into<String>) -> Self

Specifies ClickHouse’s url. Should point to HTTP endpoint.

Examples

let client = Client::default().with_url("http://localhost:8123");

pub fn with_database(self, database: impl Into<String>) -> Self

Specifies a database name.

Examples

let client = Client::default().with_database("test");

pub fn with_user(self, user: impl Into<String>) -> Self

Specifies a user.

Panics

If called after Client::with_access_token.

Examples

let client = Client::default().with_user("test");

pub fn with_password(self, password: impl Into<String>) -> Self

Specifies a password.

Panics

If called after Client::with_access_token.

Examples

let client = Client::default().with_password("secret");

pub fn with_access_token(self, access_token: impl Into<String>) -> Self

A JWT access token to authenticate with ClickHouse. JWT token authentication is supported in ClickHouse Cloud only. Should not be called after Client::with_user or Client::with_password.

Panics

If called after Client::with_user or Client::with_password.

Examples

let client = Client::default().with_access_token("jwt");

pub fn with_compression(self, compression: Compression) -> Self

Specifies a compression mode. See Compression for details. By default, Lz4 is used.

Examples

let client = Client::default().with_compression(Compression::Lz4);

pub fn with_option( self, name: impl Into<String>, value: impl Into<String>, ) -> Self

Used to specify options that will be passed to all queries.

Example

Client::default().with_option("allow_nondeterministic_mutations", "1");

pub fn with_header( self, name: impl Into<String>, value: impl Into<String>, ) -> Self

Used to specify a header that will be passed to all queries.

Example

Client::default().with_header("Cookie", "A=1");

pub fn with_product_info( self, product_name: impl Into<String>, product_version: impl Into<String>, ) -> Self

Specifies the product name and version that will be included in the default User-Agent header. Multiple products are supported. This could be useful for the applications built on top of this client.

Examples

Sample default User-Agent header:

clickhouse-rs/0.12.2 (lv:rust/1.67.0, os:macos)

Sample User-Agent with a single product information:

let client = Client::default().with_product_info("MyDataSource", "v1.0.0");

MyDataSource/v1.0.0 clickhouse-rs/0.12.2 (lv:rust/1.67.0, os:macos)

Sample User-Agent with multiple products information (NB: the products are added in the reverse order of Client::with_product_info calls, which could be useful to add higher abstraction layers first):

let client = Client::default()
    .with_product_info("MyDataSource", "v1.0.0")
    .with_product_info("MyApp", "0.0.1");

MyApp/0.0.1 MyDataSource/v1.0.0 clickhouse-rs/0.12.2 (lv:rust/1.67.0, os:macos)

pub fn insert<T: Row>(&self, table: &str) -> Result<Insert<T>>

Starts a new INSERT statement.

Panics

If T has unnamed fields, e.g. tuples.

pub fn inserter<T: Row>(&self, table: &str) -> Result<Inserter<T>>

Available on crate feature inserter only.

Creates an inserter to perform multiple INSERTs.

pub fn query(&self, query: &str) -> Query

Starts a new SELECT/DDL query.

pub fn watch(&self, query: &str) -> Watch

Available on crate feature watch only.

Starts a new WATCH query.

The query can be either the table name or a SELECT query. In the second case, a new LV table is created.

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.

impl Default for Client

fn default() -> Self

Returns the “default value” for a type.