ClickHouse

tools

• get_clickpipe

  Returns the specified ClickPipe.

  in ▸ serviceId clickPipeId organizationId

• get_organization_cost

  Retrieves billing and usage cost data for a ClickHouse Cloud organization. Returns a grand total and a list of daily, per-entity organization usage cost records for the organization in the queried time period (maximum 31 days).

  in ▸ to_date from_date organizationId

• get_organization_details

  Returns details of a single organization. The auth key must belong to the organization.

  in ▸ organizationId

• get_organizations

  Retrieves all accessible ClickHouse Cloud organizations.

• get_service_backup_configuration

  Returns the service backup configuration.

  in ▸ serviceId organizationId

• get_service_backup_details

  Returns a single backup info.

  in ▸ backupId serviceId organizationId

• get_service_details

  Returns a service that belongs to the organization.

  in ▸ serviceId organizationId

• get_services_list

  Retrieves all services in a ClickHouse Cloud organization.

  in ▸ organizationId

• list_clickpipes

  Retrieves all ClickPipes configured for a specific service.

  in ▸ serviceId organizationId

• list_databases

  Retrieves all databases available in a ClickHouse service.

  in ▸ serviceId

• list_service_backups

  Returns a list of all backups for the service. The most recent backups comes first in the list.

  in ▸ serviceId organizationId

• list_tables

  Retrieves a comprehensive list of tables in a ClickHouse database, including columns.

  in ▸ like notLike database serviceId

• run_select_query

  Executes a SELECT query against a ClickHouse service. Runs a read-only SELECT query on the specified ClickHouse service via the Query API endpoint. This function provides direct access to database content through SQL queries while ensuring that only read operations are permitted.

  in ▸ query serviceId timeoutSeconds