Skip to main content
ClickHouse logo
  • Category: databases
  • Auth: BASIC
  • Composio-managed OAuth available? N/A
  • Tools: 6
  • Triggers: 0
  • Slug: CLICKHOUSE
  • Version: 20261101_00

Tools

Slug: CLICKHOUSE_EXECUTE_QUERYExecute a SQL query in ClickHouse, including statements that can modify data or schema, and return its results. JSONEachRow results have synthesized statistics; other non-JSON formats are returned as text in a single result row.

Input Parameters

string
required
The SQL query to execute in ClickHouse
string
Output format for the query results. Common formats: JSONEachRow, JSON, CSV, TSV
string
Database to use for the query (overrides connection default)
object
Additional ClickHouse settings for the query execution
integer
Maximum query execution time in seconds

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKHOUSE_GET_DATABASE_SCHEMAGet a schema overview of a ClickHouse database, including its tables and optionally their column definitions. Requested column definitions may be unavailable if the column lookup fails.

Input Parameters

string
Database name (overrides connection default). If not specified, uses connection default or ‘default’
boolean
Whether to include full column schemas for all tables. Set to false for quick overview, true for complete schema details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKHOUSE_GET_PLAY_INTERFACEGet the ClickHouse Play web user interface for interactive query execution. Returns HTML page with Monaco Editor for writing queries and visualizing results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKHOUSE_GET_TABLE_SCHEMAGet detailed schema information for a specific table including column definitions, types, keys, and optionally sample data. This is essential for AI agents to understand table structure before constructing queries.

Input Parameters

string
Database name (overrides connection default)
string
required
Name of the table to describe
integer
Number of sample rows to return (only if include_sample_data is true)
boolean
Whether to include sample rows from the table

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKHOUSE_LIST_DATABASESList all databases in the ClickHouse instance. Useful for discovering available databases before querying tables.

Input Parameters

string
Optional LIKE pattern to filter databases (e.g., ‘prod_%’ or ‘%test’)
boolean
Whether to include list of table names for each database

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKHOUSE_LIST_TABLESList tables in ClickHouse databases. Returns information about tables including their engine, size, and row count.

Input Parameters

string
Optional LIKE pattern to filter table names (e.g., ‘user_%’ or ’%_log’)
string
Database name to list tables from. If not provided, lists tables from all databases
boolean
Whether to include views in the results
boolean
Whether to include column names for each table
boolean
Whether to include primary key information for each table

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not