LINDEX - Upstash Documentation

Use LINDEX to read the element at a given position in a list.

Indexes are zero-based from the head, and negative indexes count from the tail, so -1 is the last element. The reply is null when the key does not exist or the index is out of range. Redis walks the list from the nearer end to reach the index, so access is fast near the head and tail and gets more expensive towards the middle of a long list.

Syntax#

LINDEX <key> <index>

Arguments#

Argument	Required	Repeatable	Description
`<key>`	Yes	No	Redis key targeted by the command.
`<index>`	Yes	No	Zero-based index; negative values count from the end.

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

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

LINDEX my-key 0

@upstash/redis

import { Redis } from "@upstash/redis";const redis = Redis.fromEnv();await redis.rpush("key", "a", "b", "c");const element = await redis.lindex("key", 0);console.log(element); // "a"

upstash_redis

from upstash_redis import Redisredis = Redis.from_env()result = redis.lindex("my-key", 0)print(result)

ioredis

import Redis from "ioredis";const redis = new Redis(process.env.REDIS_URL!);const result = await redis.lindex("my-key", "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.lIndex("my-key", 0);console.log(result);

redis-py

import osimport redisclient = redis.from_url(os.environ["REDIS_URL"])result = client.lindex("my-key", 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.LIndex(context.Background(), "my-key", 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.lindex("my-key", 0);  System.out.println(result);}

redis-rs

use redis::TypedCommands;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 result = connection.lindex("my-key", 0)?;    println!("{result:?}");    Ok(())}