NAiOS IconNAiOS Logo
Volver al catálogo

ClickHouse

clickhouse

ClickHouse is a fast open-source column-oriented database management system for real-time analytics and big data processing with SQL support

Acciones
5
Triggers
0
Autenticación
OAuth gestionado
No
Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (5)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Execute ClickHouse QueryCLICKHOUSE_EXECUTE_QUERYAcción

Execute a sql query in clickhouse and return the results. this is the primary action for querying data from clickhouse databases.

Parámetros de entrada

  • querystringObligatorio

    The SQL query to execute in ClickHouse

  • formatstring

    Output format for the query results. Common formats: JSONEachRow, JSON, CSV, TSV

  • databasestring

    Database to use for the query (overrides connection default)

  • settingsobject

    Additional ClickHouse settings for the query execution

  • max_execution_timeinteger

    Maximum query execution time in seconds

Parámetros de salida

  • dataobject[]Obligatorio

    Query results as a list of dictionaries (for JSONEachRow format)

  • rowsintegerObligatorio

    Number of rows returned

  • errorstring

    Error if any occurred during the execution of the action

  • statisticsobject

    Query execution statistics if available

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Database SchemaCLICKHOUSE_GET_DATABASE_SCHEMAAcción

Get comprehensive schema overview of an entire database including all tables and optionally their column definitions. essential for ai agents to understand the complete database structure in a single call.

Parámetros de entrada

  • databasestring

    Database name (overrides connection default). If not specified, uses connection default or 'default'

  • include_table_schemasboolean

    Whether to include full column schemas for all tables. Set to false for quick overview, true for complete schema details.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Table SchemaCLICKHOUSE_GET_TABLE_SCHEMAAcción

Get detailed schema information for a specific table including column definitions, types, keys, and optionally sample data. this is essential for ai agents to understand table structure before constructing queries.

Parámetros de entrada

  • databasestring

    Database name (overrides connection default)

  • table_namestringObligatorio

    Name of the table to describe

  • sample_rowsinteger

    Number of sample rows to return (only if include_sample_data is true)

  • include_sample_databoolean

    Whether to include sample rows from the table

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List ClickHouse DatabasesCLICKHOUSE_LIST_DATABASESAcción

List all databases in the clickhouse instance. useful for discovering available databases before querying tables.

Parámetros de entrada

  • patternstring

    Optional LIKE pattern to filter databases (e.g., 'prod_%' or '%test')

  • include_tablesboolean

    Whether to include list of table names for each database

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List ClickHouse TablesCLICKHOUSE_LIST_TABLESAcción

List tables in clickhouse databases. returns information about tables including their engine, size, and row count.

Parámetros de entrada

  • patternstring

    Optional LIKE pattern to filter table names (e.g., 'user_%' or '%_log')

  • databasestring

    Database name to list tables from. If not provided, lists tables from all databases

  • include_viewsboolean

    Whether to include views in the results

  • include_columnsboolean

    Whether to include column names for each table

  • include_primary_keyboolean

    Whether to include primary key information for each table

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not