ClickHouse support (ODBC)

Dominik Ilnicki - Dataedo Team Dominik Ilnicki 7th October, 2022

ClickHouse is currently not officially supported. Connection is possible with generic ODBC driver. Metadata returned depends on driver version and provider.

We have tested and successfully connected to and imported metadata from ClickHouse with their official ODBC driver.

Tested ODBC Driver: ClickHouse Official ODBC Driver 64 bit [Free]

We have tested and successfully connected to and imported metadata in following environment:

ODBC driver: ClickHouse Official ODBC Driver 64bit

ODBC version: ClickHouse ODBC Driver 64 bit Release 1.2.1.20220905

ClickHouse version: ClickHouse 22.10 (Cloud)

Supported schema elements and metadata

Dataedo reads following metadata from ClickHouse databases.

  • Tables
    • Columns
      • Data type with length
      • Nullable
      • Default value
  • Views
    • Columns
      • Data type with length
      • Nullable
      • Default value

Limitations

Unfortunately views are currently imported as tables.

ODBC Driver configuration

First Download ODBC driver.

Image title

Extract files and double click on clickhouse-odbc-<version>-win64 and follow the instructions to install a driver.

Image title

After that hit windows key, search for ODBC DataSources 64 bit and open this app. In System DSN tab you should be able to see ClickHouse DSN (Unicode).

Image title

Go to User DSN tab and click on Add button. Double click on ClickHouse DSN (Unicode) to configure it.

Image title

Provide all the connection as follows:

  • Name - Some convinient 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.

Image title

Image title

Accept with Ok and you're ready to go.

Go to section Connecting to database with ODBC in this article to use this ODBC driver to connect to the ClickHouse database within Dataedo.

Found issue with this article? Comment below
0
There are no comments. Click here to write the first comment.