Difference between revisions of "Array Module"

From BaseX Documentation
Jump to navigation Jump to search
Line 30: Line 30:
| '''Examples'''
| '''Examples'''
|* <code>array:append([], 'member1')</code> returns the array {{Code|["member1"]}}.
* <code>array:append([], 'member1')</code> returns the array {{Code|["member1"]}}.

Revision as of 21:26, 9 August 2014

This XQuery Module contains functions for manipulating arrays, which will officially be introduced with XQuery 3.1.


All functions in this module are assigned to the http://www.w3.org/2005/xpath-functions/array namespace, which is statically bound to the array prefix.



Signatures array:size($input as array(*)) as xs:integer
Summary Returns the number of members in the supplied array. Note that because an array is an item, the fn:count function when applied to an array always returns 1.
  • array:size([1 to 10]) returns 10.
  • array:size(array { 1 to 10 }) returns 10.


Signatures array:append($input as array(*), $insert as item()*) as array(*)
Summary Adds one member at the end of the array. The result is an array whose size is array:size($array) + 1, in which all members in positions 1 to array:size($array) are the same as the members in the corresponding position of $array, and the member in position array:size($array) + 1 is $insert.
  • array:append([], 'member1') returns the array ["member1"].


Signatures map:serialize($input as map(*)) as xs:string
Summary This function is specific to BaseX. It returns a string representation of the supplied array. The purpose of this function is to get an insight into the structure of an array item; it cannot necessarily be used for reconstructing the original array.
  • array:serialize([ 1, (2, 3), 4 to 6 ]) returns [1, (2, 3), (4, 5, 6)].


Introduced with Version 8.0.