ClickHouse
Give the Sazabi agent the ClickHouse CLI (clickhousectl) in its sandbox to run ClickHouse Cloud and local ClickHouse workflows.
About
This CLI connection makes clickhousectl (also available as chctl) available in the Sazabi agent's sandbox. The agent can run ClickHouse Cloud and local ClickHouse workflows on your behalf. The tool is baked into the sandbox image; connecting it authenticates the already-installed CLI.
Prerequisites
- A Sazabi project.
- A ClickHouse Cloud API key (
CLICKHOUSE_CLOUD_API_KEY) and API secret (CLICKHOUSE_CLOUD_API_SECRET).
Set up in the dashboard
Configure the sandbox in the dashboard under Settings > Sandbox CLIs.
Find ClickHouse in the catalog
In Settings > Sandbox CLIs, find ClickHouse under Browse sandbox CLIs and choose to connect it.
Provide credentials
Enter the required values: CLICKHOUSE_CLOUD_API_KEY — your ClickHouse Cloud API key; CLICKHOUSE_CLOUD_API_SECRET — your ClickHouse Cloud API secret. Save to store them securely; Sazabi injects them into the sandbox when the agent runs.
Set up with the CLI
You can also configure the ClickHouse CLI connection with the Sazabi CLI (installed and authenticated — see CLI reference).
sazabi sandbox-clis set --type clickhouse-cli --env CLICKHOUSE_CLOUD_API_KEY=<your-clickhouse-key> --env CLICKHOUSE_CLOUD_API_SECRET=<your-clickhouse-secret>To validate the credentials without saving, run the same command with test in place of set (the test command also requires the --env flags).
Verify
Ask the agent, in a thread, to run the clickhousectl CLI (for example clickhousectl service list) and confirm it returns real output from your account. If the command is not found, the CLI connection may not be enabled; if it runs unauthenticated, recheck the credentials.
Troubleshooting
Command not found — Confirm the ClickHouse CLI connection is enabled for the project under Settings > Sandbox CLIs.
Authentication fails — Recheck the credential values; a rotated or revoked token must be re-entered under Settings > Sandbox CLIs or with sazabi sandbox-clis set --type clickhouse-cli.