Add warning about backslash corruption when building CQL with string formatting in the doc#1292
Open
howiezhao wants to merge 1 commit intoapache:trunkfrom
Open
Add warning about backslash corruption when building CQL with string formatting in the doc#1292howiezhao wants to merge 1 commit intoapache:trunkfrom
howiezhao wants to merge 1 commit intoapache:trunkfrom
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates the Getting Started guide to warn users against building CQL by interpolating Python values directly into query strings, and to steer them toward prepared statements. It fits the codebase by documenting a driver-specific correctness pitfall around collection string representations and CQL literal handling.
Changes:
- Adds a warning explaining why Python string formatting should not be used to construct CQL from query results.
- Adds an example showing how backslashes can be corrupted when collection values are interpolated into CQL text.
- Adds a prepared-statement example showing the safe binary-protocol path.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+251
to
+254
| f"map_data={row.map_data} WHERE id={row.id}" | ||
| ) | ||
| # The CQL Cassandra receives: | ||
| # UPDATE t SET map_data={'url': 'https:\\/\\/example.com'} ... |
Contributor
|
@howiezhao Does the problem occur when you round-trip data? Read from the database, and then insert it back into the database? For the getting started docs, that might be a bit of a corner case. |
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.
Update Getting Started documentation.