Clickhouse

PROD

Available In

Feature List

Metadata

Query Usage

Lineage

Column-level Lineage

Data Profiler

Data Quality

dbt

Sample Data

Reverse Metadata (Collate Only)

Auto-Classification

Owners

Tags

Stored Procedures

In this section, we provide guides and references to use the Clickhouse connector.

Configure and schedule Clickhouse metadata and profiler workflows from the OpenMetadata UI:

• Requirements
  • Profiler & Data Quality
  • Usage & Lineage
• Metadata Ingestion
  • Service Name
  • Connection Options
  • Metadata Ingestion Options
• Troubleshooting
  • Workflow Deployment Error
• Related

Ingestion Deployment

To run the Ingestion via the UI you'll need to use the OpenMetadata Ingestion Container, which comes shipped with custom Airflow plugins to handle the workflow deployment. If you want to install it manually in an already existing Airflow host, you can follow this guide.

If you don't want to use the OpenMetadata Ingestion container to configure the workflows via the UI, then you can check the following docs to run the Ingestion Framework in any orchestrator externally.

Requirements

Clickhouse user must grant SELECT privilege on system.* and schema/tables to fetch the metadata of tables and views.

• Create a new user
• More details https://clickhouse.com/docs/en/sql-reference/statements/create/user

• Grant Permissions
• More details on permissions can be found here at https://clickhouse.com/docs/en/sql-reference/statements/grant

Profiler & Data Quality

Executing the profiler workflow or data quality tests, will require the user to have SELECT permission on the tables/schemas where the profiler/tests will be executed. More information on the profiler workflow setup can be found here and data quality tests here.

Usage & Lineage

For the usage and lineage workflow, the user will need SELECT privilege. You can find more information on the usage workflow here and the lineage workflow here.

Metadata Ingestion

1. Visit the Services Page

Click Settings in the side navigation bar and then Services.

The first step is to ingest the metadata from your sources. To do that, you first need to create a Service connection first.

This Service will be the bridge between OpenMetadata and your source system.

Once a Service is created, it can be used to configure your ingestion workflows.

Select your Service Type and Add a New Service

2. Create a New Service

Click on Add New Service to start the Service creation.

Add a new Service from the Services page

3. Select the Service Type

Select Clickhouse as the Service type and click Next.

Select your Service from the list

4. Name and Describe your Service

Provide a name and description for your Service.

Service Name

OpenMetadata uniquely identifies Services by their Service Name. Provide a name that distinguishes your deployment from other Services, including the other Clickhouse Services that you might be ingesting metadata from.

Note that when the name is set, it cannot be changed.

Provide a Name and description for your Service

5. Configure the Service Connection

In this step, we will configure the connection settings required for Clickhouse.

Please follow the instructions below to properly configure the Service to read from your sources. You will also find helper documentation on the right-hand side panel in the UI.

Configure the Service connection by filling the form