ClickHouse Reader (Docker)

The ClickHouse Reader component is designed to read and access data stored in a ClickHouse database. It supports authentication using username/password or other authentication mechanisms supported by ClickHouse.

ClickHouse Reader can be configured either via the Spark Driver (RDBMS Reader) or the Docker Reader.

• Spark Driver uses the HTTP port.

• Docker Reader supports only the TCP port.

Configuration Sections

The ClickHouse Reader component configurations are organized into the following sections:

• Basic Information

• Meta Information

• Resource Configuration

• Connection Validation

Meta Information Tab

Parameter	Description	Example	Required
Host IP Address	IP address of the ClickHouse server.	192.168.1.50	Yes
Port	Port number for the given host. For Docker Reader, only TCP port is supported.	9000 (TCP), 8123 (HTTP)	Yes
Username	Username for authentication.	default	Yes
Password	Password for the database user.	********	Yes
Database Name	Name of the ClickHouse database.	analytics_db	Yes
Table Name	Single or multiple table names. Use commas (,) to separate multiple tables.	orders, customers	Conditional (if query not provided)
Query	SQL query to fetch and filter data.	SELECT * FROM orders WHERE status='active'	Conditional (if table not provided)
Settings	Custom configuration parameters for specific queries.	max_threads=4	Optional
Enable SSL	Enables SSL for secure communication between the component and the ClickHouse server.	true	Optional

Notes

• Either Table Name or Query is required.

• If multiple tables are specified in Table Name, separate them with commas.

• The Settings parameter allows query-level configuration (e.g., controlling execution threads).

• SSL can be enabled for encrypted communication. Certificates must be configured at the server level.

• Docker Reader variant supports only TCP port (9000).