Changes

Jump to navigation Jump to search
1,390 bytes added ,  13:16, 24 May 2018
no edit summary
=Conventions=
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/>All errors are assigned to the <code><nowiki>http://basex.org/errors</nowiki></code> namespace, which is statically bound to the {{Code|bxerr}} prefix.
=Functions=
==xquery:eval==
 
{{Mark|Updated with Version 8.5:}} <code>base-uri</code> 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}}. Added with * {{VersionCode|8pass}}: passes on the original error info (line and column number, optional file uri).5By default, this option is {{Code|false}}.
|-
| '''Errors'''
|{{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 limit.<br/>{{Error|BXXQ0005nested|#Errors}} nested query evaluation is not allowed.<br/>Any other error that may occur while evaluating the query.
|-
| '''Examples'''
|}
==xquery:eval-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(xs:string, xs:string*)?|item()}}<br />
|-
| '''Summary'''
|-
| '''Errors'''
|{{Error|BXXQ0002update|#Errors}} the query 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 .<br/>{{Error|limit|#Errors}} query execution exceeded memory limit.<br/>{{Error|BXXQ0005nested|#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.
|}
|-
| 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|Updated with Version 8.5}}: Relative URIs will always be resolved against the static base URI of the query.
{| 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'''
| '''Errors'''
|Any error that may occur while parsing the query.
|}
 
==xquery:invoke==
 
{{Mark|Updated with Version 8.5}}: Relative URIs will always be resolved against the static base URI of the query.
 
{| 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|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|BXXQ0005|#Errors}} nested query evaluation is not allowed.<br/>Any other error that may occur while evaluating the query.
|}
==xquery:fork-join==
 
{{Mark|Introduced with Version 8.5}}:
{| width='100%'
|-
|'''Errors'''
|{{Error|BXXQ0006error|#Errors}} an unexpected error occurred.
|}
|Description
|-
|{{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 queryQuery execution exceeded timeout.
|-
|{{Code|BXXQ0004memory}}|Query execution exceeded timeout or memory limit.
|-
|{{Code|BXXQ0005nested}}
|Nested query evaluation is not allowed.
|-
|{{Code|BXXQ0006error}}
|An unexpected error occurred.
|}
=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
 
* Added: [[#xquery:fork-join|xquery:fork-join]]
* Updated: [[#xquery:eval|xquery:eval]]: {{Code|base-uri}} option added
;Version 8.4
 
* Added: [[#xquery:parse-uri|xquery:parse-uri]]
* Updated: [[#xquery:parse|xquery:parse]]: {{Code|pass}} option added
;Version 8.0
 * Added: [[#xquery:update|xquery:update]], [[#xquery:parse|xquery:parse]]
* Deleted: [[#xquery:evaluate|xquery:evaluate]] (opened databases will now be closed by main query)
;Version 7.8.2
 
* Added: {{Code|$options}} argument
;Version 7.8
 
* Added: [[#xquery:evaluate|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.
Bureaucrats, editor, reviewer, Administrators
13,550

edits

Navigation menu