Repository navigation
fix: escape embedded backticks in column names (#316) #679
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
bjsneto
wants to merge
3
commits into
ClickHouse:main
Choose a base branch
from
bjsneto:fix/316-escape-quoted-identifiers
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 2 commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| using ClickHouse.Driver.Utility; | ||
|
|
||
| namespace ClickHouse.Driver.Tests.Utility; | ||
|
|
||
| [TestFixture] | ||
| public class QuotedStringTests | ||
| { | ||
| [Test] | ||
| public void EncloseColumnName_EscapesInteriorBackticks() | ||
| { | ||
| var result = "weird`name".EncloseColumnName(); | ||
|
|
||
| Assert.That(result, Is.EqualTo("`weird\\`name`")); | ||
| } | ||
|
|
||
| [Test] | ||
| public void EncloseColumnName_AlreadyEnclosedButNeedsEscape_EscapesInterior() | ||
| { | ||
| var result = "`col`name`".EncloseColumnName(); | ||
|
|
||
| Assert.That(result, Is.EqualTo("`\\`col\\`name\\``")); | ||
| } | ||
|
|
||
| [Test] | ||
| public void EncloseColumnName_HandlesNullOrEmpty() | ||
| { | ||
| Assert.That(StringExtensions.EncloseColumnName(null), Is.Null); | ||
| Assert.That(StringExtensions.EncloseColumnName(string.Empty), Is.EqualTo(string.Empty)); | ||
| } | ||
|
|
||
| [Test] | ||
| public void QuoteSingle_AddsOuterSingleQuotes() | ||
| { | ||
| var input = "O\\'Reilly"; | ||
| var result = input.QuoteSingle(); | ||
|
|
||
| Assert.That(result, Is.EqualTo("'O\\'Reilly'")); | ||
| } | ||
|
|
||
| [Test] | ||
| public void QuoteSingle_EmptyString_ReturnsQuotedEmptyString() | ||
| { | ||
| Assert.That(string.Empty.QuoteSingle(), Is.EqualTo("''")); | ||
| } | ||
|
|
||
| [Test] | ||
| public void QuoteDouble_AddsOuterDoubleQuotes() | ||
| { | ||
| var input = "Product \\\"Items\\\""; | ||
| var result = input.QuoteDouble(); | ||
|
|
||
| Assert.That(result, Is.EqualTo("\"Product \\\"Items\\\"\"")); | ||
| } | ||
|
|
||
| [Test] | ||
| public void QuoteDouble_EmptyString_ReturnsQuotedEmptyString() | ||
| { | ||
| Assert.That(string.Empty.QuoteDouble(), Is.EqualTo("\"\"")); | ||
| } | ||
|
|
||
| [TestCase("O\\'Reilly", "'O\\'Reilly'")] | ||
| [TestCase("Product \\\"Items\\\"", "\"Product \\\"Items\\\"\"")] | ||
| public void Quote_AddsOuterQuotes(string input, string expected) | ||
| { | ||
| var result = input.Contains('\'') | ||
| ? input.QuoteSingle() | ||
| : input.QuoteDouble(); | ||
|
|
||
| Assert.That(result, Is.EqualTo(expected)); | ||
| } | ||
| } |
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| * Fixed `EncloseColumnName` returning already-delimited input without escaping embedded backticks ([#316](https://github.com/ClickHouse/clickhouse-cs/issues/316)). |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
❌ Blocker: Document the breaking column-name contract
This changes the public
InsertBinaryAsync(..., columns, ...)andClickHouseBulkCopy.ColumnNamescontract even though the helper is internal. An element containing the SQL spelling`id`previously selected columnid; it now selects a name containing literal backticks. Existing callers therefore fail, or target a different column if both names exist.docs/http.mdxhas no update, and the changelog fragment only describes the internal helper. Document the raw-name requirement in the bulk-insert section, show callers replacing previously quoted names with raw names, and record the compatibility change in the changelog. Also state that each collection element is one name.A reply here is read on the next review: an explanation that holds up drops the finding.