feat: Introduce sqlc.optional for dynamic query generation #4005
+1,301
−76
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.