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.

rename #

Renames a key to newkey. If newkey already exists, it is overwritten.

[Redis documentation]


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

Arguments Type Description
key string Key identifier
newkey string New key identifier
options JSON Object Optional parameters
callback function Callback

Options #

Option Type Description Default
queuable boolean Make this request queuable or not true

Return value #

Returns the MemoryStorage object to allow chaining.


Callback Response #

Returns null if successful.

Usage #

Copied to clipboard!
<?php
use \Kuzzle\Kuzzle;
$kuzzle = new Kuzzle('localhost');
try {
  $kuzzle->memoryStorage()->rename('key', 'newId');
}
catch (ErrorException $e) {
}