Skip to content

Commit 10c3fb6

Browse files
docs: Update README.md (#7)
* docs: Update README.md * Update README.md * Update README.md --------- Co-authored-by: Wenxin Du <117315983+duwenxin99@users.noreply.github.com>
1 parent 6752a23 commit 10c3fb6

File tree

1 file changed

+25
-4
lines changed

1 file changed

+25
-4
lines changed

README.md

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,27 @@
11
# Gemini CLI Extension - Cloud SQL for SQL Server
22

3+
> [!NOTE]
4+
> This extension is currently in beta, and may see breaking changes until the first stable release (v1.0).
5+
36
This Gemini CLI extension provides a set of tools to interact with [Cloud SQL for SQL Server](https://cloud.google.com/sql/docs/sqlserver) instances. It allows you to manage your databases, execute queries, explore schemas, and troubleshoot issues directly from the [Gemini CLI](https://google-gemini.github.io/gemini-cli/), using natural language prompts.
47

8+
Learn more about [Gemini CLI Extensions](https://github.com/google-gemini/gemini-cli/blob/main/docs/extension.md).
9+
510
## Why Use the Cloud SQL for SQL Server Extension?
611

712
* **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.
813
* **Natural Language Management:** Stop wrestling with complex commands. Explore schemas and query data by describing what you want in plain English.
914
* **Code Generation:** Accelerate development by asking Gemini to generate data classes and other code snippets based on your table schemas.
10-
1115
## Prerequisites
1216

1317
Before you begin, ensure you have the following:
1418

15-
* [Gemini CLI](https://github.com/google-gemini/gemini-cli) installed.
19+
* [Gemini CLI](https://github.com/google-gemini/gemini-cli) installed with version +v0.6.0.
1620
* A Google Cloud project with the **Cloud SQL Admin API** enabled.
1721
* IAM Permissions:
1822
* Cloud SQL Client (`roles/cloudsql.client`)
23+
* Cloud SQL Viewer (`roles/cloudsql.viewer`)
24+
* Cloud SQL Admin (`roles/cloudsql.admin`)
1925

2026
## Installation
2127

@@ -38,13 +44,18 @@ Set the following environment variables before starting the Gemini CLI:
3844
* `CLOUD_SQL_MSSQL_PASSWORD`: The password for the database user.
3945
* `CLOUD_SQL_MSSQL_IP_TYPE`: (Optional) The IP type i.e. “Public” or “Private” (Default: Public).
4046

47+
Ensure [Application Default Credentials](https://cloud.google.com/docs/authentication/gcloud) are available in your environment.
48+
4149
> [!NOTE]
4250
> When using private IPs with Cloud SQL for SQL Server, you must use a Virtual Private Cloud (VPC) network.
4351
4452
## Usage Examples
4553

4654
Interact with Cloud SQL for SQL Server using natural language:
4755

56+
* **Provision Infrastructure:**
57+
* "Create a new Cloud SQL for SQL Server instance named 'e-commerce-prod' in the 'my-gcp-project' project."
58+
* "Create a new user named 'analyst' with read access to all tables."
4859
* **Explore Schemas and Data:**
4960
* "Show me all tables in the 'orders' database."
5061
* "What are the columns in the 'products' table?"
@@ -54,8 +65,18 @@ Interact with Cloud SQL for SQL Server using natural language:
5465

5566
## Supported Tools
5667

57-
* `list_tables`: Use this tool to list tables and descriptions.
58-
* `execute_sql`: Use this tool to execute any SQL statement.
68+
* **Admin:**
69+
* `create_instance`: Use this tool to create an Postgres instance.
70+
* `create_user`: Use this tool to create Postgres-BUILT-IN or IAM-based users.
71+
* `get_instance`: Use this tool to get details about an Postgres instance.
72+
* `get_user`: Use this tool to get details about a user.
73+
* `list_instances`: Use this tool to list instances in a given project and location.
74+
* `list_users`: Use this tool to list users in a given project and location.
75+
* `wait_for_operation`: Use this tool to poll the operations API until the operation is done.
76+
77+
* **Data:**
78+
* `list_tables`: Use this tool to list tables and descriptions.
79+
* `execute_sql`: Use this tool to execute any SQL statement.
5980

6081
## Additional Extensions
6182

0 commit comments

Comments
 (0)