ClickHouse icon

ClickHouse

Query, insert, update, delete, and manage ClickHouse tables. Supports AI agent tool use with schema discovery, auto-pagination for large results, and parameterized queries.

Actions11

Describe Schema

AI-generated

Summary

Describe the ClickHouse database schema, optionally fetching sample rows and formatting the output.

Inputs

  • database — Override the database from credentials; choose from the list or specify an ID using an expression.
  • includeSamples — Whether to include sample values per table to help AI agents understand the data
  • outputFormat — How to format the schema output (both, structured JSON, or text summary)
  • sampleSize — Number of sample rows to fetch per table when Include Sample Values is enabled
  • tablePattern — Filter table names using a SQL LIKE pattern

Output shape

An object containing the database name, an array of tables with metadata (name, engine, row/byte counts, etc.), and optional sample data and summary; returned as a single item in the items list.

When outputFormat is 'summary' only the textual summary is provided; otherwise the full schema JSON is returned. The operation always returns a single item in the workflow output list.

Examples

Example 1: Discover schema of an event database with sample rows for AI context.

database set to 'my_database', includeSamples true, outputFormat 'both', sampleSize 5, tablePattern '%events%'

Links

Discussion