Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix parameter names for path functions #993

Merged
merged 3 commits into from
Nov 5, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions pages/advanced-algorithms/available-algorithms/path.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -479,8 +479,8 @@ MATCH (w:Wolf), (d:Dog), (c:Cat), (m:Mouse), (h:Human)
CALL path.subgraph_all(d, {
relationshipFilter: ["CATCHES>","<HATES"],
labelFilter: [">Mouse", ">Human"],
minLevel: 0,
maxLevel: 4
minHops: 0,
maxHops: 4
})
YIELD nodes, rels
RETURN nodes, rels;
Expand Down Expand Up @@ -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;
Expand Down Expand Up @@ -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. |
Expand Down Expand Up @@ -673,8 +673,8 @@ MATCH (w:Wolf), (d:Dog), (c:Cat), (m:Mouse), (h:Human)
CALL path.subgraph_nodes(d, {
relationshipFilter: ["CATCHES>","<HATES"],
labelFilter: [">Mouse", ">Human"],
minLevel: 0,
maxLevel: 4
minHops: 0,
maxHops: 4
})
YIELD nodes
RETURN nodes;
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -753,4 +753,4 @@ that depend on the internal database `id` values.
| "type": "node" |
| } |
+----------------------------+
```
```
Loading