summaryrefslogtreecommitdiffstats
path: root/iredis/data/commands/lrange.md
blob: 923b542c1968daa45f17b8f121a5f79ae0ec22c4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
Returns the specified elements of the list stored at `key`. The offsets `start`
and `stop` are zero-based indexes, with `0` being the first element of the list
(the head of the list), `1` being the next element and so on.

These offsets can also be negative numbers indicating offsets starting at the
end of the list. For example, `-1` is the last element of the list, `-2` the
penultimate, and so on.

## Consistency with range functions in various programming languages

Note that if you have a list of numbers from 0 to 100, `LRANGE list 0 10` will
return 11 elements, that is, the rightmost item is included. This **may or may
not** be consistent with behavior of range-related functions in your programming
language of choice (think Ruby's `Range.new`, `Array#slice` or Python's
`range()` function).

## Out-of-range indexes

Out of range indexes will not produce an error. If `start` is larger than the
end of the list, an empty list is returned. If `stop` is larger than the actual
end of the list, Redis will treat it like the last element of the list.

@return

@array-reply: list of elements in the specified range.

@examples

```cli
RPUSH mylist "one"
RPUSH mylist "two"
RPUSH mylist "three"
LRANGE mylist 0 0
LRANGE mylist -3 2
LRANGE mylist -100 100
LRANGE mylist 5 10
```