Registering ClickHouse Data Source


To retrieve data from an external ClickHouse data source, you need to first configure the data source information and establish a connection to the target database. This document describes how to configure a connection to a ClickHouse data source.

Prerequisites


Before you begin, ensure the following:

  • Your account has been granted the required asset permissions, operation permissions, and menu group access. If not assigned, contact OU administrator.

  • You have obtained the detailed connection configuration of the data source, including the server IP address, port number, database name, access credentials, password, etc.

Procedure


  1. Log in to the EnOS Application Portal, and select Data > Data Source Registration from the left navigation bar.

  2. Click Add Data Source.

  3. On the Add Data Source page, complete the following configurations:

    Basic Information:

    • Data Source Type (Required): Select CLICKHOUSE.

    • Data Source Name (Required): Enter a name for the data source. The maximum length is 50 characters, and the name can consist of:

      • Letters

      • numbers

      • _ (underscore)

      • - (hyphen)

    • Data Source Description: Enter a description for the data source. The maximum length is 100 characters and supports internationalization (default, Chinese, English).


    Configuration Information:

    • JDBC URL: The standard URL format for connecting to relational databases, which will change based on the entered hostname or IP address.

    • Host Name/IP Address (Required): Enter the database hostname or IP address (default port: 8123). Click Add Server Address to enter multiple hostnames or IP addresses.

    • Database/Mode (Required): Enter the database name as its unique identifier, following the same character rules as the data source name.

    • Username (Required): Enter the database access username. The character rules are the same as for the data source name.

    • Password (Required): Enter the password for the username.

  4. Click Test to verify the connectivity of the data source.

  5. After a successful test, click Confirm.

    • Connectivity is not validated during data source creation. A data source can still be created even if the connectivity test fails.

    • If the connectivity test fails five times consecutively, the account will be locked for 10 minutes.

Outcome


Once the data source is successfully registered, it will appear in the Data Source Registration list. Users can view basic information about all data sources within the OU, but only the creator can modify or delete their registered data sources. For more details, see Managing Data Source.