A newer version of Hazelcast CLC is available.

View latest

clc map

5.5.0 5.4.1 5.4.0 5.3.7 5.3.6 5.3.5 5.3.4 5.2.1

Map commands are a group of map operations.

Usage:

clc map [command] [flags]

Commands

clc map clear

Removes all entries from the map.

Usage:

clc map clear [flags]

Parameters:

Parameter Required Description Default

--name, -n

Optional

Name of the map.

default

clc map get

Prints a single entry from the map as a key-value pair.

Usage:

clc map get [key] [flags]

Parameters:

Parameter Required Description Default

--name, -n

Optional

Name of the map.

default

key

Required

Key of the map entry.

N/A

--key-type, -k

Optional

Data type of the key. One of: string, bool, json, i8, i16, i32, i64, f32, f64.

string

--format, -f

Optional

Output format. Supported formats:

  • csv

  • delimited

  • json

  • table

delimited in non-interactive mode, table in interactive mode.

Example:

clc map get --name yearbook 2012 --key-type i16

clc map set

Sets the given key-value entry pair in a map.

Usage:

clc map set [key] [value] [flags]

Parameters:

Parameter Required Description Default

--name, -n

Optional

Name of the map.

default

key

Required

Key of the map entry.

N/A

value,

Required

Value to set for the key.

N/A

--key-type, -k

Optional

Data type of the key. One of: string, bool, json, i8, i16, i32, i64, f32, f64

string

--value-type, -v

Optional

Data type of the value. One of: string, bool, json, i8, i16, i32, i64, f32, f64

string

--ttl

Optional

Duration in milliseconds after which the entry will expire and be evicted. It cannot be shorter than 1 second (1000 ms).

N/A

--max-idle

Optional

Maximum time for this entry to stay idle in the map. It cannot be shorter than 1 second (1000 ms).

N/A

Example:

clc map set --key-type string hello --value-type f32 19.94 --name myMap --ttl 1300

clc map entry-set

Gets all the entries of the specified map.

Usage:

clc map entry-set [flags]

Parameters:

Parameter Required Description Default

--name, -n

Optional

Name of the map.

default

--format, -f

Optional

Output format. Supported formats:

  • csv

  • delimited

  • json

  • table

delimited in non-interactive mode, table in interactive mode.

Example:

clc map entry-set -n myMap

clc map entry-view

Returns a view of the entry with the given key.

This command doesn’t affect entry statistics, such as Hits and entry metadata such as Max Idle.

See this documentation for information about per-entry statistics: Getting Statistics about a Specific Map Entry.

The following information about the entry is returned:

  • Key

  • Value

  • Cost

  • Creation Time

  • Expiration Time

  • Hits

  • Last Access Time

  • Last Stored Time

  • Last Update Time

  • Version

  • TTL

  • Max Idle

Usage:

clc map entry-view [key] [flags]

Parameters:

Parameter Required Description Default

--name, -n

Optional

Name of the map.

default

key

Required

Key of the map entry.

N/A

--key-type, -k

Optional

Data type of the key. One of: string, bool, json, i8, i16, i32, i64, f32, f64

string

Example:

clc map entry-view -n my-map my-key

clc map key-set

Gets all the keys of the specified map.

Usage:

clc map key-set [flags]

Parameters:

Parameter Required Description Default

--name, -n

Optional

Name of the map.

default

--format, -f

Optional

Output format. Supported formats:

  • csv

  • delimited

  • json

  • table

delimited in non-interactive mode, table in interactive mode.

Example:

clc map key-set -n myMap

clc map values

Gets all the values of the given map.

Usage:

clc map values [flags]

Parameters:

Parameter Required Description Default

--name, -n

Optional

Name of the map.

default

--format, -f

Optional

Output format. Supported formats:

  • csv

  • delimited

  • json

  • table

delimited in non-interactive mode, table in interactive mode.

Example:

clc map values -n myMap

clc map lock

Locks the key of the given the map.

This command is only available in the interactive mode.

Usage:

clc map lock [key] [flags]

Parameters:

Parameter Required Description Default

--name, -n

Optional

Name of the map.

default

key

Required

Key of the map entry.

N/A

--key-type, -k

Optional

Data type of the key. One of: string, bool, json, i8, i16, i32, i64, f32, f64

String

|--ttl |Optional |Duration in milliseconds after which the lock will expire. |-1

Example:

clc map lock -n my-map --key-type string key1

clc map try-lock

Tries to lock the key of the given the map. Returns a result without waiting.

This command is only available in the interactive mode.

Usage:

clc map try-lock [key] [flags]

Parameters:

Parameter Required Description Default

--name, -n

Optional

Name of the map.

default

key

Required

Key of the map entry.

N/A

--key-type, -k

Optional

Data type of the key. One of: string, bool, json, i8, i16, i32, i64, f32, f64

String

--ttl

Optional

Duration in milliseconds after which the lock will expire.

-1

Example:

clc map try-lock -n my-map --key-type string key1

clc map unlock

Unlocks the key of the given the map.

This command is only available in the interactive mode.

Usage:

clc map unlock [key] [flags]

Parameters:

Parameter Required Description Default

--name, -n

Optional

Name of the map.

default

key

Required

Key of the map entry.

N/A

--key-type, -k

Optional

Data type of the key. One of: string, bool, json, i8, i16, i32, i64, f32, f64

String

Example:

clc map unlock -n my-map --key-type string key1

clc map size

Prints the size of the given the map.

Usage:

clc map size [flags]

Parameters:

Parameter Required Description Default

--name, -n

Optional

Name of the map.

default

clc map load-all

Load keys from map-store into the map. If no key is given, all keys are loaded.

Usage:

clc map load-all [keys] [flags]

Parameters:

Parameter Required Description Default

--name, -n

Optional

Name of the map.

default

keys

Required

Keys of the map entries.

N/A

--key-type, -k

Optional

Data type of the key. One of: string, bool, json, i8, i16, i32, i64, f32, f64

string

Example:

clc map load-all --key-type string key1 key2 --name myMap --replace

clc map remove

Deletes the value of a given key in a map and returns the key.

Usage:

clc map remove [flags] [key]

Parameters:

Parameter Required Description Default

--name, -n

Optional

Name of the map.

default

key

Required

Key of the map entry.

N/A

--key-type, -k

Optional

Data type of the key. One of: string, bool, json, i8, i16, i32, i64, f32, f64

string

--format, -f

Optional

Output format. Supported formats:

  • csv

  • delimited

  • json

  • table

delimited in non-interactive mode, table in interactive mode.

Example:

clc map remove --name myMap --key-type string k1
k1

clc map destroy

Deletes the map and all the data in it.

Usage:

clc map destroy [flags]

Parameters:

Parameter Required Description Default

--name, -n

Optional

Name of the map.

default

--yes

Optional

Skip confirming the destroy operation.

false
lifebuoy

Help and support