Index Module

From BaseX Documentation
Revision as of 14:51, 24 December 2011 by AW (talk | contribs) (Created page with "This module is introduced with BaseX {{Mark|Version 7.1}} and contains XQuery functions for handling informations coming directly from the indexes within X...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

This module is introduced with BaseX Template:Mark and 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.

General 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. $db may either be a string or a node stored in a database.
If $type is specified as flat, the function returns this information in a flat summarized version.
Errors 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.