Struct clickhouse_rs::types::Options

pub struct Options { /* fields omitted */ }

Clickhouse connection options.

Methods

impl Options

pub fn new<A>(addr: A) -> Self where
    Address: From<A>, 

Constructs a new Options.

pub fn database(self, database: &str) -> Self

Database name. (defaults to default).

pub fn username(self, username: &str) -> Self

User name (defaults to default).

pub fn password(self, password: &str) -> Self

Access password (defaults to "").

pub fn with_compression(self) -> Self

Enable compression (defaults to false).

pub fn pool_min(self, pool_min: usize) -> Self

Lower bound of opened connections for Pool (defaults to 10).

pub fn pool_max(self, pool_max: usize) -> Self

Upper bound of opened connections for Pool (defaults to 20).

pub fn nodelay(self, nodelay: bool) -> Self

Whether to enable TCP_NODELAY (defaults to true).

pub fn keepalive(self, keepalive: Option<Duration>) -> Self

TCP keep alive timeout in milliseconds (defaults to None).

pub fn ping_before_query(self, ping_before_query: bool) -> Self

Ping server every time before execute any query. (defaults to true).

pub fn send_retries(self, send_retries: usize) -> Self

Count of retry to send request to server. (defaults to 3).

pub fn retry_timeout(self, retry_timeout: Duration) -> Self

Amount of time to wait before next retry. (defaults to 5 sec).

pub fn ping_timeout(self, ping_timeout: Duration) -> Self

Timeout for ping (defaults to 500 ms).

pub fn connection_timeout(self, connection_timeout: Duration) -> Self

Timeout for connection (defaults to 500 ms).

Trait Implementations

impl Clone for Options

fn clone(&self) -> Options

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Options

fn default() -> Self

Returns the "default value" for a type.

impl PartialEq<Options> for Options

fn eq(&self, other: &Options) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Options) -> bool

This method tests for !=.

impl Debug for Options

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

Formats the value using the given formatter.

impl FromStr for Options

type Err = Error

The associated error which can be returned from parsing.

fn from_str(url: &str) -> Result<Self, Error>

Parses a string s to return a value of this type.