ClickHouse

This guide explains how to connect to ClickHouse with Oxygen. ClickHouse is an open-source column-oriented DBMS for real-time analytics.

Configuration Options

Add your ClickHouse configuration to config.yml. Here are all available parameters:

databases:
  - name: my_clickhouse_db # Unique identifier for this connection
    type: clickhouse
    host: "http://clickhouse.local:8123" # ClickHouse server url with protocol://hostname:port
    user: "default" # Username for authentication
    password: <password> # Direct password (not recommended)
    password_var: "CH_PWD" # Environment variable containing password (recommended)
    database: "default" # Database name to connect to

Example Configurations

Prepare password environment variable

Export the environment variable:

export CH_PWD=<your password>

Or put it in .env file:

echo CH_PWD=<your password> >> .env

Add ClickHouse configuration

databases:
  - name: local_ch
    type: clickhouse
    host: "http://clickhouse.local:8123"
    user: "default"
    password_var: "CH_PWD"
    database: "analytics"

Troubleshooting

Verify server status: clickhouse-client --query "SELECT 1"
Check system logs: /var/log/clickhouse-server/
Common ports: 8123 (HTTP), 9000 (TCP), 9009 (replication)
Monitor server metrics: system.metrics table

Get started

Data Infrastructure

World Model

Agentic Intelligence

SDK

Automations

Data Apps

Integrations

Edge fleet

Manage

Workspaces

Authentication

Observability

Enterprise

Reference

REST API

Resources

Troubleshooting

ClickHouse

Configuration Options

Example Configurations

Troubleshooting

​Configuration Options

​Example Configurations

​Troubleshooting

Configuration Options

Example Configurations

Troubleshooting