mirror of https://github.com/googleapis/genai-toolbox.git synced 2026-01-09 15:38:08 -05:00

Files

gRedHeadphone 5a6db196c2 docs: update spanner available tools (#1837 )

## Description

Spanner source page in docs was missing spanner-list-tables tool.

## PR Checklist

- [x] Make sure you reviewed

[CONTRIBUTING.md](https://github.com/googleapis/genai-toolbox/blob/main/CONTRIBUTING.md)
- [x] Make sure to open an issue as a

[bug/issue](https://github.com/googleapis/genai-toolbox/issues/new/choose)
  before writing your code! That way we can discuss the change, evaluate
  designs, and agree on the general idea
- [x] Ensure the tests and linter pass
- [x] Code coverage does not decrease (if any source code was changed)
- [x] Appropriate docs were updated (if necessary)
- [x] Make sure to add `!` if this involve a breaking change

🛠️ Fixes #1836

Co-authored-by: Averi Kitsch <akitsch@google.com>

2025-11-03 18:47:58 +00:00

3.5 KiB

Raw Blame History

title, type, weight, description

title	type	weight	description
Spanner	docs	1	Spanner is a fully managed database service from Google Cloud that combines relational, key-value, graph, and search capabilities.

Spanner Source

Spanner 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.

Available Tools

spanner-sql
Execute SQL on Google Cloud Spanner.
spanner-execute-sql
Run structured and parameterized queries on Spanner.
spanner-list-tables
Retrieve schema information about tables in a Spanner database.

Pre-built Configurations

Spanner using MCP
Connect your IDE to Spanner using Toolbox.

Requirements

IAM Permissions

Spanner uses Identity and Access Management (IAM) 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) to authorize and authenticate when interacting with Spanner.

In addition to setting the ADC for your server, you need to ensure the IAM identity has been given the correct IAM permissions for the query provided. See Apply IAM roles for more information on applying IAM permissions and roles to an identity.

Example

sources:
    my-spanner-source:
        kind: "spanner"
        project: "my-project-id"
        instance: "my-instance"
        database: "my_db"
        # dialect: "googlesql"

Reference

field	type	required	description
kind	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`.

3.5 KiB Raw Blame History