Skip to content

Conversation

@bog-walk
Copy link
Member

Description

Summary of the change: Add subsection to DSL root about statement builder

Detailed description:

  • Why:

    • Minimal documentation about Query.prepareSQL() except in FAQ
    • New V1 buildStatement() functionality not documented yet
  • What:

    • Add new file under DSL section
      • Reroute FAQ answer to this file
    • Add content about prepareSQL() with queries
    • Add content about buildStatement() introduced in V1
    • Add details on how to use non-executed statement withexec()

Type of Change

Please mark the relevant options with an "X":

  • Documentation update

@bog-walk
Copy link
Member Author

@vnikolova This is sort of a draft following a TODO I'm resolving, in that I'm willing to have any of the following changed depending on your advice:

  • Location (and name) of new file
  • Whether file should be .md or .topic
  • All samples are hard-coded at the moment. Please let me know, based on the final location of this section, which snippets could/should be used to store samples.

I just wanted to lay out the content for the final api, so feel free to push any changes you think are best.

Copy link
Collaborator

@vnikolova vnikolova left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this addition @bog-walk!
Looks great - I only suggest a different title and using second person whenever possible.

@bog-walk bog-walk force-pushed the bog-walk/add-statement-builder-docs branch from c8050d9 to b96b8bc Compare July 25, 2025 04:43
@bog-walk bog-walk requested a review from vnikolova July 25, 2025 04:45
bog-walk and others added 5 commits August 1, 2025 07:20
- Docs currently missing section about prepareSQL()
- New V1 functionality not documented anywhere
- Add review suggestion
- Add new example file in exposed-dsl snippets project
- Replace hard-coded examples with reference to new file
@bog-walk bog-walk force-pushed the bog-walk/add-statement-builder-docs branch from f669ff8 to 0c569fc Compare August 1, 2025 11:29
@bog-walk bog-walk merged commit 9d86a76 into main Aug 1, 2025
6 checks passed
@bog-walk bog-walk deleted the bog-walk/add-statement-builder-docs branch August 1, 2025 12:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants