Difference between revisions of "XQuery Extensions"

From BaseX Documentation
Jump to navigation Jump to search
m (Text replacement - "<syntaxhighlight lang="xquery">" to "<pre lang='xquery'>")
Tags: Mobile web edit Mobile edit
m (Text replacement - "syntaxhighlight" to "pre")
 
(One intermediate revision by the same user not shown)
Line 14: Line 14:
 
(: ternary if :)
 
(: ternary if :)
 
$ok ?? 1 !! 0
 
$ok ?? 1 !! 0
−
</syntaxhighlight>
+
</pre>
  
 
The expression returns <code>ok</code> if the effective boolean value of <code>$test</code> is true, and it returns <code>fails</code> otherwise.
 
The expression returns <code>ok</code> if the effective boolean value of <code>$test</code> is true, and it returns <code>fails</code> otherwise.
Line 26: Line 26:
 
if (file:exists($file)) then file:delete($file),
 
if (file:exists($file)) then file:delete($file),
 
if (permissions:valid($user)) then <html>Welcome!</html>
 
if (permissions:valid($user)) then <html>Welcome!</html>
−
</syntaxhighlight>
+
</pre>
  
 
If conditions are nested, a trailing else branch will be associated with the innermost <code>if</code>:
 
If conditions are nested, a trailing else branch will be associated with the innermost <code>if</code>:
Line 32: Line 32:
 
<pre lang='xquery'>
 
<pre lang='xquery'>
 
if ($a) then if($b) then '$a and $b is true' else 'only $a is true'
 
if ($a) then if($b) then '$a and $b is true' else 'only $a is true'
−
</syntaxhighlight>
+
</pre>
  
 
In general, if you have multiple or nested if expressions, additional parentheses can improve the readibility of your code:
 
In general, if you have multiple or nested if expressions, additional parentheses can improve the readibility of your code:
Line 40: Line 40:
 
   if($b) then '$a and $b is true' else 'only $a is true'
 
   if($b) then '$a and $b is true' else 'only $a is true'
 
)
 
)
−
</syntaxhighlight>
+
</pre>
  
 
=Functions=
 
=Functions=
Line 52: Line 52:
 
(: yields "!Hi! !there!" :)
 
(: yields "!Hi! !there!" :)
 
replace('Hi there', '\b', '!', 'j')
 
replace('Hi there', '\b', '!', 'j')
−
</syntaxhighlight>
+
</pre>
  
 
=Serialization=
 
=Serialization=
Line 71: Line 71:
 
declare option db:catalog 'etc/w3-catalog.xml';
 
declare option db:catalog 'etc/w3-catalog.xml';
 
doc('doc.xml')
 
doc('doc.xml')
−
</syntaxhighlight>
+
</pre>
  
 
==XQuery Locks==
 
==XQuery Locks==
Line 89: Line 89:
 
   1 to 100000000
 
   1 to 100000000
 
})
 
})
−
</syntaxhighlight>
+
</pre>
  
 
This pragma can be helpful when debugging your code.
 
This pragma can be helpful when debugging your code.
Line 99: Line 99:
 
   file:write('config.xml', <config/>)
 
   file:write('config.xml', <config/>)
 
}
 
}
−
</syntaxhighlight>
+
</pre>
  
 
==Database Pragmas==
 
==Database Pragmas==
Line 112: Line 112:
 
   return db:get($db)//name[text() = 'John']
 
   return db:get($db)//name[text() = 'John']
 
}
 
}
−
</syntaxhighlight>
+
</pre>
  
 
* Node copying in node constructors can be disabled (see {{Option|COPYNODE}} for more details). The following query will consume much less memory than without pragma as the database nodes will not be fully duplicated, but only attached to the {{Code|xml}} parent element:
 
* Node copying in node constructors can be disabled (see {{Option|COPYNODE}} for more details). The following query will consume much less memory than without pragma as the database nodes will not be fully duplicated, but only attached to the {{Code|xml}} parent element:
Line 123: Line 123:
 
   }
 
   }
 
)
 
)
−
</syntaxhighlight>
+
</pre>
  
 
* An XML catalog can be specified for URI rewritings. See the [[Catalog Resolver]] section for an example.
 
* An XML catalog can be specified for URI rewritings. See the [[Catalog Resolver]] section for an example.
Line 141: Line 141:
 
for $i in 1 to 3
 
for $i in 1 to 3
 
return local:square($i)
 
return local:square($i)
−
</syntaxhighlight>
+
</pre>
  
 
'''Query after function inlining:'''
 
'''Query after function inlining:'''
Line 150: Line 150:
 
   let $a := $i
 
   let $a := $i
 
   return $a * $a
 
   return $a * $a
−
</syntaxhighlight>
+
</pre>
  
 
'''Query after further optimizations:'''
 
'''Query after further optimizations:'''
Line 157: Line 157:
 
for $i in 1 to 3
 
for $i in 1 to 3
 
return $i * $i
 
return $i * $i
−
</syntaxhighlight>
+
</pre>
  
 
By default, XQuery functions will be ''inlined'' if the query body is not too large and does not exceed a fixed number of expressions, which can be adjusted via the {{Option|INLINELIMIT}} option.
 
By default, XQuery functions will be ''inlined'' if the query body is not too large and does not exceed a fixed number of expressions, which can be adjusted via the {{Option|INLINELIMIT}} option.
Line 169: Line 169:
 
declare %basex:inline(0) function local:e() { error() };
 
declare %basex:inline(0) function local:e() { error() };
 
local:e()
 
local:e()
−
</syntaxhighlight>
+
</pre>
  
 
'''Result:'''
 
'''Result:'''
  
−
<syntaxhighlight lang="xml">
+
<pre lang="xml">
 
Stopped at query.xq, 1/53:
 
Stopped at query.xq, 1/53:
 
[FOER0000] Halted on error().
 
[FOER0000] Halted on error().
Line 179: Line 179:
 
Stack Trace:
 
Stack Trace:
 
- query.xq, 2/9
 
- query.xq, 2/9
−
</syntaxhighlight>
+
</pre>
  
 
==Lazy Evaluation==
 
==Lazy Evaluation==
Line 189: Line 189:
 
declare %basex:lazy variable $january := doc('does-not-exist.xml');
 
declare %basex:lazy variable $january := doc('does-not-exist.xml');
 
if(month-from-date(current-date()) = 1) then $january else ()
 
if(month-from-date(current-date()) = 1) then $january else ()
−
</syntaxhighlight>
+
</pre>
  
 
The annotation ensures that an error is only raised if the condition yields true. Without the annotation, the error is always raised if the referenced document is not found.
 
The annotation ensures that an error is only raised if the condition yields true. Without the annotation, the error is always raised if the referenced document is not found.
Line 204: Line 204:
 
<xml:abc xmlns:prefix='uri' local:fn='x'/>,
 
<xml:abc xmlns:prefix='uri' local:fn='x'/>,
 
fn:exists(1)
 
fn:exists(1)
−
</syntaxhighlight>
+
</pre>
  
 
In BaseX, various other namespaces are predefined. Apart from the namespaces that are listed on the [[Module Library]] page, the following namespaces are statically bound:
 
In BaseX, various other namespaces are predefined. Apart from the namespaces that are listed on the [[Module Library]] page, the following namespaces are statically bound:
Line 243: Line 243:
 
<pre lang='xquery'>
 
<pre lang='xquery'>
 
'Hello World!'
 
'Hello World!'
−
</syntaxhighlight>
+
</pre>
  
 
* Library modules start with a module namespace declaration and have no query body:
 
* Library modules start with a module namespace declaration and have no query body:
Line 253: Line 253:
 
   'Hello World!'
 
   'Hello World!'
 
};
 
};
−
</syntaxhighlight>
+
</pre>
  
 
We recommend {{Code|.xq}} as suffix for for main modules, and {{Code|.xqm}} for library modules. However, the actual module type will dynamically be detected when a file is opened and parsed.
 
We recommend {{Code|.xq}} as suffix for for main modules, and {{Code|.xqm}} for library modules. However, the actual module type will dynamically be detected when a file is opened and parsed.

Latest revision as of 18:39, 1 December 2023

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

Expressions[edit]

Removed with Version 11: Elvis operator ?:, in favor of the new otherwise expression.

Ternary If[edit]

The ternary if operator provides a short syntax for conditions. It is also called conditional operator or ternary operator. In most languages, the syntax is a ? b : c. As ? and : have already been taken in XQuery, the syntax of Perl 6 is used: 

(: if/then/else :)
if ($ok) then 1 else 0,
(: ternary if :)
$ok ?? 1 !! 0

The expression returns ok if the effective boolean value of $test is true, and it returns fails otherwise.

If Without Else[edit]

In XQuery 3.1, both branches of the if expression need to be specified. In many cases, only one branch is required, so the else branch was made optional in BaseX. If the second branch is omitted, an empty sequence will be returned if the effective boolean value of the test expression is false. Some examples: 

if (doc-available($doc)) then doc($doc),
if (file:exists($file)) then file:delete($file),
if (permissions:valid($user)) then <html>Welcome!</html>

If conditions are nested, a trailing else branch will be associated with the innermost if: 

if ($a) then if($b) then '$a and $b is true' else 'only $a is true'

In general, if you have multiple or nested if expressions, additional parentheses can improve the readibility of your code: 

if ($a) then (
  if($b) then '$a and $b is true' else 'only $a is true'
)

Functions[edit]

Regular Expressions[edit]

In analogy with Saxon, you can specify the flag j to revert to Java’s default regex parser. For example, this allows you to use the word boundary option \b, which has not been included in the XQuery grammar for regular expressions:

Example: 

(: yields "!Hi! !there!" :)
replace('Hi there', '\b', '!', 'j')

Serialization[edit]

  • basexis used as the default serialization method: nodes are serialized as XML, atomic values are serialized as string, and items of binary type are output in their native byte representation. Function items (including maps and arrays) are output just like with the adaptive method.
  • With csv, you can output XML nodes as CSV data (see the CSV Module for more details).
  • With json, items are output as JSON as described in the official specification. If the root node is of type element(json), items are serialized as described for the direct format in the JSON Module.

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

Option Declarations[edit]

Database Options[edit]

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:catalog 'etc/w3-catalog.xml';
doc('doc.xml')

XQuery Locks[edit]

If locks are declared in the query prolog of a module via the basex:lock option, access to functions of this module locks will be controlled by the central transaction management. See Transaction Management for further details.

Pragmas[edit]

BaseX Pragmas[edit]

Updated with Version 11: Renamed from non-deterministic to nondeterministic.

Many optimizations in BaseX will only be performed if an expression is deterministic (i. e., if it always yields the same output and does not have side effects). By flagging an expression as nondeterministic, optimizations and query rewritings can be suppressed: 

sum( (# basex:nondeterministic #) {
  1 to 100000000
})

This pragma can be helpful when debugging your code.

In analogy with option declarations and function annotations, XQuery locks can also set via pragmas. See Transaction Management for details and examples. 

(# basex:write-lock CONFIGLOCK #) {
  file:write('config.xml', <config/>)
}

Database Pragmas[edit]

Local database options can also be assigned via pragmas: 

(# db:enforceindex #) {
  for $db in ('persons1', 'persons2', 'persons3')
  return db:get($db)//name[text() = 'John']
}
  • Node copying in node constructors can be disabled (see COPYNODE for more details). The following query will consume much less memory than without pragma as the database nodes will not be fully duplicated, but only attached to the xml parent element:
file:write(
  'wrapped-db-nodes.xml',
  (# db:copynode false #) {
    <xml>{ db:get('huge') }</xml>
  }
)
  • An XML catalog can be specified for URI rewritings. See the Catalog Resolver section for an example.

Annotations[edit]

Function Inlining[edit]

%basex:inline([limit]) controls if functions will be inlined.

If XQuery functions are inlined, the function call will be replaced by a FLWOR expression, in which the function variables are bound to let clauses, and in which the function body is returned. This optimization triggers further query rewritings that will speed up your query. An example:

Query: 

declare function local:square($a) { $a * $a };
for $i in 1 to 3
return local:square($i)

Query after function inlining: 

for $i in 1 to 3
return
  let $a := $i
  return $a * $a

Query after further optimizations: 

for $i in 1 to 3
return $i * $i

By default, XQuery functions will be inlined if the query body is not too large and does not exceed a fixed number of expressions, which can be adjusted via the INLINELIMIT option.

The annotation can be used to overwrite this global limit: Function inlining can be enforced if no argument is specified. Inlining will be disabled if 0 is specified.

Example: 

(: disable function inlining; the full stack trace will be shown... :)
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

Lazy Evaluation[edit]

%basex:lazy enforces lazy evaluation of a global variable. An example:

Example: 

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

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

XQuery Locks[edit]

In analogy with option declarations and pragmas, locks can also set via annotations. See Transaction Management for details and examples.

Namespaces[edit]

In XQuery, some namespaces are statically bound to prefixes. The following query requires no additional namespaces declarations in the query prolog: 

<xml:abc xmlns:prefix='uri' local:fn='x'/>,
fn:exists(1)

In BaseX, various other namespaces are predefined. Apart from the namespaces that are listed on the Module Library page, the following namespaces are statically bound:

Description Prefix Namespace URI
BaseX Annotations, Pragmas, … basex http://basex.org
RESTXQ: Input Options input http://basex.org/modules/input
EXPath Packages pkg http://expath.org/ns/pkg
XQuery Errors err http://www.w3.org/2005/xqt-errors
Serialization output http://www.w3.org/2010/xslt-xquery-serialization

Suffixes[edit]

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:

  • Main modules have an expression as query body. Here is a minimum example:
'Hello World!'
  • Library modules start with a module namespace declaration and have no query body:
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.

Miscellaneous[edit]

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

Changelog[edit]

Version 11
  • Removed: Elvis operator ?:, in favor of the new otherwise expression.
  • Updated: Renamed from non-deterministic to nondeterministic.
Version 9.1
  • Added: New Expressions: Ternary if, elvis Operator, if without else
  • Added: XQuery Locks via pragmas and function annotations.
  • Added: Regular Expressions, j flag for using Java’s default regex parser.
Retrieved from "http://docs.basex.org/index.php?title=XQuery_Extensions&oldid=16885"