Index Module

From BaseX Documentation
Revision as of 22:58, 25 May 2012 by CG (talk | contribs)
Jump to navigation Jump to search

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

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: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.
BXDB0001 is raised if $db references a node that is not stored in a database (i.e., references a main-memory XML fragment).
BXDB0002 is raised if the addressed database cannot be opened.
BXDB0004 is raised if the index required by a function 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.
BXDB0001 is raised if $db references a node that is not stored in a database (i.e., references a main-memory XML fragment).
BXDB0002 is raised if the addressed database cannot be opened.
BXDB0004 is raised if the index required by a function 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.
BXDB0001 is raised if $db references a node that is not stored in a database (i.e., references a main-memory XML fragment).
BXDB0002 is raised if the addressed database cannot be opened.
BXDB0004 is raised if the index required by a function 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.
BXDB0001 is raised if $db references a node that is not stored in a database (i.e., references a main-memory XML fragment).
BXDB0002 is raised if the addressed database cannot be opened.
BXDB0004 is raised if the index required by a function 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.
BXDB0001 is raised if $db references a node that is not stored in a database (i.e., references a main-memory XML fragment).
BXDB0002 is raised if the addressed database cannot be opened.
BXDB0004 is raised if the index required by a function is not available.

Changelog

The module was introduced with Version 7.1.