Struct Options

pub struct Options {

    pub addr: Url,
    pub database: String,
    pub username: String,
    pub password: String,
    pub compression: bool,
    pub pool_min: usize,
    pub pool_max: usize,
    pub nodelay: bool,
    pub keepalive: Option<Duration>,
    pub ping_before_query: bool,
    pub send_retries: usize,
    pub retry_timeout: Duration,
    pub ping_timeout: Duration,
    pub connection_timeout: Duration,
    pub query_timeout: Duration,
    pub insert_timeout: Option<Duration>,
    pub execute_timeout: Option<Duration>,
    pub readonly: Option<u8>,
    pub alt_hosts: Vec<Url>,
}

Clickhouse connection options.

Fields

addr: Url

Address of clickhouse server (defaults to 127.0.0.1:9000).

database: String

Database name. (defaults to default).

username: String

User name (defaults to default).

password: String

Access password (defaults to "").

compression: bool

Enable compression (defaults to false).

pool_min: usize

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

pool_max: usize

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

nodelay: bool

Whether to enable TCP_NODELAY (defaults to true).

keepalive: Option<Duration>

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

ping_before_query: bool

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

send_retries: usize

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

retry_timeout: Duration

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

ping_timeout: Duration

Timeout for ping (defaults to 500 ms)

connection_timeout: Duration

Timeout for connection (defaults to 500 ms)

query_timeout: Duration

Timeout for queries (defaults to 180 sec)

insert_timeout: Option<Duration>

Timeout for inserts (defaults to 180 sec)

execute_timeout: Option<Duration>

Timeout for execute (defaults to 180 sec)

readonly: Option<u8>

Restricts permissions for read data, write data and change settings queries.

alt_hosts: Vec<Url>

Comma separated list of single address host for load-balancing.

Implementations

impl Options

pub fn new<A>(addr: A) -> Self

where A: Into<Url>,

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).

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

Timeout for query (defaults to 180,000 ms).

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

Timeout for insert (defaults to 180,000 ms).

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

Timeout for execute (defaults to 180 sec).

pub fn readonly(self, readonly: Option<u8>) -> Self

Restricts permissions for read data, write data and change settings queries.

pub fn alt_hosts(self, alt_hosts: Vec<Url>) -> Self

Comma separated list of single address host for load-balancing.

Trait Implementations

impl Clone for Options

fn clone(&self) -> Options

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Options

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

Formats the value using the given formatter.

impl Default for Options

fn default() -> Self

Returns the “default value” for a type.

impl FromStr for Options

type Err = Error

The associated error which can be returned from parsing.

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

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

impl IntoOptions for Options

fn into_options_src(self) -> OptionsSource

impl PartialEq for Options

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Options