Skip to content

Commit 5a81f73

Browse files
docs(v1): improve search docs (#1848)
1 parent b119757 commit 5a81f73

2 files changed

Lines changed: 13 additions & 11 deletions

File tree

‎docs/03-apis/api-v1/reading-and-searching-resources.md‎

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -310,32 +310,32 @@ operators:
310310

311311
Explanation of the comparison operators:
312312

313-
* `EQ`: checks if a resource's value *equals* the search value. In
313+
* `EQ` (equal): checks if a resource's value *equals* the search value. In
314314
case of a text value type, it checks for identity of the strings
315315
compared. In case of a date value type, equality is given if the
316316
dates overlap in any way. Since dates are internally always
317317
treated as periods, equality is given if a date value's period
318318
ends after or equals the start of the defined period and a date
319319
value's period starts before or equals the end of the defined
320320
period.
321-
* `!EQ`: checks if a resource's value *does not equal* the search
321+
* `!EQ` (not equal): checks if a resource's value *does not equal* the search
322322
value. In case of a text value type, it checks if the compared
323323
strings are different. In case of a date value type, inequality
324324
is given if the dates do not overlap in any way, meaning that a
325325
date starts after the end of the defined period or ends before
326326
the beginning of the defined period (dates are internally always
327327
treated as periods, see above).
328-
* `GT`: checks if a resource's value is *greater than* the search
328+
* `GT` (greater than): checks if a resource's value is *greater than* the search
329329
value. In case of a date value type, it assures that a period
330330
begins after the indicated period's end.
331-
* `GT_EQ`: checks if a resource's value *equals or is greater
331+
* `GT_EQ` (greater than or equal): checks if a resource's value *equals or is greater
332332
than* the search value. In case of a date value type, it assures
333333
that the periods overlap in any way (see `EQ`) **or** that the
334334
period starts after the indicated period's end (see `GT`).
335-
* `LT`: checks if a resource's value is *lower than* the search
335+
* `LT` (less than): checks if a resource's value is *lower than* the search
336336
value. In case of a date value type, it assures that a period
337337
ends before the indicated period's start.
338-
* `LT_EQ`: checks if a resource's value *equals or is lower than*
338+
* `LT_EQ` (less than or equal): checks if a resource's value *equals or is lower than*
339339
the search value. In case of a date value type, it assures that
340340
the periods overlap in any way (see `EQ`) **or** that the period
341341
ends before the indicated period's start (see `LT`).
@@ -344,12 +344,13 @@ Explanation of the comparison operators:
344344
value when using EXISTS: "searchval="**. Otherwise, the query
345345
syntax rules would be violated.
346346
* `MATCH`: checks if a resource's text value *matches* the search
347-
value. The behaviour depends on the used triplestore's full text
348-
index, see [Lucene](../../08-lucene/index.md).
347+
value, see [Lucene Query Parser Syntax](../../08-lucene/lucene-query-parser-syntax.md).
349348
* `LIKE`: checks if the search value is contained in a resource's
350-
text value.
351-
* `!LIKE`: checks if the search value is not contained in a
352-
resource's text value.
349+
text value using the SPARQL [REGEX](https://www.w3.org/TR/sparql11-query/#func-regex) function,
350+
thus supporting regular expressions.
351+
* `!LIKE` (not like): checks if the search value is not contained in a
352+
resource's text value using the SPARQL [REGEX](https://www.w3.org/TR/sparql11-query/#func-regex) function,
353+
thus supporting regular expressions.
353354
* `MATCH_BOOLEAN`: checks if a resource's text value *matches* the
354355
provided list of positive (exist) and negative (do not exist)
355356
terms. The list takes this form: `([+-]term\s)+`.

‎docs/08-lucene/index.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,3 +22,4 @@ License along with DSP. If not, see <http://www.gnu.org/licenses/>.
2222
The Lucene full-text index provided by the triplestore is used to perform full-text searches in Knora.
2323
The exact behavior can be different depending on the triplestore, e.g., GraphDB or Fuseki.
2424

25+
* [Lucene Query Parser Syntax](lucene-query-parser-syntax.md)

0 commit comments

Comments
 (0)