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

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

This modules defines a set of functions for managing collections which are declared in the prolog of a module. For example, it provides functions to create, delete, or introspect collections.

This module is part of Zorba's XQuery Data Definition Facility. All the collections 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
cddl http://www.zorba-xquery.com/modules/store/static/collections/ddl
ver http://www.zorba-xquery.com/options/versioning
zerr http://www.zorba-xquery.com/errors
Function Summary
External available-collections ( ) as xs:QName*
The function returns a sequence of QNames of the collections that are statically declared and available.
Updating External create ( $name as xs:QName ) as
The create function is an updating function which creates the collection with the given expanded QName.
Updating External create ( $name as xs:QName, $content as item()* ) as
The create function is an updating function which creates the collection with the given expanded QName.
External declared-collections ( ) as xs:QName*
The function returns a sequence of QNames representing the collections 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 collection with the given expanded QName.
External is-available-collection ( $name as xs:QName ) as xs:boolean
The function returns true if a collection with the given QName is statically declared and available (i.
External is-declared-collection ( $name as xs:QName ) as xs:boolean
The function returns true if a collection with the given QName is declared in the prolog of the static context.
Functions
External available-collections back to 'Function Summary'
declare function cddl:available-collections (

) as xs:QName*

The function returns a sequence of QNames of the collections that are statically declared and available. The sequence will be empty if there are no such collections.

Returns:

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

The create function is an updating function which creates the collection with the given expanded QName.

Parameters:
Returns:
Errors:

Updating External create back to 'Function Summary'
declare function cddl:create (
            $name as xs:QName,
            $content as item()*
) as 

The create function is an updating function which creates the collection with the given expanded QName. Moreover, it adds copies of the sequence $content to the new collection.

Parameters:
Returns:
Errors:

External declared-collections back to 'Function Summary'
declare function cddl:declared-collections (

) as xs:QName*

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

Returns:

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

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

Parameters:
Returns:
Errors:

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

The function returns true if a collection with the given QName is statically declared and available (i.e. has been created).

Parameters:
Returns:

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

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

Parameters:
Returns: