Add docs on dynamic properties #972

gem-neo4j · 2024-05-31T09:53:33Z

No description provided.

gem-neo4j · 2024-05-31T12:12:17Z

Label/property create/update, etc via parameters & variables

modules/ROOT/pages/clauses/set.adoc

JoelBergstrand

Great! I think there is a spelling misstake otherwise clear and well explained.

gem-neo4j · 2024-06-27T06:52:22Z

@JoelBergstrand I have added a new part for dynamic labels for SET/REMOVE now as well :D

JPryce-Aklundh

Thanks @gem-neo4j! There were a few queries here which I think may need more explanation (I have added suggestions to this end - let me know what you think 😸 )

JPryce-Aklundh · 2024-08-13T12:35:34Z

modules/ROOT/pages/clauses/remove.adoc

+WITH [k IN keys(n) WHERE k CONTAINS "Test" | k] as propertyKeys
+FOREACH (i IN propertyKeys | REMOVE k[i])


See subsequent comment for context

Suggested change

WITH [k IN keys(n) WHERE k CONTAINS "Test" | k] as propertyKeys

FOREACH (i IN propertyKeys | REMOVE k[i])

WITH [k IN keys(n) WHERE k CONTAINS "Test" | k] as propertyKeys // <1>

FOREACH (i IN propertyKeys | REMOVE k[i]) // <2>

JPryce-Aklundh · 2024-08-13T12:45:20Z

modules/ROOT/pages/clauses/remove.adoc

+FOREACH (i IN propertyKeys | REMOVE k[i])
+RETURN n.name, keys(n);
+----
+


I think this query needs a bit more explanation (though Im not sure my attempt is accurate 😄 )

Suggested change

<1> The xref:function/list.adoc#functions-key[keys()] function retrieves all property keys of the matched nodes, and a xref:values-and-types/lists.adoc#cypher-list-comprehension[list comprehension]filters these keys to include only those that contain the substring "Test", assigning the resulting list to the variable `propertyKeys`.

<2> The xref:clauses/foreach.adoc[`FOREACH`] clause iterates over each key in the `propertyKeys` list and removes the corresponding property using the `REMOVE` clause.

I guess we should be clear that it gets all the keys of the node (singular) it is operating on, it isn't getting the keys of all the matched nodes (plural), but otherwise I think this good.

Could even mention it removes the corresponding property dynamically 😏 hehe but that is probably obvious 😅

JPryce-Aklundh · 2024-08-13T12:48:37Z

modules/ROOT/pages/clauses/remove.adoc

+== Dynamically removing a label
+
+`REMOVE` can be used to remove a label on a node even when the label is not statically known.
+


Can we add the relevant syntax here as well?

JPryce-Aklundh · 2024-08-13T12:51:01Z

modules/ROOT/pages/clauses/remove.adoc

+[source, cypher, indent=0]
+----
+MATCH (n {name: 'Peter'})
+UNWIND labels(n) AS label


Suggested change

UNWIND labels(n) AS label

UNWIND labels(n) AS label // <1>

JPryce-Aklundh · 2024-08-13T12:54:22Z

modules/ROOT/pages/clauses/remove.adoc

+REMOVE n:$(label)
+RETURN n.name, labels(n)
+----
+


Suggested change

<1> xref:clauses/unwind.adoc[`UNWIND`] is used here to transform the list of labels from the xref:functions/list.adoc#functions-list[`lists()]` function into separate rows, allowing subsequent operations to be performed on each label individually.

JPryce-Aklundh · 2024-08-13T13:11:40Z

modules/ROOT/pages/clauses/set.adoc

+[source, cypher]
+----
+MATCH (n)
+FOREACH (k IN keys(n) | SET n[k + "Copy"] = n[k])


Suggested change

FOREACH (k IN keys(n) | SET n[k + "Copy"] = n[k])

FOREACH (k IN keys(n) | SET n[k + "Copy"] = n[k]) // <1>

JPryce-Aklundh · 2024-08-13T13:18:21Z

modules/ROOT/pages/clauses/set.adoc

+FOREACH (k IN keys(n) | SET n[k + "Copy"] = n[k])
+RETURN n.name, keys(n);
+----
+


Suggested change

<1> The xref:clauses/foreach.adoc#[`FOREACH`] clause iterates over each property key `k` obtained from the xref:function/list.adoc#functions-key[`keys()`] function.

For each key, it sets a new property on the nodes with a key name of `k` + "Copy" and copies the value from the original property.

JPryce-Aklundh · 2024-08-13T13:19:24Z

modules/ROOT/pages/clauses/set.adoc

@@ -522,3 +585,28 @@ The newly-labeled node is returned by the query.
 2+d|Rows: 1 +
 Labels added: 2
 |===
+
+[[set-set-multiple-dynamic-labels-on-a-node]]


Suggested change

[[set-set-multiple-dynamic-labels-on-a-node]]

[role=label--new-5.24]

[[set-set-multiple-dynamic-labels-on-a-node]]

JPryce-Aklundh · 2024-08-13T13:21:51Z

modules/ROOT/pages/clauses/set.adoc

+.Query
+[source, cypher]
+----
+WITH COLLECT { UNWIND range(0,3) AS id RETURN "Label" + id } as labels


Suggested change

WITH COLLECT { UNWIND range(0,3) AS id RETURN "Label" + id } as labels

WITH COLLECT { UNWIND range(0,3) AS id RETURN "Label" + id } as labels //<1>

JPryce-Aklundh · 2024-08-13T13:27:12Z

modules/ROOT/pages/clauses/set.adoc

+SET n:$(labels)
+RETURN n.name, labels(n) AS labels
+----
+


Suggested change

<1> A xref:subqueries/collect.adoc[`COLLECT`] subquery aggregates the results of `UNWIND range(0,3) AS id RETURN "Label" + id`, which generates a `LIST<STRING>` strings ("Label0", "Label1", "Label2", "Label3"), and assigns it to the variable `labels`.

ikwattro · 2024-08-13T13:38:59Z

modules/ROOT/pages/clauses/set.adoc

+[source, cypher]
+----
+MATCH (n:Swedish)
+SET n:$(n.name)


Can we have an example where the label to add comes from a Cypher parameter, what would the syntax look like ?

SET n:$($label) ?

Same for multiple labels.

JoelBergstrand

No additional comments from me.

neo-technology-commit-status-publisher · 2024-08-22T13:33:20Z

Thanks for the documentation updates.

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

gem-neo4j added the team-cypher-surface label May 31, 2024

Lojjs assigned JoelBergstrand Jun 10, 2024

JoelBergstrand reviewed Jun 14, 2024

View reviewed changes

modules/ROOT/pages/clauses/set.adoc Outdated Show resolved Hide resolved

JoelBergstrand requested changes Jun 14, 2024

View reviewed changes

gem-neo4j force-pushed the dev_set_dynamic_properties branch from 7b7ebfd to 1bb0556 Compare June 25, 2024 07:29

gem-neo4j force-pushed the dev_set_dynamic_properties branch from 1bb0556 to 6eb3b4e Compare August 9, 2024 09:24

gem-neo4j added the 5.24 label Aug 9, 2024

gem-neo4j assigned JPryce-Aklundh Aug 9, 2024

gem-neo4j force-pushed the dev_set_dynamic_properties branch from 6eb3b4e to fe4cd12 Compare August 12, 2024 12:13

gem-neo4j marked this pull request as ready for review August 12, 2024 12:13

JPryce-Aklundh reviewed Aug 13, 2024

View reviewed changes

ikwattro reviewed Aug 13, 2024

View reviewed changes

gem-neo4j and others added 5 commits August 16, 2024 13:35

Add docs on dynamic properties

1280d4f

Add docs on dynamic labels

87fc1c6

add new graphs

a100c39

PR review updates

4da8aaa

Add parameters example

11ddc7e

gem-neo4j force-pushed the dev_set_dynamic_properties branch 4 times, most recently from 2da8a1d to d31e717 Compare August 16, 2024 13:38

Fix examples

1524325

gem-neo4j force-pushed the dev_set_dynamic_properties branch from d31e717 to 1524325 Compare August 16, 2024 14:09

JoelBergstrand approved these changes Aug 19, 2024

View reviewed changes

Merge branch 'dev' into dev_set_dynamic_properties

acde449

JPryce-Aklundh approved these changes Aug 22, 2024

View reviewed changes

JPryce-Aklundh merged commit 0ab44c1 into neo4j:dev Aug 22, 2024
5 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add docs on dynamic properties #972

Add docs on dynamic properties #972

gem-neo4j commented May 31, 2024 •

edited

Loading

gem-neo4j commented May 31, 2024

JoelBergstrand left a comment

gem-neo4j commented Jun 27, 2024

JPryce-Aklundh left a comment

JPryce-Aklundh Aug 13, 2024

JPryce-Aklundh Aug 13, 2024

gem-neo4j Aug 14, 2024

JPryce-Aklundh Aug 13, 2024

JPryce-Aklundh Aug 13, 2024

JPryce-Aklundh Aug 13, 2024

JPryce-Aklundh Aug 13, 2024

JPryce-Aklundh Aug 13, 2024

JPryce-Aklundh Aug 13, 2024

JPryce-Aklundh Aug 13, 2024

JPryce-Aklundh Aug 13, 2024

ikwattro Aug 13, 2024

JoelBergstrand left a comment

neo-technology-commit-status-publisher commented Aug 22, 2024 •

edited

Loading

		WITH [k IN keys(n) WHERE k CONTAINS "Test" \| k] as propertyKeys
		FOREACH (i IN propertyKeys \| REMOVE k[i])


	<1> The xref:function/list.adoc#functions-key[keys()] function retrieves all property keys of the matched nodes, and a xref:values-and-types/lists.adoc#cypher-list-comprehension[list comprehension]filters these keys to include only those that contain the substring "Test", assigning the resulting list to the variable `propertyKeys`.
	<2> The xref:clauses/foreach.adoc[`FOREACH`] clause iterates over each key in the `propertyKeys` list and removes the corresponding property using the `REMOVE` clause.

		== Dynamically removing a label

		`REMOVE` can be used to remove a label on a node even when the label is not statically known.



	<1> xref:clauses/unwind.adoc[`UNWIND`] is used here to transform the list of labels from the xref:functions/list.adoc#functions-list[`lists()]` function into separate rows, allowing subsequent operations to be performed on each label individually.

	FOREACH (k IN keys(n) \| SET n[k + "Copy"] = n[k])
	FOREACH (k IN keys(n) \| SET n[k + "Copy"] = n[k]) // <1>



	<1> The xref:clauses/foreach.adoc#[`FOREACH`] clause iterates over each property key `k` obtained from the xref:function/list.adoc#functions-key[`keys()`] function.
	For each key, it sets a new property on the nodes with a key name of `k` + "Copy" and copies the value from the original property.

	[[set-set-multiple-dynamic-labels-on-a-node]]
	[role=label--new-5.24]
	[[set-set-multiple-dynamic-labels-on-a-node]]

	WITH COLLECT { UNWIND range(0,3) AS id RETURN "Label" + id } as labels
	WITH COLLECT { UNWIND range(0,3) AS id RETURN "Label" + id } as labels //<1>


	<1> A xref:subqueries/collect.adoc[`COLLECT`] subquery aggregates the results of `UNWIND range(0,3) AS id RETURN "Label" + id`, which generates a `LIST<STRING>` strings ("Label0", "Label1", "Label2", "Label3"), and assigns it to the variable `labels`.

Add docs on dynamic properties #972

Add docs on dynamic properties #972

Conversation

gem-neo4j commented May 31, 2024 • edited Loading

gem-neo4j commented May 31, 2024

JoelBergstrand left a comment

Choose a reason for hiding this comment

gem-neo4j commented Jun 27, 2024

JPryce-Aklundh left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JoelBergstrand left a comment

Choose a reason for hiding this comment

neo-technology-commit-status-publisher commented Aug 22, 2024 • edited Loading

gem-neo4j commented May 31, 2024 •

edited

Loading

neo-technology-commit-status-publisher commented Aug 22, 2024 •

edited

Loading