ARGET - Upstash Documentation

Use ARGET to read the value stored at a single array index.

The reply is null when the slot is empty and when the key does not exist at all, so a missing array and a hole inside an existing one look the same. Use ARCOUNT or EXISTS when the difference matters. To read many slots at once, ARMGET takes a list of indexes and ARGETRANGE takes a range.

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

Syntax#

ARGET <key> <index>

Arguments#

Argument	Required	Repeatable	Description
`<key>`	Yes	No	Array key targeted by the command.
`<index>`	Yes	No	Zero-based index to read. Must be between `0` and `18446744073709551614`.

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	Bulk string or Null bulk string or null array
RESP3	Bulk string or Null

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

ARGET my-array 0

@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.arget("my-array", 0);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.arGet("my-array", 0);console.log(result);

redis-py

import osimport redisclient = redis.from_url(os.environ["REDIS_URL"])result = client.arget("my-array", 0)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.ARGet(context.Background(), "my-array", 0).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.arget("my-array", 0);  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("ARGET");    command.arg("my-array");    command.arg("0");    let result: redis::Value = command.query(&mut connection)?;    println!("{result:?}");    Ok(())}