OpenMetadata/openmetadata-docs/content/v1.1.1-SNAPSHOT/connectors/database/clickhouse/index.md

title	slug
Clickhouse	/connectors/database/clickhouse

Clickhouse

{% multiTablesWrapper %}

Feature	Status
Stage	PROD
Metadata	{% icon iconName="check" /%}
Query Usage	{% icon iconName="check" /%}
Data Profiler	{% icon iconName="check" /%}
Data Quality	{% icon iconName="check" /%}
Lineage	{% icon iconName="check" /%}
DBT	{% icon iconName="check" /%}
Supported Versions	--

Feature	Status
Lineage	{% icon iconName="check" /%}
Table-level	{% icon iconName="check" /%}
Column-level	{% icon iconName="check" /%}

{% /multiTablesWrapper %}

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:

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

{% partial file="/v1.1.1/connectors/ingestion-modes-tiles.md" variables={yamlPath: "/connectors/database/clickhouse/yaml"} /%}

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

CREATE USER <username> IDENTIFIED WITH sha256_password BY <password>

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

-- Grant SELECT and SHOW to that user
-- More details on permissions can be found here at https://clickhouse.com/docs/en/sql-reference/statements/grant
GRANT SELECT, SHOW ON system.* to <username>;
GRANT SELECT ON <schema_name>.* to <username>;

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

{% partial file="/v1.1.1/connectors/metadata-ingestion-ui.md" variables={ connector: "Clickhouse", selectServicePath: "/images/v1.1.1/connectors/clickhouse/select-service.png", addNewServicePath: "/images/v1.1.1/connectors/clickhouse/add-new-service.png", serviceConnectionPath: "/images/v1.1.1/connectors/clickhouse/service-connection.png", } /%}

{% stepsContainer %} {% extraContent parentTagName="stepsContainer" %}

Connection Options

• Username: Specify the User to connect to Clickhouse. It should have enough privileges to read all the metadata.
• Password: Password to connect to Clickhouse.
• Host and Port: Enter the fully qualified hostname and port number for your Clickhouse deployment in the Host and Port field.

{% partial file="/v1.1.1/connectors/database/advanced-configuration.md" /%}

You can find the full list of accepted options here.

• Connecting to Clickhouse with SSL Certificate: You will need to use the clickhouse+native connection scheme. Then in the Connection Options reference the following key with their value:
  • verify: true
  • secure: true
  • keyfile: /path/to/key/file

The keyfile needs to be accessible by the service running the ingestion. For example if you are running the ingestion in a docker container, your keyfile needs to be present in the container at the location specify as a value in the Connection Options. Additionally, your keyfile needs to be in the .cert or .pem format.

{% /extraContent %}

{% partial file="/v1.1.1/connectors/test-connection.md" /%}

{% partial file="/v1.1.1/connectors/database/configure-ingestion.md" /%}

{% partial file="/v1.1.1/connectors/ingestion-schedule-and-deploy.md" /%}

{% /stepsContainer %}

{% partial file="/v1.1.1/connectors/troubleshooting.md" /%}

{% partial file="/v1.1.1/connectors/database/related.md" /%}