- Notifications
You must be signed in to change notification settings - Fork900
feat: Introduce sqlc.optional for dynamic query generation#4005
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Open
copito wants to merge1 commit intosqlc-dev:mainChoose a base branch fromcopito:feat/sqlc-optional
base:main
Could not load branches
Branch not found:{{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline, and old review comments may become outdated.
Uh oh!
There was an error while loading.Please reload this page.
Conversation
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
This commit introduces the `sqlc.optional` feature, allowing conditional inclusion of SQL query fragments at runtime.Key changes:1. **Parser Enhancement**: The SQL parser now recognizes `sqlc.optional('ConditionKey', 'SQLFragment')` syntax within query files. This information is stored in the query's metadata.2. **Code Generation**: - Go code generation logic has been updated to process these `OptionalBlocks`. - Generated Go functions now include new parameters (typed as `interface{}`) corresponding to each `ConditionKey`. - Templates (`stdlib/queryCode.tmpl`, `pgx/queryCode.tmpl`) were modified to dynamically build the SQL query string and its arguments at runtime. If an optional Go parameter is non-nil, its associated SQL fragment is included in the final query, and its value is added to the list of database arguments.3. **Parameter Handling**: `$N` placeholders in all SQL fragments (base or optional) consistently refer to the Nth parameter in the generated Go function's signature.4. **Documentation**: Added comprehensive documentation for `sqlc.optional` in `docs/reference/query-annotations.md`, covering syntax, behavior, parameter numbering, and examples.5. **Examples**: A new runnable example has been added to `examples/dynamic_query/postgresql/` to demonstrate practical usage.6. **Tests**: New end-to-end tests were added in `internal/endtoend/testdata/dynamic_query/` for both `stdlib` and `pgx` drivers, ensuring the correctness of the generated code.
ororsatti commentedJun 29, 2025 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
Just a comment, but maybe the optional types can be something like NullString ? typexxxOptionalstruct {Xxx*<type>Validbool} This way it won't have to be interface{} when ever you wanna use a optional value. |
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
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.
This commit introduces the
sqlc.optional
feature, allowing conditional inclusion of SQL query fragments at runtime.Key changes:
Parser Enhancement: The SQL parser now recognizes
sqlc.optional('ConditionKey', 'SQLFragment')
syntax within query files. This information is stored in the query's metadata.Code Generation:
OptionalBlocks
.interface{}
) corresponding to eachConditionKey
.stdlib/queryCode.tmpl
,pgx/queryCode.tmpl
) were modified to dynamically build the SQL query string and its arguments at runtime. If an optional Go parameter is non-nil, its associated SQL fragment is included in the final query, and its value is added to the list of database arguments.Parameter Handling:
$N
placeholders in all SQL fragments (base or optional) consistently refer to the Nth parameter in the generated Go function's signature.Documentation: Added comprehensive documentation for
sqlc.optional
indocs/reference/query-annotations.md
, covering syntax, behavior, parameter numbering, and examples.Examples: A new runnable example has been added to
examples/dynamic_query/postgresql/
to demonstrate practical usage.Tests: New end-to-end tests were added in
internal/endtoend/testdata/dynamic_query/
for bothstdlib
andpgx
drivers, ensuring the correctness of the generated code.