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.

ttl #

Returns the remaining time to live of a key, in seconds, or a negative value if the key does not exist or if it is persistent.

[Redis documentation]

ttl(key, [options], callback) #

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

Options #

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

Callback Response #

Returns an integer containing the remaining time to live of the key, in seconds.

Usage #

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

Callback response:

Copied to clipboard!