Bureaucrats, editor, reviewer, Administrators
13,550
edits
Changes
Jump to navigation
Jump to search
| valign='top' | '''Summary'''
| valign='top' | '''Examples'''
| valign='top' | '''Summary'''
| valign='top' | '''Summary'''
| valign='top' | '''Summary'''
| valign='top' | '''Summary'''
no edit summary
|{{Mono|<b>index:facets</b>($db as item()) as xs:string}}<br/>{{Mono|<b>index:facets</b>($db as item(), $type as xs:string) as xs:string}}
|-
|Returns information about possible facets and facet values on a database in document structure format.<br/>If {{Mono|$type}} is specified as {{Mono|flat}}, the function returns this information in a flat summarized version.
|-
|'''Errors'''
|'''[[Database Module#Errors|BXDB0001]]''' is raised if {{Mono|$db}} references a node that is not stored in a database (i.e., references a main-memory XML fragment).<br/>'''[[Database Module#Errors|BXDB0002]]''' is raised if the addressed database cannot be opened.<br/>'''[[Database Module#Errors|BXDB0004]]''' is raised if the index required by a function is not available.
|-
|
* {{Mono|index:facets("DB")}} returns information about facets and facet values on the database {{Mono|DB}} in document structure.
|{{Mono|<b>index:texts</b>($db as item()) as element(value)*}}<br/>{{Mono|<b>index:texts</b>($db as item(), $prefix as xs:string) as element(value)*}}
|-
|Returns all strings stored in the text index, along with their number of occurrences.<br/>If {{Mono|$prefix}} is specified, the returned nodes will be refined to the strings starting with that prefix.
|-
|'''Errors'''
|'''[[Database Module#Errors|BXDB0001]]''' is raised if {{Mono|$db}} references a node that is not stored in a database (i.e., references a main-memory XML fragment).<br/>'''[[Database Module#Errors|BXDB0002]]''' is raised if the addressed database cannot be opened.<br/>'''[[Database Module#Errors|BXDB0004]]''' is raised if the index required by a function is not available.
|}
|{{Mono|<b>index:attributes</b>($db as item()) as element(value)*}}<br/>{{Mono|<b>index:attributes</b>($db as item(), $prefix as xs:string) as element(value)*}}
|-
|Returns all strings stored in the attribute index, along with their number of occurrences.<br/>If {{Mono|$prefix}} is specified, the returned nodes will be refined to the strings starting with that prefix.
|-
|'''Errors'''
|'''[[Database Module#Errors|BXDB0001]]''' is raised if {{Mono|$db}} references a node that is not stored in a database (i.e., references a main-memory XML fragment).<br/>'''[[Database Module#Errors|BXDB0002]]''' is raised if the addressed database cannot be opened.<br/>'''[[Database Module#Errors|BXDB0004]]''' is raised if the index required by a function is not available.
|}
|{{Mono|<b>index:element-names</b>($db as item()) as element(value)*}}
|-
|Returns all element names stored in the index, along with their number of occurrences.
|-
|'''Errors'''
|'''[[Database Module#Errors|BXDB0001]]''' is raised if {{Mono|$db}} references a node that is not stored in a database (i.e., references a main-memory XML fragment).<br/>'''[[Database Module#Errors|BXDB0002]]''' is raised if the addressed database cannot be opened.<br/>'''[[Database Module#Errors|BXDB0004]]''' is raised if the index required by a function is not available.
|}
|{{Mono|<b>index:attribute-names</b>($db as item()) as element(value)*}}
|-
|Returns all attribute names stored in the index, along with their number of occurrences.
|-
|'''Errors'''
|'''[[Database Module#Errors|BXDB0001]]''' is raised if {{Mono|$db}} references a node that is not stored in a database (i.e., references a main-memory XML fragment).<br/>'''[[Database Module#Errors|BXDB0002]]''' is raised if the addressed database cannot be opened.<br/>'''[[Database Module#Errors|BXDB0004]]''' is raised if the index required by a function is not available.
|}
