Difference between revisions of "Index Module"
Jump to navigation
Jump to search
| Line 27: | Line 27: | ||
|- | |- | ||
| width='90' | '''Signatures''' | | width='90' | '''Signatures''' | ||
| − | |{{Func|index:texts|$db as item()|element(value)*}}<br/>{{Func|index:texts|$db as item(), $prefix as xs:string|element(value)*}} | + | |{{Func|index:texts|$db as item()|element(value)*}}<br/>{{Func|index:texts|$db as item(), $prefix as xs:string|element(value)*}}<br/>{{Func|index:texts|$db as item(), $start as xs:string, $ascending as xs:boolean|element(value)*}} |
|- | |- | ||
|'''Summary''' | |'''Summary''' | ||
| − | |Returns all strings stored in the text index of the [[Database Module#Database Nodes|database node]] {{Code|$db}}, along with their number of occurrences.<br/>If {{Code|$prefix}} is specified, the returned nodes will be refined to the strings starting with that prefix. | + | |Returns all strings stored in the text index of the [[Database Module#Database Nodes|database node]] {{Code|$db}}, along with their number of occurrences.<br/>If {{Code|$prefix}} is specified, the returned nodes will be refined to the strings starting with that prefix.<br/>If {{Code|$start}} and {{Code|$ascending}} are specified, all nodes will be returned after or before the specified start text. |
|- | |- | ||
|'''Errors''' | |'''Errors''' | ||
| Line 40: | Line 40: | ||
|- | |- | ||
| width='90' | '''Signatures''' | | width='90' | '''Signatures''' | ||
| − | |{{Func|index:attributes|$db as item()|element(value)*}}<br/>{{Func|index:attributes|$db as item(), $prefix as xs:string|element(value)*}} | + | |{{Func|index:attributes|$db as item()|element(value)*}}<br/>{{Func|index:attributes|$db as item(), $prefix as xs:string|element(value)*}}<br/>{{Func|index:attributes|$db as item(), $start as xs:string, $ascending as xs:boolean|element(value)*}} |
|- | |- | ||
|'''Summary''' | |'''Summary''' | ||
| − | |Returns all strings stored in the attribute index of the [[Database Module#Database Nodes|database node]] {{Code|$db}}, along with their number of occurrences.<br/>If {{Code|$prefix}} is specified, the returned nodes will be refined to the strings starting with that prefix. | + | |Returns all strings stored in the attribute index of the [[Database Module#Database Nodes|database node]] {{Code|$db}}, along with their number of occurrences.<br/>If {{Code|$prefix}} is specified, the returned nodes will be refined to the strings starting with that prefix.<br/>If {{Code|$start}} and {{Code|$ascending}} are specified, all nodes will be returned after or before the specified start text. |
|- | |- | ||
|'''Errors''' | |'''Errors''' | ||
Revision as of 21:21, 27 May 2012
This XQuery Module provides functions for displaying information stored in the database index structures.
Contents
Conventions
All functions in this module are assigned to the http://basex.org/modules/index namespace, which is statically bound to the index prefix.
All errors are assigned to the http://basex.org/errors namespace, which is statically bound to the bxerr prefix.
Functions
index:facets
| Signatures | index:facets($db as item()) as xs:stringindex:facets($db as item(), $type as xs:string) as xs:string
|
| Summary | Returns information about possible facets and facet values of the database node $db in document structure format.If $type is specified as flat, the function returns this information in a flat summarized version.
|
| Examples |
|
index:texts
| Signatures | index:texts($db as item()) as element(value)*index:texts($db as item(), $prefix as xs:string) as element(value)*index:texts($db as item(), $start as xs:string, $ascending as xs:boolean) as element(value)*
|
| Summary | Returns all strings stored in the text index of the database node $db, along with their number of occurrences.If $prefix is specified, the returned nodes will be refined to the strings starting with that prefix.If $start and $ascending are specified, all nodes will be returned after or before the specified start text.
|
| Errors | BXDB0004: the text index is not available.
|
index:attributes
| Signatures | index:attributes($db as item()) as element(value)*index:attributes($db as item(), $prefix as xs:string) as element(value)*index:attributes($db as item(), $start as xs:string, $ascending as xs:boolean) as element(value)*
|
| Summary | Returns all strings stored in the attribute index of the database node $db, along with their number of occurrences.If $prefix is specified, the returned nodes will be refined to the strings starting with that prefix.If $start and $ascending are specified, all nodes will be returned after or before the specified start text.
|
| Errors | BXDB0004: the attribute index is not available.
|
index:element-names
| Signatures | index:element-names($db as item()) as element(value)*
|
| Summary | Returns all element names stored in the index of the database node $db, along with their number of occurrences.
|
index:attribute-names
| Signatures | index:attribute-names($db as item()) as element(value)*
|
| Summary | Returns all attribute names stored in the index of the database node $db, along with their number of occurrences.
|
Changelog
The module was introduced with Version 7.1.
