Index Module

From BaseX Documentation

Jump to: navigation, search

This XQuery Module provides functions for displaying information stored in the database index structures.

Contents

[edit] 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.

[edit] Functions

[edit] index:facets

Signatures index:facets($db as xs:string) as xs:string
index:facets($db as xs:string, $type as xs:string) as xs:string
Summary Returns information about all 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. The returned data is derived from the Path Index.
Errors BXDB0002: The addressed database does not exist or could not be opened.
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.

[edit] 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 index is not available.

[edit] 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 index is not available.

[edit] index:tokens

Signatures index:tokens($db as xs:string) as element(value)*
Summary Returns all strings stored in the Token Index of the database $db, along with their number of occurrences.
Errors BXDB0002: The addressed database does not exist or could not be opened.
BXDB0004: the index is not available.

[edit] index:element-names

Signatures index:element-names($db as xs:string) as element(value)*
Summary Returns all element names stored in the Name Index of the database $db, along with their number of occurrences.
Errors BXDB0002: The addressed database does not exist or could not be opened.

[edit] index:attribute-names

Signatures index:attribute-names($db as xs:string) as element(value)*
Summary Returns all attribute names stored in the Name Index of the database $db, along with their number of occurrences.
Errors BXDB0002: The addressed database does not exist or could not be opened.

[edit] Changelog

Version 8.4
Version 7.7
Version 7.3

The module was introduced with Version 7.1.

Personal tools
Namespaces
Variants
Actions
Navigation
Print/export