Index Module - Revision history

CG at 15:13, 9 March 2023

2023-03-09T15:13:53Z

CG at 13:54, 9 March 2023

2023-03-09T13:54:51Z

CG: Text replacement - "'''Signatures'''" to "'''Signature'''"

2023-03-09T13:05:14Z

Text replacement - "'''Signatures'''" to "'''Signature'''"

CG at 11:06, 9 March 2023

2023-03-09T11:06:05Z

CG at 12:18, 20 July 2022

2022-07-20T12:18:34Z

CG: Text replacement - "db:pre" to "db:get"

2022-07-20T11:44:10Z

Text replacement - "db:pre" to "db:get"

CG: Text replacement - "db:open" to "db:pre"

2022-07-19T18:54:43Z

Text replacement - "db:open" to "db:pre"

CG at 18:03, 18 July 2022

2022-07-18T18:03:18Z

CG: Text replacement - "\[\[#(index:[^|]+)\|(index:[^|]+)\]\]" to "{{Function|Index|$1}}"

2022-07-18T17:46:50Z

Text replacement - "\[\[#(index:[^|]+)\|(index:[^|]+)\]\]" to "{{Function|Index|$1}}"

CG at 11:48, 7 June 2018

2018-06-07T11:48:06Z

@@ Line 38: / Line 38: @@
 |<pre>index:texts(
    $db         as xs:string,
-   $prefix     as xs:string   := (),
+   $prefix     as xs:string    := (),
-   $ascending  as xs:boolean  := ()
+   $ascending  as xs:boolean?  := false()
 ) as element(value)*</pre>
 |- valign="top"
@@ Line 56: / Line 56: @@
 |<pre>index:attributes(
    $db         as xs:string,
-   $prefix     as xs:string   := (),
+   $prefix     as xs:string    := (),
-   $ascending  as xs:boolean  := ()
+   $ascending  as xs:boolean?  := false()
 ) as element(value)*</pre>
 |- valign="top"

@@ Line 15: / Line 15: @@
 | width='120' | '''Signature'''
 |<pre>index:facets(
-   $db    as xs:string
+   $db    as xs:string,
    $type  as xs:string  := ()
 ) as xs:string</pre>
@@ Line 37: / Line 37: @@
 | width='120' | '''Signature'''
 |<pre>index:texts(
-   $db         as xs:string
+   $db         as xs:string,
-   $prefix     as xs:string   := ()
+   $prefix     as xs:string   := (),
    $ascending  as xs:boolean  := ()
 ) as element(value)*</pre>
@@ Line 55: / Line 55: @@
 | width='120' | '''Signature'''
 |<pre>index:attributes(
-   $db         as xs:string
+   $db         as xs:string,
-   $prefix     as xs:string   := ()
+   $prefix     as xs:string   := (),
    $ascending  as xs:boolean  := ()
 ) as element(value)*</pre>

@@ Line 13: / Line 13: @@
 {| width='100%'
 |- valign="top"
-| width='120' | '''Signatures'''
+| width='120' | '''Signature'''
 |<pre>index:facets(
    $db    as xs:string
@@ Line 35: / Line 35: @@
 {| width='100%'
 |- valign="top"
-| width='120' | '''Signatures'''
+| width='120' | '''Signature'''
 |<pre>index:texts(
    $db         as xs:string
@@ Line 53: / Line 53: @@
 {| width='100%'
 |- valign="top"
-| width='120' | '''Signatures'''
+| width='120' | '''Signature'''
 |<pre>index:attributes(
    $db         as xs:string
@@ Line 71: / Line 71: @@
 {| width='100%'
 |- valign="top"
-| width='120' | '''Signatures'''
+| width='120' | '''Signature'''
 |<pre>index:tokens(
    $db  as xs:string
@@ Line 87: / Line 87: @@
 {| width='100%'
 |- valign="top"
-| width='120' | '''Signatures'''
+| width='120' | '''Signature'''
 |<pre>index:element-names(
    $db  as xs:string
@@ Line 103: / Line 103: @@
 {| width='100%'
 |- valign="top"
-| width='120' | '''Signatures'''
+| width='120' | '''Signature'''
 |<pre>index:attribute-names(
    $db  as xs:string

@@ Line 14: / Line 14: @@
 |- 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}}
+|<pre>index:facets(
 |- valign="top"
 |'''Summary'''
@@ Line 33: / Line 36: @@
 |- 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)*}}
+|<pre>index:texts(
 |- 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.
+|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|$prefix}} and {{Code|$ascending}} are specified, all nodes will be returned after or before the specified entry.
 |- valign="top"
 |'''Errors'''
@@ Line 47: / Line 54: @@
 |- 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)*}}
+|<pre>index:attributes(
 |- 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.
+|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|$prefix}} and {{Code|$ascending}} are specified, all nodes will be returned after or before the specified start entry.
 |- valign="top"
 |'''Errors'''
@@ Line 61: / Line 72: @@
 |- valign="top"
 | width='120' | '''Signatures'''
-|{{Func|index:tokens|$db as xs:string|element(value)*}}
+|<pre>index:tokens(
 |- valign="top"
 |'''Summary'''
@@ Line 75: / Line 88: @@
 |- valign="top"
 | width='120' | '''Signatures'''
-|{{Func|index:element-names|$db as xs:string|element(value)*}}
+|<pre>index:element-names(
 |- valign="top"
 |'''Summary'''
@@ Line 89: / Line 104: @@
 |- valign="top"
 | width='120' | '''Signatures'''
-|{{Func|index:attribute-names|$db as xs:string|element(value)*}}
+|<pre>index:attribute-names(
 |- valign="top"
 |'''Summary'''

@@ Line 12: / Line 12: @@
 {| 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|db:get|Database Module#Errors}} The addressed database does not exist or could not be opened.
-|-
+|- valign="top"
 |'''Examples'''
+|
@@ Line 31: / Line 31: @@
 {| 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|db:get|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.
@@ Line 45: / Line 45: @@
 {| 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|db:get|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.
@@ Line 59: / Line 59: @@
 {| 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#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.
@@ Line 73: / Line 73: @@
 {| 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 [[Indexes#Name Index|Name Index]] of the database {{Code|$db}}, along with their number of occurrences.
-|-
+|- valign="top"
 |'''Errors'''
 |{{Error|db:get|Database Module#Errors}} The addressed database does not exist or could not be opened.
@@ Line 87: / Line 87: @@
 {| 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 [[Indexes#Name Index|Name Index]] of the database {{Code|$db}}, along with their number of occurrences.
-|-
+|- valign="top"
 |'''Errors'''
 |{{Error|db:get|Database Module#Errors}} The addressed database does not exist or could not be opened.

@@ Line 20: / Line 20: @@
 |-
 |'''Errors'''
-|{{Error|db:open|Database Module#Errors}} The addressed database does not exist or could not be opened.
+|{{Error|db:pre|Database Module#Errors}} The addressed database does not exist or could not be opened.
 |-
 |'''Examples'''
@@ Line 39: / Line 39: @@
 |-
 |'''Errors'''
-|{{Error|db:open|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.
+|{{Error|db:pre|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.
 |}
@@ Line 53: / Line 53: @@
 |-
 |'''Errors'''
-|{{Error|db:open|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.
+|{{Error|db:pre|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.
 |}
@@ Line 67: / Line 67: @@
 |-
 |'''Errors'''
-|{{Error|db:open|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.
+|{{Error|db:pre|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.
 |}
@@ Line 81: / Line 81: @@
 |-
 |'''Errors'''
-|{{Error|db:open|Database Module#Errors}} The addressed database does not exist or could not be opened.
+|{{Error|db:pre|Database Module#Errors}} The addressed database does not exist or could not be opened.
 |}
@@ Line 95: / Line 95: @@
 |-
 |'''Errors'''
-|{{Error|db:open|Database Module#Errors}} The addressed database does not exist or could not be opened.
+|{{Error|db:pre|Database Module#Errors}} The addressed database does not exist or could not be opened.
 |}

@@ Line 102: / Line 102: @@
 ;Version 8.4
-* Added: {{Function|Index|index:tokens}}
+* Added: {{Function||index:tokens}}
 ;Version 7.7
@@ Line 110: / Line 110: @@
 ;Version 7.3
-* Updated: {{Function|Index|index:texts}}, {{Function|Index|index:attributes}}: signature with three arguments added.
+* Updated: {{Function||index:texts}}, {{Function||index:attributes}}: signature with three arguments added.
 The module was introduced with Version 7.1.

@@ Line 1: / Line 1: @@
 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|Database Module]].
+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=