revi-archive/phorge-phorge
1
0
Fork 0
mirror of https://we.phorge.it/source/phorge.git synced 2024-11-26 16:52:41 +01:00
Code Issues Releases Wiki Activity

Document the "field present" and "field absent" operators in Ferret

Browse source 
Summary: Ref T13509. Adds documentation for the new operators.

Test Plan: Read documentation, tried examples, got sensible-seeming results.

Maniphest Tasks: T13509

Differential Revision: https://secure.phabricator.com/D21112
This commit is contained in:
epriestley 2020-04-14 10:30:35 -07:00
parent b3a8754013
commit 4655a5f059
1 changed files with 10 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
src/docs/user/userguide/search.diviner
View file

@ -140,6 +140,7 @@ some special syntax. These features are supported:
- Quoted terms with `"platypus attorney"`. - Quoted terms with `"platypus attorney"`.
- Matching entire fields with `=platypus`. - Matching entire fields with `=platypus`.
- Combining features with `title:~"platypus attorney"`. - Combining features with `title:~"platypus attorney"`.
- Testing a field for presence (`title:~`) or absence (`title:-`).
See below for more detail. See below for more detail.
@ -169,7 +170,7 @@ or `title:"platypus attorney"`. These scopes are also supported:
- `title:...` searches titles. - `title:...` searches titles.
- `body:...` searches bodies (descriptions or summaries). - `body:...` searches bodies (descriptions or summaries).
- `core:...` searches titles and bodies, but not comments. - `core:...` searches titles and bodies, but not comments.
- `comments:...` searches only comments. - `comment:...` searches only comments.
**Filtering Matches**: You can remove documents which match certain terms from **Filtering Matches**: You can remove documents which match certain terms from
the result set with `-`. For example: `platypus -mammal`. Documents which match the result set with `-`. For example: `platypus -mammal`. Documents which match
@ -182,3 +183,11 @@ find documents with longer titles, like "Not a Warp Drive". The `=` operator
requires that the entire field match the query exactly, so //only// documents requires that the entire field match the query exactly, so //only// documents
exactly titled "Warp Drive" will be matched by the query (but note that the exactly titled "Warp Drive" will be matched by the query (but note that the
query is still case insensitive). query is still case insensitive).
**Present and Absent Fields**: To find objects with //any// value in a
particular field, use `field:~` as a search term (with no additional text). For
example, searching Maniphest for `comment:~` will find tasks with any comments.
If you want to find objects that are //missing// a particular field, use
`field:-` with no additional argument. For example, searching Maniphest for
`body:-` will find tasks with no description.