Avoid appending a second FORMAT clause in client.query()#776
Draft
Copilot wants to merge 2 commits into
Draft
Conversation
|
|
Copilot
AI
changed the title
[WIP] Fix client.query() to handle SHOW ROW POLICIES correctly
Avoid appending a second FORMAT clause in client.query()
May 29, 2026
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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.
Summary
client.query()unconditionally appended\nFORMAT <format>to the user-supplied SQL. This produced invalid statements when a query already carried its ownFORMATclause (e.g.SELECT 1 FORMAT CSV \nFORMAT JSON) and surfaced the server-sideSHOW ROW POLICIESparser bug, which rejects a trailingFORMATclause with aSYNTAX_ERRORwhen no row policies exist.Changes
formatQuery(packages/client-common/src/client.ts): detect an existing trailingFORMAT <Name>clause via a newhasTrailingFormatClausehelper and leave the query untouched instead of appending a second clause. Detection is case-insensitive, tolerates newlines, and does not misfire on identifiers likeFORMATDateTime(...)orSELECT format FROM t.query()JSDoc: document the FORMAT-append behavior and theSHOW ROW POLICIESlimitation, recommendingSELECT * FROM system.row_policiesas the working alternative (the empty-result case is only fully fixable server-side, since the server rejects any trailingFORMATthere).client.test.ts): cover default JSON append, omitted format, no double-append when a clause exists, case-insensitive/newline detection, trailing-semicolon stripping, and theformat-as-identifier case.Checklist