http://zorba.io/modules/store/static/indexes/dml

Description

Before using any of the functions below please remember to import the module namespace:

import module namespace idml = "http://zorba.io/modules/store/static/indexes/dml";
This module defines a set of functions to probe and refresh indexes which are declared in the prolog of a module.

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.

Module code

Here is the actual XQuery module code.

See also

Authors

Zorba Team

Version Declaration

xquery version "3.0" encoding "utf-8";

Namespaces

anhttp://zorba.io/annotations
idmlhttp://zorba.io/modules/store/static/indexes/dml
verhttp://zorba.io/options/versioning
zerrhttp://zorba.io/errors

Function Summary

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-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-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-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 .

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-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 .

refresh-index($name as xs:QName) external

Updates the index with the given name.

keys($name as xs:QName) as node()* external

Gets a sequence of all keys contained in the index with the given name.

Functions

probe-index-point-value#2

declare %an:variadic function idml: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.

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.

Parameters

  • $name

    The of the index to probe.

  • $key_i

    A search key used to probe the index with. The i-th search key corresponds to the i-th key expression in the index declaration.

Returns

  • node()*

    The set of domain nodes for which the following XQuery expression returns true: $key1 eq $node/keyExpr1 and ... and $keyM eq $node/keyExprM where keyExpri is the expression specified in the i-th keyspec of the index.

Errors

  • zerr:ZDDY0021

    if the index is not declared.

  • zerr:ZDDY0023

    if the index does not exist.

  • zerr:ZDDY0025

    if the number of search keys passed as arguments is not the same as the number of keys declared for the index.

  • err:XPTY0004

    if a non-empty seach key is given whose type does not match the sequence type specified in the corresponding keyspec.

probe-index-point-value-skip#3

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
This is an extension of the probe-index-point-value() function in that it allows index items to be skipped.

Parameters

  • $name

    The name of the index to probe.

  • $skip

    The number of index items to skip.

  • $key_i

    The search keys used to probe the index with. The i-th search key corresponds to the i-th key expression in the index declaration.

Returns

  • node()*

    The set of domain nodes that satisfy the search condition.

Errors

  • zerr:ZDDY0021

    if the index is not declared.

  • zerr:ZDDY0023

    if the index does not exist.

  • zerr:ZDDY0025

    if the number of search keys passed as arguments is not the same as the number of keys declared for the index.

  • err:XPTY0004

    if a non-empty seach key is given whose type does not match the sequence type specified in the corresponding keyspec.

probe-index-point-general#2

declare function idml: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 . The search sequence consists of an arbitrary number of search keys where each search key is an atomic item. The function is supported by general indexes only.

Parameters

  • $name

    The name of the index to probe.

  • $key

    The search sequence.

Returns

  • node()*

    The set of domain nodes for which the following XQuery expression returns true: $keys = $node/keyExpr where keyExpr is the expression specified in the keyspec of the index (remember that for general indexes, there can be only one keyspec).

Errors

  • err:XPTY0004

    if the search sequence contains a search key whose type does not match the sequence type specified in the keyspec of the index.

  • zerr:ZDDY0021

    if the index with name $name is not declared.

  • zerr:ZDDY0023

    if the index with name $name does not exist.

  • zerr:ZDDY0029

    if the index is not general.

probe-index-range-value#7

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
Gets the domain nodes associated by value order-comparison (operators 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.

Parameters

  • $name

    The name of the index to probe.

  • $lowerBound-i

    The lower bound in a range of key values.

  • $upperBound-i

    The upper bound in a range of key values.

  • $haveLowerBound-i

    If false, then there is no lower bound, or equivalently, the lower bound is -INFINITY. Otherwise, the lower bound is the one given by the $lowerBound-i value.

  • $haveUpperBound-i

    If false, then there is no upper bound, or equivalently, the upper bound is +INFINITY. Otherwise, the upper bound is the one given by the $upperBound-i value.

  • $lowerBoundIncluded-i

    If false, then the range is open from below, i.e., the $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.

  • $upperBoundIncluded-i

    If false, then the range is open from above, i.e., the $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.

Returns

  • node()*

    The intersection of all the rangespec results.

Errors

  • zerr:ZDDY0021

    if the index is not declared.

  • zerr:ZDDY0023

    if the index does not exist.

  • zerr:ZDDY0025

    if the number of rangespecs passed as arguments is zero or greater than the number of keys declared for the index.

  • zerr:ZDDY0026

    if the index is not a range index.

  • err:XPTY0004

    if $haveLowerBound-i is true and $lowerBound-i is an atomic item whose type does not match the sequence type specified by the ith keyspec, or $haveUpperBound-i is true and $upperBound-i is an atomic item whose type does not match the sequence type specified by the ith keyspec.

  • zerr:ZDDY0034

    if (a) the index is general (in which case there is only one rangespac), (b) the index is untyped, (c) there is both a lower and an upper bound, and (d) if T1 and T2 are the types of the lower and upper bound, neither T1 is a subtype of T2 nor T2 is a subtype of T1.

probe-index-range-value-skip#8

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
This function is an extension of the probe-index-range-value() function that index items to be skipped.

Parameters

  • $name

    The QName of the index to probe

  • $skip

    The number of index items to skip.

  • $lowerBound-i

    The lower bound in a range of key values.

  • $upperBound-i

    The upper bound in a range of key values.

  • $haveLowerBound-i

    If false, then there is no lower bound, or equivalently, the lower bound is -INFINITY. Otherwise, the lower bound is the one given by the $lowerBound-i value.

  • $haveUpperBound-i

    If false, then there is no upper bound, or equivalently, the upper bound is +INFINITY. Otherwise, the upper bound is the one given by the $upperBound-i value.

  • $lowerBoundIncluded-i

    If false, then the range is open from below, i.e., the 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.

  • $upperBoundIncluded-i

    If false, then the range is open from above, i.e., the 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.

Returns

  • node()*

    The set of domain nodes that satisfy the search condition.

Errors

  • zerr:ZDDY0021

    if the index with name $name is not declared.

  • zerr:ZDDY0023

    if the index with name $name does not exist.

  • zerr:ZDDY0025

    if the number of rangespecs passed as arguments is zero or greater than the number of keys declared for the index.

  • zerr:ZDDY0026

    if the index is not a range index.

  • err:XPTY0004

    if $haveLowerBound-i is true and $lowerBound-i is an atomic item whose type does not match the sequence type specified by the ith keyspec, or $haveUpperBound-i is true and $upperBound-i is an atomic item whose type does not match the sequence type specified by the ith keyspec.

  • zerr:ZDDY0034

    if (a) the index is general (in which case there is only one rangespac), (b) the index is untyped, (c) there is both a lower and an upper bound, and (d) if T1 and T2 are the types of the lower and upper bound, neither T1 is a subtype of T2 nor T2 is a subtype of T1.

probe-index-range-general#7

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
Gets the domain nodes associated by general order-comparison (operators <=, <, >=, >) 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.

Parameters

  • $name

    The of the index to probe.

  • $lowerBound

    The lower bound search sequence.

  • $upperBound

    The upper bound search sequence.

  • $haveLowerBound

    Whether a lower bound search sequence exists or not.

  • $haveUpperBound

    Whether an upper bound search sequence exists or not.

  • $lowerBoundIncluded

    Whether to use the <= or the < operator when comparing a search key from $lowerBound with an index key.

  • $upperBoundIncluded

    Whether to use the <= or the < operator when comparing an index key with a search key from $upperBound.

Returns

  • node()*

    The set of domain nodes that satisfy the search condition.

Errors

  • zerr:ZDDY0021

    if the index was not declared.

  • zerr:ZDDY0023

    if the index does not exist.

  • zerr:ZDDY0030

    if the index is not a general range index.

  • err:XPTY0004

    if $haveLowerBound is true and $lowerBoundKeys contains an atomic item whose type does not match the sequence type specified by the index keyspec, or $haveUpperBound is true and $upperBoundKeys contains an atomic item whose type does not match the sequence type specified by the index keyspec.

refresh-index#1

declare updating function idml:refresh-index(
    $name as xs:QName
) as item()* external

Updates the index with the given name. Note that if the maintenance property of the index is automatic, this function does nothing.

Parameters

  • $name

    The name of the index to refresh.

Errors

  • zerr:ZDDY0021

    if the index is not declared.

  • zerr:ZDDY0023

    if the index does not exist.

keys#1

declare function idml:keys(
    $name as xs:QName
) as node()* external
Gets a sequence of all keys contained in the index with the given name. Each element has the following structure: 
   <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.

Parameters

  • $name

    The name of the index to get the keys for.

Returns

  • node()*

    A sequence of elements comprising the keys in the index.

Errors

  • zerr:ZDDY0021

    if the index was not declared.

  • zerr:ZDDY0023

    if the index does not exist.