Struct ClickHouseConnection 

pub struct ClickHouseConnection {
    pub url: Option<String>,
    pub host: Option<String>,
    pub http_port: Option<u16>,
    pub tls: bool,
    pub database: String,
    pub user: Option<String>,
    pub password: Option<String>,
}

Available on crate features sink-clickhouse or source-clickhouse only.

Shared connection configuration for the ClickHouse source and sink.

The endpoint is specified either as a full url (http://host:8123) or as a host (+ optional http_port / tls). Exactly one of the two forms must be provided.

Fields

url: Option<String>

Full base URL of the ClickHouse HTTP interface, e.g. "http://localhost:8123". Mutually exclusive with host. A trailing slash is trimmed.

host: Option<String>

Hostname of the ClickHouse server. Mutually exclusive with url; combined with http_port and tls to build the base URL.

http_port: Option<u16>

HTTP-interface port used with host. Defaults to DEFAULT_HTTP_PORT (8123).

tls: bool

Use https:// instead of http:// when building the base URL from host. Ignored when url is set. Defaults to false.

database: String

Target database. Defaults to DEFAULT_DATABASE ("default").

user: Option<String>

ClickHouse user. When set, sent as the X-ClickHouse-User header.

password: Option<String>

ClickHouse password. When set, sent as the X-ClickHouse-Key header.

Implementations

impl ClickHouseConnection

pub fn from_url(url: impl Into<String>) -> ClickHouseConnection

Available on crate features source-clickhouse and source-rest only.

Build a connection from a full base URL, leaving credentials unset.

pub fn validate(&self) -> Result<(), FaucetError>

Available on crate features source-clickhouse and source-rest only.

Validate that exactly one of url / host is set.

pub fn base_url(&self) -> Result<String, FaucetError>

Available on crate features source-clickhouse and source-rest only.

Resolve the base URL (scheme://host:port, no trailing slash) of the ClickHouse HTTP interface.

Returns FaucetError::Config when neither url nor host is set.

Trait Implementations

impl Clone for ClickHouseConnection

fn clone(&self) -> ClickHouseConnection

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClickHouseConnection

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

Formats the value using the given formatter.

impl Default for ClickHouseConnection

fn default() -> ClickHouseConnection

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ClickHouseConnection

fn deserialize<__D>( __deserializer: __D, ) -> Result<ClickHouseConnection, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for ClickHouseConnection

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for ClickHouseConnection

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

where __S: Serializer,

Serialize this value into the given Serde serializer.