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.

zadd #

Adds the specified elements to the sorted set stored at key. If the key does not exist, it is created, holding an empty sorted set. If it already exists and does not hold a sorted set, an error is returned.

Scores are expressed as floating point numbers.

If a member to insert is already in the sorted set, its score is updated and the member is reinserted at the right position in the set.

[Redis documentation]

zadd(key, elements, [options], [callback]) #

Arguments Type Description
key string Key identifier
elements array List of JSON objects detailing the element to add to the sorted set.
Properties: score (element's score, double), member (element's value, string)
options JSON Object Optional parameters
callback function Callback

Options #

Option Type Description Default
ch boolean Instead of returning the number of added allements, return the total number of changes performed (including updates) false
incr boolean Instead of adding elements, increment the existing member with the provided score value. Only one score+element pair can be specified if this option is set false
nx boolean Only add new elements, do not update existing ones false
queuable boolean Make this request queuable or not true
xx boolean Never add new elements, update only exiting ones false

Return Value #

Returns the MemoryStorage object to allow chaining.

Callback Response #

Returns an integer containing the number of elements added to the sorted set.

Usage #

Copied to clipboard!
use \Kuzzle\Kuzzle;
$kuzzle = new Kuzzle('localhost');
$elements = [
  ['score' => 1, 'member' => 'foo'],
  ['score' => 2, 'member' => 'bar'],
  ['score' => 3, 'member' => 'baz']
try {
  $value = $kuzzle->memoryStorage()->zadd('key', elements);
catch (ErrorException $e) {

Callback response:

Copied to clipboard!