Skip to content
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

use quote in backticks rather than escape #1111

Merged
merged 2 commits into from
Nov 14, 2024

Conversation

JPryce-Aklundh
Copy link
Contributor

@JPryce-Aklundh JPryce-Aklundh commented Nov 14, 2024

Copy link
Contributor

@l-heemann l-heemann left a comment

Choose a reason for hiding this comment

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

Looks good, I have a couple of suggestions but nothing major. Thanks for the quick turnaround!

@@ -472,7 +472,7 @@ RETURN 'Cypher\'s a nice language', "Mats' quote: \"statement\""
RETURN "Cypher's a nice language", 'Mats\' quote: "statement"'
----

* Avoid having to use back-ticks to escape characters and keywords.
* Avoid having to use backticks to quote characters and keywords.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
* Avoid having to use backticks to quote characters and keywords.
* Avoid using characters and keywords that require the input to be quoted.

Feels a little bit more actionable than "avoid having the db force a rule on you"

@@ -16,7 +16,7 @@ The reserved keywords are not permitted to be used as identifiers in the followi
* Function names
* Parameters

If any reserved keyword is escaped -- i.e. is encapsulated by backticks ```, such as `++`AND`++` -- it would become a valid identifier in the above contexts.
If any reserved keyword is quoted in backticks (```), such as `++`AND`++`, it would become a valid identifier in the above contexts.
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe we should add that this isn't recommended, or maybe that is obvious 🤔

@neo-technology-commit-status-publisher
Copy link
Collaborator

Thanks for the documentation updates.

The preview documentation has now been torn down - reopening this PR will republish it.

renetapopova added a commit to neo4j/docs-operations that referenced this pull request Nov 14, 2024
This is the only mention of escaping with backticks that I found in the
Operations manual.

Cypher Manual PR: neo4j/docs-cypher#1111
renetapopova added a commit to renetapopova/docs-operations that referenced this pull request Nov 14, 2024
This is the only mention of escaping with backticks that I found in the
Operations manual.

Cypher Manual PR: neo4j/docs-cypher#1111
@JPryce-Aklundh JPryce-Aklundh merged commit fbbc11d into neo4j:dev Nov 14, 2024
5 checks passed
@JPryce-Aklundh JPryce-Aklundh deleted the quoting branch November 14, 2024 15:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants