Skip to content
Open
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
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@ The virtual table requires 4 SQL constraints to be set for all queries:
- `tocolumn`: The node id column where an edge goes to (must be integer).
- `root`: The root node id of the breadth-first traversal.

The virtual table also supports the following optional constraints for custom neighbour filtering and ordering:
- `whereclause`: An SQL WHERE clause applied to filter neighbours during traversal.
- `orderby`: An SQL ORDER BY clause applied to order neighbours during traversal.

The virtual table also provides the following columns that can be returned or used as contraints:
- `id`: The id of the current node being visited.
- `distance`: The shortest distance to the current node from the root node.
Expand Down