Bureaucrats, editor, reviewer, Administrators
13,550
edits
Changes
Jump to navigation
Jump to search
→ft:search
|-
| '''Summary'''
|Returns all text nodes from the full-text index of the database {{Code|$db}} that contain the specified {{Code|$terms}}.<br/>The options used for tokenizing the input and building the full-text will also be applied to the search terms. As an example, if the index terms have been stemmed, the search string will be stemmed as well.
The {{Code|$options}} argument can be used to control full-text processing. Options can be either specified<br/>
* as children of an {{Code|<options/>}} element, e.g.:
{ "key1": "value1", ... }
</pre>
The following options are supported (the introduction on [[Full-Text]] processing gives you some examplesequivalent expressions in the XQuery Full-Text notation):* {{Code|mode}}: determines the mode how query terms tokens are searched. Allowed values are {{Code|any}}, {{Code|any word}}, {{Code|all}}, {{Code|all words}}, and {{Code|phrase}}. {{Code|any}} is the default search mode.
* {{Code|fuzzy}}: turns fuzzy querying on or off. Allowed values are an empty string or {{Code|true}}, or {{Code|false}}. By default, fuzzy querying is turned off.
* {{Code|wildcards}}: turns wildcard querying on or off. Allowed values are an empty string or {{Code|true}}, or {{Code|false}}. By default, wildcard querying is turned off.
The following options have been added in {{Version|7.8}}:
* {{Code|ordered}}: requires that all terms tokens occur in the order in which they are specified. Allowed values are {{Code|true}} and {{Code|false}}. The default is {{Code|false}}.* {{Code|content}}: specifies that the matched terms tokens need to occur at the beginning or end of a searched string, or need to cover the entire string. Allowed values are {{Code|start}}, {{Code|end}}, and {{Code|entire}}. By default, this the option is turned off.* {{Code|scope}}: defines the scope in which tokens need to occurmust be located. The option has the following sub options:** {{Code|same}}: can be set to {{Code|true}} or {{Code|false}}; it . It specifies if tokens need to occur in the same or different units.
** {{Code|unit}}: can be {{Code|sentence}} or {{Code|paragraph}}. It specifies the unit for finding tokens.
* {{Code|window}}: sets up a window in which all tokens must be located. By default, the option is turned off. It has following sub options:
** {{Code|size}}: specifies the size of the window in terms of ''units''.
** {{Code|unit}}: can be {{Code|sentences}}, {{Code|sentences}}, or {{Code|paragraphs}}. The default is {{Code|words}}.
* {{Code|window}}: specifies the distance in which tokens must occur. By default, the option is turned off. It has following sub options:
** {{Code|min}}: specifies the minimum distance in terms of ''units''. The default is {{Code|0}}.
** {{Code|max}}: specifies the maximum distance in terms of ''units''. The default is {{Code|∞}}.
** {{Code|unit}}: can be {{Code|words}}, {{Code|sentences}}, or {{Code|paragraphs}}. The default is {{Code|words}}.
|-
| '''Errors'''
