Difference between revisions of "Process Module"
Jump to navigation
Jump to search
m (Text replace - "7.2.2" to "7.3") |
|||
(43 intermediate revisions by 4 users not shown) | |||
Line 3: | Line 3: | ||
=Conventions= | =Conventions= | ||
− | All functions in this module are assigned to the | + | All functions and errors in this module are assigned to the <code><nowiki>http://basex.org/modules/proc</nowiki></code> namespace, which is statically bound to the {{Code|proc}} prefix.<br/> |
− | |||
=Functions= | =Functions= | ||
==proc:system== | ==proc:system== | ||
− | {| | + | |
+ | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signatures''' |
− | |{{Func|proc:system|$cmd as xs:string|xs:string}}<br/>{{Func|proc:system|$cmd as xs:string, $args as xs:string*|xs:string}}<br/>{{Func|proc:system|$cmd as xs:string, $args as xs:string*, $ | + | |{{Func|proc:system|$cmd as xs:string|xs:string}}<br/>{{Func|proc:system|$cmd as xs:string, $args as xs:string*|xs:string}}<br/>{{Func|proc:system|$cmd as xs:string, $args as xs:string*, $options as map(xs:string, xs:string)|xs:string}}<br/> |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Executes the specified command in a separate process and returns the result as string. | + | |Executes the specified command in a separate process and returns the result as string. {{Code|$cmd}} is the name of the command, arguments to the command may be specified via {{Code|$args}}. The {{Code|$options}} parameter contains process options: |
+ | * {{Code|encoding}}: convert result to the specified encoding. If no encoding is supplied, the system’s default encoding is used. | ||
+ | * {{Code|timeout}}: abort process execution after the specified number of seconds. | ||
+ | * {{Code|dir}}: process command in the specified directory. | ||
+ | * {{Code|input}}: standard string input ({{Code|stdin}}) to be passed on to the command. | ||
|- | |- | ||
|'''Errors''' | |'''Errors''' | ||
− | |{{Error| | + | |{{Error|encoding|#Error}} the specified encoding does not exist or is not supported.<br/>{{Error|timeout|#Error}} the specified timeout was exceeded.<br/>{{Error|error|#Error}} the command could not be executed, or an I/O exception was raised.<br/>{{Error|code....|#Error}} If the commands returns an exit code different to 0, an error will be raised. Its code will consist of the letters {{Code|code}} and four digits with the exit code.<br/> |
|- | |- | ||
| '''Examples''' | | '''Examples''' | ||
| | | | ||
* {{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 | + | * Analyses the given input and counts the number of lines, words and characters (provided that {{Code|wc}} is available on the system): |
+ | <pre class="brush:xquery"> | ||
+ | proc:system( | ||
+ | 'wc', (), | ||
+ | map { 'input': 'A B' || out:nl() || 'C' } | ||
+ | ) | ||
+ | </pre> | ||
+ | * 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 { | ||
proc:system('xyz') | proc:system('xyz') | ||
− | } catch | + | } catch proc:error { |
− | 'Command not found | + | 'Command not found: ' || $err:description |
} | } | ||
</pre> | </pre> | ||
Line 34: | Line 45: | ||
==proc:execute== | ==proc:execute== | ||
− | {| | + | |
+ | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signatures''' |
− | |{{Func|proc:execute|$cmd as xs:string|element(result)}}<br/>{{Func|proc:execute|$cmd as xs:string, $args as xs:string*|element(result)}}<br/>{{Func|proc:execute|$cmd as xs:string, $args as xs:string*, $ | + | |{{Func|proc:execute|$cmd as xs:string|element(result)}}<br/>{{Func|proc:execute|$cmd as xs:string, $args as xs:string*|element(result)}}<br/>{{Func|proc:execute|$cmd as xs:string, $args as xs:string*, $options as map(xs:string, xs:string)|element(result)}} |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Executes the specified command in a separate process and returns the result as element | + | |Executes the specified command in a separate process and returns the result as element: |
+ | * {{Code|$cmd}} is the name of the command, and arguments to the command may be specified via {{Code|$args}}. | ||
+ | * The same {{Code|$options}} are allowed as for [[#proc:system|proc:system]]. | ||
+ | * Instead of the {{Code|proc:error}} error, the error message and process code will be assigned to the returned elements. | ||
+ | * Instead of the {{Code|proc:code....}} error, the error message will be assigned to the returned element (no process code will be returned). | ||
+ | The result has the following structure: | ||
<pre class="brush:xml"> | <pre class="brush:xml"> | ||
<result> | <result> | ||
− | <output>... | + | <output>...output...</output> |
− | <error/> | + | <error>...error message...</error> |
− | + | <code>...process code...</code> | |
</result> | </result> | ||
</pre> | </pre> | ||
|- | |- | ||
|'''Errors''' | |'''Errors''' | ||
− | |{{Error| | + | |{{Error|encoding|#Error}} the specified encoding does not exist or is not supported.<br/>{{Error|timeout|#Error}} the specified timeout was exceeded. |
+ | |- | ||
+ | | '''Examples''' | ||
+ | | | ||
+ | * {{Code|proc:execute('dir', '\')}} returns the files of the root directory of a Windows system. | ||
+ | * {{Code|proc:execute('ls', ('-l', '-a'))}} executes the {{Code|ls -la}} command on Unix systems. | ||
+ | |} | ||
+ | |||
+ | ==proc:fork== | ||
+ | |||
+ | {| width='100%' | ||
+ | |- | ||
+ | | width='120' | '''Signatures''' | ||
+ | |{{Func|proc:fork|$cmd as xs:string|element(result)}}<br/>{{Func|proc:fork|$cmd as xs:string, $args as xs:string*|element(result)}}<br/>{{Func|proc:fork|$cmd as xs:string, $args as xs:string*, $options as map(xs:string, xs:string)|element(result)}} | ||
+ | |- | ||
+ | | '''Summary''' | ||
+ | |Executes the specified command and ignores the result. {{Code|$cmd}} is the name of the command, and arguments to the command may be specified via {{Code|$args}}. The same {{Code|$options}} are allowed as for [[#proc:system|proc:system]] (but the encoding will be ignored). | ||
+ | |- | ||
+ | |'''Errors''' | ||
+ | |{{Error|encoding|#Error}} the specified encoding does not exist or is not supported. | ||
+ | |- | ||
+ | | '''Examples''' | ||
+ | | | ||
+ | * {{Code|proc:fork('sleep', '5')}}: sleep for 5 seconds (no one should notice). | ||
+ | |} | ||
+ | |||
+ | ==proc:property== | ||
+ | |||
+ | {| width='100%' | ||
+ | |- | ||
+ | | width='120' | '''Signatures''' | ||
+ | |{{Func|proc:property|$name as xs:string|xs:string?}}<br/> | ||
+ | |- | ||
+ | | '''Summary''' | ||
+ | |Returns the system property, specified by {{Code|$name}}, or a context parameter of the {{Code|web.xml}} file with that name (see [[Web_Application#Configuration|Web Applications]]). An empty sequence is returned if the property does not exist. For environment variables of the operating system, please use [https://www.w3.org/TR/xpath-functions-30/#func-environment-variable fn:environment-variable]. | ||
|- | |- | ||
| '''Examples''' | | '''Examples''' | ||
| | | | ||
− | * {{Code|proc: | + | * {{Code|map:merge(proc:property-names() ! map:entry(., proc:property(.)))}} returns a map with all system properties. |
|} | |} | ||
− | = | + | ==proc:property-names== |
− | + | {| width='100%' | |
+ | |- | ||
+ | | width='120' | '''Signatures''' | ||
+ | |{{Func|proc:property-names||xs:string*}}<br/> | ||
+ | |- | ||
+ | | '''Summary''' | ||
+ | |Returns the names of all Java system properties and context parameters of the {{Code|web.xml}} file (see [[Web_Application#Configuration|Web Applications]]). For environment variables of the operating system, please use [https://www.w3.org/TR/xpath-functions-30/#func-available-environment-variables fn:available-environment-variables]. | ||
+ | |- | ||
+ | | '''Examples''' | ||
+ | | | ||
+ | * {{Code|proc:property('java.runtime.version')}} returns the version of the Java runtime engine. | ||
+ | |} | ||
=Errors= | =Errors= | ||
{| class="wikitable" width="100%" | {| class="wikitable" width="100%" | ||
− | ! width=" | + | ! width="110"|Code |
− | + | |Description | |
+ | |- | ||
+ | |{{Code|code...}} | ||
+ | |The result of a command call with an exit code different to 0. | ||
+ | |- | ||
+ | |{{Code|code9999}} | ||
+ | |A command could not be executed. | ||
|- | |- | ||
− | |{{Code| | + | |{{Code|encoding}} |
|The specified encoding does not exist or is not supported. | |The specified encoding does not exist or is not supported. | ||
+ | |- | ||
+ | |{{Code|timeout}} | ||
+ | |The specified timeout was exceeded. | ||
|} | |} | ||
+ | |||
+ | =Changelog= | ||
+ | |||
+ | ;Version 9.0 | ||
+ | |||
+ | * Added: [[#proc:fork|proc:fork]] | ||
+ | * Updated: error codes; errors now use the module namespace | ||
+ | * Updated: new {{Code|input}} option; revised error handling | ||
+ | |||
+ | ;Version 8.6 | ||
+ | |||
+ | * Updated: [[#proc:system|proc:system]], [[#proc:exec|proc:exec]]: {{Code|encoding}} option moved to options argument, {{Code|timeout}} and {{Code|dir}} options added. | ||
+ | |||
+ | ;Version 8.3 | ||
+ | |||
+ | * Added: [[#proc:property|proc:property]], [[#proc:property-names|proc:property-names]]. | ||
+ | |||
+ | The module was introduced with Version 7.3. |
Revision as of 13:22, 24 May 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 | encoding : the specified encoding does not exist or is not supported.timeout : the specified timeout was exceeded.error : the command could not be executed, or an I/O exception was raised.code.... : If the commands returns an exit code different to 0, an error will be raised. Its code will consist of the letters code and four digits with the exit code. |
Examples |
proc:system( 'wc', (), map { 'input': 'A B' || out:nl() || 'C' } )
try { proc:system('xyz') } catch proc:error { 'Command not found: ' || $err:description } |
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:
The result has the following structure: <result> <output>...output...</output> <error>...error message...</error> <code>...process code...</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; errors now use the module namespace
- Updated: new
input
option; revised error handling
- 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.