Changes

{{Mark|Updated with Version 9.0:}} All functions and errors in this module are assigned to the {{Code|<code><nowiki>http://basex.org/modules/xquery}} </nowiki></code> namespace, which is statically bound to the {{Code|xquery}} prefix.<br/>All errors are assigned to the {{Code|http://basex.org/errors}} namespace, which is statically bound to the {{Code|bxerr}} prefix.

|{{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 itemmap(*)?|item()*}}<br />

The {{Code|$options}} parameter contains evaluation options, which can either be specified* as children of an {{Code|<xquery:options/>}} element:<pre class="brush:xml"><xquery:options> <xquery:permission value="none"/></xquery:options></pre>* as map, which contains all key/value pairs:<pre class="brush:xml">map { "permission": "none" }</pre>The following options are available:

* {{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. 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}}.

|{{Error|BXXQ0001update|#Errors}} the query contains [[XQuery Update#Updating Expressions|updating expressions]].<br/>{{Error|BXXQ0003permission|#Errors}} insufficient permissions for evaluating the query.<br/>{{Error|BXXQ0004timeout|#Errors}} query execution exceeded timeout or .<br/>{{Error|limit|#Errors}} query execution exceeded memory constraintslimit.<br/>{{Error|FOTY0013nested|#Errors}} the expression yields function itemsnested query evaluation is not allowed.<br/>Any other error that may occur while evaluating the query.

==xquery:eval-update== {{Mark|Updated with Version 9.0:}} Renamed (old name: xquery:update) {| width='100%'|-| width='120' | '''Signatures'''|{{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'''|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'''|{{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 />{{MarkFunc|Added with Version 8xquery: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.0<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==

|{{Func|xquery:invoke-update|$query uri as xs:string|item()*}}<br />{{Func|xquery:invoke-update|$query uri as xs:string, $bindings as map(*)?|item()*}}<br />{{Func|xquery:invoke-update|$query uri as xs:string, $bindings as map(*)?, $options as itemmap(*)?|item()*}}<br />

|Evaluates the updating XQuery module located at {{Code|$queryuri}} as updating XQuery expression at runtime. A relative URI will be resolved against the static base URI of the query.<br/>All updates will be added to The rules of the {{Code|$bindings}} and {{Code|$options}} parameters are the same as for [[XQuery Update#Pending Update Listxquery:eval|Pending Update Listxquery:eval]] of the main query and performed after the evaluation of the main query.

|{{Error|BXXQ0002update|#Errors}} the query expression contains no [[XQuery Update#Updating Expressions|updating expressions]].<br/>{{Error|BXXQ0003permission|#Errors}} insufficient permissions for evaluating the query.<br/>{{Error|BXXQ0004timeout|#Errors}} query execution exceeded timeout or memory constraints.<br/>{{Error|FOTY0013nested|#Errors}} the expression yields function itemsnested query evaluation is not allowed.<br/>Any other error that may occur while evaluating the query.

|{{Func|xquery:parse|$query as xs:string|item()*?}}<br />{{Func|xquery:parse|$query as xs:string, $options as itemmap(*)?|item()?}}<br />

|Parses the specified {{Code|$query}} string as XQuery module and returns information on the resulting query plan (please note that the naming of the expressions in the query plan may change over time). The {{Code|$options}} parameters can be specified in two ways:* as children of an {{Code|<xquery:options/>}} element:<pre class="brush:xml"><xquery:options> <xquery:compile value="true"/></xquery:options></pre>* as map, which contains all key/value pairs:<pre class="brush:xml">map { "compile": true() }</pre>The following options are availableparameter influences the output:

* {{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|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}}.

==xquery:invokeparse-uri== {{Mark|Updated with Version 9.0:}} {{code|base-uri}} option added.

|{{Func|xquery:invokeparse-uri|$uri as xs:string|item()*?}}<br />{{Func|xquery:invoke|$parse-uri as xs:string, $bindings as map(*)|item()*}}<br />{{Func|xquery:invoke|$uri as xs:string, $bindings options as map(*), $options as item()?|item()*?}}<br />

|Opens Parses the XQuery module located at {{Code|$uri}} as file, evaluates it as XQuery expression at runtime, and returns the resulting itemsquery plan. Database nodes in the result A relative URI will be copied and returned insteadresolved against the static base URI of the query.<br />The semantics of rules for the {{Code|$bindings}} and {{Code|$options}} parameters is parameter are the same as for [[#xquery:evalparse|xquery:evalparse]].

|{{Error|BXXQ0001|#Errors}} the expression contains [[XQuery Update#Updating Expressions|updating expressions]].<br/>{{Error|BXXQ0003|#Errors}} insufficient permissions for evaluating the query.<br/>{{Error|BXXQ0004|#Errors}} query execution exceeded timeout.<br/>{{Error|FOTY0013|#Errors}} the expression yields function items.<br/>Any other error that may occur while evaluating 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:typefork-join==

|{{Func|xquery:typefork-join|$expr functions as itemfunction(*)*|item()*}}|-|'''Summary'''|This function executes the supplied (non-updating) functions in parallel.

| '''SummaryExamples'''|Similar to * 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() {{Code|fnprof:sleep(1000) }return xquery:tracefork-join(($exprf, $msgf))}}</pre>* In the following query, but instead of a userup 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-defined messagerequest((), it emits the compile$url) }return xquery:fork-join($funcs)</pre>|-time type and estimated result size of its argument|'''Errors'''|{{Error|error|#Errors}} an unexpected error occurred.

|{{Code|BXXQ0001permission}}|The specified Insufficient permissions for evaluating the query contains [[XQuery Update#Updating Expressions|updating expressions]].

|{{Code|BXXQ0002update}}|The specified query contains no [[XQuery Update#Updating Expressions|updating expressionsexpression]]found or expected.

|{{Code|BXXQ0003timeout}}|Insufficient permissions for evaluating the Query execution exceeded timeout.|-|{{Code|memory}}|Query execution exceeded memory limit.|-|{{Code|nested}}|Nested queryevaluation is not allowed.

|{{Code|BXXQ0004error}}|Query execution exceeded timeoutAn unexpected error occurred.

 * Added: [[#xquery:update|xquery:update]], [[#xquery:parse|xquery:parse]]