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 Module#Database Nodes|database node]] {{Code|$db}} that contain the specified {{Code|$terms}}.<br/>The options used for 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 overwrite the default full-text options. It , which can be either specified as<br/>* {{Code|element(options)}}: as children of an {{Code|<options/>}} must be used as root element, and the parameters are specified as child nodes, with the element name representing the key and the text node representing the valuee.g.:<br />
<pre class="brush:xml">
<options>
<key>key1 value<='value1'/key>
...
</options>
</pre>
* [[Map Module|as map structure]]: , which contains all parameters can be directly represented as key/value pairs:<br /><codepre class="brush:xml">map { "keykey1" := "valuevalue1", ... }</codepre><br/>This variant is more compact, but please note that the W3C’s specification of maps in XQuery is still work in progress.
The following keys are supported:
* {{Code|mode}}: determines the search mode (also called [http://www.w3.org/TR/xpath-full-text-10/#ftwords AnyAllOption]). Allowed values are {{Code|any}}, {{Code|any word}}, {{Code|all}}, {{Code|all words}}, and {{Code|phrase}}. {{Code|any}} is the default search mode.
