This module is introduced with BaseX Template:Mark. It provides XQuery functions for displaying information stored in the database index structures. All functions are introduced with the index: prefix, which is linked to the statically declared http://basex.org/modules/index namespace.
General
All functions share $db as argument, which may either be a string, denoting the name of a database, or an existing node stored in a database. The following errors may be raised if the addressed database is opened by the function:
- BASX0002 is raised if
$db is a node that is not stored in a database.
- BASX0003 is raised if the addressed database
$db cannot be opened.
index:facets
| Signatures
|
index:facets($db as item()) as xs:string
index:facets($db as item(), $type as xs:string) as xs:string
|
| Summary
|
Returns information about possible facets and facet values on a database in document structure format.
If $type is specified as flat, the function returns this information in a flat summarized version.
|
| Errors
|
BASX0001 is raised if the path index is not available.
|
| Examples
|
index:facets("DB") returns information about facets and facet values on the database DB in document structure.index:facets("DB", "flat") returns information about facets and facet values on the database DB in a summarized flat structure.
|
index:texts
| Signatures
|
index:texts($db as item()) as element(value)*
index:texts($db as item(), $prefix as xs:string) as element(value)*
|
| Summary
|
Returns all strings stored in the text index, along with their number of occurrences.
If $prefix is specified, the returned nodes will be refined to the strings starting with that prefix.
|
| Errors
|
BASX0001 is raised if 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)*
|
| Summary
|
Returns all strings stored in the attribute index, along with their number of occurrences.
If $prefix is specified, the returned nodes will be refined to the strings starting with that prefix.
|
| Errors
|
BASX0001 is raised if 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, along with their number of occurrences.
|
| Errors
|
BASX0001 is raised if the element name index is not available.
|
index:attribute-names
| Signatures
|
index:attribute-names($db as item()) as element(value)*
|
| Summary
|
Returns all attribute names stored in the index, along with their number of occurrences.
|
| Errors
|
BASX0001 is raised if the attribute name index is not available.
|
