Difference between revisions of "Index Module"

From BaseX Documentation
Jump to navigation Jump to search
Line 15: Line 15:
 
|-
 
|-
 
|'''Summary'''
 
|'''Summary'''
|Returns information about possible facets and facet values of the database <code>[[Database Module#Database Nodes|$db]]</code> in document structure format.<br/>If {{Mono|$type}} is specified as {{Mono|flat}}, the function returns this information in a flat summarized version.
+
|Returns information about possible facets and facet values of the [[Database Module#Database Nodes|database node]] <code>$db</code> in document structure format.<br/>If {{Mono|$type}} is specified as {{Mono|flat}}, the function returns this information in a flat summarized version.
 
|-
 
|-
 
|'''Examples'''
 
|'''Examples'''
Line 30: Line 30:
 
|-
 
|-
 
|'''Summary'''
 
|'''Summary'''
|Returns all strings stored in the text index of the database <code>[[Database Module#Database Nodes|$db]]</code>, along with their number of occurrences.<br/>If {{Mono|$prefix}} is specified, the returned nodes will be refined to the strings starting with that prefix.
+
|Returns all strings stored in the text index of the [[Database Module#Database Nodes|database node]] <code>$db</code>, along with their number of occurrences.<br/>If {{Mono|$prefix}} is specified, the returned nodes will be refined to the strings starting with that prefix.
 
|-
 
|-
 
|'''Errors'''
 
|'''Errors'''
Line 43: Line 43:
 
|-
 
|-
 
|'''Summary'''
 
|'''Summary'''
|Returns all strings stored in the attribute index of the database <code>[[Database Module#Database Nodes|$db]]</code>, along with their number of occurrences.<br/>If {{Mono|$prefix}} is specified, the returned nodes will be refined to the strings starting with that prefix.
+
|Returns all strings stored in the attribute index of the [[Database Module#Database Nodes|database node]] <code>$db</code>, along with their number of occurrences.<br/>If {{Mono|$prefix}} is specified, the returned nodes will be refined to the strings starting with that prefix.
 
|-
 
|-
 
|'''Errors'''
 
|'''Errors'''
Line 56: Line 56:
 
|-
 
|-
 
|'''Summary'''
 
|'''Summary'''
|Returns all element names stored in the index of the database <code>[[Database Module#Database Nodes|$db]]</code>, along with their number of occurrences.
+
|Returns all element names stored in the index of the [[Database Module#Database Nodes|database node]] <code>$db</code>, along with their number of occurrences.
 
|}
 
|}
  
Line 66: Line 66:
 
|-
 
|-
 
|'''Summary'''
 
|'''Summary'''
|Returns all attribute names stored in the index of the database <code>[[Database Module#Database Nodes|$db]]</code>, along with their number of occurrences.
+
|Returns all attribute names stored in the index of the [[Database Module#Database Nodes|database node]] <code>$db</code>, along with their number of occurrences.
 
|}
 
|}
  

Revision as of 23:08, 25 May 2012

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 of the database node $db in document structure format.
If $type is specified as flat, the function returns this information in a flat summarized version.
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 of the database node $db, along with their number of occurrences.
If $prefix is specified, the returned nodes will be refined to the strings starting with that prefix.
Errors BXDB0004 is raised if the text index 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 of the database node $db, along with their number of occurrences.
If $prefix is specified, the returned nodes will be refined to the strings starting with that prefix.
Errors BXDB0004 is raised if the attribute index 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 of the database node $db, along with their number of occurrences.

index:attribute-names

Signatures index:attribute-names($db as item()) as element(value)*
Summary Returns all attribute names stored in the index of the database node $db, along with their number of occurrences.

Changelog

The module was introduced with Version 7.1.