Skip to main content
GuideServerConfigure and deploy Tabsdata servers on your machine.TutorialsConfigure data integration workflows within a running Tabsdata server.API ReferenceCLI ReferenceRelease Notes
Version: 2.3.0

tabsdatak.conn.clickhouse

AzBlobLocationAzure Blob staging area for ClickHouseDest.
ClickHouseDestClickHouse destination for @subscriber -- one output slot per table.
ClickHouseDestConnClickHouse connection.
ClickHouseTableNameSpec
ClickHouseTableNamesSpecA list of ClickHouse table names (see ClickHouseTableNameSpec), each at most once: names that differ only in quoting, or in the case of an unquoted part (unchanged, as ClickHouse names are case-sensitive), are the same table.
CloudLocationAbstract base for a ClickHouse staging cloud location.
CredentialsSpecThe credential type for ClickHouse connections: UserPassword (user + password).
DatabaseSpec
DestCfgKey
DestCfgSpec
GCSLocationGCS staging area for ClickHouseDest.
IfTableExistsSpec
S3LocationS3 staging area for ClickHouseDest.
SchemaEvolutionEngineSpecWhich machinery evolves the target's schema.
SchemaEvolutionSpec

ClickHouseTableNameSpec

type_alias
ClickHouseTableNameSpec: str

ClickHouseTableNamesSpec

type_alias
ClickHouseTableNamesSpec: list[ClickHouseTableNameSpec]

Resolved type:

list[str]

A list of ClickHouse table names (see ClickHouseTableNameSpec), each at most once: names that differ only in quoting, or in the case of an unquoted part (unchanged, as ClickHouse names are case-sensitive), are the same table.


CredentialsSpec

type_alias
CredentialsSpec: UserPassword

The credential type for ClickHouse connections: UserPassword (user + password).


DatabaseSpec

type_alias
DatabaseSpec: StrOrSecretSpec

Resolved type:

str | Secret

DestCfgKey

type_alias
DestCfgKey: Literal['clickhouse.logging_level', 'clickhouse.schema_evolution_engine']

DestCfgSpec

type_alias
DestCfgSpec: Mapping[DestCfgKey, Any]

Resolved type:

Mapping[Literal['clickhouse.logging_level', 'clickhouse.schema_evolution_engine'], Any]

IfTableExistsSpec

type_alias
IfTableExistsSpec: Literal['append', 'replace']

SchemaEvolutionEngineSpec

type_alias
SchemaEvolutionEngineSpec: Literal['iceberg']

Which machinery evolves the target's schema. ClickHouse has no schema evolution of its own, so the only engine is "iceberg": the connector diffs the target against the incoming batch and emits the ALTER statements itself.


SchemaEvolutionSpec

type_alias
SchemaEvolutionSpec: Literal['strict', 'update']