Skip to content

Commit 226dbad

Browse files
standardise
1 parent 7e5f07d commit 226dbad

File tree

6 files changed

+73
-68
lines changed

6 files changed

+73
-68
lines changed

modules/ROOT/content-nav.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@
3333
** **Write**
3434
** xref:clauses/create.adoc[]
3535
** xref:clauses/delete.adoc[]
36+
** xref::clauses/delete.adoc#delete-all-nodes-and-relationships[DETACH DELETE]
3637
** xref:clauses/foreach.adoc[]
3738
** xref:clauses/remove.adoc[]
3839
** xref:clauses/set.adoc[]

modules/ROOT/pages/clauses/index.adoc

Lines changed: 64 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55

66
This section contains information on all the clauses and subclauses in the Cypher query language.
77

8-
[[reading-clauses]]
9-
== Reading clauses
8+
[[read-clauses]]
9+
== Read clauses
1010

1111
These comprise clauses that read data from the database.
1212

@@ -17,7 +17,6 @@ This set is refined and augmented by subsequent parts of the query.
1717
|===
1818
| Clause | Description
1919

20-
2120
m| xref::clauses/filter.adoc[FILTER]
2221
| Adds filters to queries.
2322
label:new[Introduced in Neo4j 2025.06]
@@ -30,8 +29,8 @@ m| xref::clauses/optional-match.adoc[OPTIONAL MATCH]
3029

3130
|===
3231

33-
[[projecting-clauses]]
34-
== Projecting clauses
32+
[[projection-clauses]]
33+
== Projection clauses
3534

3635
These comprise clauses that define which expressions to return in the result set.
3736
The returned expressions may all be aliased using `AS`.
@@ -58,10 +57,10 @@ m| xref::clauses/with.adoc[WITH ... [AS]]
5857

5958
|===
6059

61-
[[reading-sub-clauses]]
60+
[[projection-subclauses]]
6261
== Projection subclauses
6362

64-
These comprise sub-clauses that must operate as part of reading clauses.
63+
These comprise subclauses that must operate as part of reading clauses.
6564

6665
[options="header"]
6766
|===
@@ -70,19 +69,19 @@ These comprise sub-clauses that must operate as part of reading clauses.
7069
m| xref::clauses/where.adoc[WHERE]
7170
| Adds constraints to the patterns in a `MATCH` or `OPTIONAL MATCH` clause or filters the results of a `WITH` clause.
7271

72+
m| xref::clauses/limit.adoc[LIMIT]
73+
| Constrains the number of rows in the output.
74+
7375
m| xref::clauses/order-by.adoc[ORDER BY [ASC[ENDING\] \| DESC[ENDING\]\]]
74-
| A sub-clause following `RETURN` or `WITH`, specifying that the output should be sorted in either ascending (the default) or descending order.
76+
| A subclause following `RETURN` or `WITH`, specifying that the output should be sorted in either ascending (the default) or descending order.
7577

7678
m| xref::clauses/skip.adoc[SKIP] / xref::clauses/skip.adoc#offset-synonym[`OFFSET`]
7779
| Defines from which row to start including the rows in the output.
7880

79-
m| xref::clauses/limit.adoc[LIMIT]
80-
| Constrains the number of rows in the output.
81-
8281
|===
8382

84-
[[writing-clauses]]
85-
== Writing clauses
83+
[[write-clauses]]
84+
== Write clauses
8685

8786
These comprise clauses that write the data to the database.
8887

@@ -98,24 +97,24 @@ a|
9897
Delete nodes, relationships or paths.
9998
Any node to be deleted must also have all associated relationships explicitly deleted.
10099

101-
m| xref::clauses/delete.adoc[DETACH DELETE]
100+
m| xref::clauses/delete.adoc#delete-all-nodes-and-relationships[DETACH DELETE]
102101
a|
103102
Delete a node or set of nodes.
104103
All associated relationships will automatically be deleted.
105104

105+
m| xref::clauses/foreach.adoc[FOREACH]
106+
| Update data within a list, whether components of a path, or the result of aggregation.
107+
106108
m| xref::clauses/set.adoc[SET]
107109
| Update labels on nodes and properties on nodes and relationships.
108110

109111
m| xref::clauses/remove.adoc[REMOVE]
110112
| Remove properties and labels from nodes and relationships.
111113

112-
m| xref::clauses/foreach.adoc[FOREACH]
113-
| Update data within a list, whether components of a path, or the result of aggregation.
114-
115114
|===
116115

117-
[[reading-writing-clauses]]
118-
== Reading/Writing clauses
116+
[[reade-write-clauses]]
117+
== Reade/Write clauses
119118

120119
These comprise clauses that both read data from and write data to the database.
121120

@@ -127,23 +126,35 @@ m| xref::clauses/merge.adoc[MERGE]
127126
| Ensures that a pattern exists in the graph. Either the pattern already exists, or it needs to be created.
128127

129128
m| --- xref::clauses/merge.adoc#query-merge-on-create-on-match[ON CREATE]
130-
| Used in conjunction with `MERGE`, this write sub-clause specifies the actions to take if the pattern needs to be created.
129+
| Used in conjunction with `MERGE`, this write subclause specifies the actions to take if the pattern needs to be created.
131130

132131
m| --- xref::clauses/merge.adoc#query-merge-on-create-on-match[ON MATCH]
133-
| Used in conjunction with `MERGE`, this write sub-clause specifies the actions to take if the pattern already exists.
132+
| Used in conjunction with `MERGE`, this write subclause specifies the actions to take if the pattern already exists.
134133

135-
m| xref::clauses/call.adoc[CALL ... [YIELD ... ]]
136-
| Invokes a procedure deployed in the database and return any results.
134+
|===
137135

136+
[[graph-selection-clauses]]
137+
== Graph selection clauses
138+
139+
[options="header"]
138140
|===
141+
| Clause | Description
139142

140-
[[subquery-clauses]]
141-
== Subquery clauses
143+
m| xref::clauses/use.adoc[USE]
144+
| Determines which graph a query, or query part, is executed against.
145+
146+
|===
147+
148+
[[invocation-clauses]]
149+
== Invocation clauses
142150

143151
[options="header"]
144152
|===
145153
|Clause |Description
146154

155+
m| xref::clauses/call.adoc[CALL ... [YIELD ... ]]
156+
| Invokes a procedure deployed in the database and return any results.
157+
147158
m| xref::subqueries/call-subquery.adoc[CALL { ... }]
148159
| Evaluates a subquery, typically used for post-union processing or aggregations.
149160

@@ -154,35 +165,52 @@ Typically used when modifying or importing large amounts of data.
154165

155166
|===
156167

157-
[[multiple-graphs-clauses]]
158-
== Graph selection
168+
[[importing-clauses]]
169+
== Importing clauses
159170

160171
[options="header"]
161172
|===
162173
| Clause | Description
163174

164-
m| xref::clauses/use.adoc[USE]
165-
| Determines which graph a query, or query part, is executed against.
175+
m| xref::clauses/load-csv.adoc[LOAD CSV]
176+
| Use when importing data from CSV files.
166177

167178
|===
168179

169-
[[importing-clauses]]
170-
== Importing data
180+
181+
[[schema-clauses]]
182+
== Schema clauses
171183

172184
[options="header"]
173185
|===
174186
| Clause | Description
175187

176-
m| xref::clauses/load-csv.adoc[LOAD CSV]
177-
| Use when importing data from CSV files.
188+
m| xref:constraints/managing-constraints.adoc#create-constraint[CREATE CONSTRAINT]
189+
| Create a property existence, property uniqueness, property type, or key constraint.
178190

179-
m| xref::subqueries/subqueries-in-transactions.adoc[CALL { ... } IN TRANSACTIONS]
180-
| This clause may be used to prevent an out-of-memory error from occurring when importing large amounts of data using `LOAD CSV`.
191+
m| xref:constraints/managing-constraints.adoc#list-constraints[SHOW CONSTRAINTS]
192+
| List the available constraints in a database.
193+
194+
m| xref:constraints/managing-constraints.adoc#drop-constraint[DROP CONSTRAINT]
195+
| Drop a constraint.
196+
197+
m| xref:indexes/search-performance-indexes/managing-indexes.adoc#create-range-index[CREATE INDEX]
198+
| Create a range, point, text, lookup, fulltext, or vector index.
199+
200+
m| xref:indexes/search-performance-indexes/managing-indexes.adoc#list-indexes[SHOW INDEXES]
201+
| List the available indexes in a database.
202+
203+
m| xref:indexes/search-performance-indexes/managing-indexes.adoc#drop-indexes[DROP INDEX]
204+
| Drop an index.
205+
206+
** xref:indexes/search-performance-indexes/managing-indexes.adoc#list-indexes[SHOW INDEXES]
207+
** xref:indexes/search-performance-indexes/managing-indexes.adoc#drop-indexes[DROP INDEX]
181208

182209
|===
183210

184-
[[listing-functions-and-procedures]]
211+
[[metadata-clauses]]
185212
== Metadata clauses
213+
186214
[options="header"]
187215
|===
188216
| Clause | Description
@@ -209,30 +237,6 @@ m| xref::constraints/syntax.adoc[CREATE \| SHOW \| DROP CONSTRAINT]
209237
| Create, show or drop a constraint.
210238
|===
211239

212-
[[reading-hints]]
213-
== Hints
214-
215-
These comprise clauses used to specify planner hints when tuning a query.
216-
More details regarding the usage of these -- and query tuning in general -- can be found in xref::indexes/search-performance-indexes/index-hints.adoc[Planner hints and the USING keyword].
217-
218-
[options="header"]
219-
|===
220-
| Hint | Description
221-
222-
m| xref::indexes/search-performance-indexes/index-hints.adoc#query-using-index-hint[USING INDEX]
223-
| Index hints are used to specify which index, if any, the planner should use as a starting point.
224-
225-
m| xref::indexes/search-performance-indexes/index-hints.adoc#query-using-index-hint[USING INDEX SEEK]
226-
| Index seek hint instructs the planner to use an index seek for this clause.
227-
228-
m| xref::indexes/search-performance-indexes/index-hints.adoc#query-using-scan-hint[USING SCAN]
229-
| Scan hints are used to force the planner to do a label scan (followed by a filtering operation) instead of using an index.
230-
231-
m| xref::indexes/search-performance-indexes/index-hints.adoc#query-using-join-hint[USING JOIN]
232-
| Join hints are used to enforce a join operation at specified points.
233-
234-
|===
235-
236240

237241
[[administration-clauses]]
238242
== Administration clauses

modules/ROOT/pages/clauses/match.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -321,7 +321,7 @@ RETURN movie.title AS movieTitle, director.name AS director
321321
[[where-predicates]]
322322
== MATCH with WHERE predicates
323323

324-
The `MATCH` clause is often paired with a `WHERE` sub-clause, which adds predicates to refine the patterns, making them more specific.
324+
The `MATCH` clause is often paired with a `WHERE` subclause, which adds predicates to refine the patterns, making them more specific.
325325
These predicates are part of the pattern itself, not just filters applied after matching.
326326
Thus, always place the `WHERE` clause with its corresponding `MATCH` clause.
327327

modules/ROOT/pages/clauses/order-by.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
:description: `ORDER BY` is a sub-clause following `RETURN` or `WITH`, and it specifies that the output should be sorted and how.
1+
:description: `ORDER BY` is a subclause following `RETURN` or `WITH`, and it specifies that the output should be sorted and how.
22

33
[[query-order]]
44
= ORDER BY
55

66
`ORDER BY` specifies how the output of a clause should be sorted.
7-
It be used as a sub-clause following `RETURN` or `WITH`.
7+
It be used as a subclause following `RETURN` or `WITH`.
88

99
`ORDER BY` relies on comparisons to sort the output, see xref:values-and-types/ordering-equality-comparison.adoc[Ordering and comparison of values].
1010
You can sort on many different values, e.g. node/relationship properties, the node/relationship ids, or on most expressions.
@@ -233,7 +233,7 @@ If it is an aggregating or `DISTINCT` projection, only the variables available i
233233
If the projection does not alter the output cardinality (which aggregation and `DISTINCT` do), variables available from before the projecting clause are also available.
234234
When the projection clause shadows already existing variables, only the new variables are available.
235235

236-
It is also not allowed to use aggregating expressions in the `ORDER BY` sub-clause if they are not also listed in the projecting clause.
236+
It is also not allowed to use aggregating expressions in the `ORDER BY` subclause if they are not also listed in the projecting clause.
237237
This rule is to make sure that `ORDER BY` does not change the results, only the order of them.
238238

239239
== ORDER BY and indexes

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2244,7 +2244,7 @@ label:updated[]
22442244
ALTER DATABASE ... [WAIT [n [SEC[OND[S]]]]\|NOWAIT]
22452245
----
22462246
a|
2247-
New sub-clause `WAIT` for `ALTER DATABASE`.
2247+
New subclause `WAIT` for `ALTER DATABASE`.
22482248
This enables adding a waiting clause to specify a time limit in which the command must be completed and returned.
22492249

22502250
a|
@@ -3607,7 +3607,7 @@ label:new[]
36073607
CREATE DATABASE ... TOPOLOGY n PRIMAR{Y\|IES} [m SECONDAR{Y\|IES}]
36083608
----
36093609
a|
3610-
New sub-clause for `CREATE DATABASE`, to specify the number of servers hosting a database, when creating a database in cluster environments.
3610+
New subclause for `CREATE DATABASE`, to specify the number of servers hosting a database, when creating a database in cluster environments.
36113611

36123612
a|
36133613
[[cypher-5_0-a_8]]
@@ -3618,7 +3618,7 @@ label:new[]
36183618
ALTER DATABASE ... SET TOPOLOGY n PRIMAR{Y\|IES} [m SECONDAR{Y\|IES}]
36193619
----
36203620
a|
3621-
New sub-clause for `ALTER DATABASE`, which allows modifying the number of servers hosting a database in cluster environments.
3621+
New subclause for `ALTER DATABASE`, which allows modifying the number of servers hosting a database in cluster environments.
36223622

36233623
a|
36243624
[[cypher-5_0-a_9]]

modules/ROOT/pages/functions/aggregating.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -823,7 +823,7 @@ The example below will throw an error since `n.x`, which is not a grouping key,
823823
RETURN n.x + count(*)
824824
----
825825

826-
To sort the result set using aggregating functions, the aggregation must be included in the `ORDER BY` sub-clause following the `RETURN` clause.
826+
To sort the result set using aggregating functions, the aggregation must be included in the `ORDER BY` subclause following the `RETURN` clause.
827827

828828
[[grouping-key-examples]]
829829
=== Examples

0 commit comments

Comments
 (0)