Skip to content

Commit d2928b7

Browse files
Adding link to path query documentation (#209)
* Adding link to path query documentation Co-authored-by: GavinMendelGleason <GavinMendelGleason@users.noreply.github.com>
1 parent 0e9291e commit d2928b7

File tree

2 files changed

+2
-11
lines changed

2 files changed

+2
-11
lines changed

docs/api/woql.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1132,7 +1132,7 @@ Performs a path regular expression match on the graph
11321132
| Param | Type | Description |
11331133
| --- | --- | --- |
11341134
| subject | <code>string</code> | An IRI or variable that refers to an IRI representing the subject, i.e. the starting point of the path |
1135-
| pattern | <code>string</code> | (string) - A path regular expression describing a pattern through multiple edges of the graph Path regular expressions consist of a sequence of predicates and / or a set of alternatives, with quantification operators The characters that are interpreted specially are the following: | representing alternative choices , - representing a sequence of predcitates + - Representing a quantification of 1 or more of the preceding pattern in a sequence {min, max} - Representing at least min examples and at most max examples of the preceding pattern - Representing any predicate () - Parentheses, interpreted in the normal way to group clauses |
1135+
| pattern | <code>string</code> | (string) - A path regular expression describing a pattern through multiple edges of the graph (see: https://terminusdb.com/docs/index/terminusx-db/how-to-guides/path-queries) |
11361136
| object | <code>string</code> | An IRI or variable that refers to an IRI representing the object, i.e. ending point of the path |
11371137
| [resultVarName] | <code>string</code> | A variable in which the actual paths traversed will be stored |
11381138

lib/woql.js

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1053,16 +1053,7 @@ WOQL.true = function () {
10531053
* @param {string} subject - An IRI or variable that refers to an IRI representing the subject,
10541054
* i.e. the starting point of the path
10551055
* @param {string} pattern -(string) - A path regular expression describing a pattern through
1056-
* multiple edges of the graph
1057-
* Path regular expressions consist of a sequence of predicates and / or a set of alternatives,
1058-
* with quantification operators
1059-
* The characters that are interpreted specially are the following:
1060-
* | representing alternative choices
1061-
* , - representing a sequence of predcitates
1062-
* + - Representing a quantification of 1 or more of the preceding pattern in a sequence
1063-
* {min, max} - Representing at least min examples and at most max examples of the preceding pattern
1064-
* - Representing any predicate
1065-
* () - Parentheses, interpreted in the normal way to group clauses
1056+
* multiple edges of the graph (see: https://terminusdb.com/docs/index/terminusx-db/how-to-guides/path-queries)
10661057
* @param {string} object - An IRI or variable that refers to an IRI representing the object,
10671058
* i.e. ending point of the path
10681059
* @param {string} [resultVarName] - A variable in which the actual paths traversed will be stored

0 commit comments

Comments
 (0)