mirror of https://github.com/googleapis/genai-toolbox.git synced 2026-02-12 08:05:06 -05:00

Files

Wenxin Du 8ca7e91240 docs: Add auth source docs (#132 )

Add authsources and authenticated parameter docs. Format some other .md
docs.

---------

Co-authored-by: Kurtis Van Gent <31518063+kurtisvg@users.noreply.github.com>

2024-12-17 13:49:43 -05:00

alloydb-pg.md

docs: Add auth source docs (#132 )

2024-12-17 13:49:43 -05:00

cloud-sql-pg.md

docs: Add auth source docs (#132 )

2024-12-17 13:49:43 -05:00

postgres.md

docs: add detailed documentation for sources (#37 )

2024-10-31 20:25:12 +00:00

README.md

docs: Add auth source docs (#132 )

2024-12-17 13:49:43 -05:00

spanner.md

docs(spanner): add docs (#128 )

2024-12-16 11:03:14 -08:00

README.md

Sources

A Source represents a data sources that a tool can interact with. You can define Sources as a map in the sources section of your tools.yaml file. Typically, a source configuration will contain any information needed to connect with and interact with the database.

sources:
    my-cloud-sql-source:
        kind: cloud-sql-postgres
        project: my-project-name
        region: us-central1
        instance: my-instance-name
        database: my_db
        user: my-user
        password: my-password

In implementation, each source is a different connection pool or client that used to connect to the database and execute the tool.

Kinds of Sources

We currently support the following types of kinds of sources:

alloydb-postgres - Connect to an AlloyDB for PostgreSQL cluster.
cloud-sql-postgres - Connect to a Cloud SQL for PostgreSQL instance.
postgres - Connect to any PostgreSQL compatible database.
spanner - Connect to a Spanner database.