genai-toolbox/docs/en/resources/sources/clickhouse.md at d013badbdace895d9cbb5572b85d3fffa8917187

mirror of https://github.com/googleapis/genai-toolbox.git synced 2026-04-09 03:02:26 -04:00

Files

Yuan Teoh 293c1d6889 feat!: update configuration file v2 (#2369 )

This PR introduces a significant update to the Toolbox configuration
file format, which is one of the primary **breaking changes** required
for the implementation of the Advanced Control Plane.

# Summary of Changes
The configuration schema has been updated to enforce resource isolation
and facilitate atomic, incremental updates.
* Resource Isolation: Resource definitions are now separated into
individual blocks, using a distinct structure for each resource type
(Source, Tool, Toolset, etc.). This improves readability, management,
and auditing of configuration files.
* Field Name Modification: Internal field names have been modified to
align with declarative methodologies. Specifically, the configuration
now separates kind (general resource type, e.g., Source) from type
(specific implementation, e.g., Postgres).

# User Impact
Existing tools.yaml configuration files are now in an outdated format.
Users must eventually update their files to the new YAML format.

# Mitigation & Compatibility
Backward compatibility is maintained during this transition to ensure no
immediate user action is required for existing files.
* Immediate Backward Compatibility: The source code includes a
pre-processing layer that automatically detects outdated configuration
files (v1 format) and converts them to the new v2 format under the hood.
* [COMING SOON] Migration Support: The new toolbox migrate subcommand
will be introduced to allow users to automatically convert their old
configuration files to the latest format.

# Example
Example for config file v2:
```
kind: sources
name: my-pg-instance
type: cloud-sql-postgres
project: my-project
region: my-region
instance: my-instance
database: my_db
user: my_user
password: my_pass
---
kind: authServices
name: my-google-auth
type: google
clientId: testing-id
---
kind: tools
name: example_tool
type: postgres-sql
source: my-pg-instance
description: some description
statement: SELECT * FROM SQL_STATEMENT;
parameters:
- name: country
  type: string
  description: some description
---
kind: tools
name: example_tool_2
type: postgres-sql
source: my-pg-instance
description: returning the number one
statement: SELECT 1;
---
kind: toolsets
name: example_toolset
tools:
- example_tool
```

---------

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: Averi Kitsch <akitsch@google.com>

2026-01-27 16:58:43 -08:00

3.1 KiB

Raw Blame History

title, type, weight, description

title	type	weight	description
ClickHouse	docs	1	ClickHouse is an open-source, OLTP database.

About

ClickHouse is a fast, open-source, column-oriented database

Available Tools

clickhouse-execute-sql
Execute parameterized SQL queries in ClickHouse with query logging.
clickhouse-sql
Execute SQL queries as prepared statements in ClickHouse.

Requirements

Database User

This source uses standard ClickHouse authentication. You will need to create a ClickHouse user (or with ClickHouse Cloud) to connect to the database with. The user should have appropriate permissions for the operations you plan to perform.

Network Access

ClickHouse supports multiple protocols:

HTTPS protocol (default port 8443) - Secure HTTP access (default)
HTTP protocol (default port 8123) - Good for web-based access

Example

Secure Connection Example

kind: sources
name: secure-clickhouse-source
type: clickhouse
host: clickhouse.example.com
port: "8443"
database: analytics
user: ${CLICKHOUSE_USER}
password: ${CLICKHOUSE_PASSWORD}
protocol: https
secure: true

HTTP Protocol Example

kind: sources
name: http-clickhouse-source
type: clickhouse
host: localhost
port: "8123"
database: logs
user: ${CLICKHOUSE_USER}
password: ${CLICKHOUSE_PASSWORD}
protocol: http
secure: false

{{< notice tip >}} Use environment variable replacement with the format ${ENV_NAME} instead of hardcoding your secrets into the configuration file. {{< /notice >}}

Reference

field	type	required	description
type	string	true	Must be "clickhouse".
host	string	true	IP address or hostname to connect to (e.g. "127.0.0.1" or "clickhouse.example.com")
port	string	true	Port to connect to (e.g. "8443" for HTTPS, "8123" for HTTP)
database	string	true	Name of the ClickHouse database to connect to (e.g. "my_database").
user	string	true	Name of the ClickHouse user to connect as (e.g. "analytics_user").
password	string	false	Password of the ClickHouse user (e.g. "my-password").
protocol	string	false	Connection protocol: "https" (default) or "http".
secure	boolean	false	Whether to use a secure connection (TLS). Default: false.

3.1 KiB Raw Blame History