original
http://redis.io/commands/zrangebylex
Introduction
Return a range of members in a sorted set, by lexicographical range.
Returns a range of members in a sorted set according to the dictionary range.
grammar
ZRANGEBYLEX key min max [LIMIT offset count]
Version
Available since 2.8.9.
Available since version 2.8.9.
time complexity
Time complexity: O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements being returned. If M is constant (e.g. always asking for the first 10 elements with LIMIT), you can consider it O(log(N)).
O(log(N)+M): N is the number of elements in the sorted set and M is the number of elements returned. If M is constant, you can consider the time complexity to be O(log(N)).
describe
When all the elements in a sorted set are inserted with the same score, in order to force lexicographical ordering, this command returns all the elements in the sorted set at key with a value between min and max.
To enforce lexicographic ordering when all elements inserted in the sorted set have the same score, this command returns all elements with values between min and max.
If the elements in the sorted set have different scores, the returned elements are unspecified.
If the elements in the sorted set have different scores, the returned element is unspecified.
The elements are considered to be ordered from lower to higher strings as compared byte-by-byte using the memcmp() C function. Longer strings are considered greater than shorter strings if the common part is identical.
The elements are considered to be sorted from lower to higher strings, and are compared byte-wise by the memcmp() function. Longer strings are considered larger than shorter strings if the common parts are the same.
The optional LIMIT argument can be used to only get a range of the matching elements (similar to SELECT LIMIT offset, count in SQL). Keep in mind that if offset is large, the sorted set needs to be traversed for offset elements before getting to the elements to return, which can add up to O(N) time complexity.
The LIMIT parameter can be used to get only elements that match a certain range (similar to the SQL statement SELECT LIMIT offset, count). Keep in mind that if the offset is large, the sorted set needs to go through the offset elements before getting the returned element, and the total time complexity is O(N).
How to specify intervals
Valid start and stop must start with ( or [, in order to specify if the range item is respectively exclusive or inclusive. The special values of + or - for start and stop have the special meaning or positively infinite and negatively infinite strings, so for instance the command ZRANGEBYLEX myzset - + is guaranteed to return all the elements in the sorted set, if all the elements have the same score.
If you need to specify that range boundaries are to be excluded or included, valid start and stop must start with ( or [. If start and stop are specified as + or -, a positive or negative infinity string, e.g. ZRANGEBYLEX myzset - +, All elements in the sorted set are guaranteed to be returned if all elements have the same score.
Details on strings comparison
Strings are compared as binary array of bytes. Because of how the ASCII character set is specified, this means that usually this also have the effect of comparing normal ASCII characters in an obvious dictionary way. However this is not true if non plain ASCII strings are used (for example utf8 strings).
However the user can apply a transformation to the encoded string so that the first part of the element inserted in the sorted set will compare as the user requires for the specific application. For example if I want to add strings that will be compared in a case-insensitive way, but I still want to retrieve the real case when querying, I can add strings in the following way:
ZADD autocomplete 0 foo:Foo 0 bar:BAR 0 zap:zap
Because of the first normalized part in every element (before the colon character), we are forcing a given comparison, however after the range is queries using ZRANGEBYLEX the application can display to the user the second part of the string, after the colon.
The binary nature of the comparison allows to use sorted sets as a general purpose index, for example the first part of the element can be a 64 bit big endian number: since big endian numbers have the most significant bytes in the initial positions, the binary comparison will match the numerical comparison of the numbers. This can be used in order to implement range queries on 64 bit values. As in the example below, after the first 8 bytes we can store the value of the element we are actually indexing.
return value
Array reply: list of elements in the specified score range.
Array: A list of elements of the specified range.
example
redis> ZADD myzset 0 a 0 b 0 c 0 d 0 e 0 f 0 g
(integer) 7
redis> ZRANGEBYLEX myzset - [c
1) "a"
2) "b"
3) "c"
redis> ZRANGEBYLEX myzset - (c
1) "a"
2) "b"
redis> ZRANGEBYLEX myzset [aaa (g
1) "b"
2) "c"
3) "d"
4) "e"
5) "f"
redis>