Core
API v1.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.

zrangebylex #

Returns elements within a provided interval, in a sorted set where all members have equal score, using lexicographical ordering.

[Redis documentation]


Query Syntax #

HTTP #

Copied to clipboard!
URL: http://kuzzle:7512/ms/_zrangebylex/<_id>?min=<min interval>&max=<max interval>[&limit=offset,count]
Method: GET

Other protocols #

Copied to clipboard!
{
  "controller": "ms",
  "action": "zrangebylex",
  "_id": "<key>",
  "min": "<min interval>",
  "max": "<max interval>",
  // optional
  "limit": [<offset>, <count>]
}

Arguments #

  • _id: sorted set identifier
  • min: minimum element value
  • max: maximum element value

The min and max values are inclusive by default. To change this behavior, check the full Redis documentation.

Optional: #

  • limit: 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>]

Response #

Returns an array of matched elements.

Copied to clipboard!
{
  "requestId": "<unique request identifier>",
  "status": 200,
  "error": null,
  "controller": "ms",
  "action": "zrangebylex",
  "collection": null,
  "index": null,
  "result": [
    "element1",
    "element2",
    "..."
  ]
}