From d8fea33843975709090609a50c9f8f9a0dc3e0a9 Mon Sep 17 00:00:00 2001 From: thomas-tran-de <106731411+thomas-tran-de@users.noreply.github.com> Date: Tue, 17 Sep 2024 13:19:33 +0200 Subject: [PATCH] Fix parameter names for path functions Replace minLevel/maxLevel by minHops/maxHops --- .../available-algorithms/path.mdx | 26 +++++++++---------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/pages/advanced-algorithms/available-algorithms/path.mdx b/pages/advanced-algorithms/available-algorithms/path.mdx index d042007f1..173bfd747 100644 --- a/pages/advanced-algorithms/available-algorithms/path.mdx +++ b/pages/advanced-algorithms/available-algorithms/path.mdx @@ -371,8 +371,8 @@ procedure uses bfs. | Name | Type | Default | Description | |- |- |- |- | - | minLevel | Int | 0 | The minimum number of hops in the traversal. Set to `0` if the start node should be included in the subgraph, or `1` otherwise. | - | maxLevel | Int | -1 | The maximum number of hops in the traversal. | + | minHops | Int | 0 | The minimum number of hops in the traversal. Set to `0` if the start node should be included in the subgraph, or `1` otherwise. | + | maxHops | Int | -1 | The maximum number of hops in the traversal. | | relationshipFilter | List | [ ] | List of relationships which the subgraph formation will follow. Relationships can be filtered using the notation described below. | | labelFilter | List | [ ] | List of labels which will define filtering. Labels @@ -479,8 +479,8 @@ MATCH (w:Wolf), (d:Dog), (c:Cat), (m:Mouse), (h:Human) CALL path.subgraph_all(d, { relationshipFilter: ["CATCHES>","Mouse", ">Human"], - minLevel: 0, - maxLevel: 4 + minHops: 0, + maxHops: 4 }) YIELD nodes, rels RETURN nodes, rels; @@ -524,8 +524,8 @@ MATCH (w:Wolf), (d:Dog), (c:Cat), (m:Mouse), (h:Human) CALL path.subgraph_all(d, { relationshipFilter: ["<"], labelFilter: ["-Human"], - minLevel: 0, - maxLevel: 4 + minHops: 0, + maxHops: 4 }) YIELD nodes, rels RETURN nodes, rels; @@ -573,8 +573,8 @@ relationship and label filters, and ensures each node is visited only once. | Name | Type | Default | Description | |- |- |- |- | - | minLevel | Int | 0 | The minimum number of hops in the traversal. Set to `0` if the start node should be included in the subgraph, or `1` otherwise. | - | maxLevel | Int | -1 | The maximum number of hops in the traversal. | + | minHops | Int | 0 | The minimum number of hops in the traversal. Set to `0` if the start node should be included in the subgraph, or `1` otherwise. | + | maxHops | Int | -1 | The maximum number of hops in the traversal. | | relationshipFilter | List | [ ] | List of relationships which the subgraph formation will follow. Explained in detail below. | | labelFilter | List | [ ] | List of labels which will define filtering. Explained in detail below. | | filterStartNode | Bool | False | Whether the labelFilter applies to the start nodes. | @@ -673,8 +673,8 @@ MATCH (w:Wolf), (d:Dog), (c:Cat), (m:Mouse), (h:Human) CALL path.subgraph_nodes(d, { relationshipFilter: ["CATCHES>","Mouse", ">Human"], - minLevel: 0, - maxLevel: 4 + minHops: 0, + maxHops: 4 }) YIELD nodes RETURN nodes; @@ -719,8 +719,8 @@ MATCH (w:Wolf), (d:Dog), (c:Cat), (m:Mouse), (h:Human) CALL path.subgraph_nodes(d, { relationshipFilter: ["<"], labelFilter: ["-Human"], - minLevel: 0, - maxLevel: 4 + minHops: 0, + maxHops: 4 }) YIELD nodes RETURN nodes @@ -753,4 +753,4 @@ that depend on the internal database `id` values. | "type": "node" | | } | +----------------------------+ - ``` \ No newline at end of file + ```