Clickhouse

Connect & Ingest data from / to a Clickhouse database

Setup

The following credentials keys are accepted:

• host (required) -> The hostname / ip of the instance

• database (required) -> The database name of the instance

• user (optional) -> The username to access the instance

• schema (optional) -> The default schema to use

• password (optional) -> The password to access the instance

• port (optional) -> The port of the instance. Default is 9000.

• secure (optional) -> Whether to use TLS for connecting. Default is false.

• skip_verify (optional) -> Whether to skip verification for TLS. Default is false.

• http_url (optional) -> The HTTP url to override the connection string (see https://github.com/ClickHouse/clickhouse-go?tab=readme-ov-file#http-support-experimental). When specifying http_url, sling will use the HTTP clickhouse interface instead of the native interface. Native is recommended for optimal performance.

• ssh_tunnel (optional) -> The URL of the SSH server you would like to use as a tunnel (example ssh://user:[email protected]:22)

• ssh_private_key (optional) -> The private key to use to access a SSH server (raw string or path to file).

• ssh_passphrase (optional) -> The passphrase to use to access a SSH server.

Using sling conns

Here are examples of setting a connection named CLICKHOUSE. We must provide the type=clickhouse property:

$ sling conns set CLICKHOUSE type=clickhouse host=<host> user=<user> database=<database> password=<password> port=<port> 

# OR use url
$ sling conns set CLICKHOUSE url="clickhouse://myuser:[email protected]:9000/mydatabase"

# connecting via http
$ sling conns set CLICKHOUSE type=clickhouse http_url="http://myuser:[email protected]:8123/default"

Environment Variable

export CLICKHOUSE='clickhouse://myuser:[email protected]:9000/mydatabase'
export CLICKHOUSE='{ type: clickhouse, user: "myuser", password: "mypass", host: "host.ip", port: 9000, database: "mydatabase" }'

Sling Env File YAML

See here to learn more about the sling env.yaml file.

connections:
  CLICKHOUSE:
    type: clickhouse
    host: <host>
    user: <user>
    port: <port>
    database: <database>
    schema: <schema>
    password: <password>

  # connecting via http
  CLICKHOUSE_HTTP:
    type: clickhouse
    http_url: http://myuser:[email protected]:8123/default

  CLICKHOUSE_URL:
    url: "clickhouse://myuser:[email protected]:9000/mydatabase"

If you are facing issues connecting, please reach out to us at [email protected], on discord or open a Github Issue here.