Struct ClickHouseSinkConfig 

pub struct ClickHouseSinkConfig {
    pub connection: ClickHouseConnection,
    pub table: String,
    pub batch_size: usize,
    pub async_insert: bool,
    pub wait_for_async_insert: bool,
}

Available on crate feature sink-clickhouse only.

Configuration for ClickHouseSink.

Fields

connection: ClickHouseConnection

Connection settings (url or host, database, credentials).

table: String

Target table. May be schema-qualified (db.table); each identifier segment is quoted before use.

batch_size: usize

Records per INSERT request. When the upstream StreamPage carries more records than batch_size, the sink splits it into batch_size-row chunks and issues one INSERT … FORMAT JSONEachRow per chunk. 0 forwards the whole page as a single request. Defaults to DEFAULT_BATCH_SIZE.

async_insert: bool

Enable ClickHouse asynchronous inserts (async_insert=1): the server buffers rows and flushes them in the background, which greatly improves throughput for many small inserts. Defaults to false.

wait_for_async_insert: bool

When async_insert is enabled, whether the server waits for the buffered rows to be flushed before acknowledging the request (wait_for_async_insert=1). Keeping this true (the default) preserves faucet’s at-least-once durability contract — the bookmark only advances after ClickHouse has durably accepted the batch. Ignored when async_insert is false.

Implementations

impl ClickHouseSinkConfig

pub fn new( url: impl Into<String>, table: impl Into<String>, ) -> ClickHouseSinkConfig

Build a config from a base URL and table, with defaults elsewhere.

pub fn with_batch_size(self, batch_size: usize) -> ClickHouseSinkConfig

Set the per-request record count.

pub fn with_async_insert(self, async_insert: bool) -> ClickHouseSinkConfig

Enable ClickHouse asynchronous inserts.

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

Validate connection, table, and batch size.

Trait Implementations

impl Clone for ClickHouseSinkConfig

fn clone(&self) -> ClickHouseSinkConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClickHouseSinkConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ClickHouseSinkConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for ClickHouseSinkConfig

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 ClickHouseSinkConfig

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.