ClickHouse
Supported
Data warehouses & lakehouses
Catalog ClickHouse databases, tables, materialized views and columns from the system tables.
Capabilities
| Capability | Support | Notes |
|---|---|---|
| Tables, views & columns | Supported | Read from system.tables and system.columns (or information_schema on recent versions). |
| Keys, constraints & indexes | Not available | |
| Procedures & functions | Not available | |
| Data lineage | Partial | |
| Lineage from query history | Partial | Statements can be extracted from system.query_log. |
| Business glossary links | Supported | |
| Data quality probes | Supported | |
| Data profiling | Supported | |
| Data classification | Supported | |
| Chat with your data | Supported |
Connection settings
Create the connection on the Blindata Agent from Settings > Agents > Connections with the connection wizard, choosing ClickHouse in the technology step.
| Driver class | com.clickhouse.jdbc.ClickHouseDriver |
|---|---|
| JDBC URL | jdbc:clickhouse:http://localhost:8123 |
| Authentication |
Service principal (shared technical user) User principal (personal credentials, BYOC) Ephemeral credentials (asked at each run)
|
| Crawling strategy | SQL |
The Blindata Agent does not include this driver: download the vendor JDBC driver and copy the .jar into the agent drivers folder, as described in
Add JDBC drivers.
Driver properties can be added under Advanced settings in the connection wizard.
Prerequisites & permissions
- A Blindata Agent installed with network access to ClickHouse.
- The vendor JDBC driver installed on the agent (see Add JDBC drivers).
SHOW TABLES/SHOW COLUMNSon the databases to document.SELECTonsystem.query_logfor query history.
Set up metadata crawling
- Create the connection to ClickHouse on the agent (see Connection settings) and use Test to verify it.
- Create or open the system that represents ClickHouse in the catalog and link it to the connection.
- In the CRAWLING tab add a crawling job with strategy SQL.
- Run a TEST to check the number of extracted objects, then RUN or schedule the job.
The job options and the column aliases of every extraction query are described in the Generic JDBC reference.