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

ARINFO

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

Syntax text Syntax diagram API methods

ARINFO key [FULL]

Client:

arinfo(
    name: KeyT,
    full: bool
) → dict

arInfo(
    key: RedisArgument,
    options: ArInfoOptions
) → ArInfoReply

arinfo(
    key: K  // the key of the array.
) → ArrayInfo  // the array metadata, or null if the key does not exist.

arinfoFull(
    key: K  // the key of the array.
) → ArrayInfoFull  // the extended array metadata, or null if the key does not exist.

arinfo(
    key: K  // the key of the array.
) → RedisFuture<ArrayInfo>  // the array metadata, or null if the key does not exist.

arinfoFull(
    key: K  // the key of the array.
) → RedisFuture<ArrayInfoFull>  // the extended array metadata, or null if the key does not exist.

arinfo(
    key: K  // the key of the array.
) → Mono<ArrayInfo>  // the array metadata, or null if the key does not exist.

arinfoFull(
    key: K  // the key of the array.
) → Mono<ArrayInfoFull>  // the extended array metadata, or null if the key does not exist.

ARInfo(
    ctx: context.Context,  // Context
    key: string
) → *MapStringInterfaceCmd

ARInfoFull(
    ctx: context.Context,  // Context
    key: string
) → *MapStringInterfaceCmd

arinfo(
    $key: string,
    $full: bool
) → array

Available since:: Redis Open Source 8.8.0
Time complexity:: O(1), or O(N) with FULL option where N is the number of slices.
ACL categories:: @read, @array, @slow,
Compatibility:: Redis Software and Redis Cloud compatibility

Returns metadata about an array.

Required arguments

key

The name of the key that holds the array.

Optional arguments

FULL

When present, includes per-slice statistics in the reply: the number of dense and sparse slices and their average sizes and fill rates. Raises the complexity from O(1) to O(N) where N is the number of slices.

Examples

redis> ARMSET myarray 0 "a" 1 "b" 100 "c"
(integer) 3
redis> ARINSERT myarray "d"
(integer) 0
redis> ARINFO myarray
 1) "count"
 2) (integer) 3
 3) "len"
 4) (integer) 101
 5) "next-insert-index"
 6) (integer) 1
 7) "slices"
 8) (integer) 1
 9) "directory-size"
10) (integer) 1
11) "super-dir-entries"
12) (integer) 0
13) "slice-size"
14) (integer) 4096

Redis Software and Redis Cloud compatibility

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

Return information

RESP2 RESP3

Array reply