XQuery Function Documentation

Search and Browse

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

java:org.exist.console.xquery.ConsoleModule

XQuery module providing functions to log values to a local or remote console.

console:dump

console:dump($channel as xs:string, $vars as xs:string+) as empty-sequence()

Dump the local variable stack to the console, including all variables which are visible at the point the statement appears in the code. Only the variables matching one of the names given in parameter $vars are dumped. All others are ignored. Use with care: might produce lots of output.

Parameters:
$channel The channel to print to.
$vars+ The names of the variables to dump.
Returns:
empty-sequence() : Empty

console:dump

console:dump($channel as xs:string) as empty-sequence()

Dump the local variable stack to the console, including all variables which are visible at the point the statement appears in the code. Use with care: might produce lots of output.

Parameters:
$channel The channel to print to.
Returns:
empty-sequence() : Empty

console:dump

console:dump() as empty-sequence()

Dump the local variable stack to the console, including all variables which are visible at the point the statement appears in the code. Use with care: might produce lots of output.

Returns:
empty-sequence() : Empty

console:jmx-token

console:jmx-token() as xs:string?

Retrieves the authentication token required for access to the JMX servlet.

Returns:
xs:string? : The authentication token

console:log

console:log($items as item()*) as empty-sequence()

Logs a message to the logger using the template given in the first parameter and the 'default' channel.

Parameters:
$items* Values to be printed. Will be concatenated into a single string.
Returns:
empty-sequence() : Empty

console:log

console:log($channel as xs:string, $items as item()*) as empty-sequence()

Logs a message to the logger using the template given in the first parameter.

Parameters:
$channel The channel to print to.
$items* Values to be printed. Will be concatenated into a single string.
Returns:
empty-sequence() : Empty

console:send

console:send($channel as xs:string, $items as item()?) as empty-sequence()

Send a json message to the console

Parameters:
$channel The channel to print to.
$items? Value to be sent. Will be transformed into JSON.
Returns:
empty-sequence() : Empty