ARLEN to get the length of an array, meaning the highest occupied index plus one.
Because arrays are sparse, this is a measure of extent rather than of contents: writing a single value at index 1000 makes ARLEN report 1001 while ARCOUNT still reports 1. Read it as the exclusive upper bound for any full scan of the array.
A key that does not exist has length 0.
See the array command overview for the data model these commands share.
Syntax
Arguments
Important points
- A length above the signed 64-bit range is returned as a big number reply rather than an integer.
Response
The reply reports the result of the operation. Error replies have the same shape in RESP2 and RESP3 and are surfaced as exceptions by the SDKs below.Client libraries often decode bulk strings, maps, sets, and numeric strings into language-native values. The table describes the Redis wire reply.
Examples
TCP examples use the TLSREDIS_URL from the Upstash console. REST examples use UPSTASH_REDIS_REST_URL and UPSTASH_REDIS_REST_TOKEN.
Redis CLI
Redis CLI
@upstash/redis
@upstash/redis
This command is not supported yet in
@upstash/redis.upstash_redis
upstash_redis
This command is not supported yet in
upstash_redis.ioredis
ioredis
node-redis
node-redis
redis-py
redis-py
go-redis
go-redis
jedis
jedis
redis-rs
redis-rs