Bureaucrats, editor, reviewer, Administrators
13,550
edits
Changes
Jump to navigation
Jump to search
no edit summary
This [[Module Library|XQuery Module]] provides 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.
=CommonalitiesConventions=
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:
* <b>[[XQuery Errors#BaseX Errors|BASX0001]]</b> is raised if the index required by a function is not available.
* <b>'''[[XQuery ErrorsDatabase Module#BaseX Errors|BASX0002BXDB0001]]</b> ''' is raised if {{Mono|$db}} references a node that is not stored in a database (i.e., references a main-memory XML fragment).* <b>'''[[XQuery ErrorsDatabase Module#BaseX Errors|BASX0003BXDB0002]]</b> ''' is raised if the addressed database cannot be opened.
=Functions=
