ClickHouse

Experimental

Creates:

Assets

Configure in the UI

This plugin can be configured directly in the Marmot UI with a step-by-step wizard.

View Guide

The ClickHouse plugin discovers databases, tables, and views from ClickHouse instances. It extracts schema information, column details, and table metrics like row counts and storage sizes.

Connection Examples

Required Permissions

The user needs read access to system tables:

GRANT SELECT ON system.databases TO marmot_user;
GRANT SELECT ON system.tables TO marmot_user;
GRANT SELECT ON system.columns TO marmot_user;

For read-only discovery of all databases:

GRANT SHOW DATABASES ON *.* TO marmot_user;
GRANT SHOW TABLES ON *.* TO marmot_user;
GRANT SHOW COLUMNS ON *.* TO marmot_user;

Example Configuration

host: "clickhouse.company.com"
port: 9000
user: "default"
password: "${CLICKHOUSE_PASSWORD}"
database: "default"
secure: false
include_databases: true
include_columns: true
enable_metrics: true
exclude_system_tables: true
database_filter:
  include:
    - "^analytics.*"
  exclude:
    - ".*_temp$"
tags:
  - "clickhouse"
  - "analytics"

Configuration

The following configuration options are available:

Property	Type	Required	Description
database	string	false	Default database to connect to
database_filter	plugin.Filter	false	Filter configuration for databases
enable_metrics	bool	false	Whether to include table metrics (row counts, sizes)
exclude_system_tables	bool	false	Whether to exclude system tables
external_links	[]ExternalLink	false	External links to show on all assets
host	string	false	ClickHouse server hostname or IP address
include_columns	bool	false	Whether to include column information in table metadata
include_databases	bool	false	Whether to discover databases
password	string	false	Password for authentication
port	int	false	ClickHouse native protocol port
secure	bool	false	Use TLS/SSL connection
table_filter	plugin.Filter	false	Filter configuration for tables
tags	TagsConfig	false	Tags to apply to discovered assets
user	string	false	Username for authentication

Available Metadata

The following metadata fields are available:

Field	Type	Description
column_name	string	Column name
comment	string	Database comment/description
comment	string	Column comment/description
comment	string	Table comment/description
data_type	string	Column data type
database	string	Database name
database	string	Parent database name
default_expression	string	Default value expression
default_kind	string	Default value kind (DEFAULT, MATERIALIZED, ALIAS)
engine	string	Database engine type
engine	string	Table engine (MergeTree, ReplacingMergeTree, etc.)
is_primary_key	bool	Whether column is part of primary key
is_sorting_key	bool	Whether column is part of sorting key
row_count	int64	Estimated row count
size_bytes	int64	Table size in bytes
table_name	string	Table name