Skip to main content
Version: 1.30.0 (latest)

dlt.destinations.impl.clickhouse.configuration

ClickHouseCredentials Objects​

@configspec(init=False)
class ClickHouseCredentials(ConnectionStringCredentials)

View source on GitHub

host​

Host with running ClickHouse server.

port​

Native port ClickHouse server is bound to. Defaults to 9440.

http_port​

HTTP Port to connect to ClickHouse server's HTTP interface. The HTTP port is additionally needed for loading files without a staging destination. Defaults to 8443.

username​

Database user. Defaults to 'default'.

database​

database connect to. Defaults to 'default'.

secure​

Enables TLS encryption when connecting to ClickHouse Server. 0 means no encryption, 1 means encrypted.

connect_timeout​

Timeout for establishing connection. Defaults to 10 seconds.

send_receive_timeout​

Timeout for sending and receiving data. Defaults to 300 seconds.

s3_extra_credentials​

Arguments to pass to the extra_credentials function specifically for S3 function.

session_timezone​

Timezone set on each connection. None keeps the server default

ClickHouseClientConfiguration Objects​

@configspec
class ClickHouseClientConfiguration(
        DestinationClientDwhWithStagingConfiguration)

View source on GitHub

dataset_table_separator​

Separator for dataset table names, defaults to '___', i.e. 'database.dataset___table'.

table_engine_type​

The default table engine to use. Defaults to 'merge_tree'. Other implemented options are 'shared_merge_tree' and 'replicated_merge_tree'.

dataset_sentinel_table_name​

Special table to mark dataset as existing

staging_use_https​

Connect to the staging buckets via https

select_sequential_consistency​

Ensures read-after-write consistency on ClickHouse Cloud and clusters

fingerprint​

def fingerprint() -> str

View source on GitHub

Returns a fingerprint of the configured host.

data_location​

def data_location() -> str

View source on GitHub

Returns host:port.

This demo works on codespaces. Codespaces is a development environment available for free to anyone with a Github account. You'll be asked to fork the demo repository and from there the README guides you with further steps.
The demo uses the Continue VSCode extension.

Off to codespaces!

DHelp

Ask a question

Welcome to "Codex Central", your next-gen help center, driven by OpenAI's GPT-4 model. It's more than just a forum or a FAQ hub – it's a dynamic knowledge base where coders can find AI-assisted solutions to their pressing problems. With GPT-4's powerful comprehension and predictive abilities, Codex Central provides instantaneous issue resolution, insightful debugging, and personalized guidance. Get your code running smoothly with the unparalleled support at Codex Central - coding help reimagined with AI prowess.