http://www.zorba-xquery.com/modules/store/static/indexes/dml ZC

Module Description
Before using any of the functions below please remember to import the module namespace:
import module namespace idml = "http://www.zorba-xquery.com/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 module. Please refer to the general documentation for more information and examples.

Author:

Nicolae Brinza, Matthias Brantner, David Graf, Till Westmann, Markos Zaharioudakis

XQuery version and encoding for this module:

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

Module Resources
Related Documentation

For more details please also see:

Namespaces
ann http://www.zorba-xquery.com/annotations
idml http://www.zorba-xquery.com/modules/store/static/indexes/dml
ver http://www.zorba-xquery.com/options/versioning
zerr http://www.zorba-xquery.com/errors
Function Summary
probe-index-point-value ( $name as xs:QName, $key_i as xs:anyAtomicType? ) as node()* external
The probe function retrieves the domain nodes associated with a particular search condition, which is presented as a single key tuple.
probe-index-range-value ( $name as xs:QName, $rangeLowerBound1 as xs:anyAtomicType?, $rangeUpperBound1 as xs:anyAtomicType?, $rangeHaveLowerBound1 as xs:boolean, $rangeHaveupperBound1 as xs:boolean, $rangeLowerBoundIncluded1 as xs:boolean, $rangeupperBoundIncluded1 as xs:boolean ) as node()* external
The probe function retrieves the domain nodes associated with a particular search condition, which is presented as a range of key tuples.
refresh-index ( $name as xs:QName ) external
The refresh-index function is an updating function which updates the index with the given name.
Functions
probe-index-point-value back to 'Function Summary'
declare %ann:variadic function idml:probe-index-point-value (
            $name as xs:QName, 
            $key_i as xs:anyAtomicType? 
 ) as node()* external

The probe function retrieves the domain nodes associated with a particular search condition, which is presented as a single key tuple. This function is variadic and accepts a variable number of key arguments. The first argument is the QName identifying the index to probe. The remaining arguments specify the search condition, which is given as a number of (optional) atomic items comprising a key tuple. The number of key tuples given must be equal to the number of keys declared for the index.

Parameters:
Returns:
Errors:

probe-index-range-value back to 'Function Summary'
declare %ann:variadic function idml:probe-index-range-value (
            $name as xs:QName, 
            $rangeLowerBound1 as xs:anyAtomicType?, 
            $rangeUpperBound1 as xs:anyAtomicType?, 
            $rangeHaveLowerBound1 as xs:boolean, 
            $rangeHaveupperBound1 as xs:boolean, 
            $rangeLowerBoundIncluded1 as xs:boolean, 
            $rangeupperBoundIncluded1 as xs:boolean 
 ) as node()* external

The probe function retrieves the domain nodes associated with a particular search condition, which is presented as a range of key tuples. This function accept a variable number of arguments. To describe the semantics of this function, we start by defining the i-th key column of an index as the set of key items produced by evaluating the i-th keyspec of the index for every domain node. Then, the search condition of a range probe can be defined as a number of rangespecs, where a rangespec describes a constraint on the values of a key column. The first rangespec applies to the first key column, the second rangespec to the second key column, etc. The number of rangespecs must be less or equal to the number of keyspecs found in the declaration of the given index. Each rangespec consists of six values (i.e. rangeLowerBound_i, rangeUpperBound_i, rangeHaveLowerBound_i, rangeHaveUpperBound_i, rangeLowerBoundIncluded_i, rangeUpperBoundIncluded_i). Because the function is declared as variadic, several rangespecs can be passed as arguments to the function.

Parameters:
Returns:
Errors:

refresh-index back to 'Function Summary'
declare updating function idml:refresh-index (
            $name as xs:QName 
 ) external

The refresh-index function is an updating function which updates the index with the given name. Note that if the maintenance property of the index is automatic, this function is a NOP.

Parameters:
Returns:
Errors:

blog comments powered by Disqus