XQuery Extensions

From BaseX Documentation

Jump to: navigation, search

This article is part of the XQuery Portal. It lists extensions and optimizations that are specific to the BaseX XQuery processor.

Contents

[edit] Suffixes

In BaseX, files with the suffixes .xq, .xqm, .xqy, .xql, .xqu and .xquery are treated as XQuery files. In XQuery, there are main and library modules:

'Hello World!'
module namespace hello = 'http://basex.org/examples/hello';

declare function hello:world() {
  'Hello World!'
};

We recommend .xq as suffix for for main modules, and .xqm for library modules. However, the actual module type will dynamically be detected when a file is opened and parsed.

[edit] Option Declarations

Local database options can be set in the prolog of an XQuery main module. In the option declaration, options need to be bound to the Database Module namespace. All values will be reset after the evaluation of a query:

declare option db:chop 'false';
doc('doc.xml')

[edit] Pragmas

Local database options can be assigned locally via pragmas:

(# db:chop false #) { doc('doc.xml') }

Various optimizations can be disabled by marking an expression as non-deterministic:

count( (# basex:non-deterministic #) { 1 to 10 })

[edit] Annotations

The following implementation-defined annotations are available:

Example:

declare %basex:inline(0) function local:e() { error() };
local:e()

Result:

Stopped at query.xq, 1/53:
[FOER0000] Halted on error().

Stack Trace:
- query.xq, 2/9

In the next example, function inlining was disabled globally by assigning 0 to the INLINELIMIT option. However, annotation is enforced to a single function:

Example:

declare option db:inlinelimit '0';
declare %basex:inline function local:id($x) { $x };
local:id(123)

The query will be optimized to 123.

Example:

declare %basex:lazy variable $january := doc('does-not-exist');
if(month-from-date(current-date()) == 1) then $january else ()

The annotation ensures that an error will only be thrown if the condition yields true. Without the annotation, the error will always be thrown, because the referenced document is not found.

[edit] Serialization

For more information and some additional BaseX-specific parameters, see the article on Serialization.

[edit] Non-determinism

In XQuery, deterministic functions are “guaranteed to produce ·identical· results from repeated calls within a single ·execution scope· if the explicit and implicit arguments are identical”. In BaseX, many extension functions are non-deterministic or side-effecting. If an expression is internally flagged as non-deterministic, various optimizations that might change their execution order will not be applied.

(: QUERY A... :)
let $n := 456
for $i in 1 to 2
return $n

(: ...will be optimized to :)
for $i in 1 to 2
return 456

(: QUERY B will not be rewritten :)
let $n := random:integer()
for $i in 1 to 2
return $n

In some cases, functions may contain non-deterministic code, but the query compiler may not be able to detect this statically. See the following example:

for $read in (file:read-text#1, file:read-binary#1)
let $ignored := non-deterministic $read('input.file')
return ()

Two non-deterministic functions will be bound to $read, and the result of the function call will be bound to $ignored. As the variable is not referenced in the subsequent code, the let clause would usually be discarded by the compiler. In the given query, however, execution will be enforced because of the BaseX-specific non-deterministic keyword.

[edit] Miscellaneous

Various other extensions are described in the articles on XQuery Full Text and XQuery Update.

Personal tools
Namespaces
Variants
Actions
Navigation
Print/export