zrangebyscore #
Returns all sorted set elements with a score within a provided range.
The elements are considered to be ordered from low to high scores.
Arguments #
zrangebyscore(key, min, max, [options]);
Arguments | Type | Description |
---|---|---|
key | string | Sorted set key |
min | string | Minimum score value |
max | string | Maximum score value |
options | object | Optional query arguments |
By default, min
and max
are inclusive. Check the full Redis documentation for other options.
options #
The options
arguments can contain the following option properties:
Property | Type (default) | Description |
---|---|---|
limit | integer[2] | An array of 2 integers, used to limit the number of returned matching elements (similar to SELECT LIMIT offset, count in SQL). Format: [<offset>,<count>] |
queuable | boolean (true) | If true , queues the request during downtime, until connected to Kuzzle again |
timeout | number ( -1 ) | Time (in ms) during which a request will still be waited to be resolved. Set it -1 if you want to wait indefinitely |
triggerEvents | boolean ( false ) | If set to true , will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. Available since Kuzzle 2.31.0 |
Resolve #
Resolves to the list of elements in the provided score range.
Usage #
try {
await kuzzle.ms.zadd('ssetfoo', [
{member: 'foo', score: '42'},
{member: 'bar', score: '4'},
{member: 'baz', score: '-272.15'}
]);
// Prints:
// [ { member: 'baz', score: -272.15 },
// { member: 'bar', score: 4 } ]
console.log(await kuzzle.ms.zrangebyscore('ssetfoo', '-inf', '(42'));
} catch (error) {
console.error(error.message);
}
Edit this page on Github(opens new window)