ClickHouse

Load event data into ClickHouse for real-time analytics and high-performance columnar storage.

Configuration

FieldTypeRequiredDescription
hoststringYesThe ClickHouse server hostname.
portstringYesThe ClickHouse HTTP(S) port. Defaults to 8443.
databasestringYesThe target database name.
tablestringYesThe target table name to insert rows into.
usernamestringYesThe ClickHouse username for authentication.
passwordsecretYesThe ClickHouse password for authentication.
use_tlsbooleanNoEnable TLS for the connection. Defaults to true.

Quick Setup

  1. Navigate to Integrations in the sidebar.
  2. Open the Integration Library tab.
  3. Find ClickHouse or filter by Cloud Storage.
  4. Click Install, select a variant if available, and fill in the required fields.
  5. Click Install Integration to create the integration with a ready-to-use default configuration.

API Setup

curl -X POST http://localhost:8084/v1/admin/integration-catalog/clickhouse/install \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "ClickHouse",
    "variant": "default",
    "config": {
      "host": "clickhouse.example.com",
      "port": "8443",
      "database": "analytics",
      "table": "events",
      "username": "datafly",
      "use_tls": true
    },
    "delivery_mode": "server_side"
  }'

Delivery

Events are delivered server-side from your Datafly Signal infrastructure directly to ClickHouse. No client-side scripts are loaded for this integration.

Visit ClickHouse documentation for full API documentation and credential setup instructions.