jprdonnelly/airbyte
1
0
Fork 0
mirror of synced 2025-12-25 02:09:19 -05:00
Code Issues Packages Projects Releases Wiki Activity

ClickHouse v2: doc updates (#62943)

Browse Source
This commit is contained in:
Ryan Br...
2025-07-11 15:21:01 -07:00
committed by GitHub
parent 7188e2dc3b
commit 38f6a768d3
3 changed files with 53 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
docs/integrations/destinations/clickhouse-migrations.md
View File

@@ -1,5 +1,10 @@
# Clickhouse Migration Guide
## SSH Support :warning:
SSH is not yet implemented for the new connector. If you require SSH support,
please hold off on migrating for now.
## Upgrading to 2.0.0
This version differs from 1.0.0 radically. Whereas 1.0.0 wrote all your data
@@ -14,10 +19,6 @@ with no changes, albeit writing data to a completely different location and in a
different form. So any downstream pipelines will need updating to ingest the new
data location / format.
## Gotchas
* If the "Hostname" property in your configuration contains the protocol ("http
or "https"), you need to remove it.
## Migrating existing data to the new format
Unfortunately Airbyte has no way to migrate the existing raw tables to the new
@@ -32,7 +33,22 @@ will need to delete all the tables saved in the old format, which for most
people should be under `airbyte_internal.{database}_raw__`, but may vary based
on your specific configuration.
## SSH Support
## Gotchas
SSH is not yet implemented for the new connector. If you require SSH support,
please hold off on migrating for now.
### Namespaces and the default database
In V2 namespaces are treated as equivalent to a ClickHouse "database". This
means if you set a custom namespace for your connection that will be the
database the connector will use for queries instead of the "database"
configured in the Destination settings.
Previously, namespaces where added as a prefix to the table name. If you have
existing connections configured in this fashion you may want to remove them.
### Hostname
If the "Hostname" property in your configuration contains the protocol ("http
or "https"), you will need to remove it.
The previous versions incidentally tolerated the protocol being stored in the
hostname field.

41
docs/integrations/destinations/clickhouse.md
View File

@@ -50,25 +50,42 @@ Make sure your ClickHouse database can be accessed by Airbyte. If your database
You need a ClickHouse user with the following permissions:
- can create tables and write rows.
- can create databases e.g:
- can create databases
- can alter, drop and exchange tables
You can create such a user by running:
You can create such a user by running the following:
```
GRANT CREATE ON * TO airbyte_user;
GRANT CREATE ON {your configured default database} * TO airbyte_user;
GRANT DROP ON * TO airbyte_user;
GRANT TRUNCATE ON * TO airbyte_user;
GRANT INSERT ON * TO airbyte_user;
GRANT SELECT ON * TO airbyte_user;
GRANT CREATE DATABASE ON airbyte_internal.* TO airbyte_user;
GRANT CREATE TABLE ON airbyte_internal.* TO airbyte_user;
GRANT DROP ON airbyte_internal.* TO airbyte_user;
GRANT TRUNCATE ON airbyte_internal.* TO airbyte_user;
GRANT INSERT ON airbyte_internal.* TO airbyte_user;
GRANT SELECT ON airbyte_internal.* TO airbyte_user;
GRANT CREATE ON {database}.* TO airbyte_user;
GRANT DROP ON {database}.* TO airbyte_user;
GRANT ALTER ON {database}.* TO airbyte_user;
GRANT TRUNCATE ON {database}.* TO airbyte_user;
GRANT INSERT ON {database}.* TO airbyte_user;
GRANT SELECT ON {database}.* TO airbyte_user;
GRANT CREATE DATABASE ON {database}.* TO airbyte_user;
GRANT CREATE TABLE ON {database}.* TO airbyte_user;
```
Where `{database}` is the database configured on your connector.
Then for each connection using this connector with a custom namespace, run:
```
GRANT CREATE ON {namespace}.* TO airbyte_user;
GRANT DROP ON {namespace}.* TO airbyte_user;
GRANT ALTER ON {namespace}.* TO airbyte_user;
GRANT TRUNCATE ON {namespace}.* TO airbyte_user;
GRANT INSERT ON {namespace}.* TO airbyte_user;
GRANT SELECT ON {namespace}.* TO airbyte_user;
GRANT CREATE DATABASE ON {namespace}.* TO airbyte_user;
GRANT CREATE TABLE ON {namespace}.* TO airbyte_user;
```
Where `{namespace}` is the custom namespace configured for that connection.
You can also use a pre-existing user but we highly recommend creating a dedicated user for Airbyte.
## Changelog