GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — Add leading SQL comment support via :label for queries and insert/upd… by alesasnouski · Pull Request #731 · elixir-ecto/ecto_sql

Conversation

@alesasnouski

@alesasnouski alesasnouski commented Jun 3, 2026

Copy link
Copy Markdown

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.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
@greg-rychlewski

greg-rychlewski commented Jun 4, 2026

Copy link
Copy Markdown
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

alesasnouski reacted with rocket emoji
All reactions
  • 🚀 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

alesasnouski added 4 commits August 29, 2026 11:22
@alesasnouski
Add leading SQL comment support via :label for queries and insert/upd…
b230541
…ate/delete
@alesasnouski
Switched :label to Repo option insteand of a query expression
6af8efa
@alesasnouski
Support pre_comment and post_comment options in ecto.
39ea348
@alesasnouski
Skip the default cache_statement when :comments are given
7971489
@alesasnouski
alesasnouski force-pushed the master branch from af49549 to 7971489 Compare August 29, 2026 10:01
alesasnouski added 3 commits August 29, 2026 12:10
@alesasnouski
Reject comment prefixes MySQL/MariaDB treat as executable.
fff6dd1
@alesasnouski
Rename escape_comment! to validate_comment!
03535d2
@alesasnouski
Temporarily point ecto dep at fork for CI (revert before merge).
bf81495
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

2 participants

@alesasnouski @greg-rychlewski
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.
You are visitor 01402520 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.