Document SQL generation review guidance#20
Draft
akshithg wants to merge 1 commit into
Draft
Conversation
Author
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This draft adds a short SQL generation review guide and links it from the README.
The guide is intended to capture the invariants that came up while reviewing borp's generated SQL paths: separating borp-emitted SQL syntax from bind parameters and caller-owned SQL fragments, keeping generated identifiers in identifier context, considering cached query plans, and testing dialect-specific behavior.
This is proposed as a starting point rather than final project policy. Before landing, it would benefit from maintainer review for wording, scope, and whether the listed representative code anchors match how maintainers want future SQL-generation changes reviewed.
Verification
git diff --check