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 on a database 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 in 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.
−
|-
 
−
|'''Errors'''
 
−
|'''[[Database Module#Errors|BXDB0001]]''' is raised if {{Mono|$db}} references a node that is not stored in a database (i.e., references a main-memory XML fragment).<br/>'''[[Database Module#Errors|BXDB0002]]''' is raised if the addressed database cannot be opened.<br/>'''[[Database Module#Errors|BXDB0004]]''' is raised if the index required by a function is not available.
 
 
|-
 
|-
 
|'''Examples'''
 
|'''Examples'''
Line 33: Line 30:
 
|-
 
|-
 
|'''Summary'''
 
|'''Summary'''
−
|Returns all strings stored in the text index, 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 <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.
 
|-
 
|-
 
|'''Errors'''
 
|'''Errors'''
−
|'''[[Database Module#Errors|BXDB0001]]''' is raised if {{Mono|$db}} references a node that is not stored in a database (i.e., references a main-memory XML fragment).<br/>'''[[Database Module#Errors|BXDB0002]]''' is raised if the addressed database cannot be opened.<br/>'''[[Database Module#Errors|BXDB0004]]''' is raised if the index required by a function is not available.
+
|'''[[Database Module#Errors|BXDB0004]]''' is raised if the text index is not available.
 
|}
 
|}
  
Line 46: Line 43:
 
|-
 
|-
 
|'''Summary'''
 
|'''Summary'''
−
|Returns all strings stored in the attribute index, 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 <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.
 
|-
 
|-
 
|'''Errors'''
 
|'''Errors'''
−
|'''[[Database Module#Errors|BXDB0001]]''' is raised if {{Mono|$db}} references a node that is not stored in a database (i.e., references a main-memory XML fragment).<br/>'''[[Database Module#Errors|BXDB0002]]''' is raised if the addressed database cannot be opened.<br/>'''[[Database Module#Errors|BXDB0004]]''' is raised if the index required by a function is not available.
+
|'''[[Database Module#Errors|BXDB0004]]''' is raised if the attribute index is not available.
 
|}
 
|}
  
Line 59: Line 56:
 
|-
 
|-
 
|'''Summary'''
 
|'''Summary'''
−
|Returns all element names stored in the index, along with their number of occurrences.
+
|Returns all element names stored in the index of the database <code>[[Database Module#Database Nodes|$db]]</code>, along with their number of occurrences.
−
|-
 
−
|'''Errors'''
 
−
|'''[[Database Module#Errors|BXDB0001]]''' is raised if {{Mono|$db}} references a node that is not stored in a database (i.e., references a main-memory XML fragment).<br/>'''[[Database Module#Errors|BXDB0002]]''' is raised if the addressed database cannot be opened.<br/>'''[[Database Module#Errors|BXDB0004]]''' is raised if the index required by a function is not available.
 
 
|}
 
|}
  
Line 72: Line 66:
 
|-
 
|-
 
|'''Summary'''
 
|'''Summary'''
−
|Returns all attribute names stored in the index, along with their number of occurrences.
+
|Returns all attribute names stored in the index of the database <code>[[Database Module#Database Nodes|$db]]</code>, along with their number of occurrences.
−
|-
 
−
|'''Errors'''
 
−
|'''[[Database Module#Errors|BXDB0001]]''' is raised if {{Mono|$db}} references a node that is not stored in a database (i.e., references a main-memory XML fragment).<br/>'''[[Database Module#Errors|BXDB0002]]''' is raised if the addressed database cannot be opened.<br/>'''[[Database Module#Errors|BXDB0004]]''' is raised if the index required by a function is not available.
 
 
|}
 
|}
  

Revision as of 00:03, 26 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 in the database $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 $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 $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 $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 $db, along with their number of occurrences.

Changelog

The module was introduced with Version 7.1.

Retrieved from "http://docs.basex.org/index.php?title=Index_Module&oldid=7074"