Improve tool description for running SQL++ queries #82
Conversation
nithishr
commented
Nov 13, 2025
nithishr
commented
- Update README and query.py to clarify SQL++ query usage and scoping
Summary of ChangesHello @nithishr, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request enhances the clarity and usability of SQL++ query execution by improving both the user-facing documentation and the internal code comments. The changes ensure that users understand how queries are automatically scoped to the specified bucket and scope, guiding them to use direct collection names rather than fully qualified paths. This update aims to reduce potential confusion and improve the overall developer experience when interacting with SQL++ queries. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request improves the documentation for running SQL++ queries by adding clarifications in both the README.md file and the docstring for the run_sql_plus_plus_query function. The changes make it clearer that queries are automatically scoped and collection names should be used directly. My feedback includes minor suggestions to improve the phrasing in both places for better readability.
README.md
Outdated
| - Upsert a document by ID to a specified scope and collection | ||
| - Delete a document by ID from a specified scope and collection | ||
| - Run a [SQL++ query](https://www.couchbase.com/sqlplusplus/) on a specified scope | ||
| - Queries are automatically scoped to the specified bucket and scope, so use collection names directly (e.g., `SELECT * FROM users` not `SELECT * FROM bucket.scope.users`) |
There was a problem hiding this comment.
For better readability, consider rephrasing the example. The use of 'not' inside the parentheses can be slightly awkward. Using 'instead of' makes the comparison clearer and improves the flow of the sentence.
| - Queries are automatically scoped to the specified bucket and scope, so use collection names directly (e.g., `SELECT * FROM users` not `SELECT * FROM bucket.scope.users`) | |
| - Queries are automatically scoped to the specified bucket and scope, so use collection names directly (e.g., use `SELECT * FROM users` instead of `SELECT * FROM bucket.scope.users`) |
src/tools/query.py
Outdated
| Example: | ||
| query = "SELECT * FROM users WHERE age > 18" | ||
| # Not: "SELECT * FROM bucket.scope.users WHERE age > 18" |
There was a problem hiding this comment.
The use of # Not: is a bit informal for a docstring. To improve clarity and maintain a more formal tone in the documentation, it's better to use a more descriptive term like Incorrect:.
| # Not: "SELECT * FROM bucket.scope.users WHERE age > 18" | |
| # Incorrect: "SELECT * FROM bucket.scope.users WHERE age > 18" |
