Bureaucrats, editor, reviewer, Administrators
13,550
edits
Changes
Jump to navigation
Jump to search
=Please note that not all of the features that are listed on this page are alreadyfound in the official specification documents today. You can check out the[https://www.w3.org/Bugs/Public/ W3 Bugzilla Tracker] to find out more about themost recently added features. =Maps==
==Arrays==
===Atomization===
==Lookup Operator==
for let $map in maps := (
==Arrow Operator==
===Adaptive Serialization===
In {{Version|8.0}} of BaseX, The {{Code|adaptive }} is the new default serialization method. It provides a intuitive textual representation for all XDM types, including maps and arrays, functions, attributes, and namespaces. All items will be separated using by the value of the {{Code|item-separator}} parameter, or which by default is a newline if no value character. It is specifiedutilized by the functions <code>[[Profiling Module#prof:dump|prof:dump]]</code> and <code>[http://www.w3.org/TR/xpath-functions-31/#func-trace fn:trace]</code>. Example:
id="id0"xs:token("abc"),map {
function fn:true#0
===JSON Serialization===
{{Mark|Warning}}: The {{Code|json}} output method has been introduced in BaseX quite a while ago. With BaseX 8.0, the The implementation of this method has been rewritten to comply now complies with the new standard serialization rules and, at the same time, to preserve preserves the existing semantics:
==Functions==
===Map Functions===
===Array Functions===
===JSON Functions===
====fn:parse-json====
map:serialize(parse-json('{ "name": "john" }')) (: yields { "name": "json" } :),parse-json('[ 1, 2, 4, 8, 16]')?* (: yields the integer sequence [ 1, 2, 4, 8, 16 ] :),
====fn:json-docs=doc===
===fn:contains-token===
===fn:parse-ietf-date===
===fn:apply===
===fn:random-number-generator===
===fn:format-number===
===fn:tokenize===
===fn:trace===
==Collations==
[[Category:XQuery]]
→fn:sort
This article is part of the [[XQuery|XQuery Portal]].
It summarizes the new features of the [http://www.w3.org/TR/xquery-31/ XQuery 3.1] Working Draftand[http://www.w3.org/TR/xpath-functions-31/ XQuery 3.1 Functions and Operators] specifications
that are already supported by BaseX.
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 {{Code|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 may be compared using the {{Code|fn:deep-equal}} function. The [[Map Module]] describes the available set of map functions.
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 [http://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:
Like all other values, arrays are immutable. For example, the <code>[[Array Module#array:reverse|array:reverse]]</code> 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.
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:
Arrays can be compared with the {{Code|fn:deep-equal}} function. The [[Array Module]] describes the available set of array functions.
The lookup operator provides some syntactic sugar to access values of maps or array members at a specified position. It is introduced by the question mark ({{Code|?}}) and followed by a specifier. The specifier can be:
# A wildcard {{Code|*}},
<pre class="brush:xquery">
map { 'name': 'Guðrún', 'city': 'Reykjavík' },
map { 'name': 'Hildur', 'city': 'Akureyri' }
)
return $mapmaps[?name = 'Hildur'] ?city
</pre>
The arrow operator applies a function to a value. The value is used as the first argument to the function. It is introduced with the characters <code>=></code>, and it is followed by the function to be called. 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>. This is further illustrated by an example:
The syntax makes nested function calls more readable, as it is easy to see if parentheses are balanced.
=String Constructor= The string constructor has been inspired by [https://en.wikipedia.org/wiki/Here_document 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: <pre class="brush:xquery">(: Returns "This is a 'new' & 'flexible' syntax." :)``["This is a 'new' & 'flexible' syntax."]``</pre> 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 class="brush:xquery">(: Returns »Count 1 2 3, and I will be there.« :)let $c := 1 to 3return ``[»Count `{ $c }`, and I will be there.«]``</pre> =Serialization==
Two [[Serialization]] methods have been added to the [http://www.w3.org/TR/xslt-xquery-serialization-31/ Serialization spec]:
<pre class="brush:xquery">
declare option output:method 'adaptive';
<element id='id0'/>/@id,
xs:token("abc"),
map { 'key': 'value' },
true#0
<pre class="brush:xml">
"key": "value"
}
</pre>
The new {{Code|json}} serialization output method can be used to serialize XQuery maps, arrays, atomic values and empty sequences as JSON.
* If an XML node of type {{Code|element(json)}} is found, it will be serialized following the serialization rules of the [[JSON Module]].
</pre>
The following functions of the [http://www.w3.org/TR/xpath-functions-31/ XQuery 3.1 Functions and Operators] Working Draft have been added. Please be aware that the functions are still subject to change:
The following map functions are now available:
Please check out the [[Map Module]] for more details.
The following array functions are now available:
Please check out the [[Array Module]] for more details.
XQuery now provides native support for JSON objects. Strings and resources can be parsed to XQuery items and, as [[#JSON Serialization|shown above]], serialized back to their original form.
; Signatures
* <code>fn:parse-json($input as xs:string, $options as map(*)) as item()?</code>
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 are further specified can be looked up in the [http://www.w3.org/TR/xpath-functions-31/#func-parse-json specification].
<pre class="brush:xquery">
</pre>
; Signatures
</pre>
===fn:json-to-xml=== ; Signatures* <code>fn:json-to-xml($string as xs:string?) as node()?</code> Converts a JSON string to an XML node representation. The allowed options can be looked up in the [http://www.w3.org/TR/xslt-30/#func-json-to-xml specification]. <pre class="brush:xquery">json-to-xml('{ "message": "world" }') (: result:<map xmlns="http://www.w3.org/2005/xpath-functions"> <string key="message">world</string></map> :)</pre> ===fn:xml-to-json=== ; Signatures* <code>fn:xml-to-json($node as node()?) as xs:string?</code> Converts an XML node, whose format conforms to the results created by [[#fn:json-to-xml|fn:json-to-xml]], to a JSON string representation. The allowed options can be looked up in the [http://www.w3.org/TR/xslt-30/#func-xml-to-json specification]. <pre class="brush:xquery">(: returns "JSON" :)xml-to-json(<string xmlns="http://www.w3.org/2005/xpath-functions">JSON</string>)</pre> ==fn:sort=== {{Mark|Updated with Version 8.6:}} Collation argument was inserted between first and second argument.
; Signatures
* <code>fn:sort($input as item()*) as item()*</code>
* <code>fn:sort($input as item()*, $collation as xs:string?) as xs:anyAtomicType*)) as item()*</code>* <code>fn:sort($input as item()*, $collation as xs:string?, $key as function(item()*) as xs:anyAtomicType*)) as item()*</code>
Returns a new sequence with sorted {{Code|$input}} items, using an optional {{Code|$collation}}. If a sort {{Code|$key}} function is givensupplied, 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 class="brush:xquery">
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 :)
</pre>
; Signatures
</pre>
; Signature
</pre>
; Signatures
</pre>
; Signatures
</pre>
The function has been extended to support scientific notation:
</pre>
If no separator is specified as second argument, a string will be tokenized at whitespace boundaries:
</pre>
The second argument can now be omitted:
</pre>
==fn:string-join== The type of the first argument is now <code>xs:anyAtomicType*</code>, and all items will be implicitly cast to strings: <pre class="brush:xquery">fn:string-join(1 to 3) (: yields the string "123" :)</pre> ==fn:default-language== Returns the default language used for formatting numbers and dates. BaseX always returns {{Code|en}}. =Binary Data==
Items of type <code>xs:hexBinary</code> and <code>xs:base64Binary</code> can now be compared against each other. The following queries all yield {{Code|true}}:
</pre>
XQuery 3.1 provides a new 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>
=Enclosed Expressions= ''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, it’s the empty sequence: <pre class="brush:xquery">declare function local:x() { () };try { () } catch * { () },element x { () },text { () }</pre> With XQuery 3.1, the expression can be omitted. The following query is equivalent to the upper one: <pre class="brush:xquery">declare function local:x() { };try { } catch * { },element x { }text { }</pre> =Pending Features==
The features of XQuery 3.1 are still subject to change, but we are planning to add the following enhancements in near futurefunctions have not been implemented yet:
* New functions: <code>fn:collation-key</code>, <code>fn:load-xquery-module</code>, <code>fn:transform</code>
=Changelog=
;Version 8.6
* Updated: Collation argument was inserted between first and second argument.
;Version 8.4
* Added: [[#String Constructors|String Constructors]], [[#fn:default-language|fn:default-language]], [[#Enclosed Expressions|Enclosed Expressions]]
* Updated: [[#Adaptive Serialization|Adaptive Serialization]], [[#fn:string-join|fn:string-join]]
;Version 8.2
* Added: [[#fn:json-to-xml|fn:json-to-xml]], [[#fn:xml-to-json|fn:xml-to-json]].
;Version 8.1
* Updated: arrays are now based on a [http://en.wikipedia.org/wiki/Finger_tree Finger Tree] implementation.
Introduced with Version 8.0.
