Difference between revisions of "Full-Text Module"
(40 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
− | This [[Module Library|XQuery Module]] extends the [ | + | This [[Module Library|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 {{Code|contains text}} expression, can be explicitly requested from items. |
=Conventions= | =Conventions= | ||
− | All functions in this module are assigned to the | + | All functions and errors in this module are assigned to the <code><nowiki>http://basex.org/modules/ft</nowiki></code> namespace, which is statically bound to the {{Code|ft}} prefix.<br/> |
− | |||
=Functions= | =Functions= | ||
Line 13: | Line 12: | ||
|- | |- | ||
| width='120' | '''Signatures''' | | 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 | + | |{{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''' | | '''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. | |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 {{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 following options are supported (the introduction on [[Full-Text]] processing gives you equivalent expressions in the XQuery Full-Text notation): | ||
* {{Code|mode}}: determines 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|mode}}: determines 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|fuzzy}}: turns fuzzy querying on or off. Allowed values are {{Code|true}} and {{Code|false}}. By default, fuzzy querying is turned off. | * {{Code|fuzzy}}: turns fuzzy querying on or off. Allowed values are {{Code|true}} and {{Code|false}}. By default, fuzzy querying is turned off. | ||
* {{Code|wildcards}}: turns wildcard querying on or off. Allowed values are {{Code|true}} and {{Code|false}}. By default, wildcard querying is turned off. | * {{Code|wildcards}}: turns wildcard querying on or off. Allowed values are {{Code|true}} and {{Code|false}}. By default, wildcard querying is turned off. | ||
− | |||
* {{Code|ordered}}: requires that all tokens occur in the order in which they are specified. Allowed values are {{Code|true}} and {{Code|false}}. The default is {{Code|false}}. | * {{Code|ordered}}: requires that all 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 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|content}}: specifies 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. | ||
Line 48: | Line 34: | ||
|- | |- | ||
| '''Errors''' | | '''Errors''' | ||
− | |{{Error| | + | |{{Error|db:open|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''' | | '''Examples''' | ||
| | | | ||
* {{Code|ft:search("DB", "QUERY")}}: Return all text nodes of the database {{Code|DB}} that contain the term {{Code|QUERY}}. | * {{Code|ft:search("DB", "QUERY")}}: Return all text nodes of the database {{Code|DB}} that contain the term {{Code|QUERY}}. | ||
− | * Return all text nodes of the database {{Code|DB}} that contain the numbers {{Code|2010}} and {{Code| | + | * Return all text nodes of the database {{Code|DB}} that contain the numbers {{Code|2010}} and {{Code|2020}}:<br/><code>ft:search("DB", ("2010", "2020"), map { 'mode': 'all' })</code> |
* Return text nodes that contain the terms {{Code|A}} and {{Code|B|}} in a distance of at most 5 words: | * Return text nodes that contain the terms {{Code|A}} and {{Code|B|}} in a distance of at most 5 words: | ||
− | < | + | <syntaxhighlight lang="xquery"> |
− | ft:search("db", ("A", "B"), { | + | ft:search("db", ("A", "B"), map { |
"mode": "all words", | "mode": "all words", | ||
− | "distance": { | + | "distance": map { |
"max": "5", | "max": "5", | ||
"unit": "words" | "unit": "words" | ||
} | } | ||
}) | }) | ||
− | </ | + | </syntaxhighlight> |
* Iterate over three databases and return all elements containing terms similar to {{Code|Hello World}} in the text nodes: | * Iterate over three databases and return all elements containing terms similar to {{Code|Hello World}} in the text nodes: | ||
− | < | + | <syntaxhighlight lang="xquery"> |
let $terms := "Hello Worlds" | let $terms := "Hello Worlds" | ||
let $fuzzy := true() | let $fuzzy := true() | ||
− | |||
for $db in 1 to 3 | for $db in 1 to 3 | ||
let $dbname := 'DB' || $db | let $dbname := 'DB' || $db | ||
− | return ft:search($dbname, $terms, $ | + | return ft:search($dbname, $terms, map { 'fuzzy': $fuzzy })/.. |
− | </ | + | </syntaxhighlight> |
|} | |} | ||
==ft:contains== | ==ft:contains== | ||
− | |||
− | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
| width='120' | '''Signatures''' | | 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 | + | |{{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''' | | '''Summary''' | ||
Line 92: | Line 75: | ||
|- | |- | ||
| '''Errors''' | | '''Errors''' | ||
− | |{{Error| | + | |{{Error|options|#Errors}} specified options are conflicting. |
|- | |- | ||
| '''Examples''' | | '''Examples''' | ||
| | | | ||
* Checks if {{Code|jack}} or {{Code|john}} occurs in the input string {{Code|John Doe}}: | * Checks if {{Code|jack}} or {{Code|john}} occurs in the input string {{Code|John Doe}}: | ||
− | < | + | <syntaxhighlight lang="xquery"> |
− | ft:contains("John Doe", ("jack", "john"), { "mode": "any" }) | + | ft:contains("John Doe", ("jack", "john"), map { "mode": "any" }) |
− | </ | + | </syntaxhighlight> |
* Calls the function with stemming turned on and off: | * Calls the function with stemming turned on and off: | ||
− | < | + | <syntaxhighlight lang="xquery"> |
− | (true(), false()) ! ft:contains("Häuser", "Haus", { 'stemming': ., 'language':'de' }) | + | (true(), false()) ! ft:contains("Häuser", "Haus", map { 'stemming': ., 'language':'de' }) |
− | </ | + | </syntaxhighlight> |
|} | |} | ||
==ft:mark== | ==ft:mark== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 113: | Line 97: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Puts a marker element around the resulting {{Code|$nodes}} of a full-text | + | |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''' | | '''Examples''' | ||
|'''Example 1''': The following query returns {{Code|<XML><mark>hello</mark> world</XML>}}, if one text node of the database {{Code|DB}} has the value "hello world": | |'''Example 1''': The following query returns {{Code|<XML><mark>hello</mark> world</XML>}}, if one text node of the database {{Code|DB}} has the value "hello world": | ||
− | < | + | <syntaxhighlight lang="xquery"> |
ft:mark(db:open('DB')//*[text() contains text 'hello']) | 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: | '''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 $start := 1 | ||
let $end := 10 | let $end := 10 | ||
Line 131: | Line 115: | ||
ft:mark($ft[text() contains text { $term }]) | ft:mark($ft[text() contains text { $term }]) | ||
} | } | ||
− | </ | + | </syntaxhighlight> |
− | '''Example 3''': The following expression returns | + | '''Example 3''': The following expression returns <code><xml>hello <b>word</b></xml></code>: |
− | < | + | <syntaxhighlight lang="xquery"> |
− | copy $p := | + | copy $p := <xml>hello world</xml> |
modify () | modify () | ||
− | return ft:mark($p[text() contains text 'word'], 'b')</ | + | return ft:mark($p[text() contains text 'word'], 'b') |
+ | </syntaxhighlight> | ||
|} | |} | ||
==ft:extract== | ==ft:extract== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 146: | Line 132: | ||
|- | |- | ||
| '''Summary''' | | '''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 | + | |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 [[#ft:mark|ft:mark]]. |
|- | |- | ||
| '''Examples''' | | '''Examples''' | ||
| | | | ||
* The following query may return {{Code|<XML>...<b>hello</b>...<XML>}} if a text node of the database {{Code|DB}} contains the string "hello world": | * The following query may return {{Code|<XML>...<b>hello</b>...<XML>}} if a text node of the database {{Code|DB}} contains the string "hello world": | ||
− | < | + | <syntaxhighlight lang="xquery"> |
ft:extract(db:open('DB')//*[text() contains text 'hello'], 'b', 1) | ft:extract(db:open('DB')//*[text() contains text 'hello'], 'b', 1) | ||
− | </ | + | </syntaxhighlight> |
|} | |} | ||
Line 171: | Line 157: | ||
==ft:score== | ==ft:score== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 194: | Line 181: | ||
|- | |- | ||
| '''Errors''' | | '''Errors''' | ||
− | |{{Error| | + | |{{Error|db:open|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''' | | '''Examples''' | ||
− | | | + | |Returns the number of occurrences for a single, specific index entry: |
− | < | + | <syntaxhighlight lang="xquery"> |
let $term := ft:tokenize($term) | let $term := ft:tokenize($term) | ||
− | return | + | return number(ft:tokens('db', $term)[. = $term]/@count) |
− | </ | + | </syntaxhighlight> |
|} | |} | ||
==ft:tokenize== | ==ft:tokenize== | ||
+ | |||
+ | {| 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|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|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}}. | ||
+ | The {{Code|$options}} argument can be used to control full-text processing. | ||
+ | |- | ||
+ | | '''Examples''' | ||
+ | | | ||
+ | * <code>ft:tokenize("No Doubt")</code> returns the two strings {{Code|no}} and {{Code|doubt}}. | ||
+ | * <code>ft:tokenize("École", map { 'diacritics': 'sensitive' })</code> returns the string {{Code|école}}. | ||
+ | * <code>declare ft-option using stemming; ft:tokenize("GIFTS")</code> returns a single string {{Code|gift}}. | ||
+ | |} | ||
+ | |||
+ | ==ft:normalize== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
| width='120' | '''Signatures''' | | width='120' | '''Signatures''' | ||
− | |{{Func|ft: | + | |{{Func|ft:normalize|$string as xs:string?|xs:string}}<br/>{{Func|ft:normalize|$string as xs:string?, $options as map(*)?|xs:string}} |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | | | + | |Normalizes the given {{Code|$string}}, using the current default full-text options or the {{Code|$options}} specified as second argument. The function expects the same arguments as [[#ft:tokenize|ft:tokenize]]. |
|- | |- | ||
| '''Examples''' | | '''Examples''' | ||
| | | | ||
− | * | + | * <code>ft:tokenize("Häuser am Meer", map { 'case': 'sensitive' })</code> returns the string {{Code|Hauser am Meer}}. |
− | |||
|} | |} | ||
Line 225: | Line 234: | ||
|Description | |Description | ||
|- | |- | ||
− | |{{Code| | + | |{{Code|options}} |
|Both wildcards and fuzzy search have been specified as search options. | |Both wildcards and fuzzy search have been specified as search options. | ||
|} | |} | ||
=Changelog= | =Changelog= | ||
+ | |||
+ | ; Version 9.1 | ||
+ | * Updated: [[#ft:tokenize|ft:tokenize]] and [[#ft:normalize|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:contains]], [[#ft:normalize|ft:normalize]] | ||
+ | * Updated: Options added to [[#ft:tokenize|ft:tokenize]] | ||
;Version 7.8 | ;Version 7.8 | ||
Line 247: | Line 268: | ||
* Added: [[#ft:tokens|ft:tokens]], [[#ft:tokenize|ft:tokenize]] | * Added: [[#ft:tokens|ft:tokens]], [[#ft:tokenize|ft:tokenize]] | ||
− | |||
− |
Revision as of 11:01, 15 September 2020
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
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
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 in addition:
|
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.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