Bureaucrats, editor, reviewer, Administrators
13,550
edits
Changes
Jump to navigation
Jump to search
no edit summary
=Conventions=
All functions in this module are assigned to the <code>{{Code|http://basex.org/modules/index</code> }} namespace, which is statically bound to the <code>{{Code|index</code> }} prefix.<br/>All errors are assigned to the <code>{{Code|http://basex.org/errors</code> }} namespace, which is statically bound to the <code>{{Code|bxerr</code> }} prefix.
=Functions=
|-
| width='90' | '''Signatures'''
|{{CodeFunc|<b>index:facets</b>(|$db as item()) as |xs:string}}<br/>{{CodeFunc|<b>index:facets</b>(|$db as item(), $type as xs:string) as |xs:string}}
|-
|'''Summary'''
|Returns information about possible facets and facet values of the [[Database Module#Database Nodes|database node]] <code>{{Code|$db</code> }} in document structure format.<br/>If {{Code|$type}} is specified as {{Code|flat}}, the function returns this information in a flat summarized version.
|-
|'''Examples'''
|-
| width='90' | '''Signatures'''
|{{CodeFunc|<b>index:texts</b>(|$db as item()) as |element(value)*}}<br/>{{CodeFunc|<b>index:texts</b>(|$db as item(), $prefix as xs:string) as |element(value)*}}
|-
|'''Summary'''
|Returns all strings stored in the text index of the [[Database Module#Database Nodes|database node]] <code>{{Code|$db</code>}}, along with their number of occurrences.<br/>If {{Code|$prefix}} is specified, the returned nodes will be refined to the strings starting with that prefix.
|-
|'''Errors'''
|'''[[{{Error|BXDB0004|Database Module#Errors|BXDB0004]]''' is raised if }} the text index is not available.
|}
|-
| width='90' | '''Signatures'''
|{{CodeFunc|<b>index:attributes</b>(|$db as item()) as |element(value)*}}<br/>{{CodeFunc|<b>index:attributes</b>(|$db as item(), $prefix as xs:string) as |element(value)*}}
|-
|'''Summary'''
|Returns all strings stored in the attribute index of the [[Database Module#Database Nodes|database node]] <code>{{Code|$db</code>}}, along with their number of occurrences.<br/>If {{Code|$prefix}} is specified, the returned nodes will be refined to the strings starting with that prefix.
|-
|'''Errors'''
|'''[[{{Error|BXDB0004|Database Module#Errors|BXDB0004]]''' is raised if }} the attribute index is not available.
|}
|-
| width='90' | '''Signatures'''
|{{CodeFunc|<b>index:element-names</b>(|$db as item()) as |element(value)*}}
|-
|'''Summary'''
|Returns all element names stored in the index of the [[Database Module#Database Nodes|database node]] <code>{{Code|$db</code>}}, along with their number of occurrences.
|}
|-
| width='90' | '''Signatures'''
|{{CodeFunc|<b>index:attribute-names</b>(|$db as item()) as |element(value)*}}
|-
|'''Summary'''
|Returns all attribute names stored in the index of the [[Database Module#Database Nodes|database node]] <code>{{Code|$db</code>}}, along with their number of occurrences.
|}
