Skip to main content

ClickHouse

ClickHouse is an open-source, column-oriented database management system (DBMS) designed for online analytical processing (OLAP). It is optimized for high performance on analytical queries using large volumes of data, making it widely used in big data and real-time analytics use cases.

Prerequisites​

The following prerequisites must be met in order for a user to create and test a successful connection.

  • The ClickHouse server must be accessible from the iceDQ server.
  • Valid credentials to access the database.
  • ClickHouse JDBC version 0.60 or higher.

Authentication Mechanism​

The following authentication mechanism is supported.

  • Username & Password

Connection Properties​

Use the following properties to create a valid connection. Properties marked with an asterisk (*) are required.

NameDescriptionExample Values
Connection Name *       Name that uniquely identifies the connection.Sales_prod_conn
Driver *Driver used to establish the connection. By default, one driver is available.ClickHouse Native JDBC
Custom JDBC URLStandardized string used to define the connection details. Use this format supported by the driver: jdbc:clickhouse://[host]:[port]/[database]jdbc:clickhouse://193.167.42.80:8123/prod_db
Host *IP address or hostname of the database server.clickhouse.acme.com or 193.167.42.80
Port *Port is the address on which the server listens. Default value is 8123 for ClickHouse.8123
Database *Name of the target database.prod_db
Type *The connection type – either System Connection or User Connection. Refer Connections for more details.System or User
Username *Database login username with necessary privileges.john_doe
Password *Password associated with the specified username.Admin@123

Custom Properties​

Custom properties are optional connection parameters in the ClickHouse JDBC driver, allowing customization of settings like timeouts, compression, and secure connections. A list of supported properties is available here. The availability and behavior of custom connection properties may vary depending on the version of the ClickHouse JDBC driver in use.

Unsupported Datatypes​

The following datatypes are not supported.

  • AGGREGATEFUNCTION
  • BLOBS
  • LOWCARDINALITY
  • MAP
  • TUPLE
Last updated on