Changes

{| width='100%'

| width='120' | '''Signatures'''

|{{Func|ft:search|$db as xs:string, $terms as item()*|text()*}}<br/>{{Func|ft:search|$db as xs:string, $terms as item()*, $options as map(*)?|text()*}}

| '''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.

** {{Code|max}}: specify 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'''

|{{Error|db:get|Database Module#Errors}} The addressed database does not exist or could not be opened.<br/>{{Error|db:no-index|Database Module#Errors}} the index is not available.<br/>{{Error|options|#Errors}} the fuzzy and wildcard option cannot be both specified.

| '''Examples'''

|

{| width='100%'

| width='120' | '''Signatures'''

|{{Func|ft:tokens|$db as xs:string|element(value)*}}<br/>{{Func|ft:tokens|$db as xs:string, $prefix as xs:string|element(value)*}}

| '''Summary'''

|Returns all full-text tokens stored in the index of the database {{Code|$db}}, along with their numbers of occurrences.<br/>If {{Code|$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.

| '''Errors'''

|{{Error|db:get|Database Module#Errors}} The addressed database does not exist or could not be opened.<br/>{{Error|db:no-index|Database Module#Errors}} the full-text index is not available.

| '''Examples'''

|Returns the number of occurrences for a single, specific index entry:

{| width='100%'

| width='120' | '''Signatures'''

|{{Func|ft:contains|$input as item()*, $terms as item()*|xs:boolean}}<br/>{{Func|ft:contains|$input as item()*, $terms as item()*, $options as map(*)?|xs:boolean}}

| '''Summary'''

|Checks if the specified {{Code|$input}} items contain the specified {{Code|$terms}}.<br/>The function does the same as the [[Full-Text]] expression {{Code|contains text}}, but options can be specified more dynamically. The {{Code|$options}} are the same as for {{Function||ft:search}}, and the following ones exist:

* {{Code|stemming}}: determines is tokens are stemmed. Allowed values are {{Code|true}} and {{Code|false}}. By default, stemming is turned off.

* {{Code|language}}: determines the language. This option is relevant for stemming tokens. All language codes are supported. The default language is {{Code|en}}.

| '''Errors'''

|{{Error|options|#Errors}} specified options are conflicting.

| '''Examples'''

|

{| width='100%'

| width='120' | '''Signatures'''

|{{Func|ft:count|$nodes as node()*|xs:integer}}

| '''Summary'''

|Returns the number of occurrences of the search terms specified in a full-text expression.

| '''Examples'''

|

{| width='100%'

| width='120' | '''Signatures'''

|{{Func|ft:score|$item as item()*|xs:double*}}

| '''Summary'''

|Returns the score values (0.0 - 1.0) that have been attached to the specified items. {{Code|0}} is returned a value if no score was attached.

| '''Examples'''

|

{| width='100%'

| width='120' | '''Signatures'''

|{{Func|ft:tokenize|$string as xs:string?|xs:string*}}<br/>{{Func|ft:tokenize|$string as xs:string?, $options as map(*)?|xs:string*}}

| '''Summary'''

|Tokenizes the given {{Code|$string}}, using the current default full-text options or the {{Code|$options}} specified as second argument, and returns a sequence with the tokenized string. The following options are available:

* {{Code|language}}: determines the language. This option is relevant for stemming tokens. All language codes are supported. The default language is {{Code|en}}.

The {{Code|$options}} argument can be used to control full-text processing.

| '''Examples'''

|

{| width='100%'

| width='120' | '''Signatures'''

|{{Func|ft:normalize|$string as xs:string?|xs:string}}<br/>{{Func|ft:normalize|$string as xs:string?, $options as map(*)?|xs:string}}

| '''Summary'''

|Normalizes the given {{Code|$string}}, using the current default full-text options or the {{Code|$options}} specified as second argument. The function accepts the same arguments as {{Function||ft:tokenize}}; special characters and separators will be preserved.

| '''Examples'''

|

{| width='100%'

| width='120' | '''Signatures'''

|{{Func|ft:thesaurus|$node as node(), $term as xs:string|xs:string*}}<br/>{{Func|ft:thesaurus|$node as node(), $term as xs:string, $options as map(*)?|xs:string*}}<br/>

| '''Summary'''

|Looks up a {{Code|$term}} in a [[Full-Text#Thesaurus|Thesaurus Structure]] supplied by {{Code|$node}}. The following {{Code|$options}} exist:

* {{Code|relationship}}: determines the relationship between terms

* {{Code|levels}}: determines the maximum number of levels to traverse

| '''Examples'''

| Returns {{Code|happy}} and {{Code|lucky}}:

{| width='100%'

| width='120' | '''Signatures'''

|{{Func|ft:mark|$nodes as node()*|node()*}}<br />{{Func|ft:mark|$nodes as node()*, $name as xs:string|node()*}}

| '''Summary'''

|Puts a marker element around the resulting {{Code|$nodes}} of a full-text request.<br />The default name of the marker element is {{Code|mark}}. An alternative name can be chosen via the optional {{Code|$name}} argument.<br />Please note that:

* The full-text expression that computes the token positions must be specified as argument of the <code>ft:mark()</code> function, as all position information is lost in subsequent processing steps. You may need to specify more than one full-text expression if you want to use the function in a FLWOR expression, as shown in Example 2.

* The supplied node must be a [[Database Module#Database Node|Database Node]]. As shown in Example 3, {{Code|update}} or {{Code|transform}} can be utilized to convert a fragment to the required internal representation.

| '''Examples'''

|'''Example 1''': The following query returns {{Code|&lt;XML&gt;&lt;mark&gt;hello&lt;/mark&gt; world&lt;/XML&gt;}}, if one text node of the database {{Code|DB}} has the value "hello world":

{| width='100%'

| width='120' | '''Signatures'''

|{{Func|ft:extract|$nodes as node()*|node()*}}<br />{{Func|ft:extract|$nodes as node()*, $name as xs:string|node()*}}<br />{{Func|ft:extract|$nodes as node()*, $name as xs:string, $length as xs:integer|node()*}}

| '''Summary'''

|Extracts and returns relevant parts of full-text results. It puts a marker element around the resulting {{Code|$nodes}} of a full-text index request and chops irrelevant sections of the result.<br />The default element name of the marker element is {{Code|mark}}. An alternative element name can be chosen via the optional {{Code|$name}} argument.<br />The default length of the returned text is {{Code|150}} characters. An alternative length can be specified via the optional {{Code|$length}} argument. Note that the effective text length may differ from the specified text due to formatting and readibility issues.<br />For more details on this function, please have a look at {{Function||ft:mark}}.

| '''Examples'''

|

! width="110"|Code

|Description

|{{Code|options}}

|Both wildcards and fuzzy search have been specified as search options.