Namespace: map

planBuilder. map

Builds expressions to call functions in the map server library for a row pipeline.
Since:
  • 2.1.1

Methods


contains(map, key) → {XsBoolean}

Returns true if the key exists in the map. Provides a client interface to a server function. See map:contains
Parameters:
Name Type Argument Description
map MapMap <optional>
A map.
key XsString <optional>
A key.
Since:
  • 2.1.1
Returns:
Type
XsBoolean

count(map) → {XsUnsignedInt}

Returns the number of keys used in the map. Provides a client interface to a server function. See map:count
Parameters:
Name Type Argument Description
map MapMap <optional>
A map.
Since:
  • 2.1.1
Returns:
Type
XsUnsignedInt

entry(key, value) → {MapMap}

Constructs a new map with a single entry consisting of the key and value specified as arguments. This is particularly helpful when used as part of an argument to map:new(). Provides a client interface to a server function. See map:entry
Parameters:
Name Type Argument Description
key XsString <optional>
The map key.
value Item <optional>
The map value.
Since:
  • 2.1.1
Returns:
Type
MapMap

get(map, key) → {Item}

Get a value from a map. Provides a client interface to a server function. See map:get
Parameters:
Name Type Argument Description
map MapMap <optional>
A map.
key XsString <optional>
A key.
Since:
  • 2.1.1
Returns:
Type
Item

keys(map) → {XsString}

Get the keys used in the map. Provides a client interface to a server function. See map:keys
Parameters:
Name Type Argument Description
map MapMap <optional>
A map.
Since:
  • 2.1.1
Returns:
Type
XsString

map(map) → {MapMap}

Creates a map. Provides a client interface to a server function. See map:map
Parameters:
Name Type Argument Description
map ElementNode <optional>
A serialized map element.
Since:
  • 2.1.1
Returns:
Type
MapMap

new(maps) → {MapMap}

Constructs a new map by combining the keys from the maps given as an argument. If a given key exists in more than one argument map, the value from the last such map is used. Provides a client interface to a server function. See map:new
Parameters:
Name Type Argument Description
maps MapMap <optional>
The argument maps.
Since:
  • 2.1.1
Returns:
Type
MapMap
Copyright (c) 2020 MarkLogic Corporation Documentation generated by JSDoc 4.0.0 on 2024-01-04T18:17:59-08:00 using the DocStrap template.