Difference between revisions of "Index Module"
Jump to navigation
Jump to search
Line 1: | Line 1: | ||
− | This [[Module Library|XQuery Module]] provides functions for displaying information stored in the database index structures | + | This [[Module Library|XQuery Module]] provides functions for displaying information stored in the database index structures. |
=Conventions= | =Conventions= | ||
Line 16: | Line 16: | ||
| valign='top' | '''Summary''' | | valign='top' | '''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. | ||
+ | |- | ||
+ | |'''[[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. | ||
+ | |||
|- | |- | ||
| valign='top' | '''Examples''' | | valign='top' | '''Examples''' | ||
Line 31: | Line 34: | ||
| valign='top' | '''Summary''' | | valign='top' | '''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. | ||
− | |} | + | |- |
+ | |'''[[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.|} | ||
==index:attributes== | ==index:attributes== | ||
Line 41: | Line 45: | ||
| valign='top' | '''Summary''' | | valign='top' | '''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. | ||
− | |} | + | |- |
+ | |'''[[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.|} | ||
==index:element-names== | ==index:element-names== | ||
Line 51: | Line 56: | ||
| valign='top' | '''Summary''' | | valign='top' | '''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. | ||
− | |} | + | |- |
+ | |'''[[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.|} | ||
==index:attribute-names== | ==index:attribute-names== | ||
Line 61: | Line 67: | ||
| valign='top' | '''Summary''' | | valign='top' | '''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. | ||
− | |} | + | |- |
+ | |'''[[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.|} | ||
=Changelog= | =Changelog= |
Revision as of 23:57, 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.
|
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.
| ||||||||||||||
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
|