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

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

This module defines a set of functions to manage integrity constraints which are declared in the prolog of a module. For example, it provides functions to activate or deactivate integrity constraints.

This module is part of Zorba's XQuery Data Definition Facility. All the integrity constraints 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
icddl http://www.zorba-xquery.com/modules/store/static/integrity_constraints/ddl
ver http://www.zorba-xquery.com/options/versioning
zerr http://www.zorba-xquery.com/errors
Function Summary
Updating External activate ( $name as xs:QName ) external
The activate function is an updating function that activates the integrity constraint identified by the expanded QName $name in the dynamic context.
External activated-integrity-constraints ( ) as xs:QName* external
The function returns a sequence of QNames representing the integrity constraints that are activated.
Updating External deactivate ( $name as xs:QName ) external
The deactivate function is an updating function that deactivates the integrity constraint with the given QName.
External declared-integrity-constraints ( ) as xs:QName* external
The function returns a sequence of QNames representing the integrity constraints that have been declared in the prolog of the static context.
External is-activated-integrity-constraint ( $name as xs:QName ) as xs:boolean external
The function returns true if an integrity constraints with the given QName is activated.
External is-declared-integrity-constraint ( $name as xs:QName ) as xs:boolean external
The function returns true if a integrity constraints with the given QName is declared in the prolog of the static context.
Functions
Updating External activate back to 'Function Summary'
declare updating function icddl:activate (
            $name as xs:QName 
 ) external

The activate function is an updating function that activates the integrity constraint identified by the expanded QName $name in the dynamic context.

Parameters:
Returns:
Errors:

External activated-integrity-constraints back to 'Function Summary'
declare function icddl:activated-integrity-constraints (
 ) as xs:QName* external

The function returns a sequence of QNames representing the integrity constraints that are activated. The sequence will be empty if there are none.

Returns:

Updating External deactivate back to 'Function Summary'
declare updating function icddl:deactivate (
            $name as xs:QName 
 ) external

The deactivate function is an updating function that deactivates the integrity constraint with the given QName.

Parameters:
Returns:
Errors:

External declared-integrity-constraints back to 'Function Summary'
declare function icddl:declared-integrity-constraints (
 ) as xs:QName* external

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

Returns:

External is-activated-integrity-constraint back to 'Function Summary'
declare function icddl:is-activated-integrity-constraint (
            $name as xs:QName 
 ) as xs:boolean external

The function returns true if an integrity constraints with the given QName is activated.

Parameters:
Returns:

External is-declared-integrity-constraint back to 'Function Summary'
declare function icddl:is-declared-integrity-constraint (
            $name as xs:QName 
 ) as xs:boolean external

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

Parameters:
Returns:

blog comments powered by Disqus