ClickHouse

Connect to a ClickHouse database

使用说明

Integrate ClickHouse into the workflow. Query and insert data, manage databases and tables, inspect schemas, monitor mutations and running queries, manage partitions, and execute raw SQL over the ClickHouse HTTP interface.

工具

`clickhouse_query`

Execute a SELECT query on a ClickHouse database

输入

参数	类型	必填	描述
`host`	string	是	ClickHouse server hostname (e.g., your-instance.clickhouse.cloud)
`port`	number	是	ClickHouse HTTP interface port (8443 for HTTPS, 8123 for HTTP)
`database`	string	是	Database name to connect to
`username`	string	是	ClickHouse username
`password`	string	否	ClickHouse password
`secure`	boolean	否	Use a secure HTTPS connection (default: true)
`query`	string	是	SQL SELECT query to execute

输出

参数	类型	描述
`message`	string	Operation status message
`rows`	array	Array of rows returned from the query
`rowCount`	number	Number of rows returned

`clickhouse_execute`

Execute raw SQL (DDL, mutations, or queries) on a ClickHouse database

输入

参数	类型	必填	描述
`host`	string	是	ClickHouse server hostname (e.g., your-instance.clickhouse.cloud)
`port`	number	是	ClickHouse HTTP interface port (8443 for HTTPS, 8123 for HTTP)
`database`	string	是	Database name to connect to
`username`	string	是	ClickHouse username
`password`	string	否	ClickHouse password
`secure`	boolean	否	Use a secure HTTPS connection (default: true)
`query`	string	是	Raw SQL statement to execute

输出

参数	类型	描述
`message`	string	Operation status message
`rows`	array	Array of rows returned from the statement
`rowCount`	number	Number of rows returned or affected

`clickhouse_insert`

Insert a row into a ClickHouse table

输入

参数	类型	必填	描述
`host`	string	是	ClickHouse server hostname (e.g., your-instance.clickhouse.cloud)
`port`	number	是	ClickHouse HTTP interface port (8443 for HTTPS, 8123 for HTTP)
`database`	string	是	Database name to connect to
`username`	string	是	ClickHouse username
`password`	string	否	ClickHouse password
`secure`	boolean	否	Use a secure HTTPS connection (default: true)
`table`	string	是	Table name to insert data into
`data`	object	是	Data object to insert (key-value pairs mapping column names to values)

输出

参数	类型	描述
`message`	string	Operation status message
`rows`	array	Inserted rows (empty for ClickHouse inserts)
`rowCount`	number	Number of rows inserted

`clickhouse_insert_rows`

输入

参数	类型	必填	描述

输出

参数	类型	描述
`message`	string	Success or error message describing the operation outcome
`rows`	array	Array of rows returned from the operation
`rowCount`	number	Number of rows returned or affected by the operation
`count`	number	Row count (count rows operation)
`ddl`	string	CREATE TABLE statement (show create table operation)
`tables`	array	Array of table schemas with columns and engines (introspect operation)

`clickhouse_update`

Update rows in a ClickHouse table via an ALTER TABLE ... UPDATE mutation

输入

参数	类型	必填	描述
`host`	string	是	ClickHouse server hostname (e.g., your-instance.clickhouse.cloud)
`port`	number	是	ClickHouse HTTP interface port (8443 for HTTPS, 8123 for HTTP)
`database`	string	是	Database name to connect to
`username`	string	是	ClickHouse username
`password`	string	否	ClickHouse password
`secure`	boolean	否	Use a secure HTTPS connection (default: true)
`table`	string	是	Table name to update data in
`data`	object	是	Data object with fields to update (key-value pairs)
`where`	string	是	WHERE clause condition (without the WHERE keyword)

输出

参数	类型	描述
`message`	string	Operation status message
`rows`	array	Updated rows (empty for ClickHouse mutations)
`rowCount`	number	Number of rows written by the mutation

`clickhouse_delete`

Delete rows from a ClickHouse table via an ALTER TABLE ... DELETE mutation

输入

参数	类型	必填	描述
`host`	string	是	ClickHouse server hostname (e.g., your-instance.clickhouse.cloud)
`port`	number	是	ClickHouse HTTP interface port (8443 for HTTPS, 8123 for HTTP)
`database`	string	是	Database name to connect to
`username`	string	是	ClickHouse username
`password`	string	否	ClickHouse password
`secure`	boolean	否	Use a secure HTTPS connection (default: true)
`table`	string	是	Table name to delete data from
`where`	string	是	WHERE clause condition (without the WHERE keyword)

输出

参数	类型	描述
`message`	string	Operation status message
`rows`	array	Deleted rows (empty for ClickHouse mutations)
`rowCount`	number	Number of rows affected by the mutation

`clickhouse_list_databases`

输入

参数	类型	必填	描述

输出

参数	类型	描述
`message`	string	Success or error message describing the operation outcome
`rows`	array	Array of rows returned from the operation
`rowCount`	number	Number of rows returned or affected by the operation
`count`	number	Row count (count rows operation)
`ddl`	string	CREATE TABLE statement (show create table operation)
`tables`	array	Array of table schemas with columns and engines (introspect operation)

`clickhouse_list_tables`

输入

参数	类型	必填	描述

输出

参数	类型	描述
`message`	string	Success or error message describing the operation outcome
`rows`	array	Array of rows returned from the operation
`rowCount`	number	Number of rows returned or affected by the operation
`count`	number	Row count (count rows operation)
`ddl`	string	CREATE TABLE statement (show create table operation)
`tables`	array	Array of table schemas with columns and engines (introspect operation)

`clickhouse_describe_table`

输入

参数	类型	必填	描述

输出

参数	类型	描述
`message`	string	Success or error message describing the operation outcome
`rows`	array	Array of rows returned from the operation
`rowCount`	number	Number of rows returned or affected by the operation
`count`	number	Row count (count rows operation)
`ddl`	string	CREATE TABLE statement (show create table operation)
`tables`	array	Array of table schemas with columns and engines (introspect operation)

`clickhouse_show_create_table`

输入

参数	类型	必填	描述

输出

参数	类型	描述
`message`	string	Success or error message describing the operation outcome
`rows`	array	Array of rows returned from the operation
`rowCount`	number	Number of rows returned or affected by the operation
`count`	number	Row count (count rows operation)
`ddl`	string	CREATE TABLE statement (show create table operation)
`tables`	array	Array of table schemas with columns and engines (introspect operation)

`clickhouse_count_rows`

输入

参数	类型	必填	描述

输出

参数	类型	描述
`message`	string	Success or error message describing the operation outcome
`rows`	array	Array of rows returned from the operation
`rowCount`	number	Number of rows returned or affected by the operation
`count`	number	Row count (count rows operation)
`ddl`	string	CREATE TABLE statement (show create table operation)
`tables`	array	Array of table schemas with columns and engines (introspect operation)

`clickhouse_introspect`

Introspect a ClickHouse database to retrieve table structures, columns, and engines

输入

参数	类型	必填	描述
`host`	string	是	ClickHouse server hostname (e.g., your-instance.clickhouse.cloud)
`port`	number	是	ClickHouse HTTP interface port (8443 for HTTPS, 8123 for HTTP)
`database`	string	是	Database name to introspect
`username`	string	是	ClickHouse username
`password`	string	否	ClickHouse password
`secure`	boolean	否	Use a secure HTTPS connection (default: true)

输出

参数	类型	描述
`message`	string	Operation status message
`tables`	array	Array of table schemas with columns and engines
↳ `name`	string	Table name
↳ `database`	string	Database the table belongs to
↳ `engine`	string	Table engine (e.g., MergeTree, Log)
↳ `totalRows`	number	Approximate total number of rows in the table
↳ `columns`	array	Table columns
↳ `name`	string	Column name
↳ `type`	string	ClickHouse data type (e.g., UInt32, String, DateTime)
↳ `defaultKind`	string	Kind of default expression (DEFAULT, MATERIALIZED, ALIAS)
↳ `defaultExpression`	string	Default value expression for the column
↳ `isInPrimaryKey`	boolean	Whether the column is part of the primary key
↳ `isInSortingKey`	boolean	Whether the column is part of the sorting key

`clickhouse_create_database`

输入

参数	类型	必填	描述

输出

参数	类型	描述
`message`	string	Success or error message describing the operation outcome
`rows`	array	Array of rows returned from the operation
`rowCount`	number	Number of rows returned or affected by the operation
`count`	number	Row count (count rows operation)
`ddl`	string	CREATE TABLE statement (show create table operation)
`tables`	array	Array of table schemas with columns and engines (introspect operation)

`clickhouse_drop_database`

输入

参数	类型	必填	描述

输出

参数	类型	描述
`message`	string	Success or error message describing the operation outcome
`rows`	array	Array of rows returned from the operation
`rowCount`	number	Number of rows returned or affected by the operation
`count`	number	Row count (count rows operation)
`ddl`	string	CREATE TABLE statement (show create table operation)
`tables`	array	Array of table schemas with columns and engines (introspect operation)

`clickhouse_create_table`

输入

参数	类型	必填	描述

输出

参数	类型	描述
`message`	string	Success or error message describing the operation outcome
`rows`	array	Array of rows returned from the operation
`rowCount`	number	Number of rows returned or affected by the operation
`count`	number	Row count (count rows operation)
`ddl`	string	CREATE TABLE statement (show create table operation)
`tables`	array	Array of table schemas with columns and engines (introspect operation)

`clickhouse_drop_table`

输入

参数	类型	必填	描述

输出

参数	类型	描述
`message`	string	Success or error message describing the operation outcome
`rows`	array	Array of rows returned from the operation
`rowCount`	number	Number of rows returned or affected by the operation
`count`	number	Row count (count rows operation)
`ddl`	string	CREATE TABLE statement (show create table operation)
`tables`	array	Array of table schemas with columns and engines (introspect operation)

`clickhouse_truncate_table`

输入

参数	类型	必填	描述

输出

参数	类型	描述
`message`	string	Success or error message describing the operation outcome
`rows`	array	Array of rows returned from the operation
`rowCount`	number	Number of rows returned or affected by the operation
`count`	number	Row count (count rows operation)
`ddl`	string	CREATE TABLE statement (show create table operation)
`tables`	array	Array of table schemas with columns and engines (introspect operation)

`clickhouse_rename_table`

输入

参数	类型	必填	描述

输出

参数	类型	描述
`message`	string	Success or error message describing the operation outcome
`rows`	array	Array of rows returned from the operation
`rowCount`	number	Number of rows returned or affected by the operation
`count`	number	Row count (count rows operation)
`ddl`	string	CREATE TABLE statement (show create table operation)
`tables`	array	Array of table schemas with columns and engines (introspect operation)

`clickhouse_optimize_table`

输入

参数	类型	必填	描述

输出

参数	类型	描述
`message`	string	Success or error message describing the operation outcome
`rows`	array	Array of rows returned from the operation
`rowCount`	number	Number of rows returned or affected by the operation
`count`	number	Row count (count rows operation)
`ddl`	string	CREATE TABLE statement (show create table operation)
`tables`	array	Array of table schemas with columns and engines (introspect operation)

`clickhouse_list_partitions`

输入

参数	类型	必填	描述

输出

参数	类型	描述
`message`	string	Success or error message describing the operation outcome
`rows`	array	Array of rows returned from the operation
`rowCount`	number	Number of rows returned or affected by the operation
`count`	number	Row count (count rows operation)
`ddl`	string	CREATE TABLE statement (show create table operation)
`tables`	array	Array of table schemas with columns and engines (introspect operation)

`clickhouse_drop_partition`

输入

参数	类型	必填	描述

输出

参数	类型	描述
`message`	string	Success or error message describing the operation outcome
`rows`	array	Array of rows returned from the operation
`rowCount`	number	Number of rows returned or affected by the operation
`count`	number	Row count (count rows operation)
`ddl`	string	CREATE TABLE statement (show create table operation)
`tables`	array	Array of table schemas with columns and engines (introspect operation)

`clickhouse_list_mutations`

输入

参数	类型	必填	描述

输出

参数	类型	描述
`message`	string	Success or error message describing the operation outcome
`rows`	array	Array of rows returned from the operation
`rowCount`	number	Number of rows returned or affected by the operation
`count`	number	Row count (count rows operation)
`ddl`	string	CREATE TABLE statement (show create table operation)
`tables`	array	Array of table schemas with columns and engines (introspect operation)

`clickhouse_list_running_queries`

输入

参数	类型	必填	描述

输出

参数	类型	描述
`message`	string	Success or error message describing the operation outcome
`rows`	array	Array of rows returned from the operation
`rowCount`	number	Number of rows returned or affected by the operation
`count`	number	Row count (count rows operation)
`ddl`	string	CREATE TABLE statement (show create table operation)
`tables`	array	Array of table schemas with columns and engines (introspect operation)

`clickhouse_kill_query`

输入

参数	类型	必填	描述

输出

参数	类型	描述
`message`	string	Success or error message describing the operation outcome
`rows`	array	Array of rows returned from the operation
`rowCount`	number	Number of rows returned or affected by the operation
`count`	number	Row count (count rows operation)
`ddl`	string	CREATE TABLE statement (show create table operation)
`tables`	array	Array of table schemas with columns and engines (introspect operation)

`clickhouse_table_stats`

输入

参数	类型	必填	描述

输出

参数	类型	描述
`message`	string	Success or error message describing the operation outcome
`rows`	array	Array of rows returned from the operation
`rowCount`	number	Number of rows returned or affected by the operation
`count`	number	Row count (count rows operation)
`ddl`	string	CREATE TABLE statement (show create table operation)
`tables`	array	Array of table schemas with columns and engines (introspect operation)

`clickhouse_list_clusters`

输入

参数	类型	必填	描述

输出

参数	类型	描述
`message`	string	Success or error message describing the operation outcome
`rows`	array	Array of rows returned from the operation
`rowCount`	number	Number of rows returned or affected by the operation
`count`	number	Row count (count rows operation)
`ddl`	string	CREATE TABLE statement (show create table operation)
`tables`	array	Array of table schemas with columns and engines (introspect operation)

On this page

clickhouse_query

clickhouse_execute

clickhouse_insert

clickhouse_insert_rows

clickhouse_update

clickhouse_delete

clickhouse_list_databases

clickhouse_list_tables

clickhouse_describe_table

clickhouse_show_create_table

clickhouse_count_rows

clickhouse_introspect

clickhouse_create_database

clickhouse_drop_database

clickhouse_create_table

clickhouse_drop_table

clickhouse_truncate_table

clickhouse_rename_table

clickhouse_optimize_table

clickhouse_list_partitions

clickhouse_drop_partition

clickhouse_list_mutations

clickhouse_list_running_queries

clickhouse_kill_query

clickhouse_table_stats

clickhouse_list_clusters