SDK
SDK PHP v3.x
1

You are currently looking at the documentation of a previous version of Kuzzle. We strongly recommend that you use the latest version. You can also use the version selector in the top menu.

renamenx #

Renames a key to newkey, only if newkey does not already exist.

[Redis documentation]


renamenx(key, newkey, [options], [callback]) #

ArgumentsTypeDescription
keystringKey identifier
newkeystringNew key identifier
optionsJSON ObjectOptional parameters
callbackfunctionCallback

Options #

OptionTypeDescriptionDefault
queuablebooleanMake this request queuable or nottrue

Return Value #

Returns the MemoryStorage object to allow chaining.


Callback Response #

Returns a boolean specifying if the operation was successful or not.

Usage #

<?php
use \Kuzzle\Kuzzle;
$kuzzle = new Kuzzle('localhost');
try {
  $status = $kuzzle->memoryStorage()->renamenx('key', 'newId');
}
catch (ErrorException $e) {
}

Callback response:

true