You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CLOUD-SQL-SQLSERVER.md
+12-9Lines changed: 12 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,6 +23,8 @@ This section covers connecting to a Cloud SQL for SQL Server instance.
23
23
*`CLOUD_SQL_MSSQL_USER`: The database username.
24
24
*`CLOUD_SQL_MSSQL_PASSWORD`: The password for the database user.
25
25
26
+
If you need to update any of these values later, use the `gemini extensions config cloud-sql-sqlserver` command.
27
+
26
28
2.**Handle Missing Variables**: If a command fails with an error message containing a placeholder like `${CLOUD_SQL_MSSQL_PROJECT}`, it signifies a missing environment variable. Inform the user which variable is missing and instruct them to set it.
27
29
28
30
3.**Handle Permission Errors**: If you encounter permission errors, ensure the user has the **Cloud SQL Client** (`roles/cloudsql.client`) role and the correct database-level permissions. You can provide these links for assistance:
@@ -42,9 +44,9 @@ This section covers administrative operations like managing clusters, instances,
42
44
43
45
---
44
46
45
-
# Additional Tools
47
+
# Additional Extensions
46
48
47
-
This section provides context on additional tools that can be recommended to the user based on their queries.
49
+
This section provides context on additional extensions that can be recommended to the user based on their queries.
48
50
49
51
#### Observability Extension
50
52
@@ -61,12 +63,12 @@ This section provides context on additional tools that can be recommended to the
61
63
62
64
## Connecting to New Resources
63
65
64
-
When you create a new Cloud SQL for SQL Server instance, or database using the available tools, the connection is not automatically established. You will need to perform the following steps:
66
+
When you create a new Cloud SQL for SQL Server instance, or database using the available skills, the connection is not automatically established. You will need to perform the following steps:
65
67
66
68
1. **(Optional) Save your conversation:** To avoid losing your progress, save the current session by running the command: `/chat save <your-tag>`
67
-
2. **Stop the CLI:** Terminate the Gemini CLI.
68
-
3. **Update Environment Variables:** Set or update your environment variables (e.g. `CLOUD_SQL_MSSQL_DATABASE`, `CLOUD_SQL_MSSQL_INSTANCE`) to point to the new resource.
69
-
4. **Restart:** Relaunch the Gemini CLI
69
+
2. **Stop the CLI**: Terminate the Gemini CLI.
70
+
3. **Update Extension Configuration**: Use the command `gemini extensions config cloud-sql-sqlserver` to update your settings (e.g. `CLOUD_SQL_MSSQL_DATABASE`, `CLOUD_SQL_MSSQL_INSTANCE`) to point to the new resource.
71
+
4. **Restart**: Relaunch the Gemini CLI
70
72
5. **(Optional) Resume conversation:** Resume your conversation with the command: `/chat resume <your-tag>`
71
73
72
74
**Important:** Do not assume a connection to a newly created resource is active. Always follow the steps above to reconfigure your connection.
@@ -80,11 +82,12 @@ Users may have set project environment variables:
80
82
* `CLOUD_SQL_MSSQL_INSTANCE`: The ID of the Cloud SQL for SQL Server instance.
81
83
* `CLOUD_SQL_MSSQL_DATABASE`: The name of the database.
82
84
83
-
Instead of prompting the user for these values for specific tool calls, prompt the user to verify reuse a specific value.
84
-
Make sure to not use the environment variable name like `CLOUD_SQL_MSSQL_PROJECT`, `${CLOUD_SQL_MSSQL_PROJECT}`, or `$CLOUD_SQL_MSSQL_PROJECT`. The value can be found by using command: `echo $CLOUD_SQL_MSSQL_PROJECT`.
85
+
Instead of prompting the user for these values for specific skill calls, prompt the user to verify the reuse of a specific setting value.
86
+
Make sure to not use the environment variable name like `CLOUD_SQL_MSSQL_PROJECT`, `${CLOUD_SQL_MSSQL_PROJECT}`, or `$CLOUD_SQL_MSSQL_PROJECT`.
87
+
The value can be verified by the user using the `gemini extensions config cloud-sql-sqlserver` command or by checking their local settings.
85
88
86
89
## Use Full Table Name Format "DATABASE_NAME.SCHEMA_NAME.TABLE_NAME"
87
90
88
-
**ALWAYS** use the full table name format, `DATABASE_NAME.SCHEMA_NAME.TABLE_NAME` in the generated SQL when using the `execute_sql` or `cloud_sql_sqlserver__execute_sql` tool.
91
+
**ALWAYS** use the full table name format, `DATABASE_NAME.SCHEMA_NAME.TABLE_NAME` in the generated SQL when using the `execute_sql` skill.
89
92
* Default to using "dbo" for the schema name.
90
93
* Use command `echo $CLOUD_SQL_MSSQL_DATABASE` to get the current database value.
Copy file name to clipboardExpand all lines: DEVELOPER.md
+11-27Lines changed: 11 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
# DEVELOPER.md
2
2
3
3
This document provides instructions for setting up your development environment
4
-
and contributing to the Cloud SQL for SQL Server Gemini CLI Extension project.
4
+
and contributing to the Cloud SQL for SQL Server Agent skills project.
5
5
6
6
## Prerequisites
7
7
@@ -10,44 +10,30 @@ Before you begin, ensure you have the following:
10
10
1.**Gemini CLI:** Install the Gemini CLI version v0.6.0 or above. Installation
11
11
instructions can be found on the official Gemini CLI documentation. You can
12
12
verify your version by running `gemini --version`.
13
-
2.**Cloud SQL for SQL Server Instance:** For testing data plane tools, you will need access to an active Cloud SQL for SQL Server instance.
13
+
2.**Cloud SQL for SQL Server Instance:** For testing data plane tools, you will need access to an active Cloud SQL for SQL Server
14
+
instance.
14
15
15
16
## Developing the Extension
16
17
17
18
### Running from Local Source
18
19
19
-
The core logic for this extension is handled by a pre-built `toolbox` binary. The development process involves installing the extension locally into the Gemini CLI to test changes.
0 commit comments