OverviewArchitectureRecipeSourceProcessorSinkContext Graph for AI
OverviewArchitectureRecipeSourceProcessorSinkContext Graph for AI

ClickHouse

Lists all non-system tables on a ClickHouse server and extracts their columns. It emits table entities.

Usage

source:
  name: clickhouse
  scope: my-scope
  config:
    connection_url: tcp://localhost:9000?username=admin&password=pass123&debug=true

Configuration

KeyTypeDescriptionRequired
connection_urlstringClickHouse connection URL, for example tcp://localhost:9000?username=admin&password=pass123.Yes
exclude.databases[]stringDatabases to skip. The system database is always skipped.No
exclude.tables[]stringTables to skip, in database.table format.No

Output

Entity type: table

URN pattern: urn:clickhouse:{scope}:table:{database}.{table}

Notable properties:

PropertyDescription
columnsList of column objects, each with name, data_type, and description (only when the column has a comment).
CassandraConfluence
On this page
UsageConfigurationOutput