ClickHouseDestConn

class

class ClickHouseDestConn(
    host: HostSpec,
    port: PortSpec = '8123',
    credentials: CredentialsSpec,
    staging: CloudLocation,
    database: DatabaseSpec = 'default',
    secure: BoolSpec = 'false',
    entity_whitelist: EntityWhitelistSpec | None = None,
    conn_cfg: CfgSpec | None = None,
)

Bases: Conn

Categories: destination

ClickHouse connection.

Registered on a collection; the runtime resolves it and hands it to the plugin at run time. Each string field accepts a plain string or a Secret; the plugin reads parsed values through the _host / _port / _database / _secure getters.

Parameters

parameter

hostHostSpec (str | Secret)

A DNS host name or IPv4 literal for the ClickHouse server.

parameter

portPortSpec (str | Secret)

The HTTP(S) port, 1-65535. Defaults to "8123".

parameter

credentialsCredentialsSpec (UserPassword)

UserPassword (user + password).

parameter

stagingCloudLocation

A CloudLocation (S3Location / AzBlobLocation / GCSLocation) where parquet is staged before ingest.

parameter

databaseDatabaseSpec (str | Secret)

The default database (a ClickHouse identifier: a letter or underscore, then letters, digits and underscores). Defaults to "default".

parameter

secureBoolSpec (str | Secret)

true for HTTPS, false for HTTP (boolean as text). Defaults to "false".

parameter

entity_whitelistEntityWhitelistSpec | None (list[str] | None)

Optional list of regex patterns narrowing which tables the connector considers; None (the default) filters nothing.

parameter

conn_cfgCfgSpec | None (dict | None)

Optional connector-config dict (see CfgSpec).