XQuery Function Documentation

Search and Browse

http://exist-db.org/xquery/inspection

java:org.exist.xquery.functions.inspect.InspectionModule

Functions for inspecting XQuery modules and functions

inspect:inspect-function

inspect:inspect-function($function as function) as node()

Returns an XML fragment describing the function referenced by the passed function item.

Parameters:
$function The function item to inspect
Returns:
node() : the signature of the function

inspect:inspect-module

inspect:inspect-module($location as xs:anyURI) as element()?

Compiles a module from source (without importing it) and returns an XML fragment describing the module and the functions/variables contained in it.

Parameters:
$location The location URI of the module to inspect
Returns:
element()? : An XML fragment describing the module and all functions contained in it.

inspect:inspect-module-uri

inspect:inspect-module-uri($uri as xs:anyURI) as element()?

Returns an XML fragment describing the module identified by the given URI and the functions/variables contained in it.

Parameters:
$uri The location URI of the module to inspect
Returns:
element()? : An XML fragment describing the module and all functions contained in it.

inspect:module-functions

inspect:module-functions() as function*

Returns a sequence of function items pointing to each public function in the current module.

Returns:
function* : Sequence of function items containing all public functions in the current module or the empty sequence if the module is not known in the current context.

inspect:module-functions

inspect:module-functions($location as xs:anyURI) as function*

Returns a sequence of function items pointing to each public function in the specified module.

Parameters:
$location The location URI of the module to be loaded.
Returns:
function* : Sequence of function items containing all public functions in the module or the empty sequence if the module is not known in the current context.

inspect:module-functions-by-uri

inspect:module-functions-by-uri($uri as xs:anyURI) as function*

Returns a sequence of function items pointing to each public function in the specified module.

Parameters:
$uri The URI of the module to be loaded.
Returns:
function* : Sequence of function items containing all public functions in the module or the empty sequence if the module is not known in the current context.