Core 2.x

renamenx

Renames a key, only if the new name is not already used.

[Redis documentation]

Arguments

Copied to clipboard!
renamenx(src, dest, [options]);

Arguments Type Description
src
string
Key to rename
dest
string
New key name
options
object
Optional query arguments

options

The options arguments can contain the following option properties:

Property Type (default) Description
queuable
boolean (true)
If true, queues the request during downtime, until connected to Kuzzle again

Resolve

Resolves to a boolean telling whether the operation succeeded or not.

Usage

Copied to clipboard!
try {
  await kuzzle.ms.set('foo', 'val');
  await kuzzle.ms.set('bar', 'val');
  // Prints: false
  // (the key "bar" already exists)
  console.log(await kuzzle.ms.renamenx('foo', 'bar'));
  // Prints: true
  console.log(await kuzzle.ms.renamenx('foo', 'qux'));
} catch (error) {
  console.error(error.message);
}