Difference between revisions of "Index Module"
Jump to navigation
Jump to search
| Line 16: | Line 16: | ||
|'''Summary''' | |'''Summary''' | ||
|Returns information about possible facets and facet values of the database {{Code|$db}} in document structure format.<br/>If {{Code|$type}} is specified as {{Code|flat}}, the function returns this information in a flat summarized version. | |Returns information about possible facets and facet values of the database {{Code|$db}} in document structure format.<br/>If {{Code|$type}} is specified as {{Code|flat}}, the function returns this information in a flat summarized version. | ||
| + | |- | ||
| + | |'''Errors''' | ||
| + | |{{Error|BXDB0002|XQuery Errors#BaseX Errors}} The addressed database does not exist or could not be opened. | ||
|- | |- | ||
|'''Examples''' | |'''Examples''' | ||
| Line 34: | Line 37: | ||
|- | |- | ||
|'''Errors''' | |'''Errors''' | ||
| − | |{{Error|BXDB0004|Database Module#Errors}} the text index is not available. | + | |{{Error|BXDB0002|XQuery Errors#BaseX Errors}} The addressed database does not exist or could not be opened.<br/>{{Error|BXDB0004|Database Module#Errors}} the text index is not available. |
|} | |} | ||
| Line 47: | Line 50: | ||
|- | |- | ||
|'''Errors''' | |'''Errors''' | ||
| − | |{{Error|BXDB0004|Database Module#Errors}} the attribute index is not available. | + | |{{Error|BXDB0002|XQuery Errors#BaseX Errors}} The addressed database does not exist or could not be opened.<br/>{{Error|BXDB0004|Database Module#Errors}} the attribute index is not available. |
|} | |} | ||
| Line 58: | Line 61: | ||
|'''Summary''' | |'''Summary''' | ||
|Returns all element names stored in the index of the database {{Code|$db}}, along with their number of occurrences. | |Returns all element names stored in the index of the database {{Code|$db}}, along with their number of occurrences. | ||
| + | |- | ||
| + | |'''Errors''' | ||
| + | |{{Error|BXDB0002|XQuery Errors#BaseX Errors}} The addressed database does not exist or could not be opened. | ||
|} | |} | ||
| Line 68: | Line 74: | ||
|'''Summary''' | |'''Summary''' | ||
|Returns all attribute names stored in the index of the database {{Code|$db}}, along with their number of occurrences. | |Returns all attribute names stored in the index of the database {{Code|$db}}, along with their number of occurrences. | ||
| + | |- | ||
| + | |'''Errors''' | ||
| + | |{{Error|BXDB0002|XQuery Errors#BaseX Errors}} The addressed database does not exist or could not be opened. | ||
|} | |} | ||
Revision as of 15:40, 20 May 2013
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 xs:string) as xs:stringindex:facets($db as xs:string, $type as xs:string) as xs:string
|
| Summary | Returns information about possible facets and facet values of the database $db in document structure format.If $type is specified as flat, the function returns this information in a flat summarized version.
|
| Errors | BXDB0002: The addressed database does not exist or could not be opened.
|
| Examples |
|
index:texts
| Signatures | index:texts($db as xs:string) as element(value)*index:texts($db as xs:string, $prefix as xs:string) as element(value)*index:texts($db as xs:string, $start as xs:string, $ascending as xs:boolean) as element(value)*
|
| Summary | Returns all strings stored in the text index of the database $db, along with their number of occurrences.If $prefix is specified, the returned entries will be refined to the ones starting with that prefix.If $start and $ascending are specified, all nodes will be returned after or before the specified start entry.
|
| Errors | BXDB0002: The addressed database does not exist or could not be opened.BXDB0004: the text index is not available.
|
index:attributes
| Signatures | index:attributes($db as xs:string) as element(value)*index:attributes($db as xs:string, $prefix as xs:string) as element(value)*index:attributes($db as xs:string, $start as xs:string, $ascending as xs:boolean) as element(value)*
|
| Summary | Returns all strings stored in the attribute index of the database $db, along with their number of occurrences.If $prefix is specified, the returned entries will be refined to the ones starting with that prefix.If $start and $ascending are specified, all nodes will be returned after or before the specified start entry.
|
| Errors | BXDB0002: The addressed database does not exist or could not be opened.BXDB0004: the attribute index is not available.
|
index:element-names
| Signatures | index:element-names($db as xs:string) as element(value)*
|
| Summary | Returns all element names stored in the index of the database $db, along with their number of occurrences.
|
| Errors | BXDB0002: The addressed database does not exist or could not be opened.
|
index:attribute-names
| Signatures | index:attribute-names($db as xs:string) as element(value)*
|
| Summary | Returns all attribute names stored in the index of the database $db, along with their number of occurrences.
|
| Errors | BXDB0002: The addressed database does not exist or could not be opened.
|
Changelog
- 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.3
- Updated: index:texts, index:attributes: signature with three arguments added.
The module was introduced with Version 7.1.
