Changes

Jump to navigation Jump to search
2,446 bytes added ,  15:46, 9 October 2017
no edit summary
==xquery:eval==
 
{{Mark|Updated with Version 9.0}}: {{code|pass}} option added.
{| width='100%'
|-
| 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(xs:string, xs:string)|item()*}}<br />
|-
| '''Summary'''
* {{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|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}}.
|-
| '''Errors'''
|{{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}} the expression yields function itemsnested query evaluation is not allowed.<br/>Any other error that may occur while evaluating the query.
|-
| '''Examples'''
|-
| 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(xs:string, xs:string)|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|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== {| 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|$queryuri}} as updating XQuery expression at runtimeand returns the resulting items.<br/>All updates A relative URI will be added to the [[XQuery Update#Pending Update List|Pending Update List]] of the main query and performed after resolved against the evaluation static base URI of the main query.<br />The semantics rules of the {{Code|$bindings}} and {{Code|$options}} parameters is are the same as for [[#xquery:eval|xquery:eval]].
|-
| '''Errors'''
|{{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}} the expression yields function itemsnested query evaluation is not allowed.<br/>Any other error that may occur while evaluating the query.
|}
==xquery:parse==
{{Mark|Updated with Version 89.40}}: {{Codecode|passbase-uri}} option added.
{| width='100%'
|-
| width='120' | '''Signatures'''
|{{Func|xquery:parse|$query as xs:string|item()*?}}<br />{{Func|xquery:parse|$query as xs:string, $options as map(*)|item()?}}<br />
|-
| '''Summary'''
* {{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}}.
|-
| '''Errors'''
==xquery:parse-uri==
{{Mark|Introduced Updated with Version 89.40}}:{{code|base-uri}} option added.
{| width='100%'
|-
| width='120' | '''Signatures'''
|{{Func|xquery:parse-uri|$uri as xs:string|item()*?}}<br />{{Func|xquery:parse-uri|$uri as xs:string, $options as map(*)|item()*?}}<br />
|-
| '''Summary'''
|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 is are the same as for [[#xquery:parse|xquery:parse]].
|-
| '''Errors'''
|}
=Parallelized Execution=xquery:invoke== 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.
{{Mark|Updated with Version 8.4}}: will be renamed to {{Code|==xquery:evalfork-uri}}join==
{| width='100%'
|-
| width='120' | '''Signatures'''
|{{Func|xquery:invokefork-join|$uri functions as xs:string|itemfunction()*}}<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 This function executes the XQuery module located at {{Code|$uri}} at runtime and returns the resulting items. Database nodes supplied (non-updating) functions in the result will be copied and returned instead.<br />The semantics of the {{Code|$bindings}} and {{Code|$options}} parameters is the same as for [[#xquery:eval|xquery:eval]]parallel.
|-
| '''ErrorsExamples'''|* 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() {{Error|BXXQ0001|#Errorsprof:sleep(1000) }} the expression contains [[XQuery Update#Updating Expressions|updating expressions]].return xquery:fork-join(($f, $f))<br/pre>{{Error|BXXQ0003|#Errors}} insufficient permissions for evaluating * In the following query., up to four URLs will be requested in parallel:<brpre class='brush:xquery'>let $funcs := for $segment in 1 to 4 let $url := 'http://>{{Error|BXXQ0004|#Errors}} query execution exceeded timeouturl.<brcom/>{{Errorpath' |FOTY0013|#Errors}} the expression yields $segment return function items.<br/>Any other error that may occur while evaluating the query.|() { http:send-request((), $url) ==return xquery:type==fork-join($funcs) {| width='100%'</pre>
|-
| width='120' | '''SignaturesErrors'''|{{Func|xquery:typeError|$expr as item()*|item()*}}|-| '''Summary'''|Similar to {{CodeBXXQ0006|fn:trace($expr, $msg)#Errors}}, but instead of a user-defined message, it emits the compile-time type and estimated result size of its argumentan unexpected error occurred.
|}
|-
|{{Code|BXXQ0004}}
|Query execution exceeded timeoutor memory limit.|-|{{Code|BXXQ0005}}|Nested query evaluation is not allowed.|-|{{Code|BXXQ0006}}|An unexpected error occurred.
|}
=Changelog=
 
;Version 9.0
* 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
 
;Version 8.5
* Added: [[#xquery:fork-join|xquery:fork-join]]
* 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
This module was introduced with Version 7.3. Functions have been adopted from the obsolete Utility Module.
 
[[Category:XQuery]]
Bureaucrats, editor, reviewer, Administrators
13,550

edits

Navigation menu