Struct ClickHouseSourceConfig 

pub struct ClickHouseSourceConfig {
    pub connection: ClickHouseConnection,
    pub query: String,
    pub batch_size: usize,
    pub replication: ClickHouseReplication,
    pub state_key: Option<String>,
}

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

Configuration for ClickHouseSource.

Fields

connection: ClickHouseConnection

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

query: String

SQL SELECT query to run. The output format is set to JSONEachRow via the request settings, so do not append a FORMAT clause. Use the literal @bookmark token to push the incremental cursor down into the WHERE clause; use {key} tokens to inject parent-context values in a matrix child.

batch_size: usize

Records per emitted StreamPage. 0 emits the whole result set as a single page. Defaults to DEFAULT_BATCH_SIZE.

replication: ClickHouseReplication

Replication mode. Defaults to ClickHouseReplication::Full.

state_key: Option<String>

Explicit state-store key for the bookmark. When unset, a key is derived from the connection host and a query fingerprint.

Implementations

impl ClickHouseSourceConfig

pub fn new( url: impl Into<String>, query: impl Into<String>, ) -> ClickHouseSourceConfig

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

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

Set the per-page record count.

pub fn incremental( self, column: impl Into<String>, initial: Value, ) -> ClickHouseSourceConfig

Configure incremental replication on column, starting at initial.

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

Validate connection, batch size, and replication settings.

Trait Implementations

impl Clone for ClickHouseSourceConfig

fn clone(&self) -> ClickHouseSourceConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClickHouseSourceConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ClickHouseSourceConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for ClickHouseSourceConfig

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 ClickHouseSourceConfig

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.