Difference between revisions of "XQuery 3.1"
m (Text replacement - "syntaxhighlight" to "pre") |
|||
(16 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
− | This article is part of the [[XQuery|XQuery Portal]]. It provides a summary of the most important features of the [ | + | This article is part of the [[XQuery|XQuery Portal]]. It provides a summary of the most important features of the [https://www.w3.org/TR/xquery-31/ XQuery 3.1] Recommendation. |
=Maps= | =Maps= | ||
Line 7: | Line 7: | ||
Maps can be constructed as follows: | Maps can be constructed as follows: | ||
− | <pre | + | <pre lang='xquery'> |
map { }, (: empty map :) | map { }, (: empty map :) | ||
map { 'key': true(), 1984: (<a/>, <b/>) }, (: map with two entries :) | map { 'key': true(), 1984: (<a/>, <b/>) }, (: map with two entries :) | ||
Line 16: | Line 16: | ||
</pre> | </pre> | ||
− | The function corresponding to the map has the signature {{Code|function($key as xs:anyAtomicType) as item()*}}. The expression {{Code|$map($key)}} returns the associated value; the function call {{Code|map:get($map, $key)}} is equivalent. For example, if {{Code|$books-by-isbn}} is a map whose keys are ISBNs and whose associated values are {{Code|book}} elements, then the expression {{Code|$books-by-isbn("0470192747")}} returns the {{Code|book}} element with the given ISBN. The fact that a map is a function item allows it to be passed as an argument to | + | The function corresponding to the map has the signature {{Code|function($key as xs:anyAtomicType) as item()*}}. The expression {{Code|$map($key)}} returns the associated value; the function call {{Code|map:get($map, $key)}} is equivalent. For example, if {{Code|$books-by-isbn}} is a map whose keys are ISBNs and whose associated values are {{Code|book}} elements, then the expression {{Code|$books-by-isbn("0470192747")}} returns the {{Code|book}} element with the given ISBN. The fact that a map is a function item allows it to be passed as an argument to [[Higher-Order Functions]] that expect a function item as one of their arguments. As an example, the following query uses the higher-order function {{Code|fn:map($f, $seq)}} to extract all bound values from a map: |
− | <pre | + | <pre lang='xquery'> |
let $map := map { 'foo': 42, 'bar': 'baz', 123: 456 } | let $map := map { 'foo': 42, 'bar': 'baz', 123: 456 } | ||
return fn:for-each(map:keys($map), $map) | return fn:for-each(map:keys($map), $map) | ||
Line 27: | Line 27: | ||
Because a map is a function item, functions that apply to functions also apply to maps. A map is an anonymous function, so {{Code|fn:function-name}} returns the empty sequence; {{Code|fn:function-arity}} always returns {{Code|1}}. | Because a map is a function item, functions that apply to functions also apply to maps. A map is an anonymous function, so {{Code|fn:function-name}} returns the empty sequence; {{Code|fn:function-arity}} always returns {{Code|1}}. | ||
− | Like all other values, maps are immutable. For example, the | + | Like all other values, maps are immutable. For example, the {{Function|Map|map:remove}} function creates a new map by removing an entry from an existing map, but the existing map is not changed by the operation. Like sequences, maps have no identity. It is meaningful to compare the contents of two maps, but there is no way of asking whether they are "the same map": two maps with the same content are indistinguishable. |
Maps may be compared using the {{Code|fn:deep-equal}} function. The [[Map Module]] describes the available set of map functions. | Maps may be compared using the {{Code|fn:deep-equal}} function. The [[Map Module]] describes the available set of map functions. | ||
Line 33: | Line 33: | ||
=Arrays= | =Arrays= | ||
− | An ''array'' is a function that associates a set of positions, represented as positive integer keys, with values. The first position in an array is associated with the integer {{Code|1}}. The values of an array are called its members. In the type hierarchy, array has a distinct type, which is derived from function. In BaseX, arrays (as well as sequences) are based on an efficient [ | + | An ''array'' is a function that associates a set of positions, represented as positive integer keys, with values. The first position in an array is associated with the integer {{Code|1}}. The values of an array are called its members. In the type hierarchy, array has a distinct type, which is derived from function. In BaseX, arrays (as well as sequences) are based on an efficient [https://en.wikipedia.org/wiki/Finger_tree Finger Tree] implementation. |
Arrays can be constructed in two ways. With the square bracket notation, the comma serves as delimiter: | Arrays can be constructed in two ways. With the square bracket notation, the comma serves as delimiter: | ||
− | <pre | + | <pre lang='xquery'> |
[], (: empty array :) | [], (: empty array :) | ||
[ (1, 2) ], (: array with single member :) | [ (1, 2) ], (: array with single member :) | ||
Line 45: | Line 45: | ||
With the {{Code|array}} keyword and curly brackets, the inner expression is evaluated as usual, and the resulting values will be the members of the array: | With the {{Code|array}} keyword and curly brackets, the inner expression is evaluated as usual, and the resulting values will be the members of the array: | ||
− | <pre | + | <pre lang='xquery'> |
array { }, (: empty array; same as: array { () } :) | array { }, (: empty array; same as: array { () } :) | ||
array { (1, 2) }, (: array with two members; same as: array { 1, 2 } :) | array { (1, 2) }, (: array with two members; same as: array { 1, 2 } :) | ||
Line 53: | Line 53: | ||
The function corresponding to the array has the signature {{Code|function($index as xs:integer) as item()*}}. The expression {{Code|$array($index)}} returns an addressed member of the array. The following query returns the five array members {{Code|48 49 50 51 52}} as result: | The function corresponding to the array has the signature {{Code|function($index as xs:integer) as item()*}}. The expression {{Code|$array($index)}} returns an addressed member of the array. The following query returns the five array members {{Code|48 49 50 51 52}} as result: | ||
− | <pre | + | <pre lang='xquery'> |
let $array := array { 48 to 52 } | let $array := array { 48 to 52 } | ||
for $i in 1 to array:size($array) | for $i in 1 to array:size($array) | ||
Line 59: | Line 59: | ||
</pre> | </pre> | ||
− | Like all other values, arrays are immutable. For example, the | + | Like all other values, arrays are immutable. For example, the {{Function|Array|array:reverse}} function creates a new array containing a re-ordering of the members of an existing array, but the existing array is not changed by the operation. Like sequences, arrays have no identity. It is meaningful to compare the contents of two arrays, but there is no way of asking whether they are "the same array": two arrays with the same content are indistinguishable. |
==Atomization== | ==Atomization== | ||
Line 65: | Line 65: | ||
If an array is ''atomized'', all of its members will be atomized. As a result, an atomized item may now result in more than one item. Some examples: | If an array is ''atomized'', all of its members will be atomized. As a result, an atomized item may now result in more than one item. Some examples: | ||
− | <pre | + | <pre lang='xquery'> |
fn:data([1 to 2]) (: returns the sequence 1, 2 :) | fn:data([1 to 2]) (: returns the sequence 1, 2 :) | ||
[ 'a', 'b', 'c' ] = 'b' (: returns true :) | [ 'a', 'b', 'c' ] = 'b' (: returns true :) | ||
Line 74: | Line 74: | ||
Atomization also applies to function arguments. The following query returns 5, because the array will be atomized to a sequence of 5 integers: | Atomization also applies to function arguments. The following query returns 5, because the array will be atomized to a sequence of 5 integers: | ||
− | <pre | + | <pre lang='xquery'> |
let $f := function($x as xs:integer*) { count($x) } | let $f := function($x as xs:integer*) { count($x) } | ||
return $f([1 to 5]) | return $f([1 to 5]) | ||
Line 81: | Line 81: | ||
However, the next query returns 1, because the array is already of the general type {{Code|item()}}, and no atomization will take place: | However, the next query returns 1, because the array is already of the general type {{Code|item()}}, and no atomization will take place: | ||
− | <pre | + | <pre lang='xquery'> |
let $f := function($x as item()*) { count($x) } | let $f := function($x as item()*) { count($x) } | ||
return $f([1 to 5]) | return $f([1 to 5]) | ||
Line 99: | Line 99: | ||
The following example demonstrates the four alternatives: | The following example demonstrates the four alternatives: | ||
− | <pre | + | <pre lang='xquery'> |
let $map := map { 'R': 'red', 'G': 'green', 'B': 'blue' } | let $map := map { 'R': 'red', 'G': 'green', 'B': 'blue' } | ||
return ( | return ( | ||
Line 117: | Line 117: | ||
The lookup operator can also be used without left operand. In this case, the context item will be used as input. This query returns {{Code|Akureyri}}: | The lookup operator can also be used without left operand. In this case, the context item will be used as input. This query returns {{Code|Akureyri}}: | ||
− | <pre | + | <pre lang='xquery'> |
let $maps := ( | let $maps := ( | ||
map { 'name': 'Guðrún', 'city': 'Reykjavík' }, | map { 'name': 'Guðrún', 'city': 'Reykjavík' }, | ||
Line 129: | Line 129: | ||
The arrow operator <code>=></code> provides a convenient alternative syntax for passing on functions to a value. The expression that precedes the operator will be supplied as first argument of the function that follows the arrow. If <code>$v</code> is a value and <code>f()</code> is a function, then <code>$v => f()</code> is equivalent to <code>f($v)</code>, and <code>$v => f($j)</code> is equivalent to <code>f($v, $j)</code>: | The arrow operator <code>=></code> provides a convenient alternative syntax for passing on functions to a value. The expression that precedes the operator will be supplied as first argument of the function that follows the arrow. If <code>$v</code> is a value and <code>f()</code> is a function, then <code>$v => f()</code> is equivalent to <code>f($v)</code>, and <code>$v => f($j)</code> is equivalent to <code>f($v, $j)</code>: | ||
− | <pre | + | <pre lang='xquery'> |
(: Returns 3 :) | (: Returns 3 :) | ||
count(('A', 'B', 'C')), | count(('A', 'B', 'C')), | ||
Line 156: | Line 156: | ||
The string constructors syntax uses two backticks and a square bracket for opening and closing a string: | The string constructors syntax uses two backticks and a square bracket for opening and closing a string: | ||
− | <pre | + | <pre lang='xquery'> |
(: Returns "This is a 'new' & 'flexible' syntax." :) | (: Returns "This is a 'new' & 'flexible' syntax." :) | ||
``["This is a 'new' & 'flexible' syntax."]`` | ``["This is a 'new' & 'flexible' syntax."]`` | ||
Line 163: | Line 163: | ||
XQuery expressions can be embedded via backticks and a curly bracket. The evaluated results will be separated with spaces, and all strings will eventually be concatenated: | XQuery expressions can be embedded via backticks and a curly bracket. The evaluated results will be separated with spaces, and all strings will eventually be concatenated: | ||
− | <pre | + | <pre lang='xquery'> |
(: Returns »Count 1 2 3, and I will be there.« :) | (: Returns »Count 1 2 3, and I will be there.« :) | ||
let $c := 1 to 3 | let $c := 1 to 3 | ||
Line 170: | Line 170: | ||
=Serialization= | =Serialization= | ||
− | Two [[Serialization]] methods have been added to the [ | + | Two [[Serialization]] methods have been added to the [https://www.w3.org/TR/xslt-xquery-serialization-31 Serialization spec]: |
==Adaptive Serialization== | ==Adaptive Serialization== | ||
− | The {{Code|adaptive}} serialization provides an intuitive textual representation for all XDM types, including maps and arrays, functions, attributes, and namespaces. All items will be separated by the value of the {{Code|item-separator}} parameter, which by default is a newline character. It is utilized by the functions | + | The {{Code|adaptive}} serialization provides an intuitive textual representation for all XDM types, including maps and arrays, functions, attributes, and namespaces. All items will be separated by the value of the {{Code|item-separator}} parameter, which by default is a newline character. It is utilized by the functions {{Function|Profiling|prof:dump}} and <code>[https://www.w3.org/TR/xpath-functions-31/#func-trace fn:trace]</code>. |
Example: | Example: | ||
− | <pre | + | <pre lang='xquery'> |
declare option output:method 'adaptive'; | declare option output:method 'adaptive'; | ||
<element id='id0'/>/@id, | <element id='id0'/>/@id, | ||
Line 188: | Line 188: | ||
Result: | Result: | ||
− | <pre | + | <pre lang="xml"> |
id="id0" | id="id0" | ||
xs:token("abc"), | xs:token("abc"), | ||
Line 204: | Line 204: | ||
* If an XML node of type {{Code|element(json)}} is found, it will be serialized following the serialization rules of the [[JSON Module]]. | * If an XML node of type {{Code|element(json)}} is found, it will be serialized following the serialization rules of the [[JSON Module]]. | ||
− | * Any other node or atomic value, map, array, or empty sequence will be serialized according to the [ | + | * Any other node or atomic value, map, array, or empty sequence will be serialized according to the [https://www.w3.org/TR/xslt-xquery-serialization-31/#json-output rules in the specification]. |
The following two queries will both return the JSON snippet <code>{ "key": "value" }</code>: | The following two queries will both return the JSON snippet <code>{ "key": "value" }</code>: | ||
− | <pre | + | <pre lang='xquery'> |
declare option output:method 'json'; | declare option output:method 'json'; | ||
map { "key": "value" } | map { "key": "value" } | ||
</pre> | </pre> | ||
− | <pre | + | <pre lang='xquery'> |
declare option output:method 'json'; | declare option output:method 'json'; | ||
<json type='object'> | <json type='object'> | ||
Line 222: | Line 222: | ||
=Functions= | =Functions= | ||
− | The following functions have been added in the [ | + | The following functions have been added in the [https://www.w3.org/TR/xpath-functions-31/ XQuery 3.1 Functions and Operators] Specification: |
==Map Functions== | ==Map Functions== | ||
Line 233: | Line 233: | ||
<code>array:size</code>, <code>array:append</code>, <code>array:subarray</code>, <code>array:remove</code>, <code>array:insert-before</code>, <code>array:head</code>, <code>array:tail</code>, <code>array:reverse</code>, <code>array:join</code>, <code>array:flatten</code>, <code>array:for-each</code>, <code>array:filter</code>, <code>array:fold-left</code>, <code>array:fold-right</code>, <code>array:for-each-pair</code> | <code>array:size</code>, <code>array:append</code>, <code>array:subarray</code>, <code>array:remove</code>, <code>array:insert-before</code>, <code>array:head</code>, <code>array:tail</code>, <code>array:reverse</code>, <code>array:join</code>, <code>array:flatten</code>, <code>array:for-each</code>, <code>array:filter</code>, <code>array:fold-left</code>, <code>array:fold-right</code>, <code>array:for-each-pair</code> | ||
+ | |||
+ | Please check out the [[Array Module]] for more details. | ||
==JSON Functions== | ==JSON Functions== | ||
Line 240: | Line 242: | ||
===fn:parse-json=== | ===fn:parse-json=== | ||
− | + | <pre>fn:parse-json( | |
− | + | $json as xs:string? | |
− | + | $options as map(*) := () | |
+ | ) as item()?</pre> | ||
− | Parses the supplied string as JSON text and returns its item representation. The result may be a map, an array, a string, a double, a boolean, or an empty sequence. The allowed options can be looked up in the [ | + | Parses the supplied string as JSON text and returns its item representation. The result may be a map, an array, a string, a double, a boolean, or an empty sequence. The allowed options can be looked up in the [https://www.w3.org/TR/xpath-functions-31/#func-parse-json specification]. |
− | <pre | + | <pre lang='xquery'> |
parse-json('{ "name": "john" }') (: yields { "name": "json" } :), | parse-json('{ "name": "john" }') (: yields { "name": "json" } :), | ||
parse-json('[ 1, 2, 4, 8, 16]') (: yields [ 1, 2, 4, 8, 16 ] :) | parse-json('[ 1, 2, 4, 8, 16]') (: yields [ 1, 2, 4, 8, 16 ] :) | ||
Line 253: | Line 256: | ||
===fn:json-doc=== | ===fn:json-doc=== | ||
− | + | <pre>fn:json-doc( | |
− | + | $href as xs:string? | |
− | + | $options as map(*) := () | |
+ | ) as item()?</pre> | ||
− | Retrieves the text from the specified URI, parses the supplied string as JSON text and returns its item representation (see | + | Retrieves the text from the specified URI, parses the supplied string as JSON text and returns its item representation (see {{Function||fn:parse-json}} for more details). |
− | <pre | + | <pre lang='xquery'> |
json-doc("http://ip.jsontest.com/")('ip') (: returns your IP address :) | json-doc("http://ip.jsontest.com/")('ip') (: returns your IP address :) | ||
</pre> | </pre> | ||
Line 265: | Line 269: | ||
===fn:json-to-xml=== | ===fn:json-to-xml=== | ||
− | + | <pre>fn:json-to-xml( | |
− | + | $json as xs:string? | |
+ | $options as map(*) := () | ||
+ | ) as document-node()?</pre> | ||
− | Converts a JSON string to an XML node representation. The allowed options can be looked up in the [ | + | Converts a JSON string to an XML node representation. The allowed options can be looked up in the [https://www.w3.org/TR/xpath-functions-31/#func-json-to-xm specification]. |
− | <pre | + | <pre lang='xquery'> |
json-to-xml('{ "message": "world" }') | json-to-xml('{ "message": "world" }') | ||
Line 281: | Line 287: | ||
===fn:xml-to-json=== | ===fn:xml-to-json=== | ||
− | + | <pre>fn:xml-to-json( | |
− | + | $node as xs:string? | |
+ | $options as map(*) := () | ||
+ | ) as xs:string?</pre> | ||
− | Converts an XML node, whose format conforms to the results created by | + | Converts an XML node, whose format conforms to the results created by {{Function||fn:json-to-xml}}, to a JSON string representation. The allowed options can be looked up in the [https://www.w3.org/TR/xpath-functions-31/#func-xml-to-json specification]. |
− | <pre | + | <pre lang='xquery'> |
(: returns "JSON" :) | (: returns "JSON" :) | ||
xml-to-json(<string xmlns="http://www.w3.org/2005/xpath-functions">JSON</string>) | xml-to-json(<string xmlns="http://www.w3.org/2005/xpath-functions">JSON</string>) | ||
Line 293: | Line 301: | ||
==fn:sort== | ==fn:sort== | ||
− | + | <pre>fn:sort( | |
− | + | $input as item()*, | |
− | + | $collation as xs:string? := fn:default-collation(), | |
− | + | $key as function(item()) as xs:anyAtomicType* := fn:data#1 | |
+ | ) as item()*</pre> | ||
Returns a new sequence with sorted {{Code|$input}} items, using an optional {{Code|$collation}}. If a {{Code|$key}} function is supplied, it will be applied on all items. The items of the resulting values will be sorted using the semantics of the {{Code|lt}} expression. | Returns a new sequence with sorted {{Code|$input}} items, using an optional {{Code|$collation}}. If a {{Code|$key}} function is supplied, it will be applied on all items. The items of the resulting values will be sorted using the semantics of the {{Code|lt}} expression. | ||
− | <pre | + | <pre lang='xquery'> |
sort(reverse(1 to 3)) (: yields 1, 2, 3 :), | sort(reverse(1 to 3)) (: yields 1, 2, 3 :), | ||
reverse(sort(1 to 3)) (: returns the sorted order in descending order :), | reverse(sort(1 to 3)) (: returns the sorted order in descending order :), | ||
Line 310: | Line 319: | ||
==fn:contains-token== | ==fn:contains-token== | ||
− | + | <pre>fn:contains-token( | |
− | + | $value as xs:string*, | |
− | + | $token as xs:string, | |
+ | $collation as xs:string? := fn:default-collation() | ||
+ | ) as xs:boolean</pre> | ||
The supplied strings will be tokenized at whitespace boundaries. The function returns {{Code|true}} if one of the strings equals the supplied token, possibly under the rules of a supplied collation: | The supplied strings will be tokenized at whitespace boundaries. The function returns {{Code|true}} if one of the strings equals the supplied token, possibly under the rules of a supplied collation: | ||
− | <pre | + | <pre lang='xquery'> |
contains-token(('a', 'b c', 'd'), 'c') (: yields true :) | contains-token(('a', 'b c', 'd'), 'c') (: yields true :) | ||
<xml class='one two'/>/contains-token(@class, 'one') (: yields true :) | <xml class='one two'/>/contains-token(@class, 'one') (: yields true :) | ||
Line 323: | Line 334: | ||
==fn:parse-ietf-date== | ==fn:parse-ietf-date== | ||
− | + | <pre>fn:parse-ietf-date( | |
− | + | $value as xs:string? | |
+ | ) as xs:dateTime?</pre> | ||
Parses a string in the IETF format (which is widely used on the Internet) and returns a {{Code|xs:dateTime}} item: | Parses a string in the IETF format (which is widely used on the Internet) and returns a {{Code|xs:dateTime}} item: | ||
− | <pre | + | <pre lang='xquery'> |
fn:parse-ietf-date('28-Feb-1984 07:07:07')" (: yields 1984-02-28T07:07:07Z :), | fn:parse-ietf-date('28-Feb-1984 07:07:07')" (: yields 1984-02-28T07:07:07Z :), | ||
fn:parse-ietf-date('Wed, 01 Jun 2001 23:45:54 +02:00')" (: yields 2001-06-01T23:45:54+02:00 :) | fn:parse-ietf-date('Wed, 01 Jun 2001 23:45:54 +02:00')" (: yields 2001-06-01T23:45:54+02:00 :) | ||
Line 335: | Line 347: | ||
==fn:apply== | ==fn:apply== | ||
− | + | <pre>fn:apply( | |
− | + | $function as function(*), | |
+ | $arguments as array(*) | ||
+ | ) as item()*</pre> | ||
The supplied {{Code|$function}} is invoked with the specified {{Code|$arguments}}. The arity of the function must be the same as the size of the array. | The supplied {{Code|$function}} is invoked with the specified {{Code|$arguments}}. The arity of the function must be the same as the size of the array. | ||
Line 342: | Line 356: | ||
Example: | Example: | ||
− | <pre | + | <pre lang='xquery'> |
fn:apply(concat#5, array { 1 to 5 }) (: 12345 :) | fn:apply(concat#5, array { 1 to 5 }) (: 12345 :) | ||
fn:apply(function($a) { sum($a) }, [ 1 to 5 ]) (: 15 :) | fn:apply(function($a) { sum($a) }, [ 1 to 5 ]) (: 15 :) | ||
Line 350: | Line 364: | ||
==fn:random-number-generator== | ==fn:random-number-generator== | ||
− | + | <pre>fn:random-number-generator( | |
− | + | $seed as xs:anyAtomicType? := () | |
− | + | ) as map(xs:string, item())</pre> | |
Creates a random number generator, using an optional seed. The returned map contains three entries: | Creates a random number generator, using an optional seed. The returned map contains three entries: | ||
Line 364: | Line 378: | ||
Example: | Example: | ||
− | <pre | + | <pre lang='xquery'> |
let $rng := fn:random-number-generator() | let $rng := fn:random-number-generator() | ||
let $number := $rng('number') (: returns a random number :) | let $number := $rng('number') (: returns a random number :) | ||
Line 377: | Line 391: | ||
The function has been extended to support scientific notation: | The function has been extended to support scientific notation: | ||
− | <pre | + | <pre lang='xquery'> |
format-number(1984.42, '00.0e0') (: yields 19.8e2 :) | format-number(1984.42, '00.0e0') (: yields 19.8e2 :) | ||
</pre> | </pre> | ||
Line 385: | Line 399: | ||
If no separator is specified as second argument, a string will be tokenized at whitespace boundaries: | If no separator is specified as second argument, a string will be tokenized at whitespace boundaries: | ||
− | <pre | + | <pre lang='xquery'> |
fn:tokenize(" a b c d") (: yields "a", "b", "c", "d" :) | fn:tokenize(" a b c d") (: yields "a", "b", "c", "d" :) | ||
</pre> | </pre> | ||
Line 393: | Line 407: | ||
The second argument can now be omitted: | The second argument can now be omitted: | ||
− | <pre | + | <pre lang='xquery'> |
fn:trace(<xml/>, "Node: ")/node() (: yields the debugging output "Node: <xml/>" :), | fn:trace(<xml/>, "Node: ")/node() (: yields the debugging output "Node: <xml/>" :), | ||
fn:trace(<xml/>)/node() (: returns the debugging output "<xml/>" :) | fn:trace(<xml/>)/node() (: returns the debugging output "<xml/>" :) | ||
Line 402: | Line 416: | ||
The type of the first argument is now <code>xs:anyAtomicType*</code>, and all items will be implicitly cast to strings: | The type of the first argument is now <code>xs:anyAtomicType*</code>, and all items will be implicitly cast to strings: | ||
− | <pre | + | <pre lang='xquery'> |
fn:string-join(1 to 3) (: yields the string "123" :) | fn:string-join(1 to 3) (: yields the string "123" :) | ||
</pre> | </pre> | ||
Line 418: | Line 432: | ||
Items of type <code>xs:hexBinary</code> and <code>xs:base64Binary</code> can be compared against each other. The following queries all yield {{Code|true}}: | Items of type <code>xs:hexBinary</code> and <code>xs:base64Binary</code> can be compared against each other. The following queries all yield {{Code|true}}: | ||
− | <pre | + | <pre lang='xquery'> |
xs:hexBinary('') < xs:hexBinary('bb'), | xs:hexBinary('') < xs:hexBinary('bb'), | ||
xs:hexBinary('aa') < xs:hexBinary('bb'), | xs:hexBinary('aa') < xs:hexBinary('bb'), | ||
Line 428: | Line 442: | ||
XQuery 3.1 provides a default collation, which allows for a case-insensitive comparison of ASCII characters (<code>A-Z</code> = <code>a-z</code>). This query returns <code>true</code>: | XQuery 3.1 provides a default collation, which allows for a case-insensitive comparison of ASCII characters (<code>A-Z</code> = <code>a-z</code>). This query returns <code>true</code>: | ||
− | <pre | + | <pre lang='xquery'> |
declare default collation 'http://www.w3.org/2005/xpath-functions/collation/html-ascii-case-insensitive'; | declare default collation 'http://www.w3.org/2005/xpath-functions/collation/html-ascii-case-insensitive'; | ||
'HTML' = 'html' | 'HTML' = 'html' | ||
</pre> | </pre> | ||
− | If the [http://site.icu-project.org/download ICU Library] is downloaded and added to the classpath, the full [ | + | If the [http://site.icu-project.org/download ICU Library] is downloaded and added to the classpath, the full [https://www.w3.org/TR/xpath-functions-31/#uca-collations Unicode Collation Algorithm] features become available in BaseX: |
− | <pre | + | <pre lang='xquery'> |
(: returns 0 (both strings are compared as equal) :) | (: returns 0 (both strings are compared as equal) :) | ||
compare('a-b', 'ab', 'http://www.w3.org/2013/collation/UCA?alternate=shifted') | compare('a-b', 'ab', 'http://www.w3.org/2013/collation/UCA?alternate=shifted') | ||
Line 444: | Line 458: | ||
''Enclosed expression'' is the syntactical term for the expressions that are specified inside a function body, try/catch clauses, node constructors and some other expressions. In the following example expressions, its the empty sequence: | ''Enclosed expression'' is the syntactical term for the expressions that are specified inside a function body, try/catch clauses, node constructors and some other expressions. In the following example expressions, its the empty sequence: | ||
− | <pre | + | <pre lang='xquery'> |
− | declare function local:x() { () }; | + | declare function local:x() { () }; |
try { () } catch * { () }, | try { () } catch * { () }, | ||
element x { () }, | element x { () }, | ||
Line 453: | Line 467: | ||
With XQuery 3.1, the expression can be omitted. The following query is equivalent to the upper one: | With XQuery 3.1, the expression can be omitted. The following query is equivalent to the upper one: | ||
− | <pre | + | <pre lang='xquery'> |
declare function local:x() { }; | declare function local:x() { }; | ||
try { } catch * { }, | try { } catch * { }, | ||
Line 468: | Line 482: | ||
;Version 8.4 | ;Version 8.4 | ||
− | * Added: [[#String Constructors|String Constructors]], | + | * Added: [[#String Constructors|String Constructors]], {{Code|fn:default-language}}, [[#Enclosed Expressions|Enclosed Expressions]] |
− | * Updated: [[#Adaptive Serialization|Adaptive Serialization]], | + | * Updated: [[#Adaptive Serialization|Adaptive Serialization]], {{Code|fn:string-join}} |
;Version 8.2 | ;Version 8.2 | ||
− | * Added: | + | * Added: {{Code|fn:json-to-xml}}, {{Code|fn:xml-to-json}}. |
;Version 8.1 | ;Version 8.1 | ||
− | * Updated: arrays are now based on a [ | + | * Updated: arrays are now based on a [https://en.wikipedia.org/wiki/Finger_tree Finger Tree] implementation. |
Introduced with Version 8.0. | Introduced with Version 8.0. |
Latest revision as of 18:38, 1 December 2023
This article is part of the XQuery Portal. It provides a summary of the most important features of the XQuery 3.1 Recommendation.
Contents
- 1 Maps
- 2 Arrays
- 3 Lookup Operator
- 4 Arrow Operator
- 5 String Constructor
- 6 Serialization
- 7 Functions
- 8 Binary Data
- 9 Collations
- 10 Enclosed Expressions
- 11 Changelog
Maps[edit]
A map is a function that associates a set of keys with values, resulting in a collection of key/value pairs. Each key/value pair in a map is called an entry. A key is an arbitrary atomic value, and the associated value is an arbitrary sequence. Within a map, no two entries have the same key, when compared using the eq
operator. It is not necessary that all the keys should be mutually comparable (for example, they can include a mixture of integers and strings).
Maps can be constructed as follows:
map { }, (: empty map :)
map { 'key': true(), 1984: (<a/>, <b/>) }, (: map with two entries :)
map:merge( (: map with ten entries :)
for $i in 1 to 10
return map { $i: 'value' || $i }
)
The function corresponding to the map has the signature function($key as xs:anyAtomicType) as item()*
. The expression $map($key)
returns the associated value; the function call map:get($map, $key)
is equivalent. For example, if $books-by-isbn
is a map whose keys are ISBNs and whose associated values are book
elements, then the expression $books-by-isbn("0470192747")
returns the book
element with the given ISBN. The fact that a map is a function item allows it to be passed as an argument to Higher-Order Functions that expect a function item as one of their arguments. As an example, the following query uses the higher-order function fn:map($f, $seq)
to extract all bound values from a map:
let $map := map { 'foo': 42, 'bar': 'baz', 123: 456 }
return fn:for-each(map:keys($map), $map)
This returns some permutation of (42, 'baz', 456)
.
Because a map is a function item, functions that apply to functions also apply to maps. A map is an anonymous function, so fn:function-name
returns the empty sequence; fn:function-arity
always returns 1
.
Like all other values, maps are immutable. For example, the map:remove
function creates a new map by removing an entry from an existing map, but the existing map is not changed by the operation. Like sequences, maps have no identity. It is meaningful to compare the contents of two maps, but there is no way of asking whether they are "the same map": two maps with the same content are indistinguishable.
Maps may be compared using the fn:deep-equal
function. The Map Module describes the available set of map functions.
Arrays[edit]
An array is a function that associates a set of positions, represented as positive integer keys, with values. The first position in an array is associated with the integer 1
. The values of an array are called its members. In the type hierarchy, array has a distinct type, which is derived from function. In BaseX, arrays (as well as sequences) are based on an efficient Finger Tree implementation.
Arrays can be constructed in two ways. With the square bracket notation, the comma serves as delimiter:
[], (: empty array :)
[ (1, 2) ], (: array with single member :)
[ 1 to 2, 3 ] (: array with two members; same as: [ (1, 2), 3 ] :)
With the array
keyword and curly brackets, the inner expression is evaluated as usual, and the resulting values will be the members of the array:
array { }, (: empty array; same as: array { () } :)
array { (1, 2) }, (: array with two members; same as: array { 1, 2 } :)
array { 1 to 2, 3 } (: array with three members; same as: array { 1, 2, 3 } :)
The function corresponding to the array has the signature function($index as xs:integer) as item()*
. The expression $array($index)
returns an addressed member of the array. The following query returns the five array members 48 49 50 51 52
as result:
let $array := array { 48 to 52 }
for $i in 1 to array:size($array)
return $array($i)
Like all other values, arrays are immutable. For example, the array:reverse
function creates a new array containing a re-ordering of the members of an existing array, but the existing array is not changed by the operation. Like sequences, arrays have no identity. It is meaningful to compare the contents of two arrays, but there is no way of asking whether they are "the same array": two arrays with the same content are indistinguishable.
Atomization[edit]
If an array is atomized, all of its members will be atomized. As a result, an atomized item may now result in more than one item. Some examples:
fn:data([1 to 2]) (: returns the sequence 1, 2 :)
[ 'a', 'b', 'c' ] = 'b' (: returns true :)
<a>{ [ 1, 2 ] }</a> (: returns <a>1 2</a> :)
array { 1 to 2 } + 3 (: error: the left operand returns two items :)
Atomization also applies to function arguments. The following query returns 5, because the array will be atomized to a sequence of 5 integers:
let $f := function($x as xs:integer*) { count($x) }
return $f([1 to 5])
However, the next query returns 1, because the array is already of the general type item()
, and no atomization will take place:
let $f := function($x as item()*) { count($x) }
return $f([1 to 5])
Arrays can be compared with the fn:deep-equal
function. The Array Module describes the available set of array functions.
Lookup Operator[edit]
The lookup operator provides some syntactic sugar to access values of maps or array members. It is introduced by the question mark (?
) and followed by a specifier. The specifier can be:
- A wildcard
*
, - The name of the key,
- The integer offset, or
- Any other parenthesized expression.
The following example demonstrates the four alternatives:
let $map := map { 'R': 'red', 'G': 'green', 'B': 'blue' }
return (
$map?* (: 1. returns all values; same as: map:keys($map) ! $map(.) :),
$map?R (: 2. returns the value associated with the key 'R'; same as: $map('R') :),
$map?('G','B') (: 3. returns the values associated with the key 'G' and 'B' :)
),
let $array := [ 'one', 'two', 'three' ]
return (
$array?* (: 1. returns all values; same as: (1 to array:size($array)) ! $array(.) :),
$array?1 (: 2. returns the first value; same as: $array(1) :),
$array?(2 to 3) (: 3. returns the second and third values; same as: (1 to 2) ! $array(.) :)
)
The lookup operator can also be used without left operand. In this case, the context item will be used as input. This query returns Akureyri
:
let $maps := (
map { 'name': 'Guðrún', 'city': 'Reykjavík' },
map { 'name': 'Hildur', 'city': 'Akureyri' }
)
return $maps[?name = 'Hildur'] ?city
Arrow Operator[edit]
The arrow operator =>
provides a convenient alternative syntax for passing on functions to a value. The expression that precedes the operator will be supplied as first argument of the function that follows the arrow. If $v
is a value and f()
is a function, then $v => f()
is equivalent to f($v)
, and $v => f($j)
is equivalent to f($v, $j)
:
(: Returns 3 :)
count(('A', 'B', 'C')),
('A', 'B', 'C') => count(),
('A', 'B', 'C') => (function( $sequence) { count( $sequence)})(),
(: Returns W-E-L-C-O-M-E :)
string-join(tokenize(upper-case('w e l c o m e')), '-'),
'w e l c o m e' => upper-case() => tokenize() => string-join('-'),
(: Returns xfmdpnf :)
codepoints-to-string(
for $i in string-to-codepoints('welcome')
return $i + 1
),
(for $i in 'welcome' => string-to-codepoints()
return $i + 1) => codepoints-to-string()
The syntax makes nested function calls more readable, as it is easy to see if parentheses are balanced.
String Constructor[edit]
The string constructor has been inspired by here document literals of the Unix shell and script languages. It allows you to generate strings that contain various characters that would otherwise be interpreted as XQuery delimiters.
The string constructors syntax uses two backticks and a square bracket for opening and closing a string:
(: Returns "This is a 'new' & 'flexible' syntax." :)
``["This is a 'new' & 'flexible' syntax."]``
XQuery expressions can be embedded via backticks and a curly bracket. The evaluated results will be separated with spaces, and all strings will eventually be concatenated:
(: Returns »Count 1 2 3, and I will be there.« :)
let $c := 1 to 3
return ``[»Count `{ $c }`, and I will be there.«]``
Serialization[edit]
Two Serialization methods have been added to the Serialization spec:
Adaptive Serialization[edit]
The adaptive
serialization provides an intuitive textual representation for all XDM types, including maps and arrays, functions, attributes, and namespaces. All items will be separated by the value of the item-separator
parameter, which by default is a newline character. It is utilized by the functions prof:dump
and fn:trace
.
Example:
declare option output:method 'adaptive';
<element id='id0'/>/@id,
xs:token("abc"),
map { 'key': 'value' },
true#0
Result:
id="id0"
xs:token("abc"),
map {
"key": "value"
}
fn:true#0
JSON Serialization[edit]
The new json
serialization output method can be used to serialize XQuery maps, arrays, atomic values and empty sequences as JSON.
The json
output method has been introduced in BaseX before it was added to the official specification. It complies with the standard serialization rules and, at the same time, preserves the existing semantics:
- If an XML node of type
element(json)
is found, it will be serialized following the serialization rules of the JSON Module. - Any other node or atomic value, map, array, or empty sequence will be serialized according to the rules in the specification.
The following two queries will both return the JSON snippet { "key": "value" }
:
declare option output:method 'json';
map { "key": "value" }
declare option output:method 'json';
<json type='object'>
<key>value</key>
</json>
Functions[edit]
The following functions have been added in the XQuery 3.1 Functions and Operators Specification:
Map Functions[edit]
map:merge
, map:size
, map:keys
, map:contains
, map:get
, map:entry
, map:put
, map:remove
, map:for-each
Please check out the Map Module for more details.
Array Functions[edit]
array:size
, array:append
, array:subarray
, array:remove
, array:insert-before
, array:head
, array:tail
, array:reverse
, array:join
, array:flatten
, array:for-each
, array:filter
, array:fold-left
, array:fold-right
, array:for-each-pair
Please check out the Array Module for more details.
JSON Functions[edit]
With XQuery 3.1, native support for JSON objects was added. Strings and resources can be parsed to XQuery items and, as shown above, serialized back to their original form.
fn:parse-json[edit]
fn:parse-json( $json as xs:string? $options as map(*) := () ) as item()?
Parses the supplied string as JSON text and returns its item representation. The result may be a map, an array, a string, a double, a boolean, or an empty sequence. The allowed options can be looked up in the specification.
parse-json('{ "name": "john" }') (: yields { "name": "json" } :),
parse-json('[ 1, 2, 4, 8, 16]') (: yields [ 1, 2, 4, 8, 16 ] :)
fn:json-doc[edit]
fn:json-doc( $href as xs:string? $options as map(*) := () ) as item()?
Retrieves the text from the specified URI, parses the supplied string as JSON text and returns its item representation (see fn:parse-json
for more details).
json-doc("http://ip.jsontest.com/")('ip') (: returns your IP address :)
fn:json-to-xml[edit]
fn:json-to-xml( $json as xs:string? $options as map(*) := () ) as document-node()?
Converts a JSON string to an XML node representation. The allowed options can be looked up in the specification.
json-to-xml('{ "message": "world" }')
(: result:
<map xmlns="http://www.w3.org/2005/xpath-functions">
<string key="message">world</string>
</map> :)
fn:xml-to-json[edit]
fn:xml-to-json( $node as xs:string? $options as map(*) := () ) as xs:string?
Converts an XML node, whose format conforms to the results created by fn:json-to-xml
, to a JSON string representation. The allowed options can be looked up in the specification.
(: returns "JSON" :)
xml-to-json(<string xmlns="http://www.w3.org/2005/xpath-functions">JSON</string>)
fn:sort[edit]
fn:sort( $input as item()*, $collation as xs:string? := fn:default-collation(), $key as function(item()) as xs:anyAtomicType* := fn:data#1 ) as item()*
Returns a new sequence with sorted $input
items, using an optional $collation
. If a $key
function is supplied, it will be applied on all items. The items of the resulting values will be sorted using the semantics of the lt
expression.
sort(reverse(1 to 3)) (: yields 1, 2, 3 :),
reverse(sort(1 to 3)) (: returns the sorted order in descending order :),
sort((3,-2,1), (), abs#1) (: yields 1, -2, 3 :),
sort((1,2,3), (), function($x) { -$x }) (: yields 3, 2, 1 :),
sort((1,'a')) (: yields an error, as strings and integers cannot be compared :)
fn:contains-token[edit]
fn:contains-token( $value as xs:string*, $token as xs:string, $collation as xs:string? := fn:default-collation() ) as xs:boolean
The supplied strings will be tokenized at whitespace boundaries. The function returns true
if one of the strings equals the supplied token, possibly under the rules of a supplied collation:
contains-token(('a', 'b c', 'd'), 'c') (: yields true :)
<xml class='one two'/>/contains-token(@class, 'one') (: yields true :)
fn:parse-ietf-date[edit]
fn:parse-ietf-date( $value as xs:string? ) as xs:dateTime?
Parses a string in the IETF format (which is widely used on the Internet) and returns a xs:dateTime
item:
fn:parse-ietf-date('28-Feb-1984 07:07:07')" (: yields 1984-02-28T07:07:07Z :),
fn:parse-ietf-date('Wed, 01 Jun 2001 23:45:54 +02:00')" (: yields 2001-06-01T23:45:54+02:00 :)
fn:apply[edit]
fn:apply( $function as function(*), $arguments as array(*) ) as item()*
The supplied $function
is invoked with the specified $arguments
. The arity of the function must be the same as the size of the array.
Example:
fn:apply(concat#5, array { 1 to 5 }) (: 12345 :)
fn:apply(function($a) { sum($a) }, [ 1 to 5 ]) (: 15 :)
fn:apply(count#1, [ 1,2 ]) (: error. the array has two members :)
fn:random-number-generator[edit]
fn:random-number-generator( $seed as xs:anyAtomicType? := () ) as map(xs:string, item())
Creates a random number generator, using an optional seed. The returned map contains three entries:
number
is a random double between 0 and 1next
is a function that returns another random number generatorpermute
is a function that returns a random permutation of its argument
The returned random generator is deterministic: If the function is called twice with the same arguments and in the same execution scope, it will always return the same result.
Example:
let $rng := fn:random-number-generator()
let $number := $rng('number') (: returns a random number :)
let $next-rng := $rng('next')() (: returns a new generator :)
let $next-number := $next-rng('number') (: returns another random number :)
let $permutation := $rng('permute')(1 to 5) (: returns a random permutation of (1,2,3,4,5) :)
return ($number, $next-number, $permutation)
fn:format-number[edit]
The function has been extended to support scientific notation:
format-number(1984.42, '00.0e0') (: yields 19.8e2 :)
fn:tokenize[edit]
If no separator is specified as second argument, a string will be tokenized at whitespace boundaries:
fn:tokenize(" a b c d") (: yields "a", "b", "c", "d" :)
fn:trace[edit]
The second argument can now be omitted:
fn:trace(<xml/>, "Node: ")/node() (: yields the debugging output "Node: <xml/>" :),
fn:trace(<xml/>)/node() (: returns the debugging output "<xml/>" :)
fn:string-join[edit]
The type of the first argument is now xs:anyAtomicType*
, and all items will be implicitly cast to strings:
fn:string-join(1 to 3) (: yields the string "123" :)
fn:default-language[edit]
Returns the default language used for formatting numbers and dates. BaseX always returns en
.
Appendix[edit]
The three functions fn:transform
, fn:load-xquery-module
and fn:collation-key
may be added in a future version of BaseX as their implementation might require the use of additional external libraries.
Binary Data[edit]
Items of type xs:hexBinary
and xs:base64Binary
can be compared against each other. The following queries all yield true
:
xs:hexBinary('') < xs:hexBinary('bb'),
xs:hexBinary('aa') < xs:hexBinary('bb'),
max((xs:hexBinary('aa'), xs:hexBinary('bb'))) = xs:hexBinary('bb')
Collations[edit]
XQuery 3.1 provides a default collation, which allows for a case-insensitive comparison of ASCII characters (A-Z
= a-z
). This query returns true
:
declare default collation 'http://www.w3.org/2005/xpath-functions/collation/html-ascii-case-insensitive';
'HTML' = 'html'
If the ICU Library is downloaded and added to the classpath, the full Unicode Collation Algorithm features become available in BaseX:
(: returns 0 (both strings are compared as equal) :)
compare('a-b', 'ab', 'http://www.w3.org/2013/collation/UCA?alternate=shifted')
Enclosed Expressions[edit]
Enclosed expression is the syntactical term for the expressions that are specified inside a function body, try/catch clauses, node constructors and some other expressions. In the following example expressions, its the empty sequence:
declare function local:x() { () };
try { () } catch * { () },
element x { () },
text { () }
With XQuery 3.1, the expression can be omitted. The following query is equivalent to the upper one:
declare function local:x() { };
try { } catch * { },
element x { }
text { }
Changelog[edit]
- Version 8.6
- Updated: Collation argument was inserted between first and second argument.
- Version 8.4
- Added: String Constructors,
fn:default-language
, Enclosed Expressions - Updated: Adaptive Serialization,
fn:string-join
- Version 8.2
- Added:
fn:json-to-xml
,fn:xml-to-json
.
- Version 8.1
- Updated: arrays are now based on a Finger Tree implementation.
Introduced with Version 8.0.