Skip to content

Commit 8c0e2eb

Browse files
Document the availability of graph.byelementid on standard databases (#1120)
1 parent e5de1b6 commit 8c0e2eb

File tree

4 files changed

+38
-7
lines changed

4 files changed

+38
-7
lines changed

modules/ROOT/pages/appendix/gql-conformance/additional-cypher.adoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -206,7 +206,10 @@ REMOVE n:$($label)
206206
| Description
207207

208208
| xref:functions/graph.adoc#functions-graph-by-elementid[`graph.byElementId()`]
209-
| Returns the graph reference with the given element id. It is only supported in the `USE` clause, on composite databases.
209+
| Returns the graph reference with the given element id.
210+
It is only supported in the xref:clauses/use.adoc[`USE`] clause.
211+
As of Neo4j 5.26, it is supported on both link:{neo4j-docs-base-uri}/operations-manual/{page-version}/database-administration/[standard and composite databases].
212+
On earlier versions, it is only supported on composite databases.
210213

211214
| xref:functions/graph.adoc#functions-graph-byname[`graph.byName()`]
212215
| Returns the graph reference of the given name. It is only supported in the `USE` clause, on composite databases.

modules/ROOT/pages/clauses/use.adoc

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ MATCH (n) RETURN n
9393
[[query-use-examples-query-composite-database-constituent-graph-dynamically]]
9494
=== Query a composite database constituent graph dynamically
9595

96-
The built-in function `graph.byName()` can be used in the `USE` clause to resolve a constituent graph from a `STRING` value containing the qualified name of a constituent.
96+
The xref:functions/graph.adoc#functions-graph-byname[`graph.byName()`] function can be used in the `USE` clause to resolve a constituent graph from a `STRING` value containing the qualified name of a constituent.
9797

9898
This example uses a composite database named `myComposite` that includes an alias named `myConstituent`:
9999

@@ -114,12 +114,18 @@ USE graph.byName($graphName)
114114
MATCH (n) RETURN n
115115
----
116116

117+
[role=label--new-5.13]
117118
[[query-use-examples-query-composite-database-by-element-id]]
118119
=== Query a composite database constituent using elementId
119120

120-
The `graph.byElementId()` function (introduced in Neo4j 5.13), can be used in the `USE` clause to resolve a constituent graph to which a given element id belongs.
121-
In the below example, it is assumed that the DBMS contains a composite database constituent, which contains the element id `4:c0a65d96-4993-4b0c-b036-e7ebd9174905:0`.
122-
If the constituent database is not a standard database in the DBMS an error will be thrown:
121+
The xref:functions/graph.adoc#functions-graph-by-elementid[`graph.byElementId()`] function can be used in the `USE` clause to resolve a constituent graph to which a given xref:functions/scalar.adoc#functions-elementid[element id] belongs.
122+
As of Neo4j 5.26, it is supported on both standard and composite databases (on previous versions it is only available on composite databases).
123+
124+
[NOTE]
125+
On a standard database, a `USE` clause with `graph.byElementId()` cannot be combined with other `USE` clauses unless the subsequent `USE` clauses reference the same element id.
126+
127+
In the below example, it is assumed that the DBMS contains the database corresponding to the given element id. If you are connected to a composite database it needs to be a element id to a constituent database, which is a standard database in the DBMS.
128+
123129
.Query
124130
[source, cypher, role=test-skip]
125131
----

modules/ROOT/pages/deprecations-additions-removals-compatibility.adoc

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -160,6 +160,18 @@ For more information on the deprecation of these formats, see link:{neo4j-docs-b
160160
| Feature
161161
| Details
162162

163+
a|
164+
label:functionality[]
165+
label:updated[]
166+
[source, cypher, role="noheader"]
167+
----
168+
USE graph.byElementId("4:c0a65d96-4993-4b0c-b036-e7ebd9174905:0")
169+
MATCH (n) RETURN n
170+
----
171+
172+
| xref:functions/graph.adoc#functions-graph-by-elementid[`graph.byElementId()`] can now be used on both link:{neo4j-docs-base-uri}/operations-manual/{page-version}/database-administration/[standard and composite databases].
173+
Previously it could only be used on composite databases.
174+
163175
a|
164176
label:functionality[]
165177
label:updated[]

modules/ROOT/pages/functions/graph.adoc

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -144,12 +144,18 @@ For more information, see xref:subqueries/call-subquery.adoc#import-variables[CA
144144
.Details
145145
|===
146146
| *Syntax* 3+| `graph.byName(name)`
147-
| *Description* 3+| Returns the graph reference of the given name. It is only supported in the `USE` clause, on composite databases.
147+
| *Description* 3+| Returns the graph reference of the given name.
148148
.2+| *Arguments* | *Name* | *Type* | *Description*
149149
| `name` | `STRING` | The name of the graph to be resolved.
150150
| *Returns* 3+| `GRAPH`
151151
|===
152152

153+
154+
.Considerations
155+
|===
156+
| `graph.byName()` is only supported in the xref:clauses/use.adoc[`USE`] clause, on composite databases.
157+
|===
158+
153159
.+graph.byName()+
154160
======
155161
@@ -183,7 +189,7 @@ For more information, see xref:subqueries/call-subquery.adoc#import-variables[CA
183189
.Details
184190
|===
185191
| *Syntax* 3+| `graph.byElementId(elementId)`
186-
| *Description* 3+| Returns the graph reference with the given element id. It is only supported in the `USE` clause, on composite databases.
192+
| *Description* 3+| Returns the graph reference with the given element id.
187193
.2+| *Arguments* | *Name* | *Type* | *Description*
188194
| `elementId` | `STRING` | An element id of a node or relationship.
189195
| *Returns* 3+| `GRAPH`
@@ -192,6 +198,10 @@ For more information, see xref:subqueries/call-subquery.adoc#import-variables[CA
192198
.Considerations
193199
|===
194200
| If the constituent database is not a standard database in the DBMS, an error will be thrown.
201+
| `graph.byElementId()` is only supported in the xref:clauses/use.adoc[`USE`] clause.
202+
| As of Neo4j 5.26, `graph.byElementId()` is supported on both link:{neo4j-docs-base-uri}/operations-manual/{page-version}/database-administration/[standard and composite databases].
203+
On earlier versions, it is only supported on composite databases.
204+
| On a standard database, a `USE` clause with `graph.byElementId()` cannot be combined with other `USE` clauses unless the subsequent `USE` clauses reference the same element id.
195205
|===
196206

197207
.+graph.byElementId()+

0 commit comments

Comments
 (0)