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

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

This modules provides a set of functions to modify a collection and retrieve the nodes contained in a particular collection.

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

Module Resources
Related Documentation

For more details please also see:

Namespaces
ann http://www.zorba-xquery.com/annotations
cdml http://www.zorba-xquery.com/modules/store/static/collections/dml
ver http://www.zorba-xquery.com/options/versioning
zerr http://www.zorba-xquery.com/errors
Function Summary
apply-insert-nodes ( $name as xs:QName, $content as node()* ) as node()* external
This function does the same as the insert-nodes function except it immediately applies the resulting pending updates and returns the nodes that have been inserted.
apply-insert-nodes-after ( $name as xs:QName, $pos as node(), $content as node()* ) as node()* external
This function does the same as the insert-nodes-after function except it immediately applies the resulting pending updates and returns the nodes that have been inserted.
apply-insert-nodes-before ( $name as xs:QName, $target as node(), $content as node()* ) as node()* external
This function does the same as the insert-nodes-before function except it immediately applies the resulting pending updates and returns the nodes that have been inserted.
apply-insert-nodes-first ( $name as xs:QName, $content as node()* ) as node()* external
This function does the same as the insert-nodes-first function except it immediately applies the resulting pending updates and returns the nodes that have been inserted.
apply-insert-nodes-last ( $name as xs:QName, $content as node()* ) as node()* external
This function does the same as the insert-nodes-last function except it immediately applies the resulting pending updates and returns the nodes that have been inserted.
collection ( $name as xs:QName ) as node()* external
The collection function returns the sequence of nodes of the collection identified by the given name.
collection-name ( $node as node() ) as xs:QName external
This function returns the name of the collection the given node belongs to.
delete-node-first ( $name as xs:QName ) external
The delete-node-first function is an updating function that deletes the first node from an ordered collection.
delete-node-last ( $name as xs:QName ) external
The delete-node-last function is an updating function that deletes the last node from an ordered collection.
delete-nodes ( $target as node()* ) external
The delete-nodes function is an updating function that deletes zero of more nodes from a collection.
delete-nodes-first ( $name as xs:QName, $number as xs:integer ) external
The delete-nodes-first function is an updating function that deletes the first n nodes from an ordered collection.
delete-nodes-last ( $name as xs:QName, $number as xs:integer ) external
The delete-nodes-last function is an updating function that deletes the last n nodes from an ordered collection.
index-of ( $node as node() ) as xs:integer external
The index-of function that returns the position of the node in its collection.
insert-nodes ( $name as xs:QName, $content as node()* ) external
The insert-nodes function is an updating function that inserts copies of the given nodes into a collection.
insert-nodes-after ( $name as xs:QName, $target as node(), $content as node()* ) external
The insert-nodes-after function is an updating function that inserts copies of the given nodes into a collection at the position directlry following the given target node.
insert-nodes-before ( $name as xs:QName, $target as node(), $content as node()* ) external
The insert-nodes-before function is an updating function that inserts copies of the given nodes into a collection at the position directly preceding the given target node.
insert-nodes-first ( $name as xs:QName, $content as node()* ) external
The insert-nodes-first function is an updating function that inserts copies of the given nodes at the beginning of a collection.
insert-nodes-last ( $name as xs:QName, $content as node()* ) external
The insert-nodes-last function is an updating function that inserts copies of the given nodes at the end of a collection.
Functions
apply-insert-nodes back to 'Function Summary'
declare %ann:sequential function cdml:apply-insert-nodes (
            $name as xs:QName, 
            $content as node()* 
 ) as node()* external

This function does the same as the insert-nodes function except it immediately applies the resulting pending updates and returns the nodes that have been inserted.

Parameters:
Returns:
Errors:
See:

apply-insert-nodes-after back to 'Function Summary'
declare %ann:sequential function cdml:apply-insert-nodes-after (
            $name as xs:QName, 
            $pos as node(), 
            $content as node()* 
 ) as node()* external

This function does the same as the insert-nodes-after function except it immediately applies the resulting pending updates and returns the nodes that have been inserted.

Parameters:
Returns:
Errors:
See:

apply-insert-nodes-before back to 'Function Summary'
declare %ann:sequential function cdml:apply-insert-nodes-before (
            $name as xs:QName, 
            $target as node(), 
            $content as node()* 
 ) as node()* external

This function does the same as the insert-nodes-before function except it immediately applies the resulting pending updates and returns the nodes that have been inserted.

Parameters:
Returns:
Errors:
See:

apply-insert-nodes-first back to 'Function Summary'
declare %ann:sequential function cdml:apply-insert-nodes-first (
            $name as xs:QName, 
            $content as node()* 
 ) as node()* external

This function does the same as the insert-nodes-first function except it immediately applies the resulting pending updates and returns the nodes that have been inserted.

Parameters:
Returns:
Errors:
See:

apply-insert-nodes-last back to 'Function Summary'
declare %ann:sequential function cdml:apply-insert-nodes-last (
            $name as xs:QName, 
            $content as node()* 
 ) as node()* external

This function does the same as the insert-nodes-last function except it immediately applies the resulting pending updates and returns the nodes that have been inserted.

Parameters:
Returns:
Errors:
See:

collection back to 'Function Summary'
declare function cdml:collection (
            $name as xs:QName 
 ) as node()* external

The collection function returns the sequence of nodes of the collection identified by the given name.

Parameters:
Returns:
Errors:

collection-name back to 'Function Summary'
declare function cdml:collection-name (
            $node as node() 
 ) as xs:QName external

This function returns the name of the collection the given node belongs to.

Parameters:
Returns:
Errors:

delete-node-first back to 'Function Summary'
declare updating function cdml:delete-node-first (
            $name as xs:QName 
 ) external

The delete-node-first function is an updating function that deletes the first node from an ordered collection.

Parameters:
Returns:
Errors:

delete-node-last back to 'Function Summary'
declare updating function cdml:delete-node-last (
            $name as xs:QName 
 ) external

The delete-node-last function is an updating function that deletes the last node from an ordered collection.

Parameters:
Returns:
Errors:

delete-nodes back to 'Function Summary'
declare updating function cdml:delete-nodes (
            $target as node()* 
 ) external

The delete-nodes function is an updating function that deletes zero of more nodes from a collection.

Parameters:
Returns:
Errors:

delete-nodes-first back to 'Function Summary'
declare updating function cdml:delete-nodes-first (
            $name as xs:QName, 
            $number as xs:integer 
 ) external

The delete-nodes-first function is an updating function that deletes the first n nodes from an ordered collection.

Parameters:
Returns:
Errors:

delete-nodes-last back to 'Function Summary'
declare updating function cdml:delete-nodes-last (
            $name as xs:QName, 
            $number as xs:integer 
 ) external

The delete-nodes-last function is an updating function that deletes the last n nodes from an ordered collection.

Parameters:
Returns:
Errors:

index-of back to 'Function Summary'
declare function cdml:index-of (
            $node as node() 
 ) as xs:integer external

The index-of function that returns the position of the node in its collection.

Parameters:
Returns:
Errors:

insert-nodes back to 'Function Summary'
declare updating function cdml:insert-nodes (
            $name as xs:QName, 
            $content as node()* 
 ) external

The insert-nodes function is an updating function that inserts copies of the given nodes into a collection. Please note that the insertion position of the nodes in the collection is not defined.

Parameters:
Returns:
Errors:

insert-nodes-after back to 'Function Summary'
declare updating function cdml:insert-nodes-after (
            $name as xs:QName, 
            $target as node(), 
            $content as node()* 
 ) external

The insert-nodes-after function is an updating function that inserts copies of the given nodes into a collection at the position directlry following the given target node.

Parameters:
Returns:
Errors:

insert-nodes-before back to 'Function Summary'
declare updating function cdml:insert-nodes-before (
            $name as xs:QName, 
            $target as node(), 
            $content as node()* 
 ) external

The insert-nodes-before function is an updating function that inserts copies of the given nodes into a collection at the position directly preceding the given target node.

Parameters:
Returns:
Errors:

insert-nodes-first back to 'Function Summary'
declare updating function cdml:insert-nodes-first (
            $name as xs:QName, 
            $content as node()* 
 ) external

The insert-nodes-first function is an updating function that inserts copies of the given nodes at the beginning of a collection.

Parameters:
Returns:
Errors:

insert-nodes-last back to 'Function Summary'
declare updating function cdml:insert-nodes-last (
            $name as xs:QName, 
            $content as node()* 
 ) external

The insert-nodes-last function is an updating function that inserts copies of the given nodes at the end of a collection.

Parameters:
Returns:
Errors:

blog comments powered by Disqus