Skip to content

Commit 8de64d0

Browse files
JPryce-AklundhJPryce-Aklundh
authored
Update clauses page (#586) (#587)
1 parent 42e8b7b commit 8de64d0

File tree

1 file changed

+153
-148
lines changed

1 file changed

+153
-148
lines changed

‎modules/ROOT/pages/clauses/index.adoc‎

Lines changed: 153 additions & 148 deletions
Original file line numberDiff line numberDiff line change
@@ -3,92 +3,28 @@
33
[[query-clause]]
44
= Clauses
55

6-
[abstract]
7-
--
86
This section contains information on all the clauses in the Cypher query language.
9-
--
107

8+
[[reading-clauses]]
9+
== Reading clauses
1110

12-
[[administration-clauses]]
13-
== Administration clauses
14-
15-
These comprise clauses used to manage databases, schema and security; further details can found in xref::administration/databases.adoc[Database management] and xref::administration/access-control/index.adoc[Access control].
16-
17-
[options="header"]
18-
|===
19-
| Clause | Description
20-
21-
m| xref::administration/databases.adoc[CREATE \| DROP \| START \| STOP DATABASE]
22-
| Create, drop, start or stop a database.
23-
24-
m| xref::indexes-for-search-performance.adoc#indexes-syntax[CREATE \| DROP INDEX]
25-
| Create or drop an index on all nodes with a particular label and property.
26-
27-
m| xref::constraints/syntax.adoc[CREATE \| DROP CONSTRAINT]
28-
| Create or drop a constraint pertaining to either a node label or relationship type, and a property.
29-
30-
| xref::administration/access-control/index.adoc[Access control]
31-
| Manage users, roles, and privileges for database, graph and sub-graph access control.
32-
33-
|===
34-
35-
[[configuration-commands]]
36-
== Configuration Commands
37-
38-
[options="header"]
39-
|===
40-
| Clause | Description
41-
42-
m| xref:clauses/listing-settings.adoc[SHOW SETTINGS]
43-
| List configuration settings.
44-
45-
|===
46-
47-
[[importing-clauses]]
48-
== Importing data
49-
50-
[options="header"]
51-
|===
52-
| Clause | Description
53-
54-
m| xref::clauses/load-csv.adoc[LOAD CSV]
55-
| Use when importing data from CSV files.
56-
57-
m| xref::clauses/call-subquery.adoc#subquery-call-in-transactions[CALL { ... } IN TRANSACTIONS]
58-
| This clause may be used to prevent an out-of-memory error from occurring when importing large amounts of data using `LOAD CSV`.
59-
60-
|===
61-
11+
These comprise clauses that read data from the database.
6212

63-
[[listing-functions-and-procedures]]
64-
== Listing functions and procedures
13+
The flow of data within a Cypher query is an unordered sequence of maps with key-value pairs -- a set of possible bindings between the variables in the query and values derived from the database.
14+
This set is refined and augmented by subsequent parts of the query.
6515

6616
[options="header"]
6717
|===
6818
| Clause | Description
6919

70-
m| xref::clauses/listing-functions.adoc[SHOW FUNCTIONS]
71-
| List the available functions.
72-
73-
m| xref::clauses/listing-procedures.adoc[SHOW PROCEDURES]
74-
| List the available procedures.
75-
76-
|===
77-
78-
79-
[[multiple-graphs-clauses]]
80-
== Multiple graphs
81-
82-
[options="header"]
83-
|===
84-
| Clause | Description
20+
m| xref::clauses/match.adoc[MATCH]
21+
| Specify the patterns to search for in the database.
8522

86-
m| xref::clauses/use.adoc[USE]
87-
| Determines which graph a query, or query part, is executed against. label:fabric[]
23+
m| xref::clauses/optional-match.adoc[OPTIONAL MATCH]
24+
| Specify the patterns to search for in the database while using `nulls` for missing parts of the pattern.
8825

8926
|===
9027

91-
9228
[[projecting-clauses]]
9329
== Projecting clauses
9430

@@ -110,53 +46,6 @@ m| xref::clauses/unwind.adoc[UNWIND ... [AS]]
11046

11147
|===
11248

113-
114-
[[reading-clauses]]
115-
== Reading clauses
116-
117-
These comprise clauses that read data from the database.
118-
119-
The flow of data within a Cypher query is an unordered sequence of maps with key-value pairs -- a set of possible bindings between the variables in the query and values derived from the database.
120-
This set is refined and augmented by subsequent parts of the query.
121-
122-
[options="header"]
123-
|===
124-
| Clause | Description
125-
126-
m| xref::clauses/match.adoc[MATCH]
127-
| Specify the patterns to search for in the database.
128-
129-
m| xref::clauses/optional-match.adoc[OPTIONAL MATCH]
130-
| Specify the patterns to search for in the database while using `nulls` for missing parts of the pattern.
131-
132-
|===
133-
134-
135-
[[reading-hints]]
136-
== Reading hints
137-
138-
These comprise clauses used to specify planner hints when tuning a query.
139-
More details regarding the usage of these -- and query tuning in general -- can be found in xref::query-tuning/using.adoc[Planner hints and the USING keyword].
140-
141-
[options="header"]
142-
|===
143-
| Hint | Description
144-
145-
m| xref::query-tuning/using.adoc#query-using-index-hint[USING INDEX]
146-
| Index hints are used to specify which index, if any, the planner should use as a starting point.
147-
148-
m| xref::query-tuning/using.adoc#query-using-index-hint[USING INDEX SEEK]
149-
| Index seek hint instructs the planner to use an index seek for this clause.
150-
151-
m| xref::query-tuning/using.adoc#query-using-scan-hint[USING SCAN]
152-
| Scan hints are used to force the planner to do a label scan (followed by a filtering operation) instead of using an index.
153-
154-
m| xref::query-tuning/using.adoc#query-using-join-hint[USING JOIN]
155-
| Join hints are used to enforce a join operation at specified points.
156-
157-
|===
158-
159-
16049
[[reading-sub-clauses]]
16150
== Reading sub-clauses
16251

@@ -180,6 +69,38 @@ m| xref::clauses/limit.adoc[LIMIT]
18069

18170
|===
18271

72+
[[writing-clauses]]
73+
== Writing clauses
74+
75+
These comprise clauses that write the data to the database.
76+
77+
[options="header"]
78+
|===
79+
| Clause | Description
80+
81+
m| xref::clauses/create.adoc[CREATE]
82+
| Create nodes and relationships.
83+
84+
m| xref::clauses/delete.adoc[DELETE]
85+
a|
86+
Delete nodes, relationships or paths.
87+
Any node to be deleted must also have all associated relationships explicitly deleted.
88+
89+
m| xref::clauses/delete.adoc[DETACH DELETE]
90+
a|
91+
Delete a node or set of nodes.
92+
All associated relationships will automatically be deleted.
93+
94+
m| xref::clauses/set.adoc[SET]
95+
| Update labels on nodes and properties on nodes and relationships.
96+
97+
m| xref::clauses/remove.adoc[REMOVE]
98+
| Remove properties and labels from nodes and relationships.
99+
100+
m| xref::clauses/foreach.adoc[FOREACH]
101+
| Update data within a list, whether components of a path, or the result of aggregation.
102+
103+
|===
183104

184105
[[reading-writing-clauses]]
185106
== Reading/Writing clauses
@@ -204,6 +125,22 @@ m| xref::clauses/call.adoc[CALL ... [YIELD ... ]]
204125

205126
|===
206127

128+
[[subquery-clauses]]
129+
== Subquery clauses
130+
131+
[options="header"]
132+
|===
133+
|Clause |Description
134+
135+
m| xref::clauses/call-subquery.adoc[CALL { ... }]
136+
| Evaluates a subquery, typically used for post-union processing or aggregations.
137+
138+
m| xref::clauses/call-subquery.adoc#subquery-call-in-transactions[CALL { ... } IN TRANSACTIONS]
139+
a|
140+
Evaluates a subquery in separate transactions.
141+
Typically used when modifying or importing large amounts of data.
142+
143+
|===
207144

208145
[[set-operations-clauses]]
209146
== Set operations
@@ -224,24 +161,58 @@ Duplicates are retained.
224161

225162
|===
226163

164+
[[multiple-graphs-clauses]]
165+
== Multiple graphs
227166

228-
[[subquery-clauses]]
229-
== Subquery clauses
167+
[options="header"]
168+
|===
169+
| Clause | Description
170+
171+
m| xref::clauses/use.adoc[USE]
172+
| Determines which graph a query, or query part, is executed against. label:fabric[]
173+
174+
|===
175+
176+
[[importing-clauses]]
177+
== Importing data
230178

231179
[options="header"]
232180
|===
233-
|Clause |Description
181+
| Clause | Description
234182

235-
m| xref::clauses/call-subquery.adoc[CALL { ... }]
236-
| Evaluates a subquery, typically used for post-union processing or aggregations.
183+
m| xref::clauses/load-csv.adoc[LOAD CSV]
184+
| Use when importing data from CSV files.
237185

238186
m| xref::clauses/call-subquery.adoc#subquery-call-in-transactions[CALL { ... } IN TRANSACTIONS]
239-
a|
240-
Evaluates a subquery in separate transactions.
241-
Typically used when modifying or importing large amounts of data.
187+
| This clause may be used to prevent an out-of-memory error from occurring when importing large amounts of data using `LOAD CSV`.
188+
189+
|===
190+
191+
[[listing-functions-and-procedures]]
192+
== Listing functions and procedures
193+
[options="header"]
194+
|===
195+
| Clause | Description
196+
197+
m| xref::clauses/listing-functions.adoc[SHOW FUNCTIONS]
198+
| List the available functions.
199+
200+
m| xref::clauses/listing-procedures.adoc[SHOW PROCEDURES]
201+
| List the available procedures.
242202

243203
|===
244204

205+
[[configuration-commands]]
206+
== Configuration Commands
207+
208+
[options="header"]
209+
|===
210+
| Clause | Description
211+
212+
m| xref:clauses/listing-settings.adoc[SHOW SETTINGS]
213+
| List configuration settings.
214+
215+
|===
245216

246217
[[transaction-commands]]
247218
== Transaction Commands
@@ -258,36 +229,70 @@ m| xref:clauses/transaction-clauses.adoc#query-terminate-transactions[TERMINATE
258229

259230
|===
260231

261-
[[writing-clauses]]
262-
== Writing clauses
263232

264-
These comprise clauses that write the data to the database.
233+
[[reading-hints]]
234+
== Reading hints
235+
236+
These comprise clauses used to specify planner hints when tuning a query.
237+
More details regarding the usage of these -- and query tuning in general -- can be found in xref::query-tuning/using.adoc[Planner hints and the USING keyword].
265238

266239
[options="header"]
267240
|===
268-
| Clause | Description
241+
| Hint | Description
269242

270-
m| xref::clauses/create.adoc[CREATE]
271-
| Create nodes and relationships.
243+
m| xref::query-tuning/using.adoc#query-using-index-hint[USING INDEX]
244+
| Index hints are used to specify which index, if any, the planner should use as a starting point.
272245

273-
m| xref::clauses/delete.adoc[DELETE]
274-
a|
275-
Delete nodes, relationships or paths.
276-
Any node to be deleted must also have all associated relationships explicitly deleted.
246+
m| xref::query-tuning/using.adoc#query-using-index-hint[USING INDEX SEEK]
247+
| Index seek hint instructs the planner to use an index seek for this clause.
277248

278-
m| xref::clauses/delete.adoc[DETACH DELETE]
279-
a|
280-
Delete a node or set of nodes.
281-
All associated relationships will automatically be deleted.
249+
m| xref::query-tuning/using.adoc#query-using-scan-hint[USING SCAN]
250+
| Scan hints are used to force the planner to do a label scan (followed by a filtering operation) instead of using an index.
282251

283-
m| xref::clauses/set.adoc[SET]
284-
| Update labels on nodes and properties on nodes and relationships.
252+
m| xref::query-tuning/using.adoc#query-using-join-hint[USING JOIN]
253+
| Join hints are used to enforce a join operation at specified points.
285254

286-
m| xref::clauses/remove.adoc[REMOVE]
287-
| Remove properties and labels from nodes and relationships.
255+
|===
288256

289-
m| xref::clauses/foreach.adoc[FOREACH]
290-
| Update data within a list, whether components of a path, or the result of aggregation.
257+
[[index-and-constraint-clauses]]
258+
== Index and constraint clauses
259+
260+
These comprise clauses to create, show, and drop indexes and constraints.
261+
262+
[options="header"]
263+
|===
264+
| Clause | Description
265+
266+
m| xref::indexes-for-search-performance.adoc#indexes-syntax[CREATE \| SHOW \| DROP INDEX]
267+
| Create, show or drop an index.
291268

269+
m| xref::constraints/syntax.adoc[CREATE \| SHOW \| DROP CONSTRAINT]
270+
| Create, show or drop a constraint.
271+
|===
272+
273+
[[administration-clauses]]
274+
== Administration clauses
275+
276+
These comprise clauses used to manage databases, aliases, servers, and role-based access control.
277+
More information about these topics can be found in the xref::administration/index.adoc[Administration] chapter.
278+
279+
[options="header"]
292280
|===
281+
| Clause | Description
282+
283+
m| xref::administration/databases.adoc[CREATE \| SHOW \| START \| ALTER \| STOP \| DROP [COMPOSITE\] DATABASE]
284+
| Create, show, start, alter, drop or stop a standard or composite database.
285+
286+
m| xref::administration/aliases.adoc[CREATE \| SHOW \| ALTER \| DROP ALIAS]
287+
| Create, show, alter or drop a local or remote database alias.
288+
289+
m| xref::administration/servers.adoc[ENABLE \| SHOW \| RENAME \| ALTER \| DROP SERVER]
290+
| Enable, show, rename, alter or drop a server.
291+
292+
m| xref::administration/servers.adoc#server-management-reallocate[REALLOCATE \| DEALLOCATE DATABASES]
293+
| Reallocates databases in, or deallocates databases from, a server.
294+
295+
| xref::administration/access-control/index.adoc[Access control]
296+
| Manage users, roles, and privileges for database, graph and sub-graph access control.
293297

298+
|===

0 commit comments

Comments
 (0)