Difference between revisions of "Index Module"
Jump to navigation
Jump to search
| Line 3: | Line 3: | ||
==General== | ==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 | + | 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 by all functions: |
| − | * <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|BASX0001]]</b> is raised if the addressed index is not available. |
| + | * <b>[[XQuery Errors#BaseX Errors|BASX0002]]</b> is raised if {{Mono|$db}} is a node that is not stored in a database, but references a main-memory XML fragment instead. | ||
* <b>[[XQuery Errors#BaseX Errors|BASX0003]]</b> is raised if the addressed database {{Mono|$db}} cannot be opened. | * <b>[[XQuery Errors#BaseX Errors|BASX0003]]</b> is raised if the addressed database {{Mono|$db}} cannot be opened. | ||
| Line 16: | Line 17: | ||
| 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. | ||
| − | |||
| − | |||
| − | |||
|- | |- | ||
| valign='top' | '''Examples''' | | valign='top' | '''Examples''' | ||
| Line 34: | Line 32: | ||
| 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. | ||
| − | |||
| − | |||
| − | |||
|} | |} | ||
| Line 47: | Line 42: | ||
| 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. | ||
| − | |||
| − | |||
| − | |||
|} | |} | ||
| Line 60: | Line 52: | ||
| 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. | ||
| − | |||
| − | |||
| − | |||
|} | |} | ||
| Line 73: | Line 62: | ||
| 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. | ||
| − | |||
| − | |||
| − | |||
|} | |} | ||
Revision as of 02:25, 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.
Contents
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 by all functions:
- BASX0001 is raised if the addressed index is not available.
- BASX0002 is raised if
$dbis a node that is not stored in a database, but references a main-memory XML fragment instead. - BASX0003 is raised if the addressed database
$dbcannot be opened.
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 on a database 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, along with their number of occurrences. If $prefix is specified, the returned nodes will be refined to the strings starting with that prefix.
|
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.
|
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. |
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. |
