Difference between revisions of "XQuery Module"
Line 8: | Line 8: | ||
==xquery:eval== | ==xquery:eval== | ||
+ | |||
+ | {{Mark|Updated with 9.2}}: First argument may be a URI (xquery:invoke was removed). | ||
{| width='100%' | {| width='100%' | ||
Line 15: | Line 17: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Evaluates the supplied {{Code|$query}} and returns the resulting items. | + | |Evaluates the supplied {{Code|$query}} and returns the resulting items. If the query is of type {{Code|xs:anyURI}}, the module located at this URI will be retrieved (a relative URI will be resolved against the static base URI). Otherwise, the input will be evaluated as query string. |
− | |||
Variables and context items can be declared via {{Code|$bindings}}. The specified keys must be QNames or strings: | Variables and context items can be declared via {{Code|$bindings}}. The specified keys must be QNames or strings: | ||
* If a key is a QName, it will be directly adopted as variable name. | * If a key is a QName, it will be directly adopted as variable name. | ||
Line 25: | Line 26: | ||
* {{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. 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|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}}: set [https://www.w3.org/TR/xquery-31/#dt-static-base-uri base-uri property] for the query. | + | * {{Code|base-uri}}: set [https://www.w3.org/TR/xquery-31/#dt-static-base-uri base-uri property] for the query. Overwrites the base URI of the query; 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}}. | * {{Code|pass}}: passes on the original error info (line and column number, optional file uri). By default, this option is {{Code|false}}. | ||
|- | |- | ||
Line 66: | Line 67: | ||
==xquery:eval-update== | ==xquery:eval-update== | ||
+ | |||
+ | {{Mark|Updated with 9.2}}: First argument may be a URI (xquery:invoke-update was removed). | ||
{| width='100%' | {| width='100%' | ||
Line 73: | Line 76: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Evaluates | + | |Evaluates a query as updating expression. 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 for all arguments are the same as for [[#xquery:eval|xquery:eval]]. |
|- | |- | ||
| '''Errors''' | | '''Errors''' | ||
Line 215: | Line 218: | ||
=Changelog= | =Changelog= | ||
+ | |||
+ | ;Version 9.2 | ||
+ | |||
+ | * Deleted: [[#xquery:invoke|xquery:invoke]], [[#xquery:invoke-update|xquery:invoke-update]] (merged with xquery:eval and xquery:eval-update) | ||
;Version 9.0 | ;Version 9.0 | ||
Line 229: | Line 236: | ||
* 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 | * Updated: Relative URIs will always be resolved against the static base URI of the query | ||
− | * Deleted: xquery:type (moved to [[Profiling Module]] | + | * Deleted: xquery:type (moved to [[Profiling Module]]) |
;Version 8.4 | ;Version 8.4 | ||
Line 239: | Line 246: | ||
* Added: xquery:update, [[#xquery:parse|xquery:parse]] | * Added: xquery:update, [[#xquery:parse|xquery:parse]] | ||
− | * Deleted: | + | * Deleted: xquery:evaluate (opened databases will now be closed by main query) |
;Version 7.8.2 | ;Version 7.8.2 |
Revision as of 16:41, 30 January 2019
This XQuery Module contains functions for parsing and evaluating XQuery strings at runtime, and to run code in parallel.
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.
Dynamic Evaluation
xquery:eval
Template:Mark: First argument may be a URI (xquery:invoke was removed).
Signatures | xquery:eval($query as xs:anyAtomicType) 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 and returns the resulting items. If the query is of type xs:anyURI , the module located at this URI will be retrieved (a relative URI will be resolved against the static base URI). Otherwise, the input will be evaluated as query string.
Variables and context items can be declared via
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: First argument may be a URI (xquery:invoke-update was removed).
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 a query as updating expression. 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 for all arguments 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 Parsing
xquery:parse
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
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 that 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 will rarely be optimized by the caching strategies of HDDs, SSDs, or the 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))
xquery:fork-join( for $segment in 1 to 4 let $url := 'http://url.com/path/' || $segment return function() { http:send-request((), $url) } ) |
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.2
- Deleted: xquery:invoke, xquery:invoke-update (merged with xquery:eval and xquery:eval-update)
- 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.