Repository navigation
Conversation
Contributor
There was a problem hiding this comment.
Copilot was unable to review this pull request because the user who requested the review has insufficient remaining quota. Try requesting a review at a lower effort level.
An organization owner can choose the repository organization as the billing source for reviews requested by members with a paid Copilot license. Learn about Copilot code review billing. Review the Copilot code review billing settings.
This branch has not been deployed
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.
Fixes #2250 (the backtick case from the title; see the note at the end for the rest).
Problem
The DBeaver SQL formatter puts spaces inside backtick-quoted identifiers, which Spark SQL and MySQL then read as a different name. With the default config,
is formatted to
Besides the added spaces, a keyword inside the backticks (
table) is upper-cased and gets its own line break.Root cause
SQLTokensParseronly reads a quoted identifier as one token when its opening character is inSQLDialect.getIdentifierQuoteStrings(), andDEFAULT_QUOTE_STRINGSheld only the double quote. A backtick fell through toisSymbol, so`MyCol.1`became three tokens (symbol, name, symbol) and the formatter spaced, cased and wrapped them like any other symbols and words.Fix
Add the backtick to
DEFAULT_QUOTE_STRINGS. The tokenizer's existing quoted-identifier branch then reads everything up to the closing backtick as a single token, the same way it already does for"MyCol.1", so the contents are left alone. The example above now formats toOne behavior to be aware of: an unterminated backtick is now handled like an unterminated
"or', which is to say the tokenizer runs off the end of the input instead of treating the backtick as a stray symbol.Tests
DBeaverSQLFormatterStepTest.backtickQuotedIdentifiers, which formatssql/dbeaver/backticks.dirtyand compares it withbackticks.clean.mainit fails with the spaced-out output shown above../gradlew :testlib:test --tests 'com.diffplug.spotless.sql.*' spotlessCheck :lib:spotbugsMainpasses (all 6 tests).Not in this PR
The issue was later extended with three more cases:
3p_dummybecoming3 p_dummy,arr[0]becomingarr [ 0 ], and0Lbecoming0 L. Those come from how the tokenizer reads numbers and brackets, not from identifier quoting, so I left them out to keep this change small. The issue may be worth keeping open for them.