Skip to content

Query: Add a few more example questions specific to CrateDB#60

Merged
amotl merged 1 commit intomainfrom
sql-to-text-examples
Jul 28, 2025
Merged

Query: Add a few more example questions specific to CrateDB#60
amotl merged 1 commit intomainfrom
sql-to-text-examples

Conversation

@amotl
Copy link
Member

@amotl amotl commented Jul 27, 2025

A few Text-to-SQL questions that have been explored recently.

@coderabbitai
Copy link

coderabbitai bot commented Jul 27, 2025 •
edited
Loading

Note

Currently processing new changes in this PR. This may take a few minutes, please wait...

📥 Commits

Reviewing files that changed from the base of the PR and between f246792 and 228551a.

📒 Files selected for processing (4)
  • CHANGES.md (1 hunks)
  • src/cratedb_about/cli.py (2 hunks)
  • src/cratedb_about/query/model.py (2 hunks)
  • tests/test_query.py (1 hunks)
 _____________________________________________
< HD, 4K, 8K...I see bugs in all resolutions. >
 ---------------------------------------------
  \
   \   (\__/)
       (•ㅅ•)
       / 　 づ

Walkthrough

The changes introduce a new cleanse utility, rename questions to knowledgebase in the Example class, and add categorized example questions under text_to_sql. CLI commands are updated to use these new structures, and output formatting is enhanced. Tests are updated to reference knowledgebase instead of questions.

Changes

Cohort / Files Change Summary
src/cratedb_about/query/model.py Added cleanse utility, renamed questions to knowledgebase, introduced text_to_sql dict, and added render class method to Example.
src/cratedb_about/cli.py Updated CLI commands to use knowledgebase instead of questions, enhanced output formatting for question listing.
tests/test_query.py Modified test to check Example.knowledgebase instead of Example.questions.
CHANGES.md Updated changelog to note the addition of CrateDB-specific example questions to the Query component.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CLI
    participant Example

    User->>CLI: ask command
    CLI->>Example: Access knowledgebase for question
    Example-->>CLI: Return relevant question
    CLI-->>User: Output question

    User->>CLI: list_questions command
    CLI->>Example: Access knowledgebase and text_to_sql
    Example-->>CLI: Provide categorized questions
    CLI-->>User: Output formatted question list
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

Suggested reviewers

  • surister
  • kneth

Poem

In the meadow of code, new questions bloom,
With knowledgebase fields, there's plenty of room.
The CLI now lists, with sections so neat,
And tests hop along, never missing a beat.
🐇✨
A bunny's delight—these changes complete!

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch sql-to-text-examples

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@amotl amotl requested review from WalBeh, hammerhead and joncombe July 27, 2025 23:40
@amotl amotl marked this pull request as ready for review July 27, 2025 23:40
@amotl amotl force-pushed the sql-to-text-examples branch from f246792 to 228551a Compare July 28, 2025 09:21
@amotl amotl merged commit 2ab64b9 into main Jul 28, 2025
3 of 4 checks passed
@amotl amotl deleted the sql-to-text-examples branch July 28, 2025 09:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@hammerhead hammerhead hammerhead approved these changes

@joncombe joncombe Awaiting requested review from joncombe

@WalBeh WalBeh Awaiting requested review from WalBeh

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@amotl @hammerhead