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.

hdel #

Removes fields from a hash.

[Redis documentation]

hdel(key, fields, [options], [callback]) #

Arguments Type Description
key string Key identifier
fields array List of field names to delete
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 the number of removed fields.

Usage #

Copied to clipboard!
use \Kuzzle\Kuzzle;
$kuzzle = new Kuzzle('localhost');
try {
  $count = $kuzzle->memoryStorage()->hdel('key', ['field1', 'field2']);
catch (ErrorException $e) {

Callback response:

Copied to clipboard!