Index Module

This module is introduced with BaseX Template:Mark. It contains XQuery functions for handling informations coming directly from the indexes within XQuery. All functions are introduced with the index: prefix, which is linked to the http://www.basex.org/modules/index namespace.

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. $db may either be an xs:string, denoting the database name, or a node stored in the database. If $type is specified as flat, the function returns this information in a flat summarized version.
Errors	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. BASX0021 is raised if the index is not available or doesn't have the needed information.
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.
Errors	BASX0001 is raised if the path index is not available. 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: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 occurrence. $db may either be an xs:string, denoting the database name, or a node stored in the database. 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. 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: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 occurrence. $db may either be an xs:string, denoting the database name, or a node stored in the database. 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. 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.