Struct Config

pub struct Config {
    pub ca_path: Option<PathBuf>,
    pub cert_path: Option<PathBuf>,
    pub key_path: Option<PathBuf>,
    pub timeout: Duration,
    pub keyspace: Option<String>,
}

The configuration for either a RawClient or a TransactionClient.

See also TransactionOptions which provides more ways to configure requests.

Fields

ca_path: Option<PathBuf>

cert_path: Option<PathBuf>

key_path: Option<PathBuf>

timeout: Duration

keyspace: Option<String>

Implementations

impl Config

pub fn with_security( self, ca_path: impl Into<PathBuf>, cert_path: impl Into<PathBuf>, key_path: impl Into<PathBuf>, ) -> Self

Set the certificate authority, certificate, and key locations for clients.

By default, this client will use an insecure connection over instead of one protected by Transport Layer Security (TLS). Your deployment may have chosen to rely on security measures such as a private network, or a VPN layer to provide secure transmission.

To use a TLS secured connection, use the with_security function to set the required parameters.

TiKV does not currently offer encrypted storage (or encryption-at-rest).

Examples

let config = Config::default().with_security("root.ca", "internal.cert", "internal.key");

pub fn with_timeout(self, timeout: Duration) -> Self

Set the timeout for clients.

The timeout is used for all requests when using or connecting to a TiKV cluster (including PD nodes). If the request does not complete within timeout, the request is cancelled and an error returned to the user.

The default timeout is two seconds.

Examples

let config = Config::default().with_timeout(Duration::from_secs(10));

pub fn with_default_keyspace(self) -> Self

Set to use default keyspace.

Server should enable storage.api-version = 2 to use this feature.

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

Set the use keyspace for the client.

Server should enable storage.api-version = 2 to use this feature.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Config

where Config: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Config

fn eq(&self, other: &Config) -> 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 Serialize for Config

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Config

impl StructuralPartialEq for Config