Bureaucrats, editor, reviewer, Administrators
13,550
edits
Changes
Jump to navigation
Jump to search
no edit summary
|-
| valign='top' | '''Summary'''
|Returns all text nodes from the full-text index of the database <code>[[Database Module#Database ArgumentNodes|database node]] <code>$db]]</code> that contain the specified {{Mono|$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 {{Mono|$options}} argument can be used to overwrite the default full-text options. It can be specified as
* {{Mono|element(options)}}: <code><options/></code> 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 value:<br />
|-
| valign='top' | '''Summary'''
|Returns all full-text tokens stored in the index of the database <code>[[Database Module#Database ArgumentNodes|database node]] <code>$db]]</code>, along with their numbers of occurrences. {{Mono|$db}} may either be an <code>xs:string</code>, denoting the database name, or a node stored in the database.<br/>If {{Mono|$prefix}} is specified, the returned nodes will be refined to the strings starting with that prefix. The prefix will be tokenized according to the full-text used for creating the index.
|-
| valign='top' | '''Errors'''
|'''[[Database Module#Errors|BXDB0004]]''' is raised if the full-text index is not available.<br/>'''[[Database Module#Errors|BXDB0001]]''' is raised if {{Mono|$db}} references a node that is not stored in a database (i.e., references a main-memory XML fragment).<br/>'''[[Database Module#Errors|BXDB0002]]''' is raised if the addressed database cannot be opened.
|}
