XQuery Module
Jump to navigation
Jump to search
This XQuery Module contains functions for evaluating XQuery strings and modules at runtime.
Contents
Conventions
All functions in this module are assigned to the http://basex.org/modules/xquery
namespace, which is statically bound to the xquery
prefix.
All errors are assigned to the http://basex.org/errors
namespace, which is statically bound to the bxerr
prefix.
Functions
xquery:eval
Template:Mark $options
argument added.
Signatures | xquery:eval($query as xs:string) as item()* xquery:eval($query as xs:string, $bindings as map(*)) as item()* xquery:eval($query as xs:string, $bindings as map(*), $options as item()) as item() |
Summary | Evaluates $query as XQuery expression at runtime and returns the resulting items.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. Variables and context items can be declared via $bindings . The specified keys must be QNames or strings, the values can be arbitrary item sequences:
The
<xquery:options> <xquery:permission value="none"/> </xquery:options>
map { "permission" := "none" } The following options are available:
|
Errors | BXXQ0001 : the query contains updating expressions.BXXQ0003 : insufficient permissions for evaluating the query.BXXQ0004 : query execution exceeded timeout.FOTY0013 : the expression yields function items.
|
Examples |
xquery:eval("//country", map { '' := db:open('factbook') })
xquery:eval(".", map { '': 'XML' }), xquery:eval("declare variable $xml external; $xml", map { 'xml' := 'XML' }), xquery:eval( "declare namespace pref='URI'; declare variable $pref:xml external; $pref:xml", map { '{URI}xml': 'XML' } )
declare namespace pref = 'URI'; xquery:eval("declare variable $xml external; $xml", map { xs:QName('xml'): 'XML' }), let $query := "declare namespace pref='URI'; declare variable $pref:xml external; $pref:xml" let $vars := map { xs:QName('pref:xml'): 'XML' } return xquery:eval($query, $vars) |
xquery:evaluate
Template:Mark $options
argument added.
Signatures | xquery:evaluate($query as xs:string) as item()* xquery:evaluate($query as xs:string, $bindings as map(*)) as item()* xquery:evaluate($query as xs:string, $bindings as map(*), $options as item()) as item()* |
Summary | Evaluates $query as XQuery expression at runtime and returns the resulting items.The function differs from xquery:eval in two ways:
|
Errors | BXXQ0001 : the query contains updating expressions.BXXQ0002 : the addressed database cannot be opened.BXXQ0003 : insufficient permissions for evaluating the query.BXXQ0004 : query execution exceeded timeout.FOTY0013 : the expression yields function items.
|
xquery:invoke
Template:Mark $options
argument added.
Signatures | xquery:invoke($uri as xs:string) as item()* xquery:invoke($uri as xs:string, $bindings as map(*)) as item()* xquery:invoke($uri as xs:string, $bindings as map(*), $options as item()) as item()* |
Summary | Opens $uri as file, evaluates it as XQuery expression at runtime, and returns the resulting items. Database nodes in the result will be copied and returned instead.The semantics of the $bindings and $options parameters is the same as for xquery:eval.
|
Errors | BXXQ0001 : the expression contains updating expressions.BXXQ0003 : insufficient permissions for evaluating the query.BXXQ0004 : query execution exceeded timeout.FOTY0013 : the expression yields function items.
|
xquery:type
Signatures | xquery:type($expr as item()*) as item()*
|
Summary | Similar to fn:trace($expr, $msg) , but instead of a user-defined message, it emits the compile-time type and estimated result size of its argument.
|
Errors
Code | Description |
---|---|
BXXQ0001
|
A dynamically evaluated query must not contain updating expressions. |
BXXQ0002
|
The addressed database cannot be opened. |
BXXQ0003
|
Insufficient permissions for evaluating the query. |
BXXQ0004
|
Query execution exceeded timeout. |
Changelog
Changelog
- Version 7.8.2
$options
argument added to functions.
- Version 7.8
- Added: 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.