Clickhouse

ClickHouse is an open-source column-oriented database management system that enables high-performance real-time data analysis. As a development environment in Paradime, ClickHouse enables dbtℒ️ development from Paradime's Code IDE.

Setup Instructions

  1. Click Settings in the top menu bar of the Paradime interface to access Account Settings

  2. In the left sidebar, click "Connections"

  3. Click "Add New" next to the Code IDE section

  4. Select "ClickHouse"

  5. In the Profile Configuration field, add at least these required parameters. For additional configuration options, see the Profile Fields Reference section below:

schema: dbt_transformations                    # Production database
host: clickhouse.internal.company.com          # Internal hostname
port: 9000                                     # Native protocol port
user: dbt_user                                 # Database user
password: clickhouse_pass_456                  # User password
secure: false                                  # Internal traffic
driver: native                                 # Native protocol

After adding the configuration, ensure it's properly formatted using a YAML formatter like YAML Formatter.

  1. Provide a dbtβ„’ Profile Name (This should match with the profile name set in your dbt_project.yml).

  2. In the Target field, enter "dev". This is the default target your dbt project will use for development work.

  3. The Threads value is pre-configured to 1, but you can adjust this number to specify how many parallel operations your dbt project can run.


Example Profile Configuration


Profile Fields Reference​

Field
Description
Default Value
Required

schema

ClickHouse database name for models. This is configured in the UI "Schema" field

None

βœ…

driver

Connection protocol (http or native)

http

❌

host

ClickHouse server hostname

localhost

❌

port

Connection port number

  • http: 8123/8443

  • native: 9000/9440

❌

user

Database user name

None

βœ…

password

Database user password

None

βœ…

cluster

Name of ClickHouse cluster for distributed operations

None

❌

verify

Whether to validate TLS certificate

True

❌

secure

Enable TLS/HTTPS connections

False

❌

retries

Number of connection retry attempts

None

❌

compression

Type of data compression to use

False

❌

connect_timeout

Seconds to wait for connection

10

❌

send_receive_timeout

Seconds to wait for data transfer

300 (5 minutes)

❌

cluster_mode

Settings for replicated databases

False

❌

use_lw_deletes

Enable lightweight delete operations

False

❌

check_exchange

Check support for atomic table exchange

True

❌

local_suffix

Suffix for local table names

_local

❌

local_db_prefix

Prefix for local database names

None

❌

allow_automatic_deduplication

Enable automatic data deduplication

False

❌


Last updated

Was this helpful?