Difference between revisions of "Index Module"
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. | ||
− | == | + | ==Commonalities== |
All functions share {{Mono|$db}} as argument, which may either reference a string, denoting the name of the addressed database, or a node from an already opened database. The following errors may be raised by all functions: | All functions share {{Mono|$db}} as argument, which may either reference a string, denoting the name of the addressed database, or a node from an already opened database. The following errors may be raised by all functions: |
Revision as of 02:30, 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
Commonalities
All functions share $db
as argument, which may either reference a string, denoting the name of the addressed database, or a node from an already opened database. The following errors may be raised by all functions:
- BASX0001 is raised if the index required by a function is not available.
- BASX0002 is raised if
$db
references a node that is not stored in a database (i.e., references a main-memory XML fragment). - BASX0003 is raised if the addressed database 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.
|
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. |