Preserve MySQL optimizer hints in generated query text#4382
Merged
kyleconroy merged 2 commits intomainfrom Apr 17, 2026
Merged
Conversation
Fixes #4353. Hint comments (/*+ ... */) on their own line were being treated as regular block comments and removed from the query string embedded in generated code. Inline hints already survived because the surrounding line did not match the block-comment pattern. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
khepin
added a commit
to khepin/sqlc
that referenced
this pull request
Apr 18, 2026
…te-order-by-args * 'main' of https://github.com/sqlc-dev/sqlc: Map xid8 to pgtype.Uint64 for pgx/v5 (sqlc-dev#4387) Rename :one return variable when it conflicts with a parameter (sqlc-dev#4383) Coerce SQLite JSONB output regardless of type casing (sqlc-dev#4385) Dedupe sqlc.arg parameters wrapped in a type cast for MySQL (sqlc-dev#4384) Preserve MySQL optimizer hints in generated query text (sqlc-dev#4382) Skip CI/RTD builds when the change is irrelevant (sqlc-dev#4381) build(deps): bump the production-dependencies group across 1 directory with 11 updates (sqlc-dev#4380) build(deps): bump the production-dependencies group across 1 directory with 5 updates (sqlc-dev#4368) build(deps): bump pygments from 2.19.2 to 2.20.0 in /docs (sqlc-dev#4363) build(deps): bump requests from 2.32.5 to 2.33.0 in /docs (sqlc-dev#4357) Remove github.com/jackc/pgx/v4 dependency (sqlc-dev#4379) Upgrade Go toolchain to 1.26.2 (sqlc-dev#4378) build(deps): bump actions/upload-artifact from 6 to 7 (sqlc-dev#4320) docs: add sqlc-gen-sqlx to community language support (sqlc-dev#4371) build(deps): bump github.com/jackc/pgx/v5 from 5.8.0 to 5.9.0 (sqlc-dev#4377) Catch invalid ON CONFLICT DO UPDATE column references (sqlc-dev#4366)
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
1 participant
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.
Summary
/*+ ... */on their own line) were being stripped out of the query text embedded in generated code. Inline hints on the same line asSELECTalready survived.source.StripCommentsnow keeps any line whose block comment starts with/*+, treating it as part of the SQL rather than a comment to discard.TestStripCommentsunit test and a newmysql_optimizer_hintsend-to-end testdata case covering both inline and multi-line hints.Why the bug happened
StripCommentsis line-oriented. A line matching/* ... */was classified as a block comment and dropped. For inline hints the surrounding line starts withSELECT, so the whole line — hint included — was preserved. For hints on their own line, the line itself matched the comment pattern and was removed.Test plan
go test ./internal/source/(newTestStripCommentspasses)go test --tags=examples -run "TestReplay/base" ./internal/endtoend/(full base replay still green; newmysql_optimizer_hints/mysqlcase asserts hint is preserved inquery.sql.go)🤖 Generated with Claude Code