Add leading SQL comment support via :label for queries and insert/upd…#731
Open
alesasnouski wants to merge 1 commit into
Open
Add leading SQL comment support via :label for queries and insert/upd…#731alesasnouski wants to merge 1 commit into
alesasnouski wants to merge 1 commit into
Conversation
Member
|
to run the tests you'll have to point your mix.exs file to your ecto branch and then before we merge you switch it back |
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.
Hi,
This is the adapter/SQL side of the :label feature — companion to the Ecto PR that adds Ecto.Query.label/2. It renders the leading /* ... */ comment in the generated SQL.
There are two paths:
Queries (all/update_all/delete_all): each adapter's connection module prepends /* label */ from query.label, before the SELECT/UPDATE/DELETE.
Writes (insert/insert_all/update/delete): a :label option is prepended in Ecto.Adapters.SQL (prepend_label/2), so single-row and bulk writes can be tagged too.
The option-side validation rejects /*, */ and null bytes, mirroring the query-side validation in Ecto, so the label can't break out of the comment.
Ecto.Adapters.MyXQL overrides insert/6 (for last_insert_id handling) instead of going through Ecto.Adapters.SQL.struct/10, so the label is prepended there explicitly — otherwise single-row inserts on MySQL would silently drop it.
Tested against Postgres, MySQL and SQL Server, verifying the comment reaches the server (general log / Extended Events), not just the client-side Ecto log.