Struct ClientConfig 

pub struct ClientConfig {

    pub host: String,
    pub token: Option<String>,
    pub auth_scheme: String,
    pub database: String,
    pub org: Option<String>,
    pub write_options: WriteOptions,
    pub retry: RetryConfig,
    pub headers: HeaderMap,
    pub ssl_roots_path: Option<String>,
    pub proxy: Option<String>,
    pub write_timeout: Duration,
    pub query_timeout: Duration,
    pub idle_connection_timeout: Duration,
    pub max_idle_connections: usize,
}

Configuration for the InfluxDB 3 client.

Construct with ClientConfig::builder() or parse from a connection string / environment variables with ClientConfig::from_connection_string() / ClientConfig::from_env().

Fields

host: String

InfluxDB host URL (e.g. https://cluster.influxdata.io).

token: Option<String>

API token.

auth_scheme: String

Authentication scheme: "Bearer" (default) or "Token".

database: String

Database for all operations. Required; validated at construction time.

org: Option<String>

Organization name (used for v2 API compatibility).

write_options: WriteOptions

Default write options applied to every write call.

retry: RetryConfig

Default retry policy for transient write/query failures. Override per request with WriteRequest/QueryRequest .retry() / .no_retry().

headers: HeaderMap

Extra HTTP headers sent with every request.

ssl_roots_path: Option<String>

Path to a PEM file with additional CA roots for TLS verification.

proxy: Option<String>

HTTP proxy URL.

write_timeout: Duration

Request timeout for write calls.

query_timeout: Duration

Timeout for the Flight channel connect and for collected (.await) queries. Streaming queries (.stream()) are intentionally unbounded.

idle_connection_timeout: Duration

Keep-alive idle connection timeout.

max_idle_connections: usize

Maximum number of idle connections in the pool.

Implementations

impl ClientConfig

pub fn builder() -> ClientConfigBuilder

Start building a config.

pub fn from_env() -> Result<Self, Error>

Parse INFLUX_HOST, INFLUX_TOKEN, INFLUX_DATABASE, and INFLUX_ORG from the process environment. INFLUX_HOST and INFLUX_DATABASE are required; token and org are optional.

pub fn from_connection_string(cs: &str) -> Result<Self, Error>

Parse a URL-formatted connection string, e.g.:

https://cluster.influxdata.io/?token=TOKEN&database=DB&org=ORG

database (or bucket) is required; returns an error if absent.

pub fn host_url(&self) -> &str

Return the normalised host URL (trailing slash stripped).

pub fn authorization_header(&self) -> Result<Option<HeaderValue>, Error>

Build the Authorization header value ("Bearer TOKEN" etc.).

Returns Ok(None) when no token is set. Returns an error if the token contains characters that are invalid in an HTTP header value.

Trait Implementations

impl Clone for ClientConfig

fn clone(&self) -> ClientConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClientConfig

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

Formats the value using the given formatter.

impl Default for ClientConfig

fn default() -> Self

Returns the “default value” for a type.