A newer version of Hazelcast CLC is available.

View latest

clc multimap

5.5.0 5.4.1 5.4.0 5.3.7 5.3.6 5.3.5 5.3.4 5.2.1

multimap commands are a group of MultiMap operations.

Usage:

clc multimap [command] [flags]
bash

Commands

clc multimap put

Put a value in the given MultiMap.

Usage:

clc multimap put [key] [value] [flags]
bash

Parameters:

Parameter Required Description Default

--name, -n

Optional

Name of the MultiMap.

default

key

Required

Key of the MultiMap 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

Example:

clc multimap put --key-type string hello --value-type f32 19.94 --name myMultiMap
bash

clc multimap get

Prints entries from the MultiMap.

Usage:

clc multimap get [key] [flags]
bash

Parameters:

Parameter Required Description Default

--name, -n

Optional

Name of the MultiMap.

default

key

Required

Key of the MultiMap 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.

clc multimap remove

Remove values from the given MultiMap.

Usage:

clc multimap remove [key] [flags]
bash

Parameters:

Parameter Required Description Default

--name, -n

Optional

Name of the MultiMap.

default

key

Required

Key of the MultiMap entries.

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 multimap remove --name mymulti-map --key-type string k1
k1
bash

clc multimap size

Prints the size of the given the MultiMap.

Usage:

clc multimap size [flags]
bash

Parameters:

Parameter Required Description Default

--name, -n

Optional

Name of the MultiMap.

default

clc multimap clear

Removes all entries from the MultiMap.

Usage:

clc multimap clear [flags]
bash

Parameters:

Parameter Required Description Default

--name, -n

Optional

Name of the MultiMap.

default

--yes

Optional

Skip confirming the clear operation.

false

clc multimap destroy

Deletes the MultiMap and all the data in it.

Usage:

clc multimap destroy [flags]
bash

Parameters:

Parameter Required Description Default

--name, -n

Optional

Name of the MultiMap.

default

--yes

Optional

Skip confirming the destroy operation.

false

Example:

clc multimap destroy -n myMultiMap
bash

clc multimap key-set

Gets all the keys of the specified MultiMap.

Usage:

clc multimap key-set [flags]
bash

Parameters:

Parameter Required Description Default

--name, -n

Optional

Name of the MultiMap.

default

--format, -f

Optional

Output format. Supported formats:

  • csv

  • delimited

  • json

  • table

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

Example:

clc multimap key-set -n myMultiMap
bash

clc multimap entry-set

Gets all the entries of the specified MultiMap.

Usage:

clc multimap entry-set [flags]
bash

Parameters:

Parameter Required Description Default

--name, -n

Optional

Name of the MultiMap.

default

--format, -f

Optional

Output format. Supported formats:

  • csv

  • delimited

  • json

  • table

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

Example:

clc multimap entry-set -n myMultiMap
bash

clc multimap values

Gets all values of the specified MultiMap.

Usage:

clc multimap values [flags]
bash

Parameters:

Parameter Required Description Default

--name, -n

Optional

Name of the MultiMap.

default

--format, -f

Optional

Output format. Supported formats:

  • csv

  • delimited

  • json

  • table

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

Example:

clc multimap values -n myMultiMap
bash

clc multimap lock

Lock a key in the given MultiMap.

This command is only available in the interactive mode.

Usage:

clc multimap lock [key] [flags]
bash

Parameters:

Parameter Required Description Default

--name, -n

Optional

Name of the MultiMap.

default

--key-type, -k

Optional

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

String

Example:

clc multimap lock 1
bash

clc multimap try-lock

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

This command is only available in the interactive mode.

Usage:

clc multimap try-lock [key] [flags]
bash

Parameters:

Parameter Required Description Default

--name, -n

Optional

Name of the MultiMap.

default

--key-type, -k

Optional

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

String

Example:

clc multimap try-lock 1
bash

clc multimap unlock

Unlock a key in the given MultiMap.

This command is only available in the interactive mode.

Usage:

clc multimap unlock [key] [flags]
bash

Parameters:

Parameter Required Description Default

--name, -n

Optional

Name of the MultiMap.

default

--key-type, -k

Optional

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

String

Example:

clc multimap unlock 1
bash
lifebuoy

Help and support