XQuery Function Documentation

Search and Browse

http://exquery.org/ns/restxq/exist

java:org.exist.extensions.exquery.restxq.impl.xquery.exist.ExistRestXqModule

eXist specific extension functions for RESTXQ

exrest:dependencies#0

exrest:dependencies() as document-node()

Gets a list of all the dependencies of compiled XQuery modules discovered by RESTXQ in the process of discovering resource functions.

Returns:
document-node() : The list of dependencies.

exrest:deregister-module#1

exrest:deregister-module($module as xs:anyURI) as document-node()

Deregisters all resource functions identified in the XQuery Module from the RestXQ Registry.

Parameters:
$moduleA URI pointing to an XQuery module.
Returns:
document-node() : The list of deregistered resource functions.

exrest:deregister-resource-function#2

exrest:deregister-resource-function($module as xs:anyURI, $function-signature as xs:string) as xs:boolean

Deregisters a resource function from the RestXQ Registry.

Parameters:
$moduleA URI pointing to an XQuery module.
$function-signatureA signature identifying a resource function. Takes the format {namespace}local-name#arity e.g. {http://somenamespace}some-function#2
Returns:
xs:boolean : true if the function was deregistered, false otherwise.

exrest:find-resource-functions#1

exrest:find-resource-functions($module as xs:anyURI) as document-node()

Compiles the XQuery Module and examines it, producing a list of all the declared resource functions.

Parameters:
$moduleA URI pointing to an XQuery module.
Returns:
document-node() : The list of newly registered resource functions.

exrest:invalid-modules#0

exrest:invalid-modules() as xs:string

Gets a list of all the invalid XQuery modules discovered by RESTXQ in the process of discovering resource functions.

Returns:
xs:string* : The list of invalid XQuery modules.

exrest:missing-dependencies#0

exrest:missing-dependencies() as document-node()

Gets a list of all the missing dependencies for XQuery modules discovered by RESTXQ in the process of discovering resource functions.

Returns:
document-node() : The list of missing dependencies.

exrest:register-module#1

exrest:register-module($module as xs:anyURI) as document-node()

Registers all resource functions identified in the XQuery Module with the RestXQ Registry.

Parameters:
$moduleA URI pointing to an XQuery module.
Returns:
document-node() : The list of newly registered resource functions.

exrest:register-resource-function#2

exrest:register-resource-function($module as xs:anyURI, $function-signature as xs:string) as xs:boolean

Registers a resource function from the XQuery Module with the RestXQ Registry.

Parameters:
$moduleA URI pointing to an XQuery module.
$function-signatureA signature identifying a resource function. Takes the format {namespace}local-name#arity e.g. {http://somenamespace}some-function#2
Returns:
xs:boolean : true if the function was registered, false otherwise.