Bureaucrats, editor, reviewer, Administrators
13,550
edits
Changes
Jump to navigation
Jump to search
The module was introduced with {{;Version8.4 * Added: [[#index:tokens|index:token]] ;Version 7.1}}7 * Updated: the functions no longer accept [[Database Module#Database Nodes|Database Nodes]] as reference. Instead, the name of a database must now be specified. ;Version 7.3 * Updated: [[#index:texts|index:texts]], [[#index:attributes|index:attributes]]: signature with three arguments added.
[[Category:XQuery]]The module was introduced with Version 7.1.
no edit summary
This [[Module Library|XQuery Module]] provides functions for displaying information stored in the database index structures.
For functions that use the indexes to return nodes see [[Database_Module#Value_Indexes|Value Indexes]] in the [[Database Module]] and {{Function|Full-Text|ft:search}} in the [[Full-Text Module]].
=Conventions=
All functions and errors in this module are assigned to the {{Code|<code><nowiki>http://basex.org/modules/index}} </nowiki></code> namespace, which is statically bound to the {{Code|index}} prefix.<br/>All errors are assigned to the {{Code|http://basex.org/errors}} namespace, which is statically bound to the {{Code|bxerr}} prefix.
=Functions=
==index:facets==
{|width='100%'
|-
| width='90120' | '''Signatures'''|{{Func|index:facets|$db as item()xs:string|xs:string}}<br/>{{Func|index:facets|$db as item()xs:string, $type as xs:string|xs:string}}
|-
|'''Summary'''
|Returns information about possible all facets and facet values of the [[Database Module#Database Nodes|database node]] {{Code|$db}} in document structure format.<br/>If {{Code|$type}} is specified as {{Code|flat}}, the function returns this information in a flat summarized version. The returned data is derived from the [[Indexes#Path Index|Path Index]].|-|'''Errors'''|{{Error|db:open|Database Module#Errors}} The addressed database does not exist or could not be opened.
|-
|'''Examples'''
==index:texts==
{|width='100%'
|-
| width='90120' | '''Signatures'''|{{Func|index:texts|$db as item()xs:string|element(value)*}}<br/>{{Func|index:texts|$db as item()xs:string, $prefix as xs:string|element(value)*}}<br/>{{Func|index:texts|$db as item()xs:string, $start as xs:string, $ascending as xs:boolean|element(value)*}}
|-
|'''Summary'''
|Returns all strings stored in the text index of the [[Database ModuleIndexes#Database NodesText Index|database nodeText Index]] of the database {{Code|$db}}, along with their number of occurrences.<br/>If {{Code|$prefix}} is specified, the returned nodes entries will be refined to the strings ones starting with that prefix.<br/>If {{Code|$start}} and {{Code|$ascending}} are specified, all nodes will be returned after or before the specified start textentry.
|-
|'''Errors'''
|{{Error|BXDB0004db:open|Database Module#Errors}} The addressed database does not exist or could not be opened.<br/>{{Error|db:no-index|Database Module#Errors}} the text index is not available.
|}
==index:attributes==
{|width='100%'
|-
| width='90120' | '''Signatures'''|{{Func|index:attributes|$db as item()xs:string|element(value)*}}<br/>{{Func|index:attributes|$db as item()xs:string, $prefix as xs:string|element(value)*}}<br/>{{Func|index:attributes|$db as item()xs:string, $start as xs:string, $ascending as xs:boolean|element(value)*}}
|-
|'''Summary'''
|Returns all strings stored in the attribute index of the [[Database ModuleIndexes#Database NodesAttribute Index|database nodeAttribute Index]] of the database {{Code|$db}}, along with their number of occurrences.<br/>If {{Code|$prefix}} is specified, the returned nodes entries will be refined to the strings ones starting with that prefix.<br/>If {{Code|$start}} and {{Code|$ascending}} are specified, all nodes will be returned after or before the specified start textentry.
|-
|'''Errors'''
|{{Error|BXDB0004db:open|Database Module#Errors}} The addressed database does not exist or could not be opened.<br/>{{Error|db:no-index|Database Module#Errors}} the index is not available.|} ==index:tokens== {| width='100%'|-| width='120' | '''Signatures'''|{{Func|index:tokens|$db as xs:string|element(value)*}}|-|'''Summary'''|Returns all strings stored in the [[Indexes#Token Index|Token Index]] of the database {{Code|$db}}, along with their number of occurrences.|-|'''Errors'''|{{Error|db:open|Database Module#Errors}} The addressed database does not exist or could not be opened.<br/>{{Error|db:no-index|Database Module#Errors}} the attribute index is not available.
|}
==index:element-names==
{|width='100%'
|-
| width='90120' | '''Signatures'''|{{Func|index:element-names|$db as item()xs:string|element(value)*}}
|-
|'''Summary'''
|Returns all element names stored in the index of the [[Database ModuleIndexes#Database NodesName Index|database nodeName Index]] of the database {{Code|$db}}, along with their number of occurrences.|-|'''Errors'''|{{Error|db:open|Database Module#Errors}} The addressed database does not exist or could not be opened.
|}
==index:attribute-names==
{|width='100%'
|-
| width='90120' | '''Signatures'''|{{Func|index:attribute-names|$db as item()xs:string|element(value)*}}
|-
|'''Summary'''
|Returns all attribute names stored in the index of the [[Database ModuleIndexes#Database NodesName Index|database nodeName Index]] of the database {{Code|$db}}, along with their number of occurrences.|-|'''Errors'''|{{Error|db:open|Database Module#Errors}} The addressed database does not exist or could not be opened.
|}
=Changelog=
