ClickHouse (Custom Connector)
Custom connector for ClickHouse utilizes an ODBC connection for executing custom queries and retrieves metadata using specific queries tailored to this data source.
ODBC Driver
Before importing, using the custom connector requires the installation and configuration of the ODBC driver.
We have tested the import using the ClickHouse Official ODBC Driver 64bit
ODBC Driver configuration
First Download ODBC driver.
Extract files and double click on clickhouse-odbc-<version>-win64 and follow the instructions to install the driver.
After that hit the windows key, search for ODBC DataSources 64 bit and open this app. In the System DSN tab you should be able to see ClickHouse DSN (Unicode).
Go to the User DSN tab and click on the Add button. Double click on ClickHouse DSN (Unicode) to configure it.
Provide all the connection details as follows:
- Name - Some convenient name for the connection.
- Host - Host of your ClickHouse instance (without https://).
- Port - Set it to HTTP SSL/TLS port. Default port: 8443.
- User - ClickHouse database user.
- Password - ClickHouse database password.
- Timeout - You can set it to 200 and adjust if needed.
Connector features
Data Catalog
Dataedo will document the following objects from ClickHouse:
- Tables,
- Views,
- Procedures,
- Functions
How to connect
To connect to ClickHouse create new documentation by clicking Add and choosing New connection.
On the connection screen choose ClickHouse (Local Custom Connector) or ClickHouse (Shared Custom Connector).
Choose the ODBC driver configured earlier.
Click Connect.
Connector specification
Imported objects
| Object | Imported as |
|---|---|
| Table | Table |
| View | View |
Tables metadata
| Metadata | Imported as |
|---|---|
| Name | Name |
| Comment | Description |
| Columns | Table columns |
| Name | Name |
| Data type | Data type |
Views metadata
| Metadata | Imported as |
|---|---|
| Name | Name |
| Comment | Description |
| Columns | View columns |
| Name | Name |
| Data type | Data type |
