SDK PHP v3.x

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.

expire #

Sets a timeout (in seconds) on a key. After the timeout has expired, the key will automatically be deleted.

[Redis documentation]

expire(key, seconds, [options], [callback]) #

Arguments Type Description
key string Key identifier
seconds int Time to live, in seconds
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 a boolean specifying if the operation was successful or not.

Usage #

Copied to clipboard!
use \Kuzzle\Kuzzle;
$kuzzle = new Kuzzle('localhost');
try {
  $status = $kuzzle->memoryStorage()->expire('key', 42);
catch (ErrorException $e) {

Callback response:

Copied to clipboard!