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

Module Description
Before using any of the functions below please remember to import the module namespace:
import module namespace iddl = "http://www.zorba-xquery.com/modules/store/static/indexes/ddl";

This modules defines a set of functions for managing 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
iddl http://www.zorba-xquery.com/modules/store/static/indexes/ddl
ver http://www.zorba-xquery.com/options/versioning
zerr http://www.zorba-xquery.com/errors
Function Summary
available-indexes ( ) as xs:QName* external
The function returns a sequence of QNames representing the indexes that are available.
create ( $name as xs:QName ) external
The create function is an updating function which creates the index with the given expanded QName and populates the index with its values.
declared-indexes ( ) as xs:QName* external
The function returns a sequence of QNames representing the indexes that have been declared in the prolog of the static context.
delete ( $name as xs:QName ) external
The delete function is an updating function that deletes the index with the given expanded QName.
is-available-index ( $name as xs:QName ) as xs:boolean external
The function returns true if an index with the given QName is available.
is-declared-index ( $name as xs:QName ) as xs:boolean external
The function returns true if a index with the given QName is declared in the prolog of the static context.
Functions
available-indexes back to 'Function Summary'
declare function iddl:available-indexes (
 ) as xs:QName* external

The function returns a sequence of QNames representing the indexes that are available. The sequence will be empty if there are no indexes.

Returns:

create back to 'Function Summary'
declare updating function iddl:create (
            $name as xs:QName 
 ) external

The create function is an updating function which creates the index with the given expanded QName and populates the index with its values.

Parameters:
Returns:
Errors:

declared-indexes back to 'Function Summary'
declare function iddl:declared-indexes (
 ) as xs:QName* external

The function returns a sequence of QNames representing the indexes that have been declared in the prolog of the static context.

Returns:

delete back to 'Function Summary'
declare updating function iddl:delete (
            $name as xs:QName 
 ) external

The delete function is an updating function that deletes the index with the given expanded QName.

Parameters:
Returns:
Errors:

is-available-index back to 'Function Summary'
declare function iddl:is-available-index (
            $name as xs:QName 
 ) as xs:boolean external

The function returns true if an index with the given QName is available. (i.e. has been created).

Parameters:
Returns:

is-declared-index back to 'Function Summary'
declare function iddl:is-declared-index (
            $name as xs:QName 
 ) as xs:boolean external

The function returns true if a index with the given QName is declared in the prolog of the static context.

Parameters:
Returns:

blog comments powered by Disqus