http://www.zorba-xquery.com/modules/xqxq ZC

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

This module contains functions to compile and evaluate XQuery programs. Also, it contains function that allow to parameterize the static or dynamic evaluation phase.

Author:

Juan Zacarias

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
Namespaces
an http://www.zorba-xquery.com/annotations
f http://www.zorba-xquery.com/features
op http://www.zorba-xquery.com/options/features
ver http://www.zorba-xquery.com/options/versioning
xqxq http://www.zorba-xquery.com/modules/xqxq
Function Summary
Sequential External bind-context-item ( $query-key as xs:anyURI, $dot as item() ) as empty-sequence()
This function binds the context-item of the prepared query identified by the given key to the $dot argument.
Sequential External bind-variable ( $query-key as xs:anyURI, $var as xs:QName, $value as item()* ) as empty-sequence()
This function binds the variable with name $name of the prepared query identified by $query-key to the given sequence.
Sequential External delete-query ( $query-key as xs:anyURI ) as empty-sequence()
Deletes the prepared query associated with the given identifier.
External evaluate ( $query-key as xs:anyURI ) as item()*
Evaluates the given prepared query and returns the result of the evaluation.
Sequential External evaluate-sequential ( $query-key as xs:string ) as item()*
Evaluates the given prepared query and returns the result of the evaluation.
Updating External evaluate-updating ( $query-key as xs:anyURI ) as
Evaluates the given prepared query and applies the updates computed by this query.
External external-variables ( $query-key as xs:anyURI ) as xs:QName*
The function returns the names of the external variables that are declared in the given query (either in the main module or in any of the imported library modules).
External is-bound-context-item ( $query-key as xs:anyURI ) as xs:boolean
The function tests if the context-item is bound for the execution of the query referred to by the given query identifier.
External is-bound-variable ( $query-key as xs:anyURI, $var-name as xs:QName ) as xs:boolean
The function tests if the given variable is bound for the execution of the query referred to by the given query identifier.
External is-sequential ( $query-key as xs:anyURI ) as xs:boolean
The function tests if the query identified by the given key is sequential query.
External is-updating ( $query-key as xs:anyURI ) as xs:boolean
The function tests if the query identified by the given key is an updating query.
External load-from-query-plan ( $plan as xs:base64Binary ) as xs:anyURI
The function loads a given XQuery program for execution from a xs:base64Binary query plan, obtained through the xqxq:query-plan function.
External load-from-query-plan ( $plan as xs:base64Binary, $resolver as item()?, $mapper as item()? ) as xs:anyURI
The function loads a given XQuery program for execution from a xs:base64Binary query plan, obtained through the xqxq:query-plan function.
Sequential External prepare-library-module ( $library-module-text as xs:string ) as empty-sequence()
This function compiles a given XQuery library module.
Sequential External prepare-main-module ( $main-module-text as xs:string ) as xs:anyURI
The function prepares a given XQuery program for execution.
Sequential External prepare-main-module ( $main-module-text as xs:string, $resolver as item()?, $mapper as item()? ) as xs:anyURI
The function prepares a given XQuery program for execution.
External query-plan ( $query-key as xs:anyURI ) as xs:base64Binary
Returns the compiled query identified by the given query-key as binary data.
External variable-value ( $query-key as xs:anyURI, $var-name as xs:QName ) as item()*
This function returns the value of a variable that is bound in the given query.
Functions
Sequential External bind-context-item back to 'Function Summary'
declare function xqxq:bind-context-item (
            $query-key as xs:anyURI,
            $dot as item()
) as empty-sequence()

This function binds the context-item of the prepared query identified by the given key to the $dot argument.

Parameters:
Returns:
Errors:

Sequential External bind-variable back to 'Function Summary'
declare function xqxq:bind-variable (
            $query-key as xs:anyURI,
            $var as xs:QName,
            $value as item()*
) as empty-sequence()

This function binds the variable with name $name of the prepared query identified by $query-key to the given sequence.

Parameters:
Returns:
Errors:

Sequential External delete-query back to 'Function Summary'
declare function xqxq:delete-query (
            $query-key as xs:anyURI
) as empty-sequence()

Deletes the prepared query associated with the given identifier. After the query is deleted, the corresponding identifier should not be used as argument to any of the functions of this module.

Parameters:
Returns:
Errors:

External evaluate back to 'Function Summary'
declare function xqxq:evaluate (
            $query-key as xs:anyURI
) as item()*

Evaluates the given prepared query and returns the result of the evaluation. The query must not be sequential or updating.

Parameters:
Returns:
Errors:

Sequential External evaluate-sequential back to 'Function Summary'
declare function xqxq:evaluate-sequential (
            $query-key as xs:string
) as item()*

Evaluates the given prepared query and returns the result of the evaluation. The query must be sequential.

Parameters:
Returns:
Errors:

Updating External evaluate-updating back to 'Function Summary'
declare function xqxq:evaluate-updating (
            $query-key as xs:anyURI
) as 

Evaluates the given prepared query and applies the updates computed by this query. The query must be an updating query.

Parameters:
Returns:
Errors:

External external-variables back to 'Function Summary'
declare function xqxq:external-variables (
            $query-key as xs:anyURI
) as xs:QName*

The function returns the names of the external variables that are declared in the given query (either in the main module or in any of the imported library modules).

Parameters:
Returns:
Errors:

External is-bound-context-item back to 'Function Summary'
declare function xqxq:is-bound-context-item (
            $query-key as xs:anyURI
) as xs:boolean

The function tests if the context-item is bound for the execution of the query referred to by the given query identifier.

Parameters:
Returns:
Errors:

External is-bound-variable back to 'Function Summary'
declare function xqxq:is-bound-variable (
            $query-key as xs:anyURI,
            $var-name as xs:QName
) as xs:boolean

The function tests if the given variable is bound for the execution of the query referred to by the given query identifier.

Parameters:
Returns:
Errors:

Sequential External is-sequential back to 'Function Summary'
declare function xqxq:is-sequential (
            $query-key as xs:anyURI
) as xs:boolean

The function tests if the query identified by the given key is sequential query.

Parameters:
Returns:
Errors:

Updating External is-updating back to 'Function Summary'
declare function xqxq:is-updating (
            $query-key as xs:anyURI
) as xs:boolean

The function tests if the query identified by the given key is an updating query.

Parameters:
Returns:
Errors:

External load-from-query-plan back to 'Function Summary'
declare function xqxq:load-from-query-plan (
            $plan as xs:base64Binary
) as xs:anyURI

The function loads a given XQuery program for execution from a xs:base64Binary query plan, obtained through the xqxq:query-plan function. If the program was successfully loaded, the function returns an identifier as xs:anyURI. This URI can be passed to other functions of this module (e.g. to actually evaluate the program). The URI is opaque and its lifetime is bound by the lifetime of the XQuery program that invoked this function. Further reference or uses of the identifier lead to unexpected results. Successfully prepared queries need to be deleted by passing the resulting identifier to the xqxq:delete-query function of this module.

Parameters:
Returns:
Errors:

External load-from-query-plan back to 'Function Summary'
declare function xqxq:load-from-query-plan (
            $plan as xs:base64Binary,
            $resolver as item()?,
            $mapper as item()?
) as xs:anyURI

The function loads a given XQuery program for execution from a xs:base64Binary query plan, obtained through the xqxq:query-plan function. If the program was successfully loaded, the function returns an identifier as xs:anyURI. This URI can be passed to other functions of this module (e.g. to actually evaluate the program). The URI is opaque and its lilfetime is bound by the lifetime of the XQuery program that invoked this function. Further reference or uses of the identifier lead to unexpected results. For important notes regarding the second and third parameters of the function, review the comments in xqxq:prepare-main-module#3. Successfully prepared queries need to be deleted by passing the resulting identifier to the xqxq:delete-query function of this module.

Parameters:
Returns:
Errors:

Sequential External prepare-library-module back to 'Function Summary'
declare function xqxq:prepare-library-module (
            $library-module-text as xs:string
) as empty-sequence()

This function compiles a given XQuery library module. It can be used to compile-check a module.

Parameters:
Returns:
Errors:

Sequential External prepare-main-module back to 'Function Summary'
declare function xqxq:prepare-main-module (
            $main-module-text as xs:string
) as xs:anyURI

The function prepares a given XQuery program for execution. If the program was successfully compiled, the function returns an identifier as xs:anyURI. This URI can be passed to other functions of this module (e.g. to actually evaluate the program). The URI is opaque and its lilfetime is bound by the lifetime of the XQuery program that invoked this function. Further reference or uses of the identifier lead to unexpected results. Successfully prepared queries need to be deleted by passing the resulting identifier to the xqxq:delete-query function of this module.

Parameters:
Returns:
Errors:

Sequential External prepare-main-module back to 'Function Summary'
declare function xqxq:prepare-main-module (
            $main-module-text as xs:string,
            $resolver as item()?,
            $mapper as item()?
) as xs:anyURI

The function prepares a given XQuery program for execution. If the program was successfully compiled, the function returns an identifier as xs:anyURI. This URI can be passed to other functions of this module (e.g. to actually evaluate the program). The URI is opaque and its lilfetime is bound by the lifetime of the XQuery program that invoked this function. Further reference or uses of the identifier lead to unexpected results. Important notes regarding the second and third parameters of the function: -------------------------------------------------------------------------- These parameters allow you to specify a URL resolver and a URI mapper for Zorba to use when executing this query. See http://www.zorba-xquery.com/html/documentation/2.7.0/zorba/uriresolvers The second parameter is a function item for a URL resolver. The URL resolver function must recive 2 parameters: A $namespace as xs:string that will contain the url to be resolved. A $entity as xs:string that will contain the type of resolving needed; this can be 2 values "module" and "schema". The function must return an empty sequence when the specified $namespace or $entity are not the ones to be resolved. Example: declare function mymod:url-resolver($namespace as xs:string, $entity as xs:string) { if($namespace = 'http://test.xq') then "module namespace test = 'http://test'; declare function test:foo(){'foo'};" else () }; The URL resolver function's namespace, name, and parameter naming are not restricted by XQXQ. The URL resolver function's return type is not restricted, it could be a string, a sequence, a node, etc. All the outputs types are to be serialized as a string. The third parameter is a function item for a URI mapper. The URI mapper function, just like the URL resolver, receives 2 parameters: A $namespace as xs:string that will contain the URI to be mapped. A $entity as xs:string that will contain the type of resolving needed; this can be 2 values "module" and "schema". The URI mapper must return an empty sequence when the specified $namesapce or $entity are not to be mapped. Unlike the URL resolver this function must return a sequence of strings. Example: declare function mymod:uri-mapper($namespace as xs:string, $entity as xs:string) { if($namespace = 'http://test') then ("http://www.zorba-xquery.com/test", "http://foo.com/schema/test") else () }; The URI mapper function's namespace, name, and parameter naming are not restricted by XQXQ. In order to pass the above URL resolver and URI mapper to this function, use the following syntax: variable $queryID := xqxq:prepare-main-module("..query text..", mymod:url-resolver#2, mymod:uri-mapper#2); That is, the QName of the function followed by "#2". This is XQuery "higher-order function" syntax, meaning the function with the specified QName which takes two arguments. Since URL resolvers and URI mappers must take two arguments, both will always be specified with "#2". Note that parameters 2 and 3 should be declared as follows: as function($url as xs:string, $entity as xs:string) as item() as function($uri as xs:string, $entity as xs:string) as xs:string* However Zorba's implementation of higher-order functions (HOF) is not yet complete enough to allow for this. When Zorba's HOF implementation is complete this function signature will be changed. Both the URL resolver and URI mapper functions are optional, meaning you may pass the empty-sequence () for either. Successfully prepared queries need to be deleted by passing the resulting identifier to the xqxq:delete-query function of this module.

Parameters:
Returns:
Errors:

External query-plan back to 'Function Summary'
declare function xqxq:query-plan (
            $query-key as xs:anyURI
) as xs:base64Binary

Returns the compiled query identified by the given query-key as binary data.

Parameters:
Returns:
Errors:

External variable-value back to 'Function Summary'
declare function xqxq:variable-value (
            $query-key as xs:anyURI,
            $var-name as xs:QName
) as item()*

This function returns the value of a variable that is bound in the given query.

Parameters:
Returns:
Errors: