A newer version of Hazelcast CLC is available.

View latest

clc atomicreference

5.5.0 5.4.1 5.4.0 5.3.7 5.3.6 5.3.5 5.3.4 5.2.1

AtomicReference operations

Usage:

clc atomicreference [command] [flags]
bash

Commands

clc atomicreference clear

Deletes the AtomicReference value.

Usage:

clc atomicreference clear [flags]
bash

Parameters:

Parameter Required Description Default

--name, -n

Optional

Name of the AtomicReference.

default
Global parameters
Parameter Description Default

--config, -c

Path to the configuration file in YAML format.

The following locations are tried in order for the existence of config.yaml

  1. Current working directory

  2. The parent directory of the clc executable

  3. $CLC_HOME/default directory

--format, -f

Set the output format

  • csv

  • delimited: By tab characters

  • json

  • table

  • Interactive mode: table

  • Non-interactive mode: delimited

--log.level

Set the log level, one of:

  • debug

  • info

  • warning

  • error

info

--log.path

Set the log path. Use stderr to log to the screen (stderr).

$CLC_HOME/logs/YYYY-MM-DD.log where YYYY-MM-DD is today’s date.

--quiet, -q

Prevent displaying unnecessary output.

false

--verbose

Enable output with more information.

false

--timeout

Timeout for operation to complete.

The duration is a string in the form of AMOUNTunit where AMOUNT is an integer, and unit is one of the following:

  • ms: milliseconds

  • s: seconds

  • m: minutes

  • h: hours

Underscore (_) character is ignored in the AMOUNT. unit is optional and defaults to s if not specified.

The following are a few of the valid DURATIONs:

  • 5: 5 seconds

  • 5s: 5 seconds

  • 10000ms: 10000 milliseconds

  • 10_000_000ms: 10000000 milliseconds

Warning This is a client-side timeout, the operation you started maybe in progress on the server-side even if the given timeout is exceeded.

Example:

clc atomicreference --name ref1 clear ref1
bash

clc atomicreference compare-and-set

Sets the value for the given key if it has the expected value.

Usage:

clc atomicreference compare-and-set [expected value] [new value] [flags]
bash

Parameters:

Parameter Required Description Default

--name, -n

Optional

Name of the AtomicReference.

default

expected value,

Required

Old value of the atomic reference.

N/A

new value,

Required

New value of the atomic reference.

N/A

--value-type, -v

Optional

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

string

--show-type

Optional

Add a type column to the output.

false
Global parameters
Parameter Description Default

--config, -c

Path to the configuration file in YAML format.

The following locations are tried in order for the existence of config.yaml

  1. Current working directory

  2. The parent directory of the clc executable

  3. $CLC_HOME/default directory

--format, -f

Set the output format

  • csv

  • delimited: By tab characters

  • json

  • table

  • Interactive mode: table

  • Non-interactive mode: delimited

--log.level

Set the log level, one of:

  • debug

  • info

  • warning

  • error

info

--log.path

Set the log path. Use stderr to log to the screen (stderr).

$CLC_HOME/logs/YYYY-MM-DD.log where YYYY-MM-DD is today’s date.

--quiet, -q

Prevent displaying unnecessary output.

false

--verbose

Enable output with more information.

false

--timeout

Timeout for operation to complete.

The duration is a string in the form of AMOUNTunit where AMOUNT is an integer, and unit is one of the following:

  • ms: milliseconds

  • s: seconds

  • m: minutes

  • h: hours

Underscore (_) character is ignored in the AMOUNT. unit is optional and defaults to s if not specified.

The following are a few of the valid DURATIONs:

  • 5: 5 seconds

  • 5s: 5 seconds

  • 10000ms: 10000 milliseconds

  • 10_000_000ms: 10000000 milliseconds

Warning This is a client-side timeout, the operation you started maybe in progress on the server-side even if the given timeout is exceeded.

Example:

clc atomicreference --name ref1 compare-and-set previous-value next-value
bash

clc atomicreference contains

Checks whether the AtomcReference has the given value.

Usage:

clc atomicreference contains [value] [flags]
bash

Parameters:

Parameter Required Description Default

--name, -n

Optional

Name of the AtomicReference.

default

value,

Required

Value to be checked for existence.

N/A

--value-type, -v

Optional

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

string

--show-type

Optional

Add a type column to the output.

false
Global parameters
Parameter Description Default

--config, -c

Path to the configuration file in YAML format.

The following locations are tried in order for the existence of config.yaml

  1. Current working directory

  2. The parent directory of the clc executable

  3. $CLC_HOME/default directory

--format, -f

Set the output format

  • csv

  • delimited: By tab characters

  • json

  • table

  • Interactive mode: table

  • Non-interactive mode: delimited

--log.level

Set the log level, one of:

  • debug

  • info

  • warning

  • error

info

--log.path

Set the log path. Use stderr to log to the screen (stderr).

$CLC_HOME/logs/YYYY-MM-DD.log where YYYY-MM-DD is today’s date.

--quiet, -q

Prevent displaying unnecessary output.

false

--verbose

Enable output with more information.

false

--timeout

Timeout for operation to complete.

The duration is a string in the form of AMOUNTunit where AMOUNT is an integer, and unit is one of the following:

  • ms: milliseconds

  • s: seconds

  • m: minutes

  • h: hours

Underscore (_) character is ignored in the AMOUNT. unit is optional and defaults to s if not specified.

The following are a few of the valid DURATIONs:

  • 5: 5 seconds

  • 5s: 5 seconds

  • 10000ms: 10000 milliseconds

  • 10_000_000ms: 10000000 milliseconds

Warning This is a client-side timeout, the operation you started maybe in progress on the server-side even if the given timeout is exceeded.

Example:

clc atomicreference --name ref1 contains my-value
bash

clc atomicreference get

Gets the AtomicReference value.

Usage:

clc atomicreference get [value] [flags]
bash

Parameters:

Parameter Required Description Default

--name, -n

Optional

Name of the AtomicReference.

default

value,

Required

Value to be checked for existence.

N/A

--value-type, -v

Optional

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

string

--show-type

Optional

Add a type column to the output.

false
Global parameters
Parameter Description Default

--config, -c

Path to the configuration file in YAML format.

The following locations are tried in order for the existence of config.yaml

  1. Current working directory

  2. The parent directory of the clc executable

  3. $CLC_HOME/default directory

--format, -f

Set the output format

  • csv

  • delimited: By tab characters

  • json

  • table

  • Interactive mode: table

  • Non-interactive mode: delimited

--log.level

Set the log level, one of:

  • debug

  • info

  • warning

  • error

info

--log.path

Set the log path. Use stderr to log to the screen (stderr).

$CLC_HOME/logs/YYYY-MM-DD.log where YYYY-MM-DD is today’s date.

--quiet, -q

Prevent displaying unnecessary output.

false

--verbose

Enable output with more information.

false

--timeout

Timeout for operation to complete.

The duration is a string in the form of AMOUNTunit where AMOUNT is an integer, and unit is one of the following:

  • ms: milliseconds

  • s: seconds

  • m: minutes

  • h: hours

Underscore (_) character is ignored in the AMOUNT. unit is optional and defaults to s if not specified.

The following are a few of the valid DURATIONs:

  • 5: 5 seconds

  • 5s: 5 seconds

  • 10000ms: 10000 milliseconds

  • 10_000_000ms: 10000000 milliseconds

Warning This is a client-side timeout, the operation you started maybe in progress on the server-side even if the given timeout is exceeded.

Example:

clc atomicreference --name ref1 get my-value
bash

clc atomicreference get-and-set

Sets a value in the given AtomicReference and returns the previous value.

Usage:

clc atomicreference get-and-set [value] [flags]
bash

Parameters:

Parameter Required Description Default

--name, -n

Optional

Name of the AtomicReference.

default

value,

Required

Value to be checked for existence.

N/A

--value-type, -v

Optional

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

string

--show-type

Optional

Add a type column to the output.

false
Global parameters
Parameter Description Default

--config, -c

Path to the configuration file in YAML format.

The following locations are tried in order for the existence of config.yaml

  1. Current working directory

  2. The parent directory of the clc executable

  3. $CLC_HOME/default directory

--format, -f

Set the output format

  • csv

  • delimited: By tab characters

  • json

  • table

  • Interactive mode: table

  • Non-interactive mode: delimited

--log.level

Set the log level, one of:

  • debug

  • info

  • warning

  • error

info

--log.path

Set the log path. Use stderr to log to the screen (stderr).

$CLC_HOME/logs/YYYY-MM-DD.log where YYYY-MM-DD is today’s date.

--quiet, -q

Prevent displaying unnecessary output.

false

--verbose

Enable output with more information.

false

--timeout

Timeout for operation to complete.

The duration is a string in the form of AMOUNTunit where AMOUNT is an integer, and unit is one of the following:

  • ms: milliseconds

  • s: seconds

  • m: minutes

  • h: hours

Underscore (_) character is ignored in the AMOUNT. unit is optional and defaults to s if not specified.

The following are a few of the valid DURATIONs:

  • 5: 5 seconds

  • 5s: 5 seconds

  • 10000ms: 10000 milliseconds

  • 10_000_000ms: 10000000 milliseconds

Warning This is a client-side timeout, the operation you started maybe in progress on the server-side even if the given timeout is exceeded.

Example:

clc atomicreference --name ref1 get-and-set my-value
bash

clc atomicreference is-null

Checks whether the stored value in the reference is null.

Usage:

clc atomicreference is-null [flags]
bash

Parameters:

Parameter Required Description Default

--name, -n

Optional

Name of the AtomicReference.

default

--show-type

Optional

Add a type column to the output.

false
Global parameters
Parameter Description Default

--config, -c

Path to the configuration file in YAML format.

The following locations are tried in order for the existence of config.yaml

  1. Current working directory

  2. The parent directory of the clc executable

  3. $CLC_HOME/default directory

--format, -f

Set the output format

  • csv

  • delimited: By tab characters

  • json

  • table

  • Interactive mode: table

  • Non-interactive mode: delimited

--log.level

Set the log level, one of:

  • debug

  • info

  • warning

  • error

info

--log.path

Set the log path. Use stderr to log to the screen (stderr).

$CLC_HOME/logs/YYYY-MM-DD.log where YYYY-MM-DD is today’s date.

--quiet, -q

Prevent displaying unnecessary output.

false

--verbose

Enable output with more information.

false

--timeout

Timeout for operation to complete.

The duration is a string in the form of AMOUNTunit where AMOUNT is an integer, and unit is one of the following:

  • ms: milliseconds

  • s: seconds

  • m: minutes

  • h: hours

Underscore (_) character is ignored in the AMOUNT. unit is optional and defaults to s if not specified.

The following are a few of the valid DURATIONs:

  • 5: 5 seconds

  • 5s: 5 seconds

  • 10000ms: 10000 milliseconds

  • 10_000_000ms: 10000000 milliseconds

Warning This is a client-side timeout, the operation you started maybe in progress on the server-side even if the given timeout is exceeded.

Example:

clc atomicreference --name ref1 is-null
bash

clc atomicreference set

Sets a value in the given AtomicReference.

Usage:

clc atomicreference set [value] [flags]
bash

Parameters:

Parameter Required Description Default

--name, -n

Optional

Name of the AtomicReference.

default

value,

Required

Value to be checked for existence.

N/A

--value-type, -v

Optional

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

string
Global parameters
Parameter Description Default

--config, -c

Path to the configuration file in YAML format.

The following locations are tried in order for the existence of config.yaml

  1. Current working directory

  2. The parent directory of the clc executable

  3. $CLC_HOME/default directory

--format, -f

Set the output format

  • csv

  • delimited: By tab characters

  • json

  • table

  • Interactive mode: table

  • Non-interactive mode: delimited

--log.level

Set the log level, one of:

  • debug

  • info

  • warning

  • error

info

--log.path

Set the log path. Use stderr to log to the screen (stderr).

$CLC_HOME/logs/YYYY-MM-DD.log where YYYY-MM-DD is today’s date.

--quiet, -q

Prevent displaying unnecessary output.

false

--verbose

Enable output with more information.

false

--timeout

Timeout for operation to complete.

The duration is a string in the form of AMOUNTunit where AMOUNT is an integer, and unit is one of the following:

  • ms: milliseconds

  • s: seconds

  • m: minutes

  • h: hours

Underscore (_) character is ignored in the AMOUNT. unit is optional and defaults to s if not specified.

The following are a few of the valid DURATIONs:

  • 5: 5 seconds

  • 5s: 5 seconds

  • 10000ms: 10000 milliseconds

  • 10_000_000ms: 10000000 milliseconds

Warning This is a client-side timeout, the operation you started maybe in progress on the server-side even if the given timeout is exceeded.

Example:

clc atomicreference --name ref1 set my-value
bash

clc atomicreference destroy

Deletes the AtomicReference and related data. Once destroyed, an AtomicReference with the same name cannot be used.

Usage:

clc atomicreference destroy [flags]
bash

Parameters:

Parameter Required Description Default

--name, -n

Optional

Name of the atomic reference.

default

--yes

Optional

Skip confirming the destroy operation.

false
lifebuoy

Help and support