- All Modules
- All Functions
-
www.w3.org
- 2005
- XDM
- store
- introspection
- reflection
- external
-
xqdoc
-
project_xqdoc
-
xqdoc
(E)
- xqdoc2xhtml
-
project_xqdoc
- data processing
- expath.org
- www.functx.com
- debugger
- error
- www.zorba-xquery.com
http://www.zorba-xquery.com/modules/store/dynamic/collections/ddl
import module namespace ddl = "http://www.zorba-xquery.com/modules/store/dynamic/collections/ddl";
This modules defines a set of functions for managing persistent, ordered, and updatable collections.
Please refer to our documentation for more information about the lifecycle management and the manipulation of such collections.
Matthias Brantner, David Graf, Till Westmann, Markos Zaharioudakis
xquery version "3.0" encoding "utf-8";
The latest version of this module is 2.0. For more information about module versioning in Zorba please check out this resource.
- the XQuery module can be found here.
For more details please also see:
- Data Lifecycle
- http://www.zorba-xquery.com/modules/store/dynamic/collections/dml
- http://www.zorba-xquery.com/errors
ddl | 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 |
![]() |
available-collections
(
) as xs:QName* external The function returns a sequence of QNames of the collections that are available. |
![]() ![]() |
create
(
$name as xs:QName
) external The create function is an updating function which creates the collection with the given expanded QName. |
![]() ![]() |
create
(
$name as xs:QName,
$content as node()*
) external The create function is an updating function which creates the collection with the given expanded QName. |
![]() ![]() |
delete
(
$coll as xs:QName
) external The delete function is an updating function that removes the collection with the given expanded QName. |
![]() |
is-available-collection
(
$name as xs:QName
) as xs:boolean external The function returns true if a collection with the given QName is available. |
declare function ddl:available-collections ( ) as xs:QName* external
The function returns a sequence of QNames of the collections that are available. The sequence will be empty if there are no collections.
- A sequence of QNames, one for each available collection, or an emtpy sequence.
declare updating function ddl:create (
$name as xs:QName
) external
The create function is an updating function which creates the collection with the given expanded QName.
- $name The QName of the collection to create.
- The result of the function is an empty XDM instance and a pending update list which, once applied, creates a collection with the given name.
- zerr:ZDDY0002 if a collection with the given expanded QName already exists.
declare updating function ddl:create ( $name as xs:QName, $content as node()* ) external
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.
- $name The QName of the collection to create.
- $content The sequences of nodes that should be added to the new collection.
- The result of the function is an empty XDM instance and a pending update list which, once applied, creates a collection with the given name and inserts the given nodes into it.
- zerr:ZDDY0002 if a collection with the given expanded QName already exists.
- ddl:create
- ddl:insert-nodes-last
declare updating function ddl:delete (
$coll as xs:QName
) external
The delete function is an updating function that removes the collection with the given expanded QName.
- $name The QName of the collection to delete.
- The result of the function is an empty XDM instance and a pending update list which, once applied, deletes the collection with the given name.
- zerr:ZDDY0003 if the collection with the given name does not exist.
- zerr:ZDDY0015 if any of the in-scope variables references a node that belongs to the collection with QName $name.
declare function ddl:is-available-collection (
$name as xs:QName
) as xs:boolean external
The function returns true if a collection with the given QName is available.
- $name The QName of the collection that is being checked.
- true if the collection is available and false otherwise.