SDK
SDK PHP v3.x
1

# expireat

Sets an expiration timestamp on a key. After the timestamp has been reached, the key will automatically be deleted. The timestamp parameter accepts an Epoch time value.

[Redis documentation]


# expireat(key, timestamp, [options], [callback])

Arguments Type Description
key string Key identifier
timestamp int Expiration timestamp
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!
<?php
use \Kuzzle\Kuzzle;
$kuzzle = new Kuzzle('localhost');
try {
  $status = $kuzzle->memoryStorage()->expireat('key', 1488372354);
}
catch (ErrorException $e) {
}

Callback response:

Copied to clipboard!
true