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";

Zorba version for this module:

The latest version of this module is 2.0. For more information about module versioning in Zorba please check out this resource.

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
External available-indexes ( ) as xs:QName*
The function returns a sequence of QNames representing the indexes that are available.
Updating External create ( $name as xs:QName ) as
The create function is an updating function which creates the index with the given expanded QName and populates the index with its values.
External declared-indexes ( ) as xs:QName*
The function returns a sequence of QNames representing the indexes that have been declared in the prolog of the static context.
Updating External delete ( $name as xs:QName ) as
The delete function is an updating function that deletes the index with the given expanded QName.
External is-available-index ( $name as xs:QName ) as xs:boolean
The function returns true if an index with the given QName is available.
External is-declared-index ( $name as xs:QName ) as xs:boolean
The function returns true if a index with the given QName is declared in the prolog of the static context.
Functions
External available-indexes back to 'Function Summary'
declare function iddl:available-indexes (

) as xs:QName*

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

Returns:

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

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:

External declared-indexes back to 'Function Summary'
declare function iddl:declared-indexes (

) as xs:QName*

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

Returns:

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

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

Parameters:
Returns:
Errors:

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

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

Parameters:
Returns:

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

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