> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# ClickHouse

> ClickHouse is a fast open-source column-oriented database management system for real-time analytics and big data processing with SQL support

![ClickHouse logo](https://mintcdn.com/composio-preview/NPf8agM6UrvZD-Iu/images/toolkits/clickhouse.svg?fit=max\&auto=format\&n=NPf8agM6UrvZD-Iu\&q=85\&s=dfff7534e6ee994940b0a199c7dd4a72)

* **Category:** databases
* **Auth:** BASIC
* **Composio-managed OAuth available?** N/A
* **Tools:** 6
* **Triggers:** 0
* **Slug:** `CLICKHOUSE`
* **Version:** 20261101\_00

## Tools

> [accordion] Execute ClickHouse Query
>
> **Slug:** `CLICKHOUSE_EXECUTE_QUERY`
>
> Execute 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
>
> **query** `string` *required*
>
> The SQL query to execute in ClickHouse
>
> **format** `string`
>
> Output format for the query results. Common formats: JSONEachRow, JSON, CSV, TSV
>
> **database** `string`
>
> Database to use for the query (overrides connection default)
>
> **settings** `object`
>
> Additional ClickHouse settings for the query execution
>
> **max\_execution\_time** `integer`
>
> Maximum query execution time in seconds
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Database Schema
>
> **Slug:** `CLICKHOUSE_GET_DATABASE_SCHEMA`
>
> Get 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
>
> **database** `string`
>
> Database name (overrides connection default). If not specified, uses connection default or 'default'
>
> **include\_table\_schemas** `boolean`
>
> Whether to include full column schemas for all tables. Set to false for quick overview, true for complete schema details.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get ClickHouse Play Interface
>
> **Slug:** `CLICKHOUSE_GET_PLAY_INTERFACE`
>
> Get the ClickHouse Play web user interface for interactive query execution. Returns HTML page with Monaco Editor for writing queries and visualizing results.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Table Schema
>
> **Slug:** `CLICKHOUSE_GET_TABLE_SCHEMA`
>
> Get 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
>
> **database** `string`
>
> Database name (overrides connection default)
>
> **table\_name** `string` *required*
>
> Name of the table to describe
>
> **sample\_rows** `integer`
>
> Number of sample rows to return (only if include\_sample\_data is true)
>
> **include\_sample\_data** `boolean`
>
> Whether to include sample rows from the table
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List ClickHouse Databases
>
> **Slug:** `CLICKHOUSE_LIST_DATABASES`
>
> List all databases in the ClickHouse instance. Useful for discovering available databases before querying tables.
>
> #### Input Parameters
>
> **pattern** `string`
>
> Optional LIKE pattern to filter databases (e.g., 'prod\_%' or '%test')
>
> **include\_tables** `boolean`
>
> Whether to include list of table names for each database
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List ClickHouse Tables
>
> **Slug:** `CLICKHOUSE_LIST_TABLES`
>
> List tables in ClickHouse databases. Returns information about tables including their engine, size, and row count.
>
> #### Input Parameters
>
> **pattern** `string`
>
> Optional LIKE pattern to filter table names (e.g., 'user\_%' or '%\_log')
>
> **database** `string`
>
> Database name to list tables from. If not provided, lists tables from all databases
>
> **include\_views** `boolean`
>
> Whether to include views in the results
>
> **include\_columns** `boolean`
>
> Whether to include column names for each table
>
> **include\_primary\_key** `boolean`
>
> Whether to include primary key information for each table
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
