Skip to main content
Version: 5.7.1

clc multimap

multimap commands are a group of MultiMap operations.

Usage:

bash
clc multimap [command] [flags]

Commands​

clc multimap put​

Put a value in the given MultiMap.

Usage:

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

Parameters:

ParameterRequiredDescriptionDefault
--name, -nOptionalName of the MultiMap.default
keyRequiredKey of the MultiMap entry.N/A
value,RequiredValue to set for the key.N/A
--key-type, -kOptionalData type of the key. One of: string, bool, json, i8, i16, i32, i64, f32, f64String
--value-type, -vOptionalData type of the value. One of: string, bool, json, i8, i16, i32, i64, f32, f64String

Example:

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

clc multimap get​

Prints entries from the MultiMap.

Usage:

bash
clc multimap get [key] [flags]

Parameters:

ParameterRequiredDescriptionDefault
--name, -nOptionalName of the MultiMap.default
keyRequiredKey of the MultiMap entry.N/A
--key-type, -kOptionalData type of the key. One of: string, bool, json, i8, i16, i32, i64, f32, f64.string
--format, -fOptional

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:

bash
clc multimap remove [key] [flags]

Parameters:

ParameterRequiredDescriptionDefault
--name, -nOptionalName of the MultiMap.default
keyRequiredKey of the MultiMap entries.N/A
--key-type, -kOptionalData type of the key. One of: string, bool, json, i8, i16, i32, i64, f32, f64String
--format, -fOptional

Output format. Supported formats:

  • csv
  • delimited
  • json
  • table
delimited in non-interactive mode, table in interactive mode.

Example:

bash
clc multimap remove --name mymulti-map --key-type string k1
k1

clc multimap size​

Prints the size of the given the MultiMap.

Usage:

bash
clc multimap size [flags]

Parameters:

ParameterRequiredDescriptionDefault
--name, -nOptionalName of the MultiMap.default

clc multimap clear​

Removes all entries from the MultiMap.

Usage:

bash
clc multimap clear [flags]

Parameters:

ParameterRequiredDescriptionDefault
--name, -nOptionalName of the MultiMap.default
--yesOptionalSkip confirming the clear operation.false

clc multimap destroy​

Deletes the MultiMap and all the data in it.

Usage:

bash
clc multimap destroy [flags]

Parameters:

ParameterRequiredDescriptionDefault
--name, -nOptionalName of the MultiMap.default
--yesOptionalSkip confirming the destroy operation.false

Example:

bash
clc multimap destroy -n myMultiMap

clc multimap key-set​

Gets all the keys of the specified MultiMap.

Usage:

bash
clc multimap key-set [flags]

Parameters:

ParameterRequiredDescriptionDefault
--name, -nOptionalName of the MultiMap.default
--format, -fOptional

Output format. Supported formats:

  • csv
  • delimited
  • json
  • table
delimited in non-interactive mode, table in interactive mode.

Example:

bash
clc multimap key-set -n myMultiMap

clc multimap entry-set​

Gets all the entries of the specified MultiMap.

Usage:

bash
clc multimap entry-set [flags]

Parameters:

ParameterRequiredDescriptionDefault
--name, -nOptionalName of the MultiMap.default
--format, -fOptional

Output format. Supported formats:

  • csv
  • delimited
  • json
  • table
delimited in non-interactive mode, table in interactive mode.

Example:

bash
clc multimap entry-set -n myMultiMap

clc multimap values​

Gets all values of the specified MultiMap.

Usage:

bash
clc multimap values [flags]

Parameters:

ParameterRequiredDescriptionDefault
--name, -nOptionalName of the MultiMap.default
--format, -fOptional

Output format. Supported formats:

  • csv
  • delimited
  • json
  • table
delimited in non-interactive mode, table in interactive mode.

Example:

bash
clc multimap values -n myMultiMap

clc multimap lock​

Lock a key in the given MultiMap.

This command is only available in the interactive mode.

Usage:

bash
clc multimap lock [key] [flags]

Parameters:

ParameterRequiredDescriptionDefault
--name, -nOptionalName of the MultiMap.default
--key-type, -kOptionalData type of the key. One of: string, bool, json, i8, i16, i32, i64, f32, f64String

Example:

bash
clc multimap lock 1

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:

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

Parameters:

ParameterRequiredDescriptionDefault
--name, -nOptionalName of the MultiMap.default
--key-type, -kOptionalData type of the key. One of: string, bool, json, i8, i16, i32, i64, f32, f64String

Example:

bash
clc multimap try-lock 1

clc multimap unlock​

Unlock a key in the given MultiMap.

This command is only available in the interactive mode.

Usage:

bash
clc multimap unlock [key] [flags]

Parameters:

ParameterRequiredDescriptionDefault
--name, -nOptionalName of the MultiMap.default
--key-type, -kOptionalData type of the key. One of: string, bool, json, i8, i16, i32, i64, f32, f64String

Example:

bash
clc multimap unlock 1