Difference between revisions of "Process Module"
Jump to navigation
Jump to search
m (Text replace - "with Version 9.0}}:" to "with Version 9.0:}}") |
|||
Line 28: | Line 28: | ||
| | | | ||
* {{Code|proc:system('date')}} returns the current date on a Linux system. | * {{Code|proc:system('date')}} returns the current date on a Linux system. | ||
− | * The following example returns "Command not found" | + | * The following example returns "Command not found" (unless {{Code|xyz}} is a valid command on the system): |
<pre class="brush:xquery"> | <pre class="brush:xquery"> | ||
try { | try { |
Revision as of 11:36, 18 January 2018
This XQuery Module provides functions for executing system commands from XQuery.
Contents
Conventions
All functions and errors in this module are assigned to the http://basex.org/modules/proc
namespace, which is statically bound to the proc
prefix.
Functions
proc:system
Signatures | proc:system($cmd as xs:string) as xs:string proc:system($cmd as xs:string, $args as xs:string*) as xs:string proc:system($cmd as xs:string, $args as xs:string*, $options as map(xs:string, xs:string)) as xs:string |
Summary | Executes the specified command in a separate process and returns the result as string. $cmd is the name of the command, arguments to the command may be specified via $args . The $options parameter contains process options:
|
Errors | code.... : If the commands returns an exit code different to 0, an XQuery error will be raised. Its code will consist of the letters code and four digits with the exit code. code9999 will be returned if the command cannot be executed.encoding : the specified encoding does not exist or is not supported.timeout : the specified timeout was exceeded.
|
Examples |
try { proc:system('xyz') } catch bxerr:BXPR0002 { 'Command not found.' } |
proc:execute
Signatures | proc:execute($cmd as xs:string) as element(result) proc:execute($cmd as xs:string, $args as xs:string*) as element(result) proc:execute($cmd as xs:string, $args as xs:string*, $options as map(xs:string, xs:string)) as element(result)
|
Summary | Executes the specified command in a separate process and returns the result as element. $cmd is the name of the command, and arguments to the command may be specified via $args . The same $options are allowed as for proc:system. The code 9999 will be assigned if the command cannot be executed.A result has the following structure: <result> <output>...result output...</output> <error>...error output...</error> <code>0</code> </result> |
Errors | encoding : the specified encoding does not exist or is not supported.timeout : the specified timeout was exceeded.
|
Examples |
|
proc:fork
Signatures | proc:fork($cmd as xs:string) as element(result) proc:fork($cmd as xs:string, $args as xs:string*) as element(result) proc:fork($cmd as xs:string, $args as xs:string*, $options as map(xs:string, xs:string)) as element(result)
|
Summary | Executes the specified command and ignores the result. $cmd is the name of the command, and arguments to the command may be specified via $args . The same $options are allowed as for proc:system (but the encoding will be ignored).
|
Errors | encoding : the specified encoding does not exist or is not supported.
|
Examples |
|
proc:property
Signatures | proc:property($name as xs:string) as xs:string? |
Summary | Returns the system property, specified by $name , or a context parameter of the web.xml file with that name (see Web Applications). An empty sequence is returned if the property does not exist. For environment variables of the operating system, please use fn:environment-variable.
|
Examples |
|
proc:property-names
Signatures | proc:property-names() as xs:string* |
Summary | Returns the names of all Java system properties and context parameters of the web.xml file (see Web Applications). For environment variables of the operating system, please use fn:available-environment-variables.
|
Examples |
|
Errors
Code | Description |
---|---|
code...
|
The result of a command call with an exit code different to 0. |
code9999
|
A command could not be executed. |
encoding
|
The specified encoding does not exist or is not supported. |
timeout
|
The specified timeout was exceeded. |
Changelog
- Version 9.0
- Added: proc:fork
- Updated: error codes updated; errors now use the module namespace
- Version 8.6
- Updated: proc:system, proc:exec:
encoding
option moved to options argument,timeout
anddir
options added.
- Version 8.3
- Added: proc:property, proc:property-names.
The module was introduced with Version 7.3.