Gemini CLI Extension - AlloyDB for PostgreSQL

Note

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

Instantly manage and query your AlloyDB for PostgreSQL databases using the power of natural language, directly from your command line. Go from an idea to a running cluster and queryable data in minutes, without ever leaving your terminal.

Learn more about Gemini CLI Extensions.

Important

We Want Your Feedback! Please share your thoughts with us by filling out our feedback form. Your input is invaluable and helps us improve the project for everyone.

Why Use the AlloyDB Extension?

• Natural Language Management: Stop wrestling with complex commands. Provision infrastructure, manage users, and query data by describing what you want in plain English.
• Seamless Workflow: Stay in your CLI. No need to constantly switch contexts to the GCP console for common database tasks.
• Full Lifecycle Control: Manage the entire lifecycle of your database, from creating clusters and 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.
• Setup Gemini CLI Authentication.
• A Google Cloud project with the AlloyDB API enabled.
• Ensure Application Default Credentials are available in your environment.
• IAM Permissions:
  • AlloyDB Admin (roles/alloydb.admin) (for managing infrastructure)
  • AlloyDB Client (roles/alloydb.client) (for connecting and querying)
  • Service Usage Consumer (roles/serviceusage.serviceUsageConsumer)

Getting Started

Installation

To install the extension, use the following command before starting the Gemini CLI:

gemini extensions install https://github.com/gemini-cli-extensions/alloydb

Configuration

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 the Admin toolset.

export ALLOYDB_POSTGRES_PROJECT="<your-gcp-project-id>"
export ALLOYDB_POSTGRES_REGION="<your-alloydb-region>"
export ALLOYDB_POSTGRES_CLUSTER="<your-alloydb-cluster-id>"
export ALLOYDB_POSTGRES_INSTANCE="<your-alloydb-instance-id>"
export ALLOYDB_POSTGRES_DATABASE="<your-database-name>"
export ALLOYDB_POSTGRES_USER="<your-database-user>"  # Optional
export ALLOYDB_POSTGRES_PASSWORD="<your-database-password>"  # Optional
export ALLOYDB_POSTGRES_IP_TYPE="PUBLIC"  # Optional: `PUBLIC`, `PRIVATE`, `PSC`. Defaults to `PUBLIC`.

Note

If your AlloyDB instance uses private IPs, you must run Gemini CLI in the same Virtual Private Cloud (VPC) network.

Start Gemini CLI

To start the Gemini CLI, use the following command:

gemini

Warning

Changing Instance & Database Connections Currently, the database connection must be configured before starting the Gemini CLI and can not be changed during a session. To save and resume conversation history use command: /chat save <tag> and /chat resume <tag>.

Usage Examples

Interact with AlloyDB using natural language right from your IDE:

• Provision Infrastructure:

  • "Create a new AlloyDB cluster named 'e-commerce-prod' in the 'my-gcp-project' project."
  • "Add a read-only instance to my 'e-commerce-prod' cluster."
  • "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

This extension provides a comprehensive set of tools:

• Admin:

  • create_cluster: Use this tool to create an AlloyDB cluster.
  • create_instance: Use this tool to create an AlloyDB instance (PRIMARY, READ-POOL, or SECONDARY).
  • create_user: Use this tool to create ALLOYDB-BUILT-IN or IAM-based users for an AlloyDB cluster.
  • get_cluster: Use this tool to get details about an AlloyDB cluster.
  • get_instance: Use this tool to get details about an AlloyDB instance.
  • get_user: Use this tool to get details about a user in an AlloyDB cluster.
  • list_clusters: Use this tool to list clusters in a given project and location.
  • 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:

• Generic PostgreSQL extension
• AlloyDB Observability extension
• and more!

Troubleshooting

Use gemini --debug to enable debugging.

Common issues:

• "failed to find default credentials: google: could not find default credentials.": Ensure Application Default Credentials are available in your environment. See Set 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/alloydb/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. See Installing the server for more information.