Repository files navigation

This Gemini CLI extension provides a set of tools to interact withCloud SQL for PostgreSQL instances. It allows you to manage your databases, execute queries, explore schemas, and troubleshoot issues directly from theGemini CLI, using natural language prompts.

Learn more aboutGemini CLI Extensions.

• Seamless Workflow: As a Google-developed extension, it integrates seamlessly into the Gemini CLI environment. No need to constantly switch contexts for common database tasks.
• Natural Language Queries: Stop wrestling with complex commands. Explore schemas and query data by describing what you want in plain English.
• Full Lifecycle Control: Manage the entire lifecycle of your database, from creating instances to exploring schemas and running queries.
• Code Generation: Accelerate development by asking Gemini to generate data classes and other code snippets based on your table schemas.

Before you begin, ensure you have the following:

• Gemini CLI installed with version+v0.6.0.
• Setup Gemini CLIAuthentication.
• A Google Cloud project with theCloud SQL Admin API enabled.
• EnsureApplication Default Credentials are available in your environment.
• IAM Permissions:
  • Cloud SQL Client (roles/cloudsql.client)
  • Cloud SQL Admin (roles/cloudsql.admin)

To install the extension, use the command:

gemini extensions install https://github.com/gemini-cli-extensions/cloud-sql-postgresql

Set the following environment variables before starting the Gemini CLI. These variables can be loaded from a.env file.This configuration is not required if utilizing theAdmin toolset.

export CLOUD_SQL_POSTGRES_PROJECT="<your-gcp-project-id>"export CLOUD_SQL_POSTGRES_REGION="<your-cloud-sql-region>"export CLOUD_SQL_POSTGRES_INSTANCE="<your-cloud-sql-instance-id>"export CLOUD_SQL_POSTGRES_DATABASE="<your-database-name>"export CLOUD_SQL_POSTGRES_USER="<your-database-user>"# Optionalexport CLOUD_SQL_POSTGRES_PASSWORD="<your-database-password>"# Optionalexport CLOUD_SQL_POSTGRES_IP_TYPE="PUBLIC"# Optional: `PUBLIC`, `PRIVATE`, `PSC`. Defaults to `PUBLIC`.

EnsureApplication Default Credentials are available in your environment.

To start the Gemini CLI, use the following command:

gemini

Interact with Cloud SQL for PostgreSQL using natural language:

• Provision Infrastructure:
  • "Create a new CLoud SQL for Postgres instance named 'e-commerce-prod' in the 'my-gcp-project' project."
  • "Create a new user named 'analyst' with read access to all tables."
• Explore Schemas and Data:
  • "Show me all tables in the 'orders' database."
  • "What are the columns in the 'products' table?"
  • "How many orders were placed in the last 30 days, and what were the top 5 most purchased items?"
• Generate Code:
  • "Generate a Python dataclass to represent the 'customers' table."

• Admin:

  • create_instance: Use this tool to create an Postgres instance.
  • create_user: Use this tool to create Postgres-BUILT-IN or IAM-based users.
  • create_database: Creates a new database in a Cloud SQL instance.
  • get_instance: Use this tool to get details about an Postgres instance.
  • list_instances: Use this tool to list instances in a given project and location.
  • list_databases: Lists all databases for a Cloud SQL instance.
  • wait_for_operation: Use this tool to poll the operations API until the operation is done.

• Data:

  • list_tables: Use this tool to lists tables in the database.
  • execute_sql: Use this tool to executes a SQL query.
  • list_active_queries: Use this tool to list currently running queries.
  • list_available_extensions: Use this tool to list available extensions for installation.
  • list_installed_extensions: Use this tool to list installed extensions.
  • get_query_plan: Use this tool to get query plan.
  • list_autovacuum_configurations: Use this tool to list autovacuum configurations and its value.
  • list_memory_configurations: Use this tool to list memory configurations and its value.
  • list_top_bloated_tables: Use this tool to list top bloated tables.
  • list_replication_slots: Use this tool to list replication slots.
  • list_invalid_indexes: Use this tool to list invalid indexes.

Find additional extensions to support your entire software development lifecycle atgithub.com/gemini-cli-extensions, including:

• Generic PostgreSQL extension
• Cloud SQL for PostgreSQL Observability extension
• and more!

Usegemini --debug to enable debugging.

Common issues:

• "failed to find default credentials: google: could not find default credentials.": EnsureApplication Default Credentials are available in your environment. SeeSet up Application Default Credentials for more information.
• "✖ Error during discovery for server: MCP error -32000: Connection closed": The database connection has not been established. Ensure your configuration is set via environment variables.
• "✖ MCP ERROR: Error: spawn /Users/USER/.gemini/extensions/cloud-sql-postgresql/toolbox ENOENT": The Toolbox binary did not download correctly. Ensure you are using Gemini CLI v0.6.0+.
• "cannot execute binary file": The Toolbox binary did not download correctly. Ensure the correct binary for your OS/Architecture has been downloaded. SeeInstalling the server for more information.