Class RenameNxCommand

Available since 1.0.0.

RENAMENX key newkey

Renames key to newkey if newkey does not yet exist. It returns an error when key does not exist.

In Cluster mode, both key and newkey must be in the same hash slot, meaning that in practice only keys that have the same hash tag can be reliably renamed in cluster.

History

<= 3.2.0: Before Redis 3.2.0, an error is returned if source and destination names are the same.

Return value

Integer reply, specifically:

1 if key was renamed to newkey. 0 if newkey already exists.

Examples

redis> SET mykey "Hello"
"OK"
redis> SET myotherkey "World"
"OK"
redis> RENAMENX mykey myotherkey
(integer) 0
redis> GET myotherkey
"World"
redis>

Hierarchy

Constructors

constructor

Properties

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

Methods

execSync

Constructors

constructor

Properties

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 = "renamenx"

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