Changes

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/>

==xquery:eval==

{| width='100%'

| '''Summary'''

|Evaluates the supplied {{Code|$query}} and returns the resulting items. If the query is of type {{Code|xs:anyURI}}, the module located at this URI will be retrieved (a relative URI will be resolved against the static base URI). Otherwise, the input is expected to be of type {{Code|xs:string}}.

Variables and context items can be declared via {{Code|$bindings}}. The specified keys must be QNames or strings:

* If a key is a QName, it will be directly adopted as variable name.

* If the specified string is empty, the value will be bound to the context item.

The {{Code|$options}} parameter contains evaluation options:

* {{Code|base-uri}}: set [https://www.w3.org/TR/xquery-31/#dt-static-base-uri base-uri property] for the query. Overwrites the base URI of the query; 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|update|#Errors}} the query 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|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.

| '''Examples'''

|

</pre>

* The following expressions use strings as keys. All of them return 'XML':<br/>

xquery:eval(".", map { '': 'XML' }),

</pre>

* The following expressions use QNames as keys. All of them return 'XML':<br/>

declare namespace pref = 'URI';

let $vars := map { xs:QName('pref:xml'): 'XML' }

return xquery:eval($query, $vars)

</pre>

|}

==xquery:eval-update==

{| width='100%'

| '''Summary'''

| '''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.

| '''Examples'''

|

* Removes entries from a temporary databases and returns an info string:

xquery:eval-update("

update:output('TEMPORARY DATABASE WAS CLEANED UP')

")

|}

==xquery:parse==

{| width='100%'

| '''Summary'''

* {{Code|compile}}: additionally compiles the query after parsing it. By default, this option is {{Code|false}}.

* {{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|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'''

|Any error that may occur while parsing the query.

| '''Examples'''

|

* {{Code|xquery:parse("1 + 3")}} returns:

<MainModule updating="false">

<QueryPlan compiled="false">

</MainModule>

</pre>

|}

==xquery:fork-join==

{| width='100%'

|'''Summary'''

| '''Examples'''

|

xquery:fork-join(

let $url := 'http://url.com/path/' || $segment

)

</pre>

|'''Errors'''

|{{Error|error|#Errors}} an unexpected error occurred.

! width="110"|Code

|Description

|{{Code|permission}}

|Insufficient permissions for evaluating the query.

|{{Code|update}}

|[[XQuery Update#Updating Expressions|updating expression]] found or expected.

|{{Code|timeout}}

|Query execution exceeded timeout.

|{{Code|memory}}

|Query execution exceeded memory limit.

|{{Code|nested}}

|Nested query evaluation is not allowed.

|{{Code|error}}

|An unexpected error occurred.

=Changelog=

;Version 9.2

;Version 9.0

* Updated: error codes updated; errors now use the module namespace

;Version 8.5

* 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

;Version 8.0

* Deleted: xquery:evaluate (opened databases will now be closed by main query)

;Version 7.8

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