Back to Genai Toolbox

cloud-sql-list-databases

docs/en/integrations/cloud-sql-admin/tools/cloudsqllistdatabases.md

1.1.01.4 KB
Original Source

About

The cloud-sql-list-databases tool lists all Cloud SQL databases in a specified Google Cloud project and instance.

Compatible Sources

{{< compatible-sources >}}

Parameters

The cloud-sql-list-databases tool has two required parameters:

fieldtyperequireddescription
projectstringtrueThe Google Cloud project ID.
instancestringtrueThe Cloud SQL instance ID.

Example

Here is an example of how to configure the cloud-sql-list-databases tool in your tools.yaml file:

yaml
kind: source
name: my-cloud-sql-admin-source
type: cloud-sql-admin
---
kind: tool
name: list_my_databases
type: cloud-sql-list-databases
source: my-cloud-sql-admin-source
description: Use this tool to list all Cloud SQL databases in an instance.

Reference

fieldtyperequireddescription
typestringtrueMust be "cloud-sql-list-databases".
sourcestringtrueThe name of the cloud-sql-admin source to use for this tool.
descriptionstringfalseDescription of the tool that is passed to the agent.