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}}. It provides [[Querying#Functions|XQuery functions]] for displaying information stored in the database index structures. All functions are introduced with the {{Mono|index:}} prefix, which is linked to the statically declared {{Mono|http://basex.org/modules/index}} namespace.
 
This module is introduced with BaseX {{Mark|Version 7.1}}. It provides [[Querying#Functions|XQuery functions]] for displaying information stored in the database index structures. All functions are introduced with the {{Mono|index:}} prefix, which is linked to the statically declared {{Mono|http://basex.org/modules/index}} namespace.
 +
 +
==General==
 +
 +
All functions share {{Mono|$db}} as argument, which may either be a string, denoting the name of a database, or an existing node stored in a database. The following errors may be raised if the addressed database is opened by the function:
 +
 +
* <b>[[XQuery Errors#BaseX Errors|BASX0002]]</b> is raised if {{Mono|$db}} is a node that is not stored in a database.
 +
* <b>[[XQuery Errors#BaseX Errors|BASX0003]]</b> is raised if the addressed database {{Mono|$db}} cannot be opened.
  
 
==index:facets==
 
==index:facets==
Line 8: Line 15:
 
|-
 
|-
 
| valign='top' | '''Summary'''
 
| valign='top' | '''Summary'''
−
|Returns information about possible facets and facet values on a database in document structure format. {{Mono|$db}} may either be an <code>xs:string</code>, denoting the database name, or a node stored in the database.<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 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.
 
|-
 
|-
 
| valign='top' | '''Errors'''
 
| valign='top' | '''Errors'''
−
|<b>[[XQuery Errors#BaseX Errors|BASX0001]]</b> is raised if the path index is not available.<br/><b>[[XQuery Errors#BaseX Errors|BASX0002]]</b> is raised if {{Mono|$db}} is a node that is not stored in a database.<br/><b>[[XQuery Errors#BaseX Errors|BASX0003]]</b> is raised if the addressed database {{Mono|$db}} cannot be opened.<br/>
+
|<b>[[XQuery Errors#BaseX Errors|BASX0001]]</b> is raised if the path index is not available.
 
|-
 
|-
 
| valign='top' | '''Examples'''
 
| valign='top' | '''Examples'''
Line 26: Line 33:
 
|-
 
|-
 
| valign='top' | '''Summary'''
 
| valign='top' | '''Summary'''
−
|Returns all strings stored in the text index, along with their number of occurrences. {{Mono|$db}} may either be an <code>xs:string</code>, denoting the database name, or a node stored in the database.<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, 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.
 
|-
 
|-
 
| valign='top' | '''Errors'''
 
| valign='top' | '''Errors'''
−
|<b>[[XQuery Errors#BaseX Errors|BASX0001]]</b> is raised if the text index is not available.<br/><b>[[XQuery Errors#BaseX Errors|BASX0002]]</b> is raised if {{Mono|$db}} is a node that is not stored in a database.<br/><b>[[XQuery Errors#BaseX Errors|BASX0003]]</b> is raised if the addressed database {{Mono|$db}} cannot be opened.<br/>
+
|<b>[[XQuery Errors#BaseX Errors|BASX0001]]</b> is raised if the text index is not available.
 
|}
 
|}
  
Line 39: Line 46:
 
|-
 
|-
 
| valign='top' | '''Summary'''
 
| valign='top' | '''Summary'''
−
|Returns all strings stored in the attribute index, along with their number of occurrences. {{Mono|$db}} may either be an <code>xs:string</code>, denoting the database name, or a node stored in the database.<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, 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.
 
|-
 
|-
 
| valign='top' | '''Errors'''
 
| valign='top' | '''Errors'''
−
|<b>[[XQuery Errors#BaseX Errors|BASX0001]]</b> is raised if the attribute index is not available.<br/><b>[[XQuery Errors#BaseX Errors|BASX0002]]</b> is raised if {{Mono|$db}} is a node that is not stored in a database.<br/><b>[[XQuery Errors#BaseX Errors|BASX0003]]</b> is raised if the addressed database {{Mono|$db}} cannot be opened.<br/>
+
|<b>[[XQuery Errors#BaseX Errors|BASX0001]]</b> is raised if the attribute index is not available.
 
|}
 
|}
  
Line 52: Line 59:
 
|-
 
|-
 
| valign='top' | '''Summary'''
 
| valign='top' | '''Summary'''
−
|Returns all element names stored in the index, along with their number of occurrences. {{Mono|$db}} may either be an <code>xs:string</code>, denoting the database name, or a node stored in the database.
+
|Returns all element names stored in the index, along with their number of occurrences.
 
|-
 
|-
 
| valign='top' | '''Errors'''
 
| valign='top' | '''Errors'''
−
|<b>[[XQuery Errors#BaseX Errors|BASX0001]]</b> is raised if the element name index is not available.<br/><b>[[XQuery Errors#BaseX Errors|BASX0002]]</b> is raised if {{Mono|$db}} is a node that is not stored in a database.<br/><b>[[XQuery Errors#BaseX Errors|BASX0003]]</b> is raised if the addressed database {{Mono|$db}} cannot be opened.<br/>
+
|<b>[[XQuery Errors#BaseX Errors|BASX0001]]</b> is raised if the element name index is not available.
 
|}
 
|}
  
Line 65: Line 72:
 
|-
 
|-
 
| valign='top' | '''Summary'''
 
| valign='top' | '''Summary'''
−
|Returns all attribute names stored in the index, along with their number of occurrences. {{Mono|$db}} may either be an <code>xs:string</code>, denoting the database name, or a node stored in the database.
+
|Returns all attribute names stored in the index, along with their number of occurrences.
 
|-
 
|-
 
| valign='top' | '''Errors'''
 
| valign='top' | '''Errors'''
−
|<b>[[XQuery Errors#BaseX Errors|BASX0001]]</b> is raised if the attribute name index is not available.<br/><b>[[XQuery Errors#BaseX Errors|BASX0002]]</b> is raised if {{Mono|$db}} is a node that is not stored in a database.<br/><b>[[XQuery Errors#BaseX Errors|BASX0003]]</b> is raised if the addressed database {{Mono|$db}} cannot be opened.<br/>
+
|<b>[[XQuery Errors#BaseX Errors|BASX0001]]</b> is raised if the attribute name index is not available.
 
|}
 
|}

Revision as of 02:22, 26 January 2012

This module is introduced with BaseX Template:Mark. It provides XQuery functions for displaying information stored in the database index structures. All functions are introduced with the index: prefix, which is linked to the statically declared http://basex.org/modules/index namespace.

General

All functions share $db as argument, which may either be a string, denoting the name of a database, or an existing node stored in a database. The following errors may be raised if the addressed database is opened by the function:

  • 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.

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.
If $type is specified as flat, the function returns this information in a flat summarized version.
Errors BASX0001 is raised if the path index is not available.
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, along with their number of occurrences.
If $prefix is specified, the returned nodes will be refined to the strings starting with that prefix.
Errors BASX0001 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, along with their number of occurrences.
If $prefix is specified, the returned nodes will be refined to the strings starting with that prefix.
Errors BASX0001 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, along with their number of occurrences.
Errors BASX0001 is raised if the element name index is not available.

index:attribute-names

Signatures index:attribute-names($db as item()) as element(value)*
Summary Returns all attribute names stored in the index, along with their number of occurrences.
Errors BASX0001 is raised if the attribute name index is not available.
Retrieved from "http://docs.basex.org/index.php?title=Index_Module&oldid=5527"