Difference between revisions of "XQuery Module"
(32 intermediate revisions by the same user not shown) | |||
Line 3: | Line 3: | ||
=Conventions= | =Conventions= | ||
− | All functions in this module are assigned to the <code><nowiki>http://basex.org/modules/xquery</nowiki></code> namespace, which is statically bound to the {{Code|xquery}} prefix.<br/> | + | {{Mark|Updated with Version 9.0:}} |
− | + | ||
+ | All functions and errors in this module are assigned to the <code><nowiki>http://basex.org/modules/xquery</nowiki></code> namespace, which is statically bound to the {{Code|xquery}} prefix.<br/> | ||
=Functions= | =Functions= | ||
Line 10: | Line 11: | ||
==xquery:eval== | ==xquery:eval== | ||
− | {{Mark|Updated with Version | + | {{Mark|Updated with Version 9.0:}} {{code|pass}} option added. |
{| width='100%' | {| width='100%' | ||
|- | |- | ||
| width='120' | '''Signatures''' | | width='120' | '''Signatures''' | ||
− | |{{Func|xquery:eval|$query as xs:string|item()*}}<br />{{Func|xquery:eval|$query as xs:string, $bindings as map(*)|item()*}}<br />{{Func|xquery:eval|$query as xs:string, $bindings as map(*), $options as map( | + | |{{Func|xquery:eval|$query as xs:string|item()*}}<br />{{Func|xquery:eval|$query as xs:string, $bindings as map(*)?|item()*}}<br />{{Func|xquery:eval|$query as xs:string, $bindings as map(*)?, $options as map(*)?|item()*}}<br /> |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
Line 25: | Line 26: | ||
* {{Code|permission}}: the query will be evaluated with the specified permissions (see [[User Management]]). | * {{Code|permission}}: the query will be evaluated with the specified permissions (see [[User Management]]). | ||
* {{Code|timeout}}: query execution will be interrupted after the specified number of seconds. | * {{Code|timeout}}: query execution will be interrupted after the specified number of seconds. | ||
− | * {{Code|memory}}: query execution will be interrupted if the specified number of megabytes will be exceeded. This check works best if only one process is running at the same time. | + | * {{Code|memory}}: query execution will be interrupted if the specified number of megabytes will be exceeded. This check works best if only one process is running at the same time. Moreover, please note that this option enforces garbage collection, so it will take some additional time, and it requires GC to be enabled in your JVM. |
− | * {{Code|base-uri}}: | + | * {{Code|base-uri}}: set [https://www.w3.org/TR/xquery-31/#dt-static-base-uri base-uri property] for the query. This URI will be used when resolving relative URIs by functions such as {{Code|fn:doc}}. |
+ | * {{Code|pass}}: passes on the original error info (line and column number, optional file uri). By default, this option is {{Code|false}}. | ||
|- | |- | ||
| '''Errors''' | | '''Errors''' | ||
− | |{{Error| | + | |{{Error|update|#Errors}} the query contains [[XQuery Update#Updating Expressions|updating expressions]].<br/>{{Error|permission|#Errors}} insufficient permissions for evaluating the query.<br/>{{Error|timeout|#Errors}} query execution exceeded timeout.<br/>{{Error|limit|#Errors}} query execution exceeded memory limit.<br/>{{Error|nested|#Errors}} nested query evaluation is not allowed.<br/>Any other error that may occur while evaluating the query. |
|- | |- | ||
| '''Examples''' | | '''Examples''' | ||
Line 65: | Line 67: | ||
|} | |} | ||
− | ==xquery:update== | + | ==xquery:eval-update== |
+ | |||
+ | {{Mark|Updated with Version 9.0:}} Renamed (old name: xquery:update) | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
| width='120' | '''Signatures''' | | width='120' | '''Signatures''' | ||
− | |{{Func|xquery:update|$query as xs:string|item()*}}<br />{{Func|xquery:update|$query as xs:string, $bindings as map(*)|item()*}}<br />{{Func|xquery:update|$query as xs:string, $bindings as map(*), $options as map( | + | |{{Func|xquery:eval-update|$query as xs:string|item()*}}<br />{{Func|xquery:eval-update|$query as xs:string, $bindings as map(*)?|item()*}}<br />{{Func|xquery:eval-update|$query as xs:string, $bindings as map(*)?, $options as map(*)?|item()}}<br /> |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Evaluates {{Code|$query}} as updating XQuery expression at runtime.<br/>All updates will be added to the [[XQuery Update#Pending Update List|Pending Update List]] of the main query and performed after the evaluation of the main query.<br />The | + | |Evaluates {{Code|$query}} as updating XQuery expression at runtime.<br/>All updates will be added to the [[XQuery Update#Pending Update List|Pending Update List]] of the main query and performed after the evaluation of the main query.<br />The rules of the {{Code|$bindings}} and {{Code|$options}} parameters are the same as for [[#xquery:eval|xquery:eval]]. |
|- | |- | ||
| '''Errors''' | | '''Errors''' | ||
− | |{{Error| | + | |{{Error|update|#Errors}} the query contains no [[XQuery Update#Updating Expressions|updating expressions]].<br/>{{Error|permission|#Errors}} insufficient permissions for evaluating the query.<br/>{{Error|timeout|#Errors}} query execution exceeded timeout.<br/>{{Error|limit|#Errors}} query execution exceeded memory limit.<br/>{{Error|nested|#Errors}} nested query evaluation is not allowed.<br/>Any other error that may occur while evaluating the query. |
+ | |} | ||
+ | |||
+ | ==xquery:invoke== | ||
+ | |||
+ | {| width='100%' | ||
+ | |- | ||
+ | | width='120' | '''Signatures''' | ||
+ | |{{Func|xquery:invoke|$uri as xs:string|item()*}}<br />{{Func|xquery:invoke|$uri as xs:string, $bindings as map(*)?|item()*}}<br />{{Func|xquery:invoke|$uri as xs:string, $bindings as map(*)?, $options as map(*)?|item()*}}<br /> | ||
+ | |- | ||
+ | | '''Summary''' | ||
+ | |Evaluates the XQuery module located at {{Code|$uri}} at runtime and returns the resulting items. A relative URI will be resolved against the static base URI of the query.<br />The rules of the {{Code|$bindings}} and {{Code|$options}} parameters are the same as for [[#xquery:eval|xquery:eval]]. | ||
+ | |- | ||
+ | | '''Errors''' | ||
+ | |{{Error|update|#Errors}} the expression contains [[XQuery Update#Updating Expressions|updating expressions]].<br/>{{Error|permission|#Errors}} insufficient permissions for evaluating the query.<br/>{{Error|timeout|#Errors}} query execution exceeded timeout.<br/>{{Error|nested|#Errors}} nested query evaluation is not allowed.<br/>Any other error that may occur while evaluating the query. | ||
+ | |} | ||
+ | |||
+ | ==xquery:invoke-update== | ||
+ | |||
+ | {| width='100%' | ||
+ | |- | ||
+ | | width='120' | '''Signatures''' | ||
+ | |{{Func|xquery:invoke-update|$uri as xs:string|item()*}}<br />{{Func|xquery:invoke-update|$uri as xs:string, $bindings as map(*)?|item()*}}<br />{{Func|xquery:invoke-update|$uri as xs:string, $bindings as map(*)?, $options as map(*)?|item()*}}<br /> | ||
+ | |- | ||
+ | | '''Summary''' | ||
+ | |Evaluates the updating XQuery module located at {{Code|$uri}} at runtime. A relative URI will be resolved against the static base URI of the query.<br />The rules of the {{Code|$bindings}} and {{Code|$options}} parameters are the same as for [[#xquery:eval|xquery:eval]]. | ||
+ | |- | ||
+ | | '''Errors''' | ||
+ | |{{Error|update|#Errors}} the expression contains no [[XQuery Update#Updating Expressions|updating expressions]].<br/>{{Error|permission|#Errors}} insufficient permissions for evaluating the query.<br/>{{Error|timeout|#Errors}} query execution exceeded timeout.<br/>{{Error|nested|#Errors}} nested query evaluation is not allowed.<br/>Any other error that may occur while evaluating the query. | ||
|} | |} | ||
==xquery:parse== | ==xquery:parse== | ||
+ | |||
+ | {{Mark|Updated with Version 9.0:}} {{code|base-uri}} option added. | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
| width='120' | '''Signatures''' | | width='120' | '''Signatures''' | ||
− | |{{Func|xquery:parse|$query as xs:string|item() | + | |{{Func|xquery:parse|$query as xs:string|item()?}}<br />{{Func|xquery:parse|$query as xs:string, $options as map(*)?|item()?}}<br /> |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
Line 91: | Line 125: | ||
* {{Code|plan}}: returns an XML representation of the internal query plan. By default, this option is {{Code|true}}. The naming of the expressions in the query plan may change over time | * {{Code|plan}}: returns an XML representation of the internal query plan. By default, this option is {{Code|true}}. The naming of the expressions in the query plan may change over time | ||
* {{Code|pass}}: passes on the original error info (line and column number, optional file uri). By default, this option is {{Code|false}}. | * {{Code|pass}}: passes on the original error info (line and column number, optional file uri). By default, this option is {{Code|false}}. | ||
+ | * {{Code|base-uri}}: set [https://www.w3.org/TR/xquery-31/#dt-static-base-uri base-uri property] for the query. This URI will be used when resolving relative URIs by functions such as {{Code|fn:doc}}. | ||
|- | |- | ||
| '''Errors''' | | '''Errors''' | ||
Line 111: | Line 146: | ||
==xquery:parse-uri== | ==xquery:parse-uri== | ||
+ | |||
+ | {{Mark|Updated with Version 9.0:}} {{code|base-uri}} option added. | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
| width='120' | '''Signatures''' | | width='120' | '''Signatures''' | ||
− | |{{Func|xquery:parse-uri|$uri as xs:string|item() | + | |{{Func|xquery:parse-uri|$uri as xs:string|item()?}}<br />{{Func|xquery:parse-uri|$uri as xs:string, $options as map(*)?|item()?}}<br /> |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Parses the XQuery module located at {{Code|$uri}} and returns the resulting query plan. The {{Code|$options}} parameter | + | |Parses the XQuery module located at {{Code|$uri}} and returns the resulting query plan. A relative URI will be resolved against the static base URI of the query. The rules for the {{Code|$options}} parameter are the same as for [[#xquery:parse|xquery:parse]]. |
|- | |- | ||
| '''Errors''' | | '''Errors''' | ||
Line 124: | Line 161: | ||
|} | |} | ||
− | ==xquery: | + | =Parallelized Execution= |
+ | |||
+ | Parallel query execution is recommendable if you have various calls that require a lot of time, but cannot be sped up by rewriting the code. This is e. g. the case if external URLs are called. If you are parallelizing local data reads (such as the access to a database), single-threaded queries will usually be faster, because parallelized access to disk data often results in randomized access patterns, which can hardly be optimized by the caching strategies of HD, SSD or operating system. | ||
+ | |||
+ | ==xquery:fork-join== | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
| width='120' | '''Signatures''' | | width='120' | '''Signatures''' | ||
− | |{{Func|xquery: | + | |{{Func|xquery:fork-join|$functions as function(*)*|item()*}} |
|- | |- | ||
− | | '''Summary''' | + | |'''Summary''' |
− | | | + | |This function executes the supplied (non-updating) functions in parallel. |
|- | |- | ||
− | | ''' | + | | '''Examples''' |
− | |{ | + | | |
− | + | * The following function sleeps in parallel; it will be finished in 1 second if your system has at least 2 cores: | |
− | + | <pre class='brush:xquery'> | |
− | + | let $f := function() { prof:sleep(1000) } | |
− | + | return xquery:fork-join(($f, $f)) | |
− | + | </pre> | |
+ | * In the following query, up to four URLs will be requested in parallel: | ||
+ | <pre class='brush:xquery'> | ||
+ | let $funcs := | ||
+ | for $segment in 1 to 4 | ||
+ | let $url := 'http://url.com/path' || $segment | ||
+ | return function() { http:send-request((), $url) } | ||
+ | return xquery:fork-join($funcs) | ||
+ | </pre> | ||
|- | |- | ||
− | + | |'''Errors''' | |
− | |{{ | + | |{{Error|error|#Errors}} an unexpected error occurred. |
− | |||
− | |||
− | |||
|} | |} | ||
=Errors= | =Errors= | ||
+ | |||
+ | {{Mark|Updated with Version 9.0:}} | ||
{| class="wikitable" width="100%" | {| class="wikitable" width="100%" | ||
Line 155: | Line 203: | ||
|Description | |Description | ||
|- | |- | ||
− | |{{Code| | + | |{{Code|permission}} |
− | | | + | |Insufficient permissions for evaluating the query. |
+ | |- | ||
+ | |{{Code|update}} | ||
+ | |[[XQuery Update#Updating Expressions|updating expression]] found or expected. | ||
|- | |- | ||
− | |{{Code| | + | |{{Code|timeout}} |
− | | | + | |Query execution exceeded timeout. |
|- | |- | ||
− | |{{Code| | + | |{{Code|memory}} |
− | | | + | |Query execution exceeded memory limit. |
+ | |- | ||
+ | |{{Code|nested}} | ||
+ | |Nested query evaluation is not allowed. | ||
|- | |- | ||
− | |{{Code| | + | |{{Code|error}} |
− | | | + | |An unexpected error occurred. |
|} | |} | ||
=Changelog= | =Changelog= | ||
+ | |||
+ | ;Version 9.0 | ||
+ | |||
+ | * Added: [[#xquery:invoke-update|xquery:invoke-update]] | ||
+ | * Updated: [[#xquery:eval|xquery:eval]]: {{Code|pass}} option added | ||
+ | * Updated: [[#xquery:parse|xquery:parse]], [[#xquery:parse-uri|xquery:parse-uri]]: {{Code|base-uri}} option added | ||
+ | * Updated: xquery:update renamed to [[#xquery:eval-update|xquery:eval-update]] | ||
+ | * Updated: error codes updated; errors now use the module namespace | ||
;Version 8.5 | ;Version 8.5 | ||
+ | |||
+ | * Added: [[#xquery:fork-join|xquery:fork-join]] | ||
* Updated: [[#xquery:eval|xquery:eval]]: {{Code|base-uri}} option added | * Updated: [[#xquery:eval|xquery:eval]]: {{Code|base-uri}} option added | ||
+ | * Updated: Relative URIs will always be resolved against the static base URI of the query | ||
+ | * Deleted: xquery:type (moved to [[Profiling Module]] | ||
;Version 8.4 | ;Version 8.4 | ||
+ | |||
* Added: [[#xquery:parse-uri|xquery:parse-uri]] | * Added: [[#xquery:parse-uri|xquery:parse-uri]] | ||
* Updated: [[#xquery:parse|xquery:parse]]: {{Code|pass}} option added | * Updated: [[#xquery:parse|xquery:parse]]: {{Code|pass}} option added | ||
;Version 8.0 | ;Version 8.0 | ||
− | * Added: | + | |
+ | * Added: xquery:update, [[#xquery:parse|xquery:parse]] | ||
* Deleted: [[#xquery:evaluate|xquery:evaluate]] (opened databases will now be closed by main query) | * Deleted: [[#xquery:evaluate|xquery:evaluate]] (opened databases will now be closed by main query) | ||
;Version 7.8.2 | ;Version 7.8.2 | ||
+ | |||
* Added: {{Code|$options}} argument | * Added: {{Code|$options}} argument | ||
;Version 7.8 | ;Version 7.8 | ||
+ | |||
* Added: [[#xquery:evaluate|xquery:evaluate]] | * Added: [[#xquery:evaluate|xquery:evaluate]] | ||
* Updated: used variables must be explicitly declared in the query string. | * Updated: used variables must be explicitly declared in the query string. | ||
This module was introduced with Version 7.3. Functions have been adopted from the obsolete Utility Module. | This module was introduced with Version 7.3. Functions have been adopted from the obsolete Utility Module. |
Revision as of 12:16, 24 November 2017
This XQuery Module contains functions for evaluating XQuery strings and modules at runtime.
Contents
Conventions
All functions and errors in this module are assigned to the http://basex.org/modules/xquery
namespace, which is statically bound to the xquery
prefix.
Functions
xquery:eval
Template:Mark pass
option added.
Signatures | xquery:eval($query as xs:string) as item()* xquery:eval($query as xs:string, $bindings as map(*)?) as item()* xquery:eval($query as xs:string, $bindings as map(*)?, $options as map(*)?) as item()* |
Summary | Evaluates the supplied $query string as XQuery expression and returns the resulting items.The evaluated query has its own query context. If a returned node is stored in a database, a main-memory copy will be returned as result, because the referenced database is closed after query execution and will not be accessible anymore. Variables and context items can be declared via $bindings . The specified keys must be QNames or strings:
The
|
Errors | update : the query contains updating expressions.permission : insufficient permissions for evaluating the query.timeout : query execution exceeded timeout.limit : query execution exceeded memory limit.nested : nested query evaluation is not allowed.Any other error that may occur while evaluating the query. |
Examples |
xquery:eval("//country", map { '': db:open('factbook') })
xquery:eval(".", map { '': 'XML' }), xquery:eval("declare variable $xml external; $xml", map { 'xml': 'XML' }), xquery:eval( "declare namespace pref='URI'; declare variable $pref:xml external; $pref:xml", map { '{URI}xml': 'XML' } )
declare namespace pref = 'URI'; xquery:eval("declare variable $xml external; $xml", map { xs:QName('xml'): 'XML' }), let $query := "declare namespace pref='URI'; declare variable $pref:xml external; $pref:xml" let $vars := map { xs:QName('pref:xml'): 'XML' } return xquery:eval($query, $vars) |
xquery:eval-update
Template:Mark Renamed (old name: xquery:update)
Signatures | xquery:eval-update($query as xs:string) as item()* xquery:eval-update($query as xs:string, $bindings as map(*)?) as item()* xquery:eval-update($query as xs:string, $bindings as map(*)?, $options as map(*)?) as item() |
Summary | Evaluates $query as updating XQuery expression at runtime.All updates will be added to the Pending Update List of the main query and performed after the evaluation of the main query. The rules of the $bindings and $options parameters are the same as for xquery:eval.
|
Errors | update : the query contains no updating expressions.permission : insufficient permissions for evaluating the query.timeout : query execution exceeded timeout.limit : query execution exceeded memory limit.nested : nested query evaluation is not allowed.Any other error that may occur while evaluating the query. |
xquery:invoke
Signatures | xquery:invoke($uri as xs:string) as item()* xquery:invoke($uri as xs:string, $bindings as map(*)?) as item()* xquery:invoke($uri as xs:string, $bindings as map(*)?, $options as map(*)?) as item()* |
Summary | Evaluates the XQuery module located at $uri at runtime and returns the resulting items. A relative URI will be resolved against the static base URI of the query.The rules of the $bindings and $options parameters are the same as for xquery:eval.
|
Errors | update : the expression contains updating expressions.permission : insufficient permissions for evaluating the query.timeout : query execution exceeded timeout.nested : nested query evaluation is not allowed.Any other error that may occur while evaluating the query. |
xquery:invoke-update
Signatures | xquery:invoke-update($uri as xs:string) as item()* xquery:invoke-update($uri as xs:string, $bindings as map(*)?) as item()* xquery:invoke-update($uri as xs:string, $bindings as map(*)?, $options as map(*)?) as item()* |
Summary | Evaluates the updating XQuery module located at $uri at runtime. A relative URI will be resolved against the static base URI of the query.The rules of the $bindings and $options parameters are the same as for xquery:eval.
|
Errors | update : the expression contains no updating expressions.permission : insufficient permissions for evaluating the query.timeout : query execution exceeded timeout.nested : nested query evaluation is not allowed.Any other error that may occur while evaluating the query. |
xquery:parse
Template:Mark base-uri
option added.
Signatures | xquery:parse($query as xs:string) as item()? xquery:parse($query as xs:string, $options as map(*)?) as item()? |
Summary | Parses the specified $query string as XQuery module and returns the resulting query plan. The $options parameter influences the output:
|
Errors | Any error that may occur while parsing the query. |
Examples |
<MainModule updating="false"> <QueryPlan compiled="false"> <Arith op="+"> <Int value="1" type="xs:integer"/> <Int value="3" type="xs:integer"/> </Arith> </QueryPlan> </MainModule> |
xquery:parse-uri
Template:Mark base-uri
option added.
Signatures | xquery:parse-uri($uri as xs:string) as item()? xquery:parse-uri($uri as xs:string, $options as map(*)?) as item()? |
Summary | Parses the XQuery module located at $uri and returns the resulting query plan. A relative URI will be resolved against the static base URI of the query. The rules for the $options parameter are the same as for xquery:parse.
|
Errors | Any error that may occur while parsing the query. |
Parallelized Execution
Parallel query execution is recommendable if you have various calls that require a lot of time, but cannot be sped up by rewriting the code. This is e. g. the case if external URLs are called. If you are parallelizing local data reads (such as the access to a database), single-threaded queries will usually be faster, because parallelized access to disk data often results in randomized access patterns, which can hardly be optimized by the caching strategies of HD, SSD or operating system.
xquery:fork-join
Signatures | xquery:fork-join($functions as function(*)*) as item()*
|
Summary | This function executes the supplied (non-updating) functions in parallel. |
Examples |
let $f := function() { prof:sleep(1000) } return xquery:fork-join(($f, $f))
let $funcs := for $segment in 1 to 4 let $url := 'http://url.com/path' || $segment return function() { http:send-request((), $url) } return xquery:fork-join($funcs) |
Errors | error : an unexpected error occurred.
|
Errors
Code | Description |
---|---|
permission
|
Insufficient permissions for evaluating the query. |
update
|
updating expression found or expected. |
timeout
|
Query execution exceeded timeout. |
memory
|
Query execution exceeded memory limit. |
nested
|
Nested query evaluation is not allowed. |
error
|
An unexpected error occurred. |
Changelog
- Version 9.0
- Added: xquery:invoke-update
- Updated: xquery:eval:
pass
option added - Updated: xquery:parse, xquery:parse-uri:
base-uri
option added - Updated: xquery:update renamed to xquery:eval-update
- Updated: error codes updated; errors now use the module namespace
- Version 8.5
- Added: xquery:fork-join
- Updated: xquery:eval:
base-uri
option added - Updated: Relative URIs will always be resolved against the static base URI of the query
- Deleted: xquery:type (moved to Profiling Module
- Version 8.4
- Added: xquery:parse-uri
- Updated: xquery:parse:
pass
option added
- Version 8.0
- Added: xquery:update, xquery:parse
- Deleted: xquery:evaluate (opened databases will now be closed by main query)
- Version 7.8.2
- Added:
$options
argument
- Version 7.8
- Added: xquery:evaluate
- Updated: used variables must be explicitly declared in the query string.
This module was introduced with Version 7.3. Functions have been adopted from the obsolete Utility Module.