ARMGET - Upstash Documentation

Use ARMGET to read several array slots in one call.

The reply has one element per requested index, in the order the indexes were given, with null for an empty slot. That positional guarantee is what makes it usable as a gather step: the caller can zip the reply back onto its own list of indexes without re-checking which ones existed.

A key that does not exist behaves like an array where every slot is empty, so the reply is a list of nulls rather than an error.

See the array command overview for the data model these commands share.

Syntax#

ARMGET <key> <index> [<index> ...]

Arguments#

Argument	Required	Repeatable	Description
`<key>`	Yes	No	Array key targeted by the command.
`<index>`	Yes	Yes	Zero-based index to read. Repeat to read several slots in one call.

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.

Protocol	Reply
RESP2	Array of bulk strings and null bulk strings
RESP3	Array of bulk strings and nulls

Note

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 TLS REDIS_URL from the Upstash console. REST examples use UPSTASH_REDIS_REST_URL and UPSTASH_REDIS_REST_TOKEN.

Redis CLI

ARMGET my-array 0 1 5

@upstash/redis

Note

This command is not supported yet in @upstash/redis.

upstash_redis

Note

This command is not supported yet in upstash_redis.

ioredis

import Redis from "ioredis";const redis = new Redis(process.env.REDIS_URL!);const result = await redis.armget("my-array", 0, 1, 5);console.log(result);

node-redis

import { createClient } from "redis";const client = await createClient({ url: process.env.REDIS_URL })  .on("error", console.error)  .connect();const result = await client.arMGet("my-array", [0, 1, 5]);console.log(result);

redis-py

import osimport redisclient = redis.from_url(os.environ["REDIS_URL"])result = client.armget("my-array", 0, 1, 5)print(result)

go-redis

package mainimport (    "context"    "fmt"    "os"    "github.com/redis/go-redis/v9")func main() {    opts, err := redis.ParseURL(os.Getenv("REDIS_URL"))    if err != nil {        panic(err)    }    client := redis.NewClient(opts)    result, err := client.ARMGet(context.Background(), "my-array", 0, 1, 5).Result()    if err != nil {        panic(err)    }    fmt.Println(result)}

jedis

import java.net.URI;import redis.clients.jedis.Jedis;try (Jedis jedis = new Jedis(new URI(System.getenv("REDIS_URL")))) {  Object result = jedis.armget("my-array", 0, 1, 5);  System.out.println(result);}

redis-rs

fn main() -> redis::RedisResult<()> {    let url = std::env::var("REDIS_URL").expect("REDIS_URL is not set");    let client = redis::Client::open(url)?;    let mut connection = client.get_connection()?;    let mut command = redis::cmd("ARMGET");    command.arg("my-array");    command.arg("0");    command.arg("1");    command.arg("5");    let result: redis::Value = command.query(&mut connection)?;    println!("{result:?}");    Ok(())}