Changes

=Conventions=

Some examples use the ''map'' {{Code|$week}} defined as:

declare variable $week := map {

0: "Sun", 1: "Mon", 2: "Tue", 3: "Wed", 4: "Thu", 5: "Fri", 6: "Sat"

};

==map:contains==

{| width='100%'

| '''Summary'''

| Returns true if the supplied {{Code|$map}} contains an entry with a key equal to the supplied value of {{Code|$key}}; otherwise it returns false. No error is raised if the map contains keys that are not comparable with the supplied {{Code|$key}}.

If the supplied key is {{Code|xs:untypedAtomic}}, it is compared as an instance of {{Code|xs:string}}. If the supplied key is the {{Code|xs:float}} or {{Code|xs:double}} value {{Code|NaN}}, the function returns true if there is an entry whose key is {{Code|NaN}}, or false otherwise.

| '''Examples'''

|

{| width='100%'

| '''Summary'''

| Creates a new ''map'' containing a single entry. The key of the entry in the new map is {{Code|$key}}, and its associated value is {{Code|$value}}.

map:merge((

map:entry("Sun", "Sunday"),

map:entry("Sat", "Saturday")

))

Unlike the <code>map { ... }</code> expression, this technique can be used to construct a map with a variable number of entries, for example:

| '''Examples'''

|{{Code|map:entry("M", "Monday")}} creates <code>map { "M": "Monday" }</code>.

{| width='100%'

| '''Summary'''

| Returns all values of maps in the supplied {{Code|$input}} with the specified {{Code|$key}}. The found values will be returned in an array. Arbitrary input will be processed recursively as follows:

* In an array, all array members will be processed as sequence.

* In a map, all entries whose keys match the specified key. Moreover, all values of the map will be processed as sequence.

| '''Examples'''

|

{| width='100%'

| '''Summary'''

| '''Examples'''

|The following query adds the keys and values of all map entries and returns {{Code|(3,7)}}:

map:for-each(

map { 1: 2, 3: 4 },

function($key, $value) { $key + $value }

)

|}

{| width='100%'

| '''Summary'''

|Returns the value associated with a supplied key in a given map. This function attempts to find an entry within the {{Code|$map}} that has a key equal to the supplied value of {{Code|$key}}. If there is such an entry, the function returns the associated value; otherwise it returns an empty sequence. No error is raised if the map contains keys that are not comparable with the supplied {{Code|$key}}. If the supplied key is {{Code|xs:untypedAtomic}}, it is converted to {{Code|xs:string}}.

A return value of {{Code|()}} from {{Code|map:get}} could indicate that the key is present in the map with an associated value of {{Code|()}}, or it could indicate that the key is not present in the map. The two cases can be distinguished by calling {{Code|map:contains}}.

Invoking the ''map'' as a function item has the same effect as calling {{Code|get}}: that is, when {{Code|$map}} is a map, the expression {{Code|$map($K)}} is equivalent to {{Code|get($map, $K)}}. Similarly, the expression {{Code|get(get(get($map, 'employee'), 'name'), 'first')}} can be written as {{Code|$map('employee')('name')('first')}}.

| '''Examples'''

|

{| width='100%'

| '''Summary'''

|Returns a sequence containing all the key values present in a map. The function takes the supplied {{Code|$map}} and returns the keys that are present in the map as a sequence of atomic values. The order may differ from the order in which entries were inserted in the map.

| '''Examples'''

|

{| width='100%'

| '''Summary'''

| Constructs and returns a new map. The ''map'' is formed by combining the contents of the supplied {{Code|$maps}}. The maps are combined as follows:

# There is one entry in the new map for each distinct key present in the union of the input maps.

# The {{Code|$options}} argument defines how duplicate keys are handled. Currently, a single option {{Code|duplicates}} exists, and its allowed values are {{Code|use-first}}, {{Code|use-last}}, {{Code|combine}} and {{Code|reject}} (default: {{Code|use-first}}).

| '''Examples'''

|

* {{Code|map:merge((map:entry(0, "no"), map:entry(1, "yes")))}} creates <code>map { 0: "no", 1: "yes" }</code>.

* The following function adds a seventh entry to an existing map:

map:merge(($week, map { 7: "---" }))

* In the following example, the values of all maps are combined, resulting in a map with a single key (<code>map { "key": (1, 2, 3) }</code>):

map:merge(

for $i in 1 to 3 return map { 'key': $i },

map { 'duplicates': 'combine' }

)

|}

{| width='100%'

| '''Summary'''

| Creates a new ''map'', containing the entries of the supplied {{Code|$map}} and a new entry composed by {{Code|$key}} and {{Code|$value}}. The semantics of this function are equivalent to <code>map:merge((map { $key, $value }, $map))</code>

{| width='100%'

| '''Summary'''

| Constructs a new map by removing entries from an existing map. The entries in the new map correspond to the entries of {{Code|$map}}, excluding entries supplied via {{Code|$keys}}.

No failure occurs if the input map contains no entry with the supplied keys; the input map is returned unchanged.

| '''Examples'''

|

{| width='100%'

| '''Summary'''

| Returns a the number of entries in the supplied map. The function takes the supplied {{Code|$map}} and returns the number of entries that are present in the map.

| '''Examples'''

|

;Version 8.6

;Version 8.4

;Version 8.0

* Removed: support for collations (in accordance with the XQuery 3.1 spec).

* Removed: {{Code|map:new}} (replaced with {{Code|map:merge}})

;Version 7.8

* Updated: map syntax <code>map { 'key': 'value' }</code>

;Version 7.7.1

* Updated: alternative map syntax without {{Code|map}} keyword and {{Code|:}} as key/value delimiter (e.g.: <code>{ 'key': 'value' })</code>