This module is part of Zorba's XQuery Data Definition Facility. All the indexes managed by this module have to be pre-declared in the prolog of a library module. Please refer to the general documentation for more information and examples.
keys
($name as xs:QName) as node()* external
Gets a sequence of all keys contained in the index with the given name. |
probe-index-point-general
($name as xs:QName, $key as xs:anyAtomicType*) as node()* external
Gets from an index the domain nodes associated by general equality with a given search sequence . |
probe-index-point-value-skip
($name as xs:QName, $skip as xs:integer, $key_i as xs:anyAtomicType?) as node()* external
This is an extension of the probe-index-point-value() function in that it allows index items to be skipped. |
probe-index-point-value
($name as xs:QName, $key_i as xs:anyAtomicType?) as node()* external
Gets the domain nodes from an index associated by value equality with a given search tuple . |
probe-index-range-general
($name as xs:QName, $lowerBound as xs:anyAtomicType*, $upperBound as xs:anyAtomicType*, $haveLowerBound as xs:boolean, $haveUpperBound as xs:boolean, $lowerBoundIncluded as xs:boolean, $upperBoundIncluded as xs:boolean) as node()* external
Gets the domain nodes associated by general order-comparison (operators <= , < , >= , > ) with one or two search sequences . |
probe-index-range-value-skip
($name as xs:QName, $skip as xs:integer, $lowerBound-i as xs:anyAtomicType?, $upperBound-i as xs:anyAtomicType?, $haveLowerBound-i as xs:boolean, $haveUpperBound-i as xs:boolean, $lowerBoundIncluded-i as xs:boolean, $upperBoundIncluded-i as xs:boolean) as node()* external
This function is an extension of the probe-index-range-value() function that index items to be skipped. |
probe-index-range-value
($name as xs:QName, $lowerBound-i as xs:anyAtomicType?, $upperBound-i as xs:anyAtomicType?, $haveLowerBound-i as xs:boolean, $haveUpperBound-i as xs:boolean, $lowerBoundIncluded-i as xs:boolean, $upperBoundIncluded-i as xs:boolean) as node()* external
Gets the domain nodes associated by value order-comparison (operators le , lt , ge , gt ) with a given search box . |
refresh-index
($name as xs:QName) external
Updates the index with the given name. |
declare function idml:keys($name as xs:QName) as node()* external
<key xmlns="http://zorba.io/modules/store/static/indexes/dml">
<attribute value="key1_value"/>
<attribute value="key2_value"/>
<attribute value="key3_value"/>
</key>
Note that the order of the attribute elements reflects the order of
the keys in the index specification. Also note that the values in
these attributes have the type that is declared in the corresponding
index specification.
declare function idml:probe-index-point-general($name as xs:QName, $key as xs:anyAtomicType*) as node()* external
$keys = $node/keyExprwhere keyExpr is the expression specified in the keyspec of the index (remember that for general indexes, there can be only one keyspec).
declare %an:variadic function idml:probe-index-point-value-skip($name as xs:QName, $skip as xs:integer, $key_i as xs:anyAtomicType?) as node()* external
probe-index-point-value() function
in that it allows index items to be skipped.
declare %an:variadic function idml:probe-index-point-value($name as xs:QName, $key_i as xs:anyAtomicType?) as node()* external
The search tuple consists of a number of search keys where each search key is either an atomic item or the empty sequence. The number of search keys given must be equal to the number of keys declared for the index. Since the number of keys differs from one index to another, this function is variadic.
$key1 eq $node/keyExpr1 and ... and $keyM eq $node/keyExprMwhere keyExpri is the expression specified in the i-th keyspec of the index.
declare function idml:probe-index-range-general($name as xs:QName, $lowerBound as xs:anyAtomicType*, $upperBound as xs:anyAtomicType*, $haveLowerBound as xs:boolean, $haveUpperBound as xs:boolean, $lowerBoundIncluded as xs:boolean, $upperBoundIncluded as xs:boolean) as node()* external
<=, <, >=,
>) with one or two search sequences.
Each search sequence consists of an arbitrary number of search keys where each search key is an atomic item. This method is supported by general range indexes only. Its result is either an error or the set of domain nodes for which the following XQuery expression returns true:
if ( $haveLowerBound and $haveUpperBound ) then
$lowerBoundKeys lop $node/keyExpr and $node/keyExpr uop $upperBoundKeys
else if ( $haveLowerBound ) then
$lowerBoundKeys lop $node/keyExpr
else if ( $haveUpperBound ) then
$node/keyExpr uop $upperBoundKeys
else
fn:true()
where keyExpr is the expression specified in the keyspec of the
index, lop is either the <= or the <
operator depending on whether $lowerBoundsIncluded is true or
false, and uop is either the <= or the
< operator depending on whether
$upperBoundsIncluded is true or false.
<= or the < operator when comparing a search key from $lowerBound with an index key.<= or the < operator when comparing an index key with a search key from $upperBound.declare %an:variadic function idml:probe-index-range-value-skip($name as xs:QName, $skip as xs:integer, $lowerBound-i as xs:anyAtomicType?, $upperBound-i as xs:anyAtomicType?, $haveLowerBound-i as xs:boolean, $haveUpperBound-i as xs:boolean, $lowerBoundIncluded-i as xs:boolean, $upperBoundIncluded-i as xs:boolean) as node()* external
probe-index-range-value()
function that index items to be skipped.
$lowerBound-i value.$upperBound-i value.$lowerBound-i value is part of the range.$upperBound-i value is part of the range.declare %an:variadic function idml:probe-index-range-value($name as xs:QName, $lowerBound-i as xs:anyAtomicType?, $upperBound-i as xs:anyAtomicType?, $haveLowerBound-i as xs:boolean, $haveUpperBound-i as xs:boolean, $lowerBoundIncluded-i as xs:boolean, $upperBoundIncluded-i as xs:boolean) as node()* external
le, lt, ge, gt) with a
given search box.
The search box is specified as a number M of rangespecs where each rangespec consists of six values. The number M must be greater than 0 and less than or equal to the number N of keyspecs found in the index declaration. If M < N, then the "missing" rangespecs are assumed to have the following value: [(), (), false, false, false, false]. As a result, we can assume that M = N. Remember that for general indexes, there can be only one IndexKeySpec and, as a result for general indexes, M = N = 1. Since the number of keys differs from one index to another, this function is variadic.
The ith rangespec corresponds to the ith keyspec, and specifies a search condition on the key values that are produced by evaluating that keyspec for every domain node. Specifically, we define the ith rangespec result as the set of domain nodes for which the following XQuery expression returns true:
if ( $haveLowerBound-i and $haveUpperBound-i ) then
$lowerBound-i lop $node/keyExpr-i and $node/keyExpr-i uop $upperBound-i
else if ( $haveLowerBound-i ) then
$lowerBound-i lop $node/keyExpr-i
else if ( $haveUpperBound-i ) then
$node/keyExpr-i uop $upperBound-i
else
fn:true()
where keyExpr-i is the expression specified by the ith
keyspec of the index, lop is either the le or the
lt operator depending on whether
$lowerBoundsIncluded-i is true or false, and uop is
either the le or the lt operator depending on whether
$upperBoundsIncluded-i is true or false.
$lowerBound-i value.$upperBound-i value.$lowerBound-i value is not considered part of the range. Otherwise, the range is closed from below, i.e., the $lowerBound-i value is part of the range.$upperBound-i value is not considered part of the range. Otherwise, the range is closed from above, i.e., the $upperBound-i value is part of the range.declare function idml:refresh-index($name as xs:QName) external