Clickhouse

Feature supports in Clickouse

Feature Supports

Metadata

Query Usage

Data Profile

Lineage

DBT

Supported Versions

Requirements

To run the Ingestion via the UI you'll need to use the metadata Ingestion Container, which comes shipped with custom Airflow plugins to handle the workflow deployment.

Metadata Ingestion

Step 1: Visit the Service Page

The first step is ingesting the metadata from your sources. Under Settings, you will find a Services link an external source system to Darkseal. Once a service is created, it can be used to configure metadata, usage, and profiler workflows.

To visit the Services page, select Services from the Settings menu or my-data table.

Step 2: Create a New Service

Click on the Add New Service button to start the Service creation.

Step 3: Select the Service Type

Select Clickhouse as the service type and click Next.

Step 4: Name and Describe your Service

Provide a name and description for your service as illustrated below.

Step 5: Configure the Service Connection

In this step, we will configure the connection settings required for this connector. Please follow the instructions below to ensure that you've configured the connector to read from your clickhouse service as desired.

Once the credentials have been added, click on Test Connection and Save the changes.

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.

• Connection Options (Optional): Enter the details for any additional connection options that can be sent to Clickhouse during the connection. These details must be added as Key-Value pairs. You can find the full list of accepted options here

• Connection Arguments (Optional): Enter the details for any additional connection arguments such as security or protocol configs that can be sent to Clickhouse during the connection. These details must be added as Key-Value pairs.

  • In case you are using Single-Sign-On (SSO) for authentication, add the authenticator details in the Connection Arguments as a Key-Value pair as follows: "authenticator" : "sso_login_url"

  • In case you authenticate with SSO using an external browser popup, then add the authenticator details in the Connection Arguments as a Key-Value pair as follows: "authenticator" : "externalbrowser"

• 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 specified as a value in the Connection Options. Additionally, your keyfile needs to be in the .cert or .pem format.

Step 6: Configure Metadata Ingestion

In this step we will configure the metadata ingestion pipeline, Please follow the instructions below:

Metadata Ingestion Options:

• Name: This field refers to the name of ingestion pipeline, you can customize the name or use the generated name.

• Database Filter Pattern (Optional): Use to database filter patterns to control whether or not to include database as part of metadata ingestion.

  • Include: Explicitly include databases by adding a list of comma-separated regular expressions to the Include field. OpenMetadata will include all databases with names matching one or more of the supplied regular expressions. All other databases will be excluded.

  • Exclude: Explicitly exclude databases by adding a list of comma-separated regular expressions to the Exclude field. OpenMetadata will exclude all databases with names matching one or more of the supplied regular expressions. All other databases will be included.

• Schema Filter Pattern (Optional): Use to schema filter patterns to control whether or not to include schemas as part of metadata ingestion.

  • Include: Explicitly include schemas by adding a list of comma-separated regular expressions to the Include field. OpenMetadata will include all schemas with names matching one or more of the supplied regular expressions. All other schemas will be excluded.

  • Exclude: Explicitly exclude schemas by adding a list of comma-separated regular expressions to the Exclude field. OpenMetadata will exclude all schemas with names matching one or more of the supplied regular expressions. All other schemas will be included.

• Table Filter Pattern (Optional): Use to table filter patterns to control whether or not to include tables as part of metadata ingestion.

  • Include: Explicitly include tables by adding a list of comma-separated regular expressions to the Include field. OpenMetadata will include all tables with names matching one or more of the supplied regular expressions. All other tables will be excluded.

  • Exclude: Explicitly exclude tables by adding a list of comma-separated regular expressions to the Exclude field. OpenMetadata will exclude all tables with names matching one or more of the supplied regular expressions. All other tables will be included.

• Include views (toggle): Set the Include views toggle to control whether or not to include views as part of metadata ingestion.

• Include tags (toggle): Set the Include tags toggle to control whether or not to include tags as part of metadata ingestion.

• Enable Debug Log (toggle): Set the Enable Debug Log toggle to set the default log level to debug, these logs can be viewed later in Airflow.

• Mark Deleted Tables (toggle): Set the Mark Deleted Tables toggle to flag tables as soft-deleted if they are not present anymore in the source system.

• Mark Deleted Tables from Filter Only (toggle): Set the Mark Deleted Tables from Filter Only toggle to flag tables as soft-deleted if they are not present anymore within the filtered schema or database only. This flag is useful when you have more than one ingestion pipelines. For example if you have a schema

• Auto Tag PII(toggle): Auto PII tagging checks for column name to mark PII Sensitive/NonSensitive tag

Step 7: Schedule the Ingestion and Deploy

Scheduling can be set up at an hourly, daily, or weekly cadence. The timezone is in UTC. Select a Start Date to schedule for ingestion. It is optional to add an End Date.

Review your configuration settings. If they match what you intended, click Deploy to create the service and schedule metadata ingestion.

If something doesn't look right, click the Back button to return to the appropriate step and change the settings as needed.

After configuring the workflow, you can click on Deploy to create the pipeline.