Difference between revisions of "Index Module"
Jump to navigation
Jump to search
m (Text replace - "| valign='top' width='90' |" to "| width='90' |") |
|||
| Line 11: | Line 11: | ||
{| | {| | ||
|- | |- | ||
| − | | | + | | width='90' | '''Signatures''' |
|{{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}} | ||
|- | |- | ||
| Line 26: | Line 26: | ||
{| | {| | ||
|- | |- | ||
| − | | | + | | width='90' | '''Signatures''' |
|{{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)*}} | ||
|- | |- | ||
| Line 39: | Line 39: | ||
{| | {| | ||
|- | |- | ||
| − | | | + | | width='90' | '''Signatures''' |
|{{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)*}} | ||
|- | |- | ||
| Line 52: | Line 52: | ||
{| | {| | ||
|- | |- | ||
| − | | | + | | width='90' | '''Signatures''' |
|{{Mono|<b>index:element-names</b>($db as item()) as element(value)*}} | |{{Mono|<b>index:element-names</b>($db as item()) as element(value)*}} | ||
|- | |- | ||
| Line 62: | Line 62: | ||
{| | {| | ||
|- | |- | ||
| − | | | + | | width='90' | '''Signatures''' |
|{{Mono|<b>index:attribute-names</b>($db as item()) as element(value)*}} | |{{Mono|<b>index:attribute-names</b>($db as item()) as element(value)*}} | ||
|- | |- | ||
Revision as of 00:43, 26 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:stringindex: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: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 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 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 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 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.
