Difference between revisions of "Index Module"

From BaseX Documentation
Jump to navigation Jump to search
Line 1: Line 1:
 
This module is introduced with BaseX {{Mark|Version 7.1}} and contains [[Querying#Functions|XQuery functions]] for handling informations coming directly from the indexes within XQuery. All functions are introduced with the {{Mono|index:}} prefix, which is linked to the {{Mono|http://www.basex.org/modules/index}} namespace.
 
This module is introduced with BaseX {{Mark|Version 7.1}} and contains [[Querying#Functions|XQuery functions]] for handling informations coming directly from the indexes within XQuery. All functions are introduced with the {{Mono|index:}} prefix, which is linked to the {{Mono|http://www.basex.org/modules/index}} namespace.
 
=General Functions=
 
  
 
==index:facets==
 
==index:facets==

Revision as of 16:01, 27 December 2011

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.

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.