Changes

Jump to navigation Jump to search
1,665 bytes added ,  12:16, 24 November 2017
no edit summary
=Conventions=
{{Mark|Updated with Version 9.0:}} 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 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'''
|-
| '''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== {{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(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.
|}
|-
| 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'''
|-
| '''Errors'''
|{{Error|BXXQ0001update|#Errors}} the expression 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.<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|BXXQ0005nested|#Errors}} nested query evaluation is not allowed.<br/>Any other error that may occur while evaluating the query.
|}
==xquery:parse==
 
{{Mark|Updated with Version 9.0:}} {{code|base-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|Updated with Version 9.0:}} {{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'''
|-
|'''Errors'''
|{{Error|BXXQ0006error|#Errors}} an unexpected error occurred.
|}
=Errors=
 
{{Mark|Updated with Version 9.0:}}
{| class="wikitable" width="100%"
|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.
|}
;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