support for qm.Comment query mod #872
Merged
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
|
I'm not opposed to this. Code seems reasonable, you've included tests, it's non-breaking and barely affects users who don't use it. Thank you for the great PR. |
gaiottino
added a commit
to gaiottino/sqlboiler
that referenced
this pull request
Aug 23, 2021
https://google.github.io/sqlcommenter/ makes it possible to add tracing comments that can be interpreted by e.g. GCPs query analyser. volatiletech#872 added support for comments but they are prepended on a separate line and sqlcommenter requires the form `/* … */` to be added on the same line as the query which is why I’ve added this PR and the `qm.AppendComment` function. For example: ``` q := shop.Customers( qm.Comment("shop.getAllCustomers"), qm.Select("id", "name"), qm.From("customers"), ) ``` will be: ``` SELECT id, name FROM customers; /* shop.getAllCustomers /* ```
gaiottino
added a commit
to gaiottino/sqlboiler
that referenced
this pull request
Aug 23, 2021
https://google.github.io/sqlcommenter/ makes it possible to add tracing comments that can be interpreted by e.g. GCPs query analyser. volatiletech#872 added support for comments but they are prepended on a separate line and sqlcommenter requires the form `/* … */` to be added on the same line as the query which is why I’ve added this PR and the `qm.AppendComment` function. For example: ``` q := shop.Customers( qm.AppendComment("shop.getAllCustomers"), qm.Select("id", "name"), qm.From("customers"), ) ``` will be: ``` SELECT id, name FROM customers; /* shop.getAllCustomers /* ```
gaiottino
added a commit
to gaiottino/sqlboiler
that referenced
this pull request
Aug 23, 2021
https://google.github.io/sqlcommenter/ makes it possible to add tracing comments that can be interpreted by e.g. GCPs query analyser. volatiletech#872 added support for comments but they are prepended on a separate line and sqlcommenter requires the form `/* … */` to be added on the same line as the query which is why I’ve added this PR and the `qm.AppendComment` function. For example: ``` q := shop.Customers( qm.AppendComment("shop.getAllCustomers"), qm.Select("id", "name"), qm.From("customers"), ) ``` will be: ``` SELECT id, name FROM customers; /* shop.getAllCustomers /* ```
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 simple query mod adds custom comment just before main query.
For example:
will be:
these comments might be very useful for query analysis at database layer - we can easily find function/method related to particular query.