Difference between revisions of "Index Module"

From BaseX Documentation
Jump to navigation Jump to search
m (Text replace - "{{Mono|" to "{{Code|")
Line 3: Line 3:
 
=Conventions=
 
=Conventions=
  
−
All functions in this module are assigned to the <code>http://basex.org/modules/index</code> namespace, which is statically bound to the <code>index</code> prefix.<br/>
+
All functions in this module are assigned to the {{Code|http://basex.org/modules/index}} namespace, which is statically bound to the {{Code|index}} prefix.<br/>
−
All errors are assigned to the <code>http://basex.org/errors</code> namespace, which is statically bound to the <code>bxerr</code> prefix.
+
All errors are assigned to the {{Code|http://basex.org/errors}} namespace, which is statically bound to the {{Code|bxerr}} prefix.
  
 
=Functions=
 
=Functions=
Line 12: Line 12:
 
|-
 
|-
 
| width='90' | '''Signatures'''
 
| width='90' | '''Signatures'''
−
|{{Code|<b>index:facets</b>($db as item()) as xs:string}}<br/>{{Code|<b>index:facets</b>($db as item(), $type as xs:string) as xs:string}}
+
|{{Func|index:facets|$db as item()|xs:string}}<br/>{{Func|index:facets|$db as item(), $type as xs:string|xs:string}}
 
|-
 
|-
 
|'''Summary'''
 
|'''Summary'''
−
|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 {{Code|$type}} is specified as {{Code|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}} in document structure format.<br/>If {{Code|$type}} is specified as {{Code|flat}}, the function returns this information in a flat summarized version.
 
|-
 
|-
 
|'''Examples'''
 
|'''Examples'''
Line 27: Line 27:
 
|-
 
|-
 
| width='90' | '''Signatures'''
 
| width='90' | '''Signatures'''
−
|{{Code|<b>index:texts</b>($db as item()) as element(value)*}}<br/>{{Code|<b>index:texts</b>($db as item(), $prefix as xs:string) as element(value)*}}
+
|{{Func|index:texts|$db as item()|element(value)*}}<br/>{{Func|index:texts|$db as item(), $prefix as xs:string|element(value)*}}
 
|-
 
|-
 
|'''Summary'''
 
|'''Summary'''
−
|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 {{Code|$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}}, along with their number of occurrences.<br/>If {{Code|$prefix}} is specified, the returned nodes will be refined to the strings starting with that prefix.
 
|-
 
|-
 
|'''Errors'''
 
|'''Errors'''
−
|'''[[Database Module#Errors|BXDB0004]]''' is raised if the text index is not available.
+
|{{Error|BXDB0004|Database Module#Errors}} the text index is not available.
 
|}
 
|}
  
Line 40: Line 40:
 
|-
 
|-
 
| width='90' | '''Signatures'''
 
| width='90' | '''Signatures'''
−
|{{Code|<b>index:attributes</b>($db as item()) as element(value)*}}<br/>{{Code|<b>index:attributes</b>($db as item(), $prefix as xs:string) as element(value)*}}
+
|{{Func|index:attributes|$db as item()|element(value)*}}<br/>{{Func|index:attributes|$db as item(), $prefix as xs:string|element(value)*}}
 
|-
 
|-
 
|'''Summary'''
 
|'''Summary'''
−
|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 {{Code|$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}}, along with their number of occurrences.<br/>If {{Code|$prefix}} is specified, the returned nodes will be refined to the strings starting with that prefix.
 
|-
 
|-
 
|'''Errors'''
 
|'''Errors'''
−
|'''[[Database Module#Errors|BXDB0004]]''' is raised if the attribute index is not available.
+
|{{Error|BXDB0004|Database Module#Errors}} the attribute index is not available.
 
|}
 
|}
  
Line 53: Line 53:
 
|-
 
|-
 
| width='90' | '''Signatures'''
 
| width='90' | '''Signatures'''
−
|{{Code|<b>index:element-names</b>($db as item()) as element(value)*}}
+
|{{Func|index:element-names|$db as item()|element(value)*}}
 
|-
 
|-
 
|'''Summary'''
 
|'''Summary'''
−
|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.
+
|Returns all element names stored in the index of the [[Database Module#Database Nodes|database node]] {{Code|$db}}, along with their number of occurrences.
 
|}
 
|}
  
Line 63: Line 63:
 
|-
 
|-
 
| width='90' | '''Signatures'''
 
| width='90' | '''Signatures'''
−
|{{Code|<b>index:attribute-names</b>($db as item()) as element(value)*}}
+
|{{Func|index:attribute-names|$db as item()|element(value)*}}
 
|-
 
|-
 
|'''Summary'''
 
|'''Summary'''
−
|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.
+
|Returns all attribute names stored in the index of the [[Database Module#Database Nodes|database node]] {{Code|$db}}, along with their number of occurrences.
 
|}
 
|}
  

Revision as of 16:07, 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 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: 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: 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.

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