Skip to content
HotKVDocs

Ask the HotKV docs

Answers come only from these docs and can be wrong; check the linked pages before you rely on them.

LTRIM

Last updated 
LTRIM key start stop
Group
List
Complexity
O(N) where N is the number of elements removed
Arity
4 (exactly, counting the command name)
Flags
write
Keys
first 1, last 1, step 1
HotKV Cloud
All plans
On-Premise
no license needed

LTRIM keeps only the elements of the list at key from index start to index stop, both included, and removes the rest. Indexes follow the same rules as LRANGE: they start at 0, negative values count from the end, and out-of-range values are clamped. If the range is empty, the whole list is removed and the key is deleted.

A common pattern is to push and then trim, to keep a capped list of the most recent items:

LPUSH recent:events <event>
LTRIM recent:events 0 99

Return value

Section titled “Return value”
Case RESP2 RESP3
Success (including a missing key) Simple string OK Same

Errors:

  • ERR value is not an integer or out of range if start or stop is not an integer. This is checked before the key is looked up.
  • WRONGTYPE if key holds a value that is not a list.

Examples

Section titled “Examples”
127.0.0.1:6379> RPUSH letters a b c d e
(integer) 5
127.0.0.1:6379> LTRIM letters 1 -2
OK
127.0.0.1:6379> LRANGE letters 0 -1
1) "b"
2) "c"
3) "d"
127.0.0.1:6379> LTRIM letters 5 10
OK
127.0.0.1:6379> EXISTS letters
(integer) 0

Compatibility

Section titled “Compatibility”

Same as Redis 7.4 and Valkey 8.

See also

Section titled “See also”

LRANGE, LREM, LPUSH, LLEN