rename #
Renames a key to newkey
. If newkey
already exists, it is overwritten.
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 #
<?php
use \Kuzzle\Kuzzle;
$kuzzle = new Kuzzle('localhost');
try {
$kuzzle->memoryStorage()->rename('key', 'newId');
}
catch (ErrorException $e) {
}
Edit this page on Github(opens new window)