Difference between revisions of "Full-Text Module"
Line 8: | Line 8: | ||
==ft:search== | ==ft:search== | ||
+ | |||
+ | {{Mark|Updated with Version 9.6:}} new {{Code|errors}} option. | ||
{| width='100%' | {| width='100%' | ||
Line 17: | Line 19: | ||
|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. | |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. The following options are supported (the introduction on [[Full-Text]] processing gives you equivalent expressions in the XQuery Full-Text notation): | The {{Code|$options}} argument can be used to control full-text processing. The following options are supported (the introduction on [[Full-Text]] processing gives you equivalent expressions in the XQuery Full-Text notation): | ||
− | * {{Code|mode}}: | + | * {{Code|mode}}: determine the mode how 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| | + | * {{Code|wildcards}}: turn wildcard querying on or off. Allowed values are {{Code|true}} and {{Code|false}}. By default, wildcard querying is turned off. |
− | * {{Code| | + | * {{Code|fuzzy}}: turn fuzzy querying on or off. Allowed values are {{Code|true}} and {{Code|false}}. By default, fuzzy querying is turned off. |
− | * {{Code|ordered}}: | + | * {{Code|errors}}: control the maximum number of tolerated errors for fuzzy querying. By default, {{Code|0}} is assigned (see [[Full-Text#Fuzzy_Querying|Fuzzy Querying]] for more details). |
− | * {{Code|content}}: | + | * {{Code|ordered}}: indicate if all tokens must occur in the order in which they are specified. Allowed values are {{Code|true}} and {{Code|false}}. The default is {{Code|false}}. |
− | * {{Code|scope}}: | + | * {{Code|content}}: specify that the matched 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, the option is turned off. |
+ | * {{Code|scope}}: define the scope in which tokens must be located. The option has following sub options: | ||
** {{Code|same}}: can be set to {{Code|true}} or {{Code|false}}. It specifies if tokens need to occur in the same or different units. | ** {{Code|same}}: can be set to {{Code|true}} or {{Code|false}}. 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|unit}}: can be {{Code|sentence}} or {{Code|paragraph}}. It specifies the unit for finding tokens. | ||
− | * {{Code|window}}: | + | * {{Code|window}}: set up a window in which all tokens must be located. By default, the option is turned off. It has following sub options: |
− | ** {{Code|size}}: | + | ** {{Code|size}}: specify 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|unit}}: can be {{Code|sentences}}, {{Code|sentences}} or {{Code|paragraphs}}. The default is {{Code|words}}. | ||
− | * {{Code|distance}}: | + | * {{Code|distance}}: specify the distance in which tokens must occur. By default, the option is turned off. It has following sub options: |
− | ** {{Code|min}}: | + | ** {{Code|min}}: specify the minimum distance in terms of ''units''. The default is {{Code|0}}. |
− | ** {{Code|max}}: | + | ** {{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}}. | ** {{Code|unit}}: can be {{Code|words}}, {{Code|sentences}} or {{Code|paragraphs}}. The default is {{Code|words}}. | ||
|- | |- | ||
Line 61: | Line 64: | ||
==ft:contains== | ==ft:contains== | ||
+ | |||
+ | {{Mark|Updated with Version 9.6:}} new {{Code|errors}} option. | ||
{| width='100%' | {| width='100%' | ||
Line 68: | Line 73: | ||
|- | |- | ||
| '''Summary''' | | '''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 [[#ft:search|ft:search]], and the following ones | + | |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 [[#ft:search|ft:search]], and the following ones exist: |
− | * {{Code|case}}: determines how character case is processed. Allowed values are {{Code|insensitive}}, {{Code|sensitive}}, {{Code|upper}} and {{Code|lower}}. By default, search is case insensitive. | + | * {{Code|case}}: determines how character case is processed. Allowed values are {{Code|insensitive}}, {{Code|sensitive}}, {{Code|upper}} and {{Code|lower}}. By default, search is case-insensitive. |
* {{Code|diacritics}}: determines how diacritical characters are processed. Allowed values are {{Code|insensitive}} and {{Code|sensitive}}. By default, search is diacritical insensitive. | * {{Code|diacritics}}: determines how diacritical characters are processed. Allowed values are {{Code|insensitive}} and {{Code|sensitive}}. By default, search is diacritical insensitive. | ||
* {{Code|stemming}}: determines is tokens are stemmed. Allowed values are {{Code|true}} and {{Code|false}}. By default, stemming is turned off. | * {{Code|stemming}}: determines is tokens are stemmed. Allowed values are {{Code|true}} and {{Code|false}}. By default, stemming is turned off. | ||
Line 239: | Line 244: | ||
=Changelog= | =Changelog= | ||
+ | |||
+ | ; Version 9.6 | ||
+ | * Updated: [[#ft:search|ft:search]], [[#ft:contains|ft:contains]]: new {{Code|errors}} option. | ||
; Version 9.1 | ; Version 9.1 |
Revision as of 11:25, 15 March 2021
This XQuery Module extends the Full-Text features of BaseX: The index can be directly accessed, full-text results can be marked with additional elements, or the relevant parts can be extracted. Moreover, the score value, which is generated by the contains text
expression, can be explicitly requested from items.
Contents
Conventions
All functions and errors in this module are assigned to the http://basex.org/modules/ft
namespace, which is statically bound to the ft
prefix.
Functions
ft:search
Template:Mark new errors
option.
Signatures | ft:search($db as xs:string, $terms as item()*) as text()* ft:search($db as xs:string, $terms as item()*, $options as map(*)?) as text()*
|
Summary | Returns all text nodes from the full-text index of the database $db that contain the specified $terms .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
|
Errors | db:open : The addressed database does not exist or could not be opened.db:no-index : the index is not available.options : the fuzzy and wildcard option cannot be both specified.
|
Examples |
<syntaxhighlight lang="xquery"> ft:search("db", ("A", "B"), map { "mode": "all words", "distance": map { "max": "5", "unit": "words" } }) </syntaxhighlight>
<syntaxhighlight lang="xquery"> let $terms := "Hello Worlds" let $fuzzy := true() for $db in 1 to 3 let $dbname := 'DB' || $db return ft:search($dbname, $terms, map { 'fuzzy': $fuzzy })/.. </syntaxhighlight> |
ft:contains
Template:Mark new errors
option.
Signatures | ft:contains($input as item()*, $terms as item()*) as xs:boolean ft:contains($input as item()*, $terms as item()*, $options as map(*)?) as xs:boolean
|
Summary | Checks if the specified $input items contain the specified $terms .The function does the same as the Full-Text expression contains text , but options can be specified more dynamically. The $options are the same as for ft:search, and the following ones exist:
|
Errors | options : specified options are conflicting.
|
Examples |
<syntaxhighlight lang="xquery"> ft:contains("John Doe", ("jack", "john"), map { "mode": "any" }) </syntaxhighlight>
<syntaxhighlight lang="xquery"> (true(), false()) ! ft:contains("Häuser", "Haus", map { 'stemming': ., 'language':'de' }) </syntaxhighlight> |
ft:mark
Signatures | ft:mark($nodes as node()*) as node()* ft:mark($nodes as node()*, $name as xs:string) as node()*
|
Summary | Puts a marker element around the resulting $nodes of a full-text request.The default name of the marker element is mark . An alternative name can be chosen via the optional $name argument.Please note that:
|
Examples | Example 1: The following query returns <XML><mark>hello</mark> world</XML> , if one text node of the database DB has the value "hello world":
<syntaxhighlight lang="xquery"> ft:mark(db:open('DB')//*[text() contains text 'hello']) </syntaxhighlight> Example 2: The following expression loops through the first ten full-text results and marks the results in a second expression: <syntaxhighlight lang="xquery"> let $start := 1 let $end := 10 let $term := 'welcome' for $ft in (db:open('DB')//*[text() contains text { $term }])[position() = $start to $end] return element hit { ft:mark($ft[text() contains text { $term }]) }
</syntaxhighlight>
Example 3: The following expression returns |
ft:extract
Signatures | ft:extract($nodes as node()*) as node()* ft:extract($nodes as node()*, $name as xs:string) as node()* ft:extract($nodes as node()*, $name as xs:string, $length as xs:integer) as node()*
|
Summary | Extracts and returns relevant parts of full-text results. It puts a marker element around the resulting $nodes of a full-text index request and chops irrelevant sections of the result.The default element name of the marker element is mark . An alternative element name can be chosen via the optional $name argument.The default length of the returned text is 150 characters. An alternative length can be specified via the optional $length argument. Note that the effective text length may differ from the specified text due to formatting and readibility issues.For more details on this function, please have a look at ft:mark. |
Examples |
<syntaxhighlight lang="xquery"> ft:extract(db:open('DB')//*[text() contains text 'hello'], 'b', 1) </syntaxhighlight> |
ft:count
Signatures | ft:count($nodes as node()*) as xs:integer
|
Summary | Returns the number of occurrences of the search terms specified in a full-text expression. |
Examples |
|
ft:score
Signatures | ft:score($item as item()*) as xs:double*
|
Summary | Returns the score values (0.0 - 1.0) that have been attached to the specified items. 0 is returned a value if no score was attached.
|
Examples |
|
ft:tokens
Signatures | ft:tokens($db as xs:string) as element(value)* ft:tokens($db as xs:string, $prefix as xs:string) as element(value)*
|
Summary | Returns all full-text tokens stored in the index of the database $db , along with their numbers of occurrences.If $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 | db:open : The addressed database does not exist or could not be opened.db:no-index : the full-text index is not available.
|
Examples | Returns the number of occurrences for a single, specific index entry:
<syntaxhighlight lang="xquery"> let $term := ft:tokenize($term) return number(ft:tokens('db', $term)[. = $term]/@count) </syntaxhighlight> |
ft:tokenize
Signatures | ft:tokenize($string as xs:string?) as xs:string* ft:tokenize($string as xs:string?, $options as map(*)?) as xs:string*
|
Summary | Tokenizes the given $string , using the current default full-text options or the $options specified as second argument, and returns a sequence with the tokenized string. The following options are available:
The |
Examples |
|
ft:normalize
Signatures | ft:normalize($string as xs:string?) as xs:string ft:normalize($string as xs:string?, $options as map(*)?) as xs:string
|
Summary | Normalizes the given $string , using the current default full-text options or the $options specified as second argument. The function expects the same arguments as ft:tokenize.
|
Examples |
|
Errors
Code | Description |
---|---|
options
|
Both wildcards and fuzzy search have been specified as search options. |
Changelog
- Version 9.6
- Updated: ft:search, ft:contains: new
errors
option.
- Version 9.1
- Updated: ft:tokenize and ft:normalize can be called with empty sequence.
- Version 9.0
- Updated: error codes updated; errors now use the module namespace
- Version 8.0
- Added: ft:contains, ft:normalize
- Updated: Options added to ft:tokenize
- Version 7.8
- Added: ft:contains
- Updated: Options added to ft:search
- Version 7.7
- Updated: the functions no longer accept Database Nodes as reference. Instead, the name of a database must now be specified.
- Version 7.2
- Updated: ft:search (second argument generalized, third parameter added)
- Version 7.1
- Added: ft:tokens, ft:tokenize