Gemini CLI Extension - Cloud SQL for PostgreSQL

Note

This extension is currently in beta (pre-v1.0), and may see breaking changes until the first stable release (v1.0).

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

Learn more about Gemini CLI Extensions.

Why Use the Cloud SQL for PostgreSQL Extension?

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

Prerequisites

Before you begin, ensure you have the following:

• Gemini CLI installed with version +v0.6.0.
• A Google Cloud project with the Cloud SQL Admin API enabled.
• IAM Permissions:
  • Cloud SQL Client (roles/cloudsql.client)
  • Cloud SQL Admin (roles/cloudsql.admin)

Installation

To install the extension, use the command:

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

Configuration

Set the following environment variables before starting the Gemini CLI. This configuration is not required if utilizing the Admin toolset.

• CLOUD_SQL_POSTGRES_PROJECT: The GCP project ID.
• CLOUD_SQL_POSTGRES_REGION: The region of your Cloud SQL instance.
• CLOUD_SQL_POSTGRES_INSTANCE: The ID of your Cloud SQL instance.
• CLOUD_SQL_POSTGRES_DATABASE: The name of the database to connect to.
• CLOUD_SQL_POSTGRES_USER: (Optional) The database username.
• CLOUD_SQL_POSTGRES_PASSWORD: (Optional) The password for the database user.
• CLOUD_SQL_POSTGRES_IP_TYPE: (Optional) The IP Type.

Ensure Application Default Credentials are available in your environment.

Note

When using private IPs with Cloud SQL for PostgreSQL, you must use a Virtual Private Cloud (VPC) network.

Usage Examples

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

Supported Tools

• 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.
  • get_instance: Use this tool to get details about an Postgres instance.
  • get_user: Use this tool to get details about a user.
  • list_instances: Use this tool to list instances in a given project and location.
  • list_users: Use this tool to list users in a given project and location.
  • 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.

Additional Extensions

Find additional extensions to support your entire software development lifecycle at github.com/gemini-cli-extensions, including a generic PostgreSQL extension.

Troubleshooting

• "cannot execute binary file": Ensure the correct binary for your OS/Architecture has been downloaded. See Installing the server for more information.