ClickHouse

Supports:

  • ✅ Models
  • ✅ Model sync destination
  • ✅ Bulk sync source
  • ✅ Bulk sync destination

Connection

Configuration

NameTypeDescriptionRequired
databasestringDatabase (optional)false
hostnamestringHostnametrue
passwordstringPasswordfalse
portintegerPorttrue
skip_verifybooleanSkip certificate verificationfalse
sshbooleanConnect over SSH tunnel false
sslbooleanUse SSLfalse
usernamestringUsernametrue

ssh

When ssh is true
NameTypeDescriptionRequired
ssh_hoststringSSH hostfalse
ssh_portintegerSSH portfalse
ssh_private_keystringPrivate keyfalse
ssh_userstringSSH userfalse

Example

1{
2 "name": "ClickHouse connection",
3 "type": "clickhouse",
4 "configuration": {
5 "database": "default",
6 "hostname": "clickhouse.example.com",
7 "password": "",
8 "port": 0,
9 "skip_verify": false,
10 "ssh": false,
11 "ssl": false,
12 "username": "default"
13 }
14}

Model Sync

Source

Configuration

NameTypeDescriptionRequired
querystringfalse
tablestringTablefalse
viewstringViewfalse

Example

1{
2 ...
3 "configuration": {
4 "query": "SELECT * from users",
5 "table": "users",
6 "view": "active_users"
7 }
8}

Target

ClickHouse connections may be used as the destination in a model sync.

All targets

Configuration
NameTypeDescriptionRequired
created_columnstring’Created at’ timestamp columnfalse
preserve_table_on_resyncbooleanPreserve destination table when resyncingfalse
updated_columnstring’Updated at’ timestamp columnfalse
write_record_timestampsbooleanWrite row timestamp metadatafalse
Example
1{
2 ...
3 "target": {
4 "configuration": {
5 "created_column": "",
6 "preserve_table_on_resync": false,
7 "updated_column": "",
8 "write_record_timestamps": false
9 }
10 }
11}

Bulk Sync

Destination

Configuration

NameTypeDescriptionRequired
advancedobjectfalse
mirror_schemasbooleanMirror schemasfalse
schemastringOutput schemafalse

Example

1{
2 ...
3 "destination_configuration": {
4 "advanced": {
5 "empty_strings_null": false,
6 "hard_deletes": false,
7 "initial_execution": "",
8 "table_prefix": "",
9 "truncate_existing": false
10 },
11 "mirror_schemas": false,
12 "schema": "schema"
13 }
14}