Skip to content

Fix DBeaver SQL formatter adding spaces inside backtick-quoted identifiers - #3187

Open
toyeshhm wants to merge 1 commit into
diffplug:mainfrom
toyeshhm:fix-2250-dbeaver-backtick-identifiers
Open

toyeshhm wants to merge 1 commit into
diffplug:mainfrom
toyeshhm:fix-2250-dbeaver-backtick-identifiers

Conversation

@toyeshhm

Copy link
Copy Markdown
Contributor

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,

select `MyCol.1` as MY_COLUMN_1, t.`MyCol.2` as MY_COLUMN_2 from `my table` t where `MyCol.1` = 1;

is formatted to

SELECT
    ` MyCol.1 ` AS MY_COLUMN_1,
    t. ` MyCol.2 ` AS MY_COLUMN_2
FROM
    ` my TABLE
        ` t
    WHERE
        ` MyCol.1 `= 1;

Besides the added spaces, a keyword inside the backticks (table) is upper-cased and gets its own line break.

Root cause

SQLTokensParser only reads a quoted identifier as one token when its opening character is in SQLDialect.getIdentifierQuoteStrings(), and DEFAULT_QUOTE_STRINGS held only the double quote. A backtick fell through to isSymbol, 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 to

SELECT
    `MyCol.1` AS MY_COLUMN_1,
    t.`MyCol.2` AS MY_COLUMN_2
FROM
    `my table` t
WHERE
    `MyCol.1` = 1;

One 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

  • Added DBeaverSQLFormatterStepTest.backtickQuotedIdentifiers, which formats sql/dbeaver/backticks.dirty and compares it with backticks.clean.
    • On main it fails with the spaced-out output shown above.
    • With the fix it passes.
  • ./gradlew :testlib:test --tests 'com.diffplug.spotless.sql.*' spotlessCheck :lib:spotbugsMain passes (all 6 tests).

Not in this PR

The issue was later extended with three more cases: 3p_dummy becoming 3 p_dummy, arr[0] becoming arr [ 0 ], and 0L becoming 0 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.

Copilot AI balanced review requested due to automatic review settings November 17, 2026 21:39

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

BUG: Spotless SQL DBeaver formatter produces INVALID spark sql syntax with whitespaces added inside backticks and other places

2 participants