Struct ClickhouseConfig 

pub struct ClickhouseConfig {

    pub endpoint: UriSerde,
    pub table: Template,
    pub database: Option<Template>,
    pub format: Format,
    pub skip_unknown_fields: Option<bool>,
    pub date_time_best_effort: bool,
    pub insert_random_shard: bool,
    pub compression: Compression,
    pub encoding: Transformer,
    pub batch_encoding: Option<ClickhouseBatchEncoding>,
    pub batch: BatchConfig<RealtimeSizeBasedDefaultBatchSettings>,
    pub auth: Option<Auth>,
    pub request: TowerRequestConfig,
    pub tls: Option<TlsConfig>,
    pub acknowledgements: AcknowledgementsConfig,
    pub query_settings: QuerySettingsConfig,
}

Configuration for the clickhouse sink.

Fields

endpoint: UriSerde

The endpoint of the ClickHouse server.

table: Template

The table that data is inserted into.

database: Option<Template>

The database that contains the table that data is inserted into.

format: Format

The format to parse input data.

skip_unknown_fields: Option<bool>

Sets input_format_skip_unknown_fields, allowing ClickHouse to discard fields not present in the table schema.

If left unspecified, use the default provided by the ClickHouse server.

date_time_best_effort: bool

Sets date_time_input_format to best_effort, allowing ClickHouse to properly parse RFC3339/ISO 8601.

insert_random_shard: bool

Sets insert_distributed_one_random_shard, allowing ClickHouse to insert data into a random shard when using Distributed Table Engine.

compression: Compression

encoding: Transformer

batch_encoding: Option<ClickhouseBatchEncoding>

The batch encoding configuration for encoding events in batches.

When specified, events are encoded together as a single batch. This is mutually exclusive with per-event encoding based on the format field.

batch: BatchConfig<RealtimeSizeBasedDefaultBatchSettings>

auth: Option<Auth>

request: TowerRequestConfig

tls: Option<TlsConfig>

acknowledgements: AcknowledgementsConfig

query_settings: QuerySettingsConfig

Trait Implementations

impl Clone for ClickhouseConfig

fn clone(&self) -> ClickhouseConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Configurable for ClickhouseConfig

fn referenceable_name() -> Option<&'static str>

Gets the referenceable name of this value, if any.

fn metadata() -> Metadata

Gets the metadata for this value.

fn generate_schema( schema_gen: &RefCell<SchemaGenerator>, ) -> Result<SchemaObject, GenerateError>

Generates the schema for this value.

fn is_optional() -> bool

where Self: Sized,

Whether or not this value is optional.

fn validate_metadata(_metadata: &Metadata) -> Result<(), GenerateError>

where Self: Sized,

Validates the given metadata against this type.

fn as_configurable_ref() -> ConfigurableRef

where Self: Sized + 'static,

Create a new configurable reference table.

impl Debug for ClickhouseConfig

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

Formats the value using the given formatter.

impl Default for ClickhouseConfig

fn default() -> ClickhouseConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ClickhouseConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl GenerateConfig for ClickhouseConfig

fn generate_config() -> Value

impl NamedComponent for ClickhouseConfig

fn get_component_name(&self) -> &'static str

Gets the name of the component.

impl Serialize for ClickhouseConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl SinkConfig for ClickhouseConfig

fn build<'life0, 'async_trait>( &'life0 self, cx: SinkContext, ) -> Pin<Box<dyn Future<Output = Result<(VectorSink, Healthcheck)>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Builds the sink with the given context.

fn input(&self) -> Input

Gets the input configuration for this sink.

fn acknowledgements(&self) -> &AcknowledgementsConfig

Gets the acknowledgements configuration for this sink.

fn files_to_watch(&self) -> Vec<&PathBuf>

Gets the files to watch to trigger reload

fn resources(&self) -> Vec<Resource>

Gets the list of resources, if any, used by this sink.

impl ToValue for ClickhouseConfig

fn to_value(&self) -> Value

Convert this value into a serde_json::Value. Must not fail.