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

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

This modules defines a set of functions for managing persistent, ordered, and updatable collections.

Such collections are identified by a URI as defined in the XQuery specification. However, please note that we do not advice users to use collections identified by URIs. Instead, we refer to the data lifecycle documentation. It gives an overview over serveral ways to work with collections, documents, and other data-structures.

Author:

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
Module Dependencies

Imported modules:

Related Documentation

For more details please also see:

Namespaces
ddl http://www.zorba-xquery.com/modules/store/dynamic/collections/w3c/ddl
qddl http://www.zorba-xquery.com/modules/store/dynamic/collections/ddl
ver http://www.zorba-xquery.com/options/versioning
zerr http://www.zorba-xquery.com/errors
Function Summary
available-collections ( ) as xs:string*
The function returns a sequence of URIs of the collections that are available.
Updating create ( $coll-name as xs:string ) as
The create function is an updating function which creates the collection with the given URI and the empty-sequence as contents.
Updating create ( $coll-name as xs:string, $content as node()* ) as
The create function is an updating function which creates the collection with the given URI.
Updating delete ( $coll-name as xs:string ) as
The delete function is an updating function that removes the collection with the given URI.
from-qname ( $name as xs:QName ) as xs:string
Function used for internal purposes only.
is-available-collection ( $coll-name as xs:string ) as xs:boolean
The function returns true if a collection with the given URI is available (i.
to-qname ( $name as xs:string ) as xs:QName
Function used for internal purposes only.
Functions
available-collections back to 'Function Summary'
declare function ddl:available-collections (

) as xs:string*

The function returns a sequence of URIs of the collections that are available. The sequence will be empty if there are no collections.

Returns:

Updating create back to 'Function Summary'
declare function ddl:create (
            $coll-name as xs:string
) as 

The create function is an updating function which creates the collection with the given URI and the empty-sequence as contents.

Parameters:
Returns:
Errors:

Updating create back to 'Function Summary'
declare function ddl:create (
            $coll-name as xs:string,
            $content as node()*
) as 

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

Parameters:
Returns:
Errors:

Updating delete back to 'Function Summary'
declare function ddl:delete (
            $coll-name as xs:string
) as 

The delete function is an updating function that removes the collection with the given URI.

Parameters:
Returns:
Errors:

from-qname back to 'Function Summary'
declare function ddl:from-qname (
            $name as xs:QName
) as xs:string

Function used for internal purposes only. It returns the namespace component of the given QName.

Parameters:
Returns:

is-available-collection back to 'Function Summary'
declare function ddl:is-available-collection (
            $coll-name as xs:string
) as xs:boolean

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

Parameters:
Returns:

to-qname back to 'Function Summary'
declare function ddl:to-qname (
            $name as xs:string
) as xs:QName

Function used for internal purposes only. It converts a URI given as string into a reserved QName. This QName is used in the module to be able to store collections identified by URIs using dynamic collections which are identified by QNames.

Parameters:
Returns:

blog comments powered by Disqus