Changes

All functions 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|<code><nowiki>http://basex.org/errors}} </nowiki></code> 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(xs:string, xs:string)|item()*}}<br />

|Evaluates the supplied {{Code|$query}} string as XQuery expression at runtime and returns the resulting items.<br/>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.<br />Variables and context items can be declared via {{Code|$bindings}}. The specified keys must be QNames or strings, the values can be arbitrary item sequences:* variables specified as QNames If a key is a QName, it will be directly interpreted adopted as variable name.* variables specified as xs:It a key is a string , it may be prefixed with a dollar sign. Namespace can be specified using the [http://www.jclark.com/xml/xmlns.htm Clark Notation].

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|BXXQ0001|#Errors}} the query 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 or memory constraintslimit.<br/>{{Error|FOTY0013BXXQ0005|#Errors}} nested query evaluation is not allowed.<br/>Any other error that may occur while evaluating the expression yields function itemsquery.

{| width='100%'|-| width='120' | '''Signatures'''|{{MarkFunc|xquery:update|$query as xs:string|Added with Version 8item()*}}<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(xs:string, xs:string)|item()}}<br />|-| '''Summary'''|Evaluates {{Code|$query}} as updating XQuery expression at runtime.0<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|BXXQ0002|#Errors}} the query contains no [[XQuery Update#Updating Expressions|updating expressions]].<br/>{{Error|BXXQ0003|#Errors}} insufficient permissions for evaluating the query.<br/>{{Error|BXXQ0004|#Errors}} query execution exceeded timeout or memory limit.<br/>{{Error|BXXQ0005|#Errors}}nested query evaluation is not allowed.<br/>Any other error that may occur while evaluating the query.|} ==xquery:invoke==

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

|Evaluates the XQuery module located at {{Code|$queryuri}} as updating XQuery expression at runtimeand returns the resulting items. 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|BXXQ0002BXXQ0001|#Errors}} the query expression contains no [[XQuery Update#Updating Expressions|updating expressions]].<br/>{{Error|BXXQ0003|#Errors}} insufficient permissions for evaluating the query.<br/>{{Error|BXXQ0004|#Errors}} query execution exceeded timeout or memory constraints.<br/>{{Error|FOTY0013BXXQ0005|#Errors}} nested query evaluation is not allowed.<br/>Any other error that may occur while evaluating the expression yields function itemsquery.

==xquery:invokeparse==

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

|Opens Parses the specified {{Code|$uriquery}} as file, evaluates it string as XQuery expression at runtime, module and returns the resulting itemsquery plan. The {{Code|$options}} parameter influences the output:* {{Code|compile}}: additionally compiles the query after parsing it. Database nodes in By default, this option is {{Code|false}}.* {{Code|plan}}: returns an XML representation of the result will be copied and returned insteadinternal query plan. By default, this option is {{Code|true}}.<br />The semantics naming of the expressions in the query plan may change over time* {{Code|$bindingspass}} : passes on the original error info (line and column number, optional file uri). By default, this option is {{Code|$optionsfalse}} parameters is the same as for [[#xquery:eval|xquery:eval]].

|Any error that may occur while parsing the query.|-| '''Examples'''|* {{ErrorCode|BXXQ0001|#Errorsxquery:parse("1 + 3")}} the expression contains [[XQuery Update#Updating Expressions|returns:<pre class='brush:xml'><MainModule updating expressions]].="false"> <QueryPlan compiled="false"> <Arith op="+"> <Int value="1" type="xs:integer"/> <Int value="3" type="xs:integer"/> </Arith> <br/QueryPlan>{{Error|BXXQ0003|#Errors}} insufficient permissions for evaluating the query.<br/MainModule>{{Error|BXXQ0004|#Errors}} query execution exceeded timeout.<br/pre>{{Error|FOTY0013|#Errors}} the expression yields function items.

==xquery:typeparse-uri==

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

|Similar to Parses the XQuery module located at {{Code|fn:trace($expr, 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|$msg)options}}parameter are the same as for [[#xquery:parse|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 instead of 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 userdatabase), single-defined messagethreaded 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='120' | '''Signatures'''|{{Func|xquery:fork-join|$functions as function(*)*|item()*}}|-|'''Summary'''|This function executes the supplied (non-updating) functions in parallel.|-| '''Examples'''|* The following function sleeps in parallel; it emits 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 compilefollowing 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-time type and estimated result size of its argumentrequest((), $url) }return xquery:fork-join($funcs)</pre>|-|'''Errors'''|{{Error|BXXQ0006|#Errors}} an unexpected error occurred.

|Query execution exceeded timeoutor memory limit.|-|{{Code|BXXQ0005}}|Nested query evaluation is not allowed.|-|{{Code|BXXQ0006}}|An unexpected error occurred.

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