Get Help

ClickHouse@1

ClickHouse@1 reads data from a ClickHouse server. Nothing to install.

Connects to

A ClickHouse server, self-hosted or ClickHouse Cloud.

Example

Name
MyClickHouseData
Technology
ClickHouse
Provider
ClickHouse@1
Connection string
Host=localhost;
Protocol=https;
Port=8443;
Username=default;
Password=%MY_PASSWORD_FOR_CLICKHOUSE%;
Data sources:
- Name: MyClickHouseData
  Provider: ClickHouse@1
  Technology: ClickHouse
  Connection string: >
    Host=localhost;
    Protocol=https;
    Port=8443;
    Username=default;
    Password=%MY_PASSWORD_FOR_CLICKHOUSE%;

Connection string

A ClickHouse.Client connection string — Key=Value pairs separated by semicolons; the client talks to the server’s HTTP interface. The keys you will use most:

Key Meaning
Host Server name or address
Protocol http or https
Port 8123 for http, 8443 for https, unless your server says otherwise
Database Database to connect to; default when omitted
Username, Password Credentials

The full list is in the ClickHouse C# client documentation.

A password, or the whole string, can come from an environment variable — %NAME% is replaced with the value of NAME; see How every provider is used.

Settings

None beyond Connection string.

Query

One SQL statement in ClickHouse’s dialect that returns a result set.

Prerequisites

None. The driver ships with CAT. Windows; on Linux it has no extra dependencies and is expected to work, but it has not been tested there.

Serving test and data source definitions

ClickHouse@1 can also serve lists of definitions: any statement that returns the columns of a test, data source or query definition works. Ready-made table scripts are in Store definitions in a database.

  • Technologies — what CAT can test, with the provider behind each.