Skip to content

Commit

Permalink
Fix parameter names for path functions (#993)
Browse files Browse the repository at this point in the history
Replace minLevel/maxLevel by minHops/maxHops

Co-authored-by: Ivan Milinović <44698587+imilinovic@users.noreply.github.com>
Co-authored-by: Katarina Supe <61758502+katarinasupe@users.noreply.github.com>
3 people authored Nov 5, 2024

Unverified

This user has not yet uploaded their public signing key.
1 parent 2a27813 commit 829189d
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions pages/advanced-algorithms/available-algorithms/path.mdx
Original file line number Diff line number Diff line change
@@ -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>","<HATES"],
labelFilter: [">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>","<HATES"],
labelFilter: [">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" |
| } |
+----------------------------+
```
```

1 comment on commit 829189d

@vercel
Copy link

@vercel vercel bot commented on 829189d Nov 5, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

documentation – ./

documentation-memgraph.vercel.app
documentation-git-main-memgraph.vercel.app
nextra-docs-blush.vercel.app

Please sign in to comment.