Javascript 7.x

rename

Renames a key.

If the new key name is already used, then it is overwritten.

[Redis documentation]

Arguments

Copied to clipboard!
rename(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 once the operation succeeds.

Usage

Copied to clipboard!
try {
  await kuzzle.ms.set('foo', 'World');
  await kuzzle.ms.rename('foo', 'Hello');
  // Prints: World
  console.log(await kuzzle.ms.get('Hello'));
} catch (error) {
  console.error(error.message);
}