fix(clickhouse): avoid placeholder conflicts by using explicit parameter tokens#10160
Open
W48B1T wants to merge 1 commit intocube-js:masterfrom
Open
fix(clickhouse): avoid placeholder conflicts by using explicit parameter tokens#10160W48B1T wants to merge 1 commit intocube-js:masterfrom
W48B1T wants to merge 1 commit intocube-js:masterfrom
Conversation
…ter tokens
The current implementation of the ClickHouse driver uses the `?` symbol as a placeholder. The `sqlstring.format` function replaces all `?` characters positionally with parameters. This only works when the built query does not contain `?` for any other purpose; it breaks as soon as a literal question mark is used in the SQL.
Question marks commonly appear in SQL literals, for example in regular expressions used in cube fields:
```
group: {
title: `group`,
type: `string`,
sql: `extract(${CUBE}."group", '(.*?)(?:-?\\d{2})')`
}
```
There is also no way to escape such occurrences of the `?` symbol for `sqlstring.format`, so these conflicts cannot be avoided with the existing approach.
This change replaces the placeholder symbol `?` with placeholder tokens of the form `___ClickHouseParam_(\d+)___` in the driver and the clickhouse schema compiler. The remaining logic and escaping of sqlstring (using `sqlstring.escape`) stays intact.
Signed-off-by: W48B1T <125169428+W48B1T@users.noreply.github.com>
github-actions
bot
added
driver:clickhouse
Author
|
Hi, any updates on this? |
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.
Problem
The current implementation of the ClickHouse driver uses the
?symbol as a placeholder. Thesqlstring.formatfunction replaces all?characters positionally with parameters. This only works when the built query does not contain?for any other purpose; it breaks as soon as a literal question mark is used in the SQL.Question marks commonly appear in SQL literals, for example in regular expressions used in cube fields:
There is also no way to escape such occurrences of the
?symbol forsqlstring.format, so these conflicts cannot be avoided with the existing approach.Proposed Solution
This change replaces the placeholder symbol
?with placeholder tokens of the form___ClickHouseParam_(\d+)___in the driver and the clickhouse schema compiler. The remaining logic and escaping of sqlstring (usingsqlstring.escape) stays intact.Check List
Issue Reference this PR resolves
#6589