Skip to content

ClickHouse Client

Hydrolix uses the ClickHouse SQL engine. Use the ClickHouse-provided Client, a CLI tool for querying databases.

To install clickhouse-client, see the installation instructions.

The default server port for ClickHouse native protocol on clusters with TLS enabled is 9440. For clusters without TLS enabled, the default is 9000. Administrators can alter the native_tls_port tunable.

Supply the correct port for your cluster. The examples below use port 9440.

Present an authorization token⚓︎

Hydrolix supports authorization tokens, issued to user or service accounts.

Use the special username __api_token__ and pass the token in the password field.

1
2
3
4
5
clickhouse-client \
  --user "__api_token__" --password "$HDX_TOKEN" \
  --host "hostname.hydrolix.live" \
  --port "9440" \
  --secure

Authenticate with credentials⚓︎

1
2
3
4
5
clickhouse-client \
  --user "$HDX_USERNAME" --password "$HDX_PASSWORD" \
  --host "hostname.hydrolix.live" \
  --port "9440" \
  --secure

Once connected, you can query your cluster using ClickHouse SQL.