feat: Introduce sqlc.optional for dynamic query generation#4005
Closed
copito wants to merge 1 commit intosqlc-dev:mainfrom
Closed
feat: Introduce sqlc.optional for dynamic query generation#4005copito wants to merge 1 commit intosqlc-dev:mainfrom
copito wants to merge 1 commit intosqlc-dev:mainfrom
Conversation
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.
|
Just a comment, but maybe the optional types can be something like NullString ? type xxxOptional struct {
Xxx *<type>
Valid bool
}This way it won't have to be interface{} when ever you wanna use a optional value. |
Collaborator
|
Really appreciate you taking a crack at this! You're heading in the right direction, but I don't think this exact syntax is what we're going to adopt. Sorry I don't have more specific feedback, but hoping to get more time in the next few months to get to a design that I'm happy with. In the future, please start a discussion first so that you don't implement a full feature I end up not merging. |
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
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.optionalfeature, 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:
$Nplaceholders 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.optionalindocs/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 bothstdlibandpgxdrivers, ensuring the correctness of the generated code.