ClickHouse

Connect to a ClickHouse database

Nutzungsanweisungen

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.

Tools

`clickhouse_query`

Execute a SELECT query on a ClickHouse database

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`host`	string	Ja	ClickHouse server hostname (e.g., your-instance.clickhouse.cloud)
`port`	number	Ja	ClickHouse HTTP interface port (8443 for HTTPS, 8123 for HTTP)
`database`	string	Ja	Database name to connect to
`username`	string	Ja	ClickHouse username
`password`	string	Nein	ClickHouse password
`secure`	boolean	Nein	Use a secure HTTPS connection (default: true)
`query`	string	Ja	SQL SELECT query to execute

Ausgabe

Parameter	Typ	Beschreibung
`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

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`host`	string	Ja	ClickHouse server hostname (e.g., your-instance.clickhouse.cloud)
`port`	number	Ja	ClickHouse HTTP interface port (8443 for HTTPS, 8123 for HTTP)
`database`	string	Ja	Database name to connect to
`username`	string	Ja	ClickHouse username
`password`	string	Nein	ClickHouse password
`secure`	boolean	Nein	Use a secure HTTPS connection (default: true)
`query`	string	Ja	Raw SQL statement to execute

Ausgabe

Parameter	Typ	Beschreibung
`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

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`host`	string	Ja	ClickHouse server hostname (e.g., your-instance.clickhouse.cloud)
`port`	number	Ja	ClickHouse HTTP interface port (8443 for HTTPS, 8123 for HTTP)
`database`	string	Ja	Database name to connect to
`username`	string	Ja	ClickHouse username
`password`	string	Nein	ClickHouse password
`secure`	boolean	Nein	Use a secure HTTPS connection (default: true)
`table`	string	Ja	Table name to insert data into
`data`	object	Ja	Data object to insert (key-value pairs mapping column names to values)

Ausgabe

Parameter	Typ	Beschreibung
`message`	string	Operation status message
`rows`	array	Inserted rows (empty for ClickHouse inserts)
`rowCount`	number	Number of rows inserted

`clickhouse_insert_rows`

Eingabe

Parameter	Typ	Erforderlich	Beschreibung

Ausgabe

Parameter	Typ	Beschreibung
`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

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`host`	string	Ja	ClickHouse server hostname (e.g., your-instance.clickhouse.cloud)
`port`	number	Ja	ClickHouse HTTP interface port (8443 for HTTPS, 8123 for HTTP)
`database`	string	Ja	Database name to connect to
`username`	string	Ja	ClickHouse username
`password`	string	Nein	ClickHouse password
`secure`	boolean	Nein	Use a secure HTTPS connection (default: true)
`table`	string	Ja	Table name to update data in
`data`	object	Ja	Data object with fields to update (key-value pairs)
`where`	string	Ja	WHERE clause condition (without the WHERE keyword)

Ausgabe

Parameter	Typ	Beschreibung
`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

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`host`	string	Ja	ClickHouse server hostname (e.g., your-instance.clickhouse.cloud)
`port`	number	Ja	ClickHouse HTTP interface port (8443 for HTTPS, 8123 for HTTP)
`database`	string	Ja	Database name to connect to
`username`	string	Ja	ClickHouse username
`password`	string	Nein	ClickHouse password
`secure`	boolean	Nein	Use a secure HTTPS connection (default: true)
`table`	string	Ja	Table name to delete data from
`where`	string	Ja	WHERE clause condition (without the WHERE keyword)

Ausgabe

Parameter	Typ	Beschreibung
`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`

Eingabe

Parameter	Typ	Erforderlich	Beschreibung

Ausgabe

Parameter	Typ	Beschreibung
`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`

Eingabe

Parameter	Typ	Erforderlich	Beschreibung

Ausgabe

Parameter	Typ	Beschreibung
`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`

Eingabe

Parameter	Typ	Erforderlich	Beschreibung

Ausgabe

Parameter	Typ	Beschreibung
`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`

Eingabe

Parameter	Typ	Erforderlich	Beschreibung

Ausgabe

Parameter	Typ	Beschreibung
`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`

Eingabe

Parameter	Typ	Erforderlich	Beschreibung

Ausgabe

Parameter	Typ	Beschreibung
`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

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`host`	string	Ja	ClickHouse server hostname (e.g., your-instance.clickhouse.cloud)
`port`	number	Ja	ClickHouse HTTP interface port (8443 for HTTPS, 8123 for HTTP)
`database`	string	Ja	Database name to introspect
`username`	string	Ja	ClickHouse username
`password`	string	Nein	ClickHouse password
`secure`	boolean	Nein	Use a secure HTTPS connection (default: true)

Ausgabe

Parameter	Typ	Beschreibung
`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`

Eingabe

Parameter	Typ	Erforderlich	Beschreibung

Ausgabe

Parameter	Typ	Beschreibung
`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`

Eingabe

Parameter	Typ	Erforderlich	Beschreibung

Ausgabe

Parameter	Typ	Beschreibung
`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`

Eingabe

Parameter	Typ	Erforderlich	Beschreibung

Ausgabe

Parameter	Typ	Beschreibung
`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`

Eingabe

Parameter	Typ	Erforderlich	Beschreibung

Ausgabe

Parameter	Typ	Beschreibung
`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`

Eingabe

Parameter	Typ	Erforderlich	Beschreibung

Ausgabe

Parameter	Typ	Beschreibung
`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`

Eingabe

Parameter	Typ	Erforderlich	Beschreibung

Ausgabe

Parameter	Typ	Beschreibung
`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`

Eingabe

Parameter	Typ	Erforderlich	Beschreibung

Ausgabe

Parameter	Typ	Beschreibung
`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`

Eingabe

Parameter	Typ	Erforderlich	Beschreibung

Ausgabe

Parameter	Typ	Beschreibung
`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`

Eingabe

Parameter	Typ	Erforderlich	Beschreibung

Ausgabe

Parameter	Typ	Beschreibung
`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`

Eingabe

Parameter	Typ	Erforderlich	Beschreibung

Ausgabe

Parameter	Typ	Beschreibung
`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`

Eingabe

Parameter	Typ	Erforderlich	Beschreibung

Ausgabe

Parameter	Typ	Beschreibung
`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`

Eingabe

Parameter	Typ	Erforderlich	Beschreibung

Ausgabe

Parameter	Typ	Beschreibung
`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`

Eingabe

Parameter	Typ	Erforderlich	Beschreibung

Ausgabe

Parameter	Typ	Beschreibung
`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`

Eingabe

Parameter	Typ	Erforderlich	Beschreibung

Ausgabe

Parameter	Typ	Beschreibung
`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

Nutzungsanweisungen

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