mirror of
https://github.com/googleapis/genai-toolbox.git
synced 2026-05-02 03:00:36 -04:00
293c1d6889
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>
85 lines
3.6 KiB
Markdown
85 lines
3.6 KiB
Markdown
---
|
|
title: "Spanner"
|
|
type: docs
|
|
weight: 1
|
|
description: >
|
|
Spanner is a fully managed database service from Google Cloud that combines
|
|
relational, key-value, graph, and search capabilities.
|
|
|
|
---
|
|
|
|
# Spanner Source
|
|
|
|
[Spanner][spanner-docs] is a fully managed, mission-critical database service
|
|
that brings together relational, graph, key-value, and search. It offers
|
|
transactional consistency at global scale, automatic, synchronous replication
|
|
for high availability, and support for two SQL dialects: GoogleSQL (ANSI 2011
|
|
with extensions) and PostgreSQL.
|
|
|
|
If you are new to Spanner, you can try to [create and query a database using
|
|
the Google Cloud console][spanner-quickstart].
|
|
|
|
[spanner-docs]: https://cloud.google.com/spanner/docs
|
|
[spanner-quickstart]:
|
|
https://cloud.google.com/spanner/docs/create-query-database-console
|
|
|
|
## Available Tools
|
|
|
|
- [`spanner-sql`](../tools/spanner/spanner-sql.md)
|
|
Execute SQL on Google Cloud Spanner.
|
|
|
|
- [`spanner-execute-sql`](../tools/spanner/spanner-execute-sql.md)
|
|
Run structured and parameterized queries on Spanner.
|
|
|
|
- [`spanner-list-tables`](../tools/spanner/spanner-list-tables.md)
|
|
Retrieve schema information about tables in a Spanner database.
|
|
|
|
- [`spanner-list-graphs`](../tools/spanner/spanner-list-graphs.md)
|
|
Retrieve schema information about graphs in a Spanner database.
|
|
|
|
### Pre-built Configurations
|
|
|
|
- [Spanner using MCP](https://googleapis.github.io/genai-toolbox/how-to/connect-ide/spanner_mcp/)
|
|
Connect your IDE to Spanner using Toolbox.
|
|
|
|
## Requirements
|
|
|
|
### IAM Permissions
|
|
|
|
Spanner uses [Identity and Access Management (IAM)][iam-overview] to control
|
|
user and group access to Spanner resources at the project, Spanner instance, and
|
|
Spanner database levels. Toolbox will use your [Application Default Credentials
|
|
(ADC)][adc] to authorize and authenticate when interacting with Spanner.
|
|
|
|
In addition to [setting the ADC for your server][set-adc], you need to ensure
|
|
the IAM identity has been given the correct IAM permissions for the query
|
|
provided. See [Apply IAM roles][grant-permissions] for more information on
|
|
applying IAM permissions and roles to an identity.
|
|
|
|
[iam-overview]: https://cloud.google.com/spanner/docs/iam
|
|
[adc]: https://cloud.google.com/docs/authentication#adc
|
|
[set-adc]: https://cloud.google.com/docs/authentication/provide-credentials-adc
|
|
[grant-permissions]: https://cloud.google.com/spanner/docs/grant-permissions
|
|
|
|
## Example
|
|
|
|
```yaml
|
|
kind: sources
|
|
name: my-spanner-source
|
|
type: "spanner"
|
|
project: "my-project-id"
|
|
instance: "my-instance"
|
|
database: "my_db"
|
|
# dialect: "googlesql"
|
|
```
|
|
|
|
## Reference
|
|
|
|
| **field** | **type** | **required** | **description** |
|
|
|-----------|:--------:|:------------:|---------------------------------------------------------------------------------------------------------------------|
|
|
| type | string | true | Must be "spanner". |
|
|
| project | string | true | Id of the GCP project that the cluster was created in (e.g. "my-project-id"). |
|
|
| instance | string | true | Name of the Spanner instance. |
|
|
| database | string | true | Name of the database on the Spanner instance |
|
|
| dialect | string | false | Name of the dialect type of the Spanner database, must be either `googlesql` or `postgresql`. Default: `googlesql`. |
|