Difference between revisions of "Index Module"
Jump to navigation
Jump to search
Line 14: | Line 14: | ||
|{{Mono|<b>index:facets</b>($db as item()) as xs:string}}<br/>{{Mono|<b>index:facets</b>($db as item(), $type as xs:string) as xs:string}} | |{{Mono|<b>index:facets</b>($db as item()) as xs:string}}<br/>{{Mono|<b>index:facets</b>($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.<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. | ||
|- | |- | ||
+ | |'''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|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''' | |
| | | | ||
* {{Mono|index:facets("DB")}} returns information about facets and facet values on the database {{Mono|DB}} in document structure. | * {{Mono|index:facets("DB")}} returns information about facets and facet values on the database {{Mono|DB}} in document structure. | ||
Line 31: | Line 32: | ||
|{{Mono|<b>index:texts</b>($db as item()) as element(value)*}}<br/>{{Mono|<b>index:texts</b>($db as item(), $prefix as xs:string) as element(value)*}} | |{{Mono|<b>index:texts</b>($db as item()) as element(value)*}}<br/>{{Mono|<b>index:texts</b>($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.<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. | ||
|- | |- | ||
+ | |'''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|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 43: | Line 45: | ||
|{{Mono|<b>index:attributes</b>($db as item()) as element(value)*}}<br/>{{Mono|<b>index:attributes</b>($db as item(), $prefix as xs:string) as element(value)*}} | |{{Mono|<b>index:attributes</b>($db as item()) as element(value)*}}<br/>{{Mono|<b>index:attributes</b>($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.<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. | ||
|- | |- | ||
+ | |'''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|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 55: | Line 58: | ||
|{{Mono|<b>index:element-names</b>($db as item()) as element(value)*}} | |{{Mono|<b>index:element-names</b>($db as item()) as element(value)*}} | ||
|- | |- | ||
− | + | |'''Summary''' | |
|Returns all element names stored in the index, along with their number of occurrences. | |Returns all element names stored in the index, 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. | |'''[[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 67: | Line 71: | ||
|{{Mono|<b>index:attribute-names</b>($db as item()) as element(value)*}} | |{{Mono|<b>index:attribute-names</b>($db as item()) as element(value)*}} | ||
|- | |- | ||
− | + | |'''Summary''' | |
|Returns all attribute names stored in the index, along with their number of occurrences. | |Returns all attribute names stored in the index, 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. | |'''[[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 23:59, 25 May 2012
This XQuery Module provides functions for displaying information stored in the database index structures.
Contents
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 on a database in document structure format. If $type is specified as flat , the function returns this information in a flat summarized version.
|
Errors | BXDB0001 is raised if $db references a node that is not stored in a database (i.e., references a main-memory XML fragment).BXDB0002 is raised if the addressed database cannot be opened. BXDB0004 is raised if the index required by a function is not available. |
Examples |
|
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 | BXDB0001 is raised if $db references a node that is not stored in a database (i.e., references a main-memory XML fragment).BXDB0002 is raised if the addressed database cannot be opened. BXDB0004 is raised if the index required by a function 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 | BXDB0001 is raised if $db references a node that is not stored in a database (i.e., references a main-memory XML fragment).BXDB0002 is raised if the addressed database cannot be opened. BXDB0004 is raised if the index required by a function 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 | BXDB0001 is raised if $db references a node that is not stored in a database (i.e., references a main-memory XML fragment).BXDB0002 is raised if the addressed database cannot be opened. BXDB0004 is raised if the index required by a function 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 | BXDB0001 is raised if $db references a node that is not stored in a database (i.e., references a main-memory XML fragment).BXDB0002 is raised if the addressed database cannot be opened. BXDB0004 is raised if the index required by a function is not available. |
Changelog
The module was introduced with Version 7.1.