SDK
SDK Javascript v5.x
1

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]) #

ArgumentsTypeDescription
keystringKey identifier
elementsarrayList of JSON objects detailing the element to add to the sorted set.
Properties: score (element's score, double), member (element's value, string)
optionsJSON ObjectOptional parameters
callbackfunctionCallback

Options #

OptionTypeDescriptionDefault
chbooleanInstead of returning the number of added allements, return the total number of changes performed (including updates)false
incrbooleanInstead of adding elements, increment the existing member with the provided score value. Only one score+element pair can be specified if this option is setfalse
nxbooleanOnly add new elements, do not update existing onesfalse
queuablebooleanMake this request queuable or nottrue
xxbooleanNever add new elements, update only exiting onesfalse

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 #

var elements = [
  {'score': 1, 'member': 'foo'},
  {'score': 2, 'member': 'bar'},
  {'score': 3, 'member': 'baz'}
];
// Using callbacks (NodeJS or Web Browser)
kuzzle.memoryStorage.zadd('key', elements, function (err, count) {
  // callback called once the action has completed
});
// Using promises (NodeJS only)
kuzzle.memoryStorage.zaddPromise('key', elements)
  .then(count => {
    // resolved once the action has completed
  });

Callback response:

3