Bureaucrats, editor, reviewer, Administrators
13,550
edits
Changes
Jump to navigation
Jump to search
[[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|<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%'
|-valign="top"
| width='120' | '''Signatures'''
|{{Func|index:facets|$db as xs:string|xs:string}}<br/>{{Func|index:facets|$db as xs:string, $type as xs:string|xs:string}}
|-valign="top"
|'''Summary'''
|Returns information about all facets and facet values of the database {{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]].
|-valign="top"
|'''Errors'''
|{{Error|BXDB0002db:get|XQuery ErrorsDatabase Module#BaseX Errors}} The addressed database does not exist or could not be opened.|-valign="top"
|'''Examples'''
|
{| width='100%'
|-valign="top"
| width='120' | '''Signatures'''
|{{Func|index:texts|$db as xs:string|element(value)*}}<br/>{{Func|index:texts|$db as xs:string, $prefix as xs:string|element(value)*}}<br/>{{Func|index:texts|$db as xs:string, $start as xs:string, $ascending as xs:boolean|element(value)*}}
|-valign="top"
|'''Summary'''
|Returns all strings stored in the [[Indexes#Text Index|Text Index]] of the database {{Code|$db}}, along with their number of occurrences.<br/>If {{Code|$prefix}} is specified, the returned entries will be refined to the 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 entry.
|-valign="top"
|'''Errors'''
|{{Error|BXDB0002db:get|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 text index is not available.
|}
==index:attributes==
{| width='100%'
|-valign="top"
| width='120' | '''Signatures'''
|{{Func|index:attributes|$db as xs:string|element(value)*}}<br/>{{Func|index:attributes|$db as xs:string, $prefix as xs:string|element(value)*}}<br/>{{Func|index:attributes|$db as xs:string, $start as xs:string, $ascending as xs:boolean|element(value)*}}
|-valign="top"
|'''Summary'''
|Returns all strings stored in the [[Indexes#Attribute Index|Attribute Index]] of the database {{Code|$db}}, along with their number of occurrences.<br/>If {{Code|$prefix}} is specified, the returned entries will be refined to the 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 entry.
|-valign="top"
|'''Errors'''
|{{Error|BXDB0002db:get|XQuery 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%'|- valign="top"| width='120' | '''Signatures'''|{{Func|index:tokens|$db as xs:string|element(value)*}}|- valign="top"|'''Summary'''|Returns all strings stored in the [[Indexes#Token Index|Token Index]] of the database {{Code|$db}}, along with their number of occurrences.|- valign="top"|'''Errors'''|{{Error|db:get|Database Module#BaseX Errors}} The addressed database does not exist or could not be opened.<br/>{{Error|BXDB0004db:no-index|Database Module#Errors}} the attribute index is not available.
|}
==index:element-names==
{| width='100%'
|-valign="top"
| width='120' | '''Signatures'''
|{{Func|index:element-names|$db as xs:string|element(value)*}}
|-valign="top"
|'''Summary'''
|Returns all element names stored in the index [[Indexes#Name Index|Name Index]] of the database {{Code|$db}}, along with their number of occurrences. The returned data is derived from the [[Indexes#Name Index|Name Index]].|-valign="top"
|'''Errors'''
|{{Error|BXDB0002db:get|XQuery ErrorsDatabase Module#BaseX Errors}} The addressed database does not exist or could not be opened.
|}
==index:attribute-names==
{| width='100%'
|-valign="top"
| width='120' | '''Signatures'''
|{{Func|index:attribute-names|$db as xs:string|element(value)*}}
|-valign="top"
|'''Summary'''
|Returns all attribute names stored in the index [[Indexes#Name Index|Name Index]] of the database {{Code|$db}}, along with their number of occurrences. The returned data is derived from the [[Indexes#Name Index|Name Index]].|-valign="top"
|'''Errors'''
|{{Error|BXDB0002db:get|XQuery ErrorsDatabase Module#BaseX Errors}} The addressed database does not exist or could not be opened.
|}
=Changelog=
;Version 8.4
* Added: {{Function||index:tokens}}
;Version 7.7
;Version 7.3
* Updated: [[#index:texts{{Function||index:texts]]}}, [[#index:attributes{{Function||index:attributes]]}}: signature with three arguments added.
The module was introduced with Version 7.1.
