ClickHouse (Destination)

Install

See the Install guide for the full setup, including Windows PowerShell.

curl -fsSL https://install.skippr.io/install.sh | shClick to copy

Loads data into ClickHouse over HTTP.

Configuration

warehouse:
  kind: clickhouse
  url: http://localhost:8123
  database: default
  user: default
  password: ${CLICKHOUSE_PASSWORD}

Field	Default	Description
url	http://localhost:8123	ClickHouse HTTP URL
database		Database name
user	default	Username
password		Password

CLI

skippr connect warehouse clickhouse \
  --url http://localhost:8123 \
  --database default \
  --user default \
  --password "secret"

Flag	Description
--url	HTTP interface URL (default: http://localhost:8123)
--database	Database name (default: default)
--user	Username (default: default)
--password	Password

Authentication

Use the configured ClickHouse user and password, or rely on the default local user for development. For security best practices, we strongly advise against storing the password in skippr.yaml. Use environment variable interpolation instead: replace the password value with your own ${ENV_VAR} reference.

The relevant part of skippr.yaml looks like this:

warehouse:
  kind: clickhouse
  password: ${CLICKHOUSE_PASSWORD}

Set the env var before running skippr:

macOS / Linux

export CLICKHOUSE_PASSWORD="secret"

Windows PowerShell

$env:CLICKHOUSE_PASSWORD = "secret"

Windows Command Prompt

set CLICKHOUSE_PASSWORD=secret

Permissions or Network Requirements

The ClickHouse user needs write access to the target database and tables, and the runner must be able to reach the ClickHouse HTTP endpoint.

Troubleshooting

Symptom	Fix
authentication failed	Verify the ClickHouse user, password, URL, and database name.
writes succeed but deduped state looks delayed	This destination relies on ReplacingMergeTree merges. Use FINAL for point-in-time correctness when querying fresh data.

CDC Support

ClickHouse supports CDC with final-state reconciliation using ReplacingMergeTree engine semantics. Skippr automatically creates _skippr_order_token columns and tombstone tables.

See CDC Destinations -- ClickHouse for details.

Next steps

• Pair this destination with a source from Source Connectors.
• For CDC semantics, see CDC Destinations, CDC Guarantees, and CDC Operations.

Install

See the Install guide for the full setup, including Windows PowerShell.

curl -fsSL https://install.skippr.io/install.sh | shClick to copy