Skip to content

Add dynamically referenced labels and types to allowed parameters #1143

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Jan 7, 2025
Merged

Add dynamically referenced labels and types to allowed parameters #1143

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cde7b3e
add dynamic referencing
JPryce-Aklundh Jan 7, 2025
7d07511
add properties
JPryce-Aklundh Jan 7, 2025
8013136
fix xref
JPryce-Aklundh Jan 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions modules/ROOT/pages/clauses/where.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,12 +185,19 @@ The `name`, `age` and `email` values for `Peter` are returned because `Andy` has

To filter on a property using a dynamically computed name, use square bracket syntax:

.Parameters
[source, parameters]
----
{
"propname": "age"
}
----

.Query
[source, cypher]
----
WITH 'AGE' AS propname
MATCH (n:Person)
WHERE n[toLower(propname)] < 30
WHERE n[$propname] < 30
RETURN n.name, n.age
----

Expand Down
12 changes: 7 additions & 5 deletions modules/ROOT/pages/syntax/parameters.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,16 @@ Additionally, parameters make caching of execution plans much easier for Cypher,

Parameters can be used for:

* literals and expressions
* node and relationship ids
* Literals and expressions.
* Node and relationship ids.
* Properties, when referenced dynamically (for more information, see xref:clauses/where.adoc#filter-on-dynamic-property[filter-on-dynamic-property]).
* Node labels and relationship types, when referenced dynamically (for more information, see xref:clauses/match.adoc#dynamic-match[`MATCH` using dynamic node labels and relationship types]). label:new[Introduced in 5.26]

Parameters cannot be used for the following constructs, as these form part of the query structure that is compiled into a query plan:

* property keys; so `MATCH (n) WHERE n.$param = 'something'` is invalid
* relationship types; so `MATCH (n)-[:$param]->(m)` is invalid
* labels; so `MATCH (n:$param)` is invalid
* Property keys; `MATCH (n) WHERE n.$param = 'something'` is invalid.
* Relationship types; `MATCH (n)-[:$param]->(m)` is invalid.
* Node labels; `MATCH (n:$param)` is invalid.

Parameters may consist of letters and numbers, and any combination of these, but cannot start with a number or a currency symbol.

Expand Down
Loading