ClickHouse (Source)

Install

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

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

Reads from ClickHouse via the HTTP API.

Configuration

source:
  kind: clickhouse_source
  url: http://localhost:8123
  database: default
  user: default
  password: ${CLICKHOUSE_PASSWORD}
  tables:
    - events

Field	Default	Description
url	http://localhost:8123	ClickHouse HTTP URL
database		Database name
user	default	Username
password		Password
tables	(optional)	Tables to extract
query		Custom SQL query (overrides tables)

Namespace: clickhouse.{database}.{table}

CLI

skippr connect source clickhouse-source \
  --url http://localhost:8123 \
  --database default \
  --user default \
  --tables events,metrics

Flag	Description
--url	HTTP interface URL
--database	Database name
--user	Username
--password	Password
--tables	Comma-separated list of tables
--query	SQL query instead of table list

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:

source:
  kind: clickhouse_source
  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 read access to the selected 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, and database name.
connection refused	Check the HTTP URL, port, and network access to the ClickHouse endpoint.

Next steps

• Pair this source with a destination from Destination Connectors.
• See How It Works for the end-to-end pipeline flow.

Install

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

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