FruxonDocs

ClickHouse

ClickHouse database integration for querying, inserting, and deleting analytical data

The ClickHouse integration lets your agents query, insert, and delete data in ClickHouse, a column-oriented database built for fast analytics over large datasets.

Prerequisites

You need:

  • ClickHouse connection string — The connection details for your ClickHouse instance in key-value format (e.g., Host=myhost.clickhouse.cloud;Port=8443;Username=default;Password=pass;Database=default;Protocol=https). ClickHouse Cloud uses HTTPS on port 8443; self-hosted instances use HTTP on port 8123 by default. This includes authentication credentials.

Setup

  1. Open Integrations from the sidebar
  2. Select ClickHouse from the catalog
  3. Click Add Integration Config
  4. Give the config a display name (e.g., "ClickHouse - Analytics")
  5. Enter your Connection String (stored encrypted)
  6. Save the config

No separate authentication setup is needed — credentials are embedded in the connection string.

Using in Your Agent

  1. Open your agent in Agent Studio and select an Agent Step
  2. Under Attached Integration Configurations, click Attach configuration and choose your config
  3. Attach ClickHouse tools from the tools panel
  4. Tools are referenced as clickhouse.query, clickhouse.insert, etc.

Available Tools

ToolDescriptionAction Type
list_tablesList all tables in the databaseReadOnly
describe_tableGet the schema of a tableReadOnly
queryExecute a SELECT queryReadOnly
insertInsert rows into a tableReversible
deleteDelete rows with a lightweight DELETE FROM statementIrreversible

ClickHouse is analytics-oriented and has no standalone UPDATE statement, so there is no update tool. The delete tool issues a lightweight delete that runs as an asynchronous mutation — rows stop being returned by queries immediately, while physical removal happens in the background.

On this page