Download documentation

Choose the products and versions you want. Everything arrives as one .tar.gz, with a directory per product.

Format

This page

	Products	Version
	Develop with Redis Clients, data types, programmability, and Redis for AI. RedisVL is listed separately.
	Libraries and tools Client libraries, observability, and cloud integrations. Redis Data Integration is listed separately.
	RedisVL
	Redis Software
	Redis Cloud
	Redis for Kubernetes
	Redis Open Source
	Redis Iris context engine
	Redis Feature Form
	Redis Insight
	Redis Data Integration
	Glossary
	Command reference

ARSEEK

Array is a new data type that is currently in preview and may be subject to change.

Syntax text Syntax diagram API methods

ARSEEK key index

Client:

arseek(
    name: KeyT,
    index: int
) → int

arSeek(
    key: RedisArgument,
    index: number | string
) → NumberReply

arseek(
    key: K,  // the key of the array.
    index: long  // the index to seek to.
) → Long  // 1 if the key exists, 0 if it does not.

arseek(
    key: K,  // the key of the array.
    index: long  // the index to seek to.
) → RedisFuture<Long>  // 1 if the key exists, 0 if it does not.

arseek(
    key: K,  // the key of the array.
    index: long  // the index to seek to.
) → Mono<Long>  // 1 if the key exists, 0 if it does not.

ARSeek(
    ctx: context.Context,  // Context
    key: string,
    index: uint64
) → *IntCmd

arseek(
    $key: string,
    $index: int
) → int

Available since:: Redis Open Source 8.8.0
Time complexity:: O(1)
ACL categories:: @write, @array, @fast,
Compatibility:: Redis Software and Redis Cloud compatibility

Sets the ARINSERT / ARRING cursor to a specific index.

Required arguments

key

The name of the key that holds the array.

index

The zero-based integer index to set as the new insert cursor position for subsequent ARINSERT calls.

Examples

redis> ARINSERT myarray "a"
(integer) 0
redis> ARINSERT myarray "b"
(integer) 1
redis> ARNEXT myarray
(integer) 2
redis> ARSEEK myarray 10
(integer) 1
redis> ARINSERT myarray "c"
(integer) 10
redis> ARNEXT myarray
(integer) 11

Redis Software and Redis Cloud compatibility

Redis Software	Redis Cloud	Notes
❌ Standard ❌ Active-Active	❌ Standard ❌ Active-Active

Return information

RESP2 RESP3

Integer reply: 1 if the cursor was set, 0 if the key does not exist.