This guide will walk you through the steps to connect Hashboard with your ClickHouse instance. This information is also available on Hashboard’s ClickHouse integration documentation.
Pre-requisites
- A ClickHouse database either hosted on your own infrastructure or on ClickHouse Cloud.
- A Hashboard account and project.
Steps to connect Hashboard to ClickHouse
- Gather your connection details
To connect to ClickHouse with native TCP you need this information:
| Parameters | Description |
|---|---|
HOST and PORT | Typically, the port is 9440 when using TLS, or 9000 when not using TLS. |
DATABASE NAME | Out of the box there is a database named default, use the name of the database that you want to connect to. |
USERNAME and PASSWORD | Out of the box the username is default. Use the username appropriate for your use case. |
clickhouse-client command.
If you’re using self-managed ClickHouse, the connection details are set by your ClickHouse administrator.
- Add a new database connection in Hashboard
- Navigate to your Hashboard project.
- Open the Settings page by clicking the gear icon in the side navigation bar.
- Click
+ New Database Connection. - In the modal, select “ClickHouse.”
- Fill in the Connection Name, Host, Port, Username, Password, and Database fields with the information gathered earlier.
- Click “Test” to validate that the connection is configured successfully.
- Click “Add”