genai-toolbox/docs/en/resources/sources/tidb.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
TiDB	docs	1	TiDB is a distributed SQL database that combines the best of traditional RDBMS and NoSQL databases.

About

TiDB is an open-source distributed SQL database that supports Hybrid Transactional and Analytical Processing (HTAP) workloads. It is MySQL-compatible and features horizontal scalability, strong consistency, and high availability.

Requirements

Database User

This source uses standard MySQL protocol authentication. You will need to create a TiDB user to login to the database with.

For TiDB Cloud users, you can create database users through the TiDB Cloud console.

SSL Configuration

TiDB Cloud

For TiDB Cloud instances, SSL is automatically enabled when the hostname matches the TiDB Cloud pattern (gateway*.*.*.tidbcloud.com). You don't need to explicitly set ssl: true for TiDB Cloud connections.
Self-Hosted TiDB

For self-hosted TiDB instances, you can optionally enable SSL by setting ssl: true in your configuration.

Example

TiDB Cloud

kind: sources
name: my-tidb-cloud-source
type: tidb
host: gateway01.us-west-2.prod.aws.tidbcloud.com
port: 4000
database: my_db
user: ${TIDB_USERNAME}
password: ${TIDB_PASSWORD}
# SSL is automatically enabled for TiDB Cloud

Self-Hosted TiDB

kind: sources
name: my-tidb-source
type: tidb
host: 127.0.0.1
port: 4000
database: my_db
user: ${TIDB_USERNAME}
password: ${TIDB_PASSWORD}
# ssl: true  # Optional: enable SSL for secure connections

{{< 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 "tidb".
host	string	true	IP address or hostname to connect to (e.g. "127.0.0.1" or "gateway01.*.tidbcloud.com").
port	string	true	Port to connect to (typically "4000" for TiDB).
database	string	true	Name of the TiDB database to connect to (e.g. "my_db").
user	string	true	Name of the TiDB user to connect as (e.g. "my-tidb-user").
password	string	true	Password of the TiDB user (e.g. "my-password").
ssl	boolean	false	Whether to use SSL/TLS encryption. Automatically enabled for TiDB Cloud instances.

3.1 KiB Raw Blame History