Bureaucrats, editor, reviewer, Administrators
13,550
edits
Changes
Jump to navigation
Jump to search
{{Mark|Introduced with Version 8.4:}}
[[Category:XQuery]]
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><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><nowiki>http://basex.org/errors</nowiki></code> namespace, which is statically bound to the {{Code|bxerr}} prefix.
=Functions=
|-
|'''Errors'''
|{{Error|BXDB0002db:open|XQuery ErrorsDatabase Module#BaseX Errors}} The addressed database does not exist or could not be opened.
|-
|'''Examples'''
|-
|'''Errors'''
|{{Error|BXDB0002db:open|XQuery ErrorsDatabase Module#BaseX Errors}} The addressed database does not exist or could not be opened.<br/>{{Error|BXDB0004db:no-index|Database Module#Errors}} the index is not available.
|}
|-
|'''Errors'''
|{{Error|BXDB0002db:open|XQuery ErrorsDatabase Module#BaseX Errors}} The addressed database does not exist or could not be opened.<br/>{{Error|BXDB0004db:no-index|Database Module#Errors}} the index is not available.
|}
==index:tokens==
{| width='100%'
|-
|'''Errors'''
|{{Error|BXDB0002db:open|XQuery ErrorsDatabase Module#BaseX Errors}} The addressed database does not exist or could not be opened.<br/>{{Error|BXDB0004db:no-index|Database Module#Errors}} the index is not available.
|}
|-
|'''Errors'''
|{{Error|BXDB0002db:open|XQuery ErrorsDatabase Module#BaseX Errors}} The addressed database does not exist or could not be opened.
|}
|-
|'''Errors'''
|{{Error|BXDB0002db:open|XQuery ErrorsDatabase Module#BaseX Errors}} The addressed database does not exist or could not be opened.
|}
The module was introduced with Version 7.1.
