Add descriptions of partitioned operators. (#847)

Co-authored-by: Jens Pryce-Åklundh <[email protected]>

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

@@ -55,6 +55,34 @@ RETURN "string" IS NORMALIZED
 | Introduction of an xref::syntax/operators.adoc#match-string-is-normalized[IS NORMALIZED] operator.
 The operator can be used to check if a `STRING` is normalized according to the specified normalization form, which can be of type `NFC`, `NFD`, `NFKC`, or `NFKD`.
 
+a|
+label:functionality[]
+label:new[]
+
+New operators:
+
+* xref:planning-and-tuning/operators/operators-detail.adoc#query-plan-partitioned-all-nodes-scan[`PartitionedAllNodesScan`]
+* xref:planning-and-tuning/operators/operators-detail.adoc#query-plan-partitioned-directed-all-relationships-scan[`PartitionedDirectedAllRelationshipsScan`]
+* xref::planning-and-tuning/operators/operators-detail.adoc#query-plan-partitioned-directed-relationship-index-scan[`PartitionedDirectedRelationshipIndexScan`]
+* xref::planning-and-tuning/operators/operators-detail.adoc#query-plan-partitioned-directed-relationship-index-seek[`PartitionedDirectedRelationshipIndexSeek`]
+* xref::planning-and-tuning/operators/operators-detail.adoc#query-plan-partitioned-directed-relationship-index-seek-by-range[`PartitionedDirectedRelationshipIndexSeekByRange`]
+* xref::planning-and-tuning/operators/operators-detail.adoc#query-plan-partitioned-directed-union-relationship-types-scan[`PartitionedDirectedUnionRelationshipTypesScan`]
+* xref::planning-and-tuning/operators/operators-detail.adoc#query-plan-partitioned-node-by-label-scan[`PartitionedNodeByLabelScan`]
+* xref::planning-and-tuning/operators/operators-detail.adoc#query-plan-partitioned-node-index-scan[`PartitionedNodeIndexScan`]
+* xref::planning-and-tuning/operators/operators-detail.adoc#query-plan-partitioned-node-index-seek[`PartitionedNodeIndexSeek`]
+* xref:planning-and-tuning/operators/operators-detail.adoc#query-plan-partitioned-node-index-seek-by-range[`PartitionedNodeIndexSeekByRange`]
+* xref::planning-and-tuning/operators/operators-detail.adoc#query-plan-partitioned-undirected-all-relationships-scan[`PartitionedUndirectedAllRelationshipsScan`]
+* xref::planning-and-tuning/operators/operators-detail.adoc#query-plan-partitioned-undirected-relationship-index-scan[`PartitionedUndirectedRelationshipIndexScan`]
+* xref::planning-and-tuning/operators/operators-detail.adoc#query-plan-partitioned-undirected-relationship-index-seek[`PartitionedUndirectedRelationshipIndexSeek`]
+* xref::planning-and-tuning/operators/operators-detail.adoc#query-plan-partitioned-undirected-relationship-index-seek-by-range[`PartitionedUndirectedRelationshipIndexSeekByRange`]
+* xref::planning-and-tuning/operators/operators-detail.adoc#query-plan-partitioned-undirected-relationship-type-scan[`PartitionedUndirectedRelationshipTypeScan`]
+*  xref::planning-and-tuning/operators/operators-detail.adoc#query-plan-partitioned-undirected-union-relationship-types-scan[`PartitionedUndirectedUnionRelationshipTypesScan`]
+* xref::planning-and-tuning/operators/operators-detail.adoc#query-plan-partitioned-union-node-by-labels-scan[`PartitionedUnionNodeByLabelsScan`]
+* xref::planning-and-tuning/operators/operators-detail.adoc#query-plan-partitioned-unwind[`PartitionedUnwind`]
+
+| Introduction of partitioned operators used by the xref:planning-and-tuning/runtimes/concepts.adoc#runtimes-parallel-runtime[parallel runtime].
+These operators segment the data and operate on each segment in parallel
+
 |===
 
 [[cypher-deprecations-additions-removals-5.16]]

modules/ROOT/pages/planning-and-tuning/operators/index.adoc

@@ -471,6 +471,130 @@ It is not eager.
 |
 |
 
+| xref::planning-and-tuning/operators/operators-detail.adoc#query-plan-partitioned-all-nodes-scan[PartitionedAllNodesScan]
+| Used by the parallel runtime to read all nodes from the node store.
+| label:yes[]
+|
+| label:new[Introduced in 5.17]
+
+| xref::planning-and-tuning/operators/operators-detail.adoc#query-plan-partitioned-directed-all-relationships-scan[PartitionedDirectedAllRelationshipsScan]
+| Used by the parallel runtime to fetch all relationships and their start and end nodes from the database.
+| label:yes[]
+|
+| label:new[Introduced in 5.17]
+
+
+| xref::planning-and-tuning/operators/operators-detail.adoc#query-plan-partitioned-directed-relationship-index-scan[PartitionedDirectedRelationshipIndexScan]
+| Used by the parallel runtime to examine all values stored in an index. 
+It returns all relationships with a particular type and a specified property, along with their start and end nodes.
+| label:yes[]
+|
+| label:new[Introduced in 5.17]
+
+| xref::planning-and-tuning/operators/operators-detail.adoc#query-plan-partitioned-directed-relationship-index-seek[PartitionedDirectedRelationshipIndexSeek]
+| Finds relationships and their start and end nodes using a parallel index seek.
+| label:yes[]
+|
+| label:new[Introduced in 5.17]
+
+| xref::planning-and-tuning/operators/operators-detail.adoc#query-plan-partitioned-directed-relationship-index-seek-by-range[PartitionedDirectedRelationshipIndexSeekByRange]
+| Finds relationships using a parallel index seek where the value of the of the specified relationship type property is within a given range.
+It also finds the start and end nodes of those relationships.
+| label:yes[]
+|
+| label:new[Introduced in 5.17]
+
+| xref::planning-and-tuning/operators/operators-detail.adoc#query-plan-partitioned-directed-relationship-types-scan[PartitionedDirectedRelationshipTypesScan]
+| Fetches all relationships with a specific type from the relationship type index using a parallel scan.
+It also fetches the start and end nodes of those relationships.
+| label:yes[]
+|
+| label:new[Introduced in 5.17]
+
+| xref::planning-and-tuning/operators/operators-detail.adoc#query-plan-partitioned-directed-union-relationship-types-scan[PartitionedDirectedUnionRelationshipTypesScan]
+| Fetches all relationships with at least one of the provided types from the relationship type index using a parallel scan.
+It also fetches the start and end nodes of those relationships.
+|
+|
+| label:new[Introduced in 5.17]
+
+| xref::planning-and-tuning/operators/operators-detail.adoc#query-plan-partitioned-node-by-label-scan[PartitionedNodeByLabelScan]
+| Used by the parallel runtime to fetch all nodes with a specific label from the node label index.
+| label:yes[]
+|
+| label:new[Introduced in 5.17]
+
+| xref::planning-and-tuning/operators/operators-detail.adoc#query-plan-partitioned-node-index-scan[PartitionedNodeIndexScan]
+| Used by the parallel runtime to examine all values stored in an index, returning all nodes with a particular label and a specified property.
+| label:yes[]
+|
+| label:new[Introduced in 5.17]
+
+| xref::planning-and-tuning/operators/operators-detail.adoc#query-plan-partitioned-node-index-seek[PartitionedNodeIndexSeek]
+| Used by the parallel runtime to find nodes using an index seek.
+| label:yes[]
+|
+| label:new[Introduced in 5.17]
+
+| xref::planning-and-tuning/operators/operators-detail.adoc#query-plan-partitioned-node-index-seek-by-range[PartitionedNodeIndexSeekByRange]
+| Finds nodes using a parallel index seek where the value of the specified property is within a given range.
+| label:yes[]
+|
+| label:new[Introduced in 5.17]
+
+| xref::planning-and-tuning/operators/operators-detail.adoc#query-plan-partitioned-undirected-all-relationships-scan[PartitionedUndirectedAllRelationshipsScan]
+| Used by the parallel runtime to fetch all relationships and their start and end nodes from the database.
+| label:yes[]
+|
+| label:new[Introduced in 5.17]
+
+
+| xref::planning-and-tuning/operators/operators-detail.adoc#query-plan-partitioned-undirected-relationship-index-scan[PartitionedUndirectedRelationshipIndexScan]
+| Used by the parallel runtime to examine all values stored in an index, returning all relationships with a particular relationship type and a specified property.
+It also returns the start and end nodes of those relationships.
+| label:yes[]
+|
+| label:new[Introduced in 5.17]
+
+| xref::planning-and-tuning/operators/operators-detail.adoc#query-plan-partitioned-undirected-relationship-index-seek[PartitionedUndirectedRelationshipIndexSeek]
+| Finds relationships and their start and end nodes using a parallel index seek.
+| label:yes[]
+|
+| label:new[Introduced in 5.17]
+
+| xref::planning-and-tuning/operators/operators-detail.adoc#query-plan-partitioned-undirected-relationship-index-seek-by-range[PartitionedUndirectedRelationshipIndexSeekByRange]
+| Finds relationships using a parallel index seek where the value of the specified relationship property type is within a given range.
+It also finds the start and end nodes of those relationships.
+| label:yes[]
+|
+| label:new[Introduced in 5.17]
+
+| xref::planning-and-tuning/operators/operators-detail.adoc#query-plan-partitioned-undirected-relationship-type-scan[PartitionedUndirectedRelationshipTypeScan]
+| Used by the parallel runtime to fetch all relationships with a specific type from the relationship type index.
+It also fetches the start and end nodes of those relationships.
+| label:yes[]
+|
+| label:new[Introduced in 5.17]
+
+| xref::planning-and-tuning/operators/operators-detail.adoc#query-plan-partitioned-undirected-union-relationship-types-scan[PartitionedUndirectedUnionRelationshipTypesScan]
+| Used by the parallel runtime to fetch all relationships with at least one of the provided types from the relationship type index.
+It also fetches the start and end nodes of those relationships.
+| label:yes[]
+|
+| label:new[Introduced in 5.17]
+
+| xref::planning-and-tuning/operators/operators-detail.adoc#query-plan-partitioned-union-node-by-labels-scan[PartitionedUnionNodeByLabelsScan]
+| Used by the parallel runtime to fetch all nodes that have at least one of the provided labels from the node label index.
+| label:yes[]
+|
+| label:new[Introduced in 5.17]
+
+| xref::planning-and-tuning/operators/operators-detail.adoc#query-plan-partitioned-unwind[PartitionedUnwind]
+| Used by the parallel runtime to return one row per item in a list.
+|
+|
+| label:new[Introduced in 5.17]
+
 | xref::planning-and-tuning/operators/operators-detail.adoc#query-plan-procedure-call[ProcedureCall]
 | Calls a procedure.
 |