Class GetSetCommand

Available since 1.0.0.

GETSET key value

Atomically sets key to value and returns the old value stored at key. Returns an error when key exists but does not hold a string value.

Design pattern

GETSET can be used together with INCR for counting with atomic reset. For example: a process may call INCR against the key mycounter every time some event occurs, but from time to time we need to get the value of the counter and reset it to zero atomically. This can be done using GETSET mycounter "0":

Example

redis> INCR mycounter
(integer) 1
redis> GETSET mycounter "0"
"1"
redis> GET mycounter
"0"
redis>

Return value

Bulk string reply: the old value stored at key, or nil when key did not exist.

Hierarchy

Constructors

constructor

Properties

DbDataType blocking? dataType? logger maxParams minParams name pubSubAllowed? sign? txIgnore?

Methods

execSync

Constructors

constructor

Properties

DbDataType

DbDataType: DataType = DataType.STRING

Optional blocking

blocking?: boolean

Optional dataType

dataType?: DataType

Used for "database" commands to enforce type checking.

Private logger

logger: Logger = ...

maxParams

maxParams: number = 2

Maximum number of parameters allowed. -1 for no maximum.

minParams

minParams: number = 2

Minimum number of parameters require.

name

name: string = "getset"

Optional pubSubAllowed

pubSubAllowed?: boolean

Used when PUB/SUB is in effect.

Optional sign

sign?: number

Sign is used in commands with a compliment command. The only current example is INCR/DECR. Sign is 1 for INCR and -1 for DECR

Optional txIgnore

txIgnore?: boolean

Used in transactions to enqueue a command.

Methods

execSync

Settings

Member Visibility

Theme

On This Page