JSON.ARRPOP to remove an element from the arrays a path selects and return it.
Without an index the last element is popped, which makes the command a stack pop; index 0 pops the first element, and negative indexes count from the end. An index past the end of the array is clamped to the last element. The reply is the removed element as JSON text, or null when the array is empty.
Because the read and the removal happen in one atomic step, a JSON array can be used as a small work queue without the risk of two clients taking the same element.
Syntax
Arguments
Important points
- Raw TCP examples pass JSON values as valid JSON text. Typed Upstash SDK helpers serialize native objects and values for you.
- Paths beginning with
$use JSONPath and can match multiple values, so many JSON commands return an array of per-match results.
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
upstash_redis
upstash_redis
ioredis
ioredis
node-redis
node-redis
redis-py
redis-py
go-redis
go-redis
jedis
jedis
redis-rs
redis-rs