io.lettuce.core.api.async

Interface RedisArrayAsyncCommands<K,V>

Type Parameters:

K - Key type.

V - Value type.

All Known Subinterfaces:

RedisAdvancedClusterAsyncCommands<K,V>, RedisAsyncCommands<K,V>, RedisClusterAsyncCommands<K,V>, RedisClusterPubSubAsyncCommands<K,V>, RedisPubSubAsyncCommands<K,V>

All Known Implementing Classes:

AbstractRedisAsyncCommands, RedisAdvancedClusterAsyncCommandsImpl, RedisAsyncCommandsImpl, RedisClusterPubSubAsyncCommandsImpl, RedisPubSubAsyncCommandsImpl

public interface RedisArrayAsyncCommands<K,V>

Asynchronous executed commands for the Redis Array data type.

Arrays are a Redis data type for sparse, indexed collections that support efficient element access, range operations, pattern matching, and aggregation.

Since:

7.6

Author:

Aleksandar Todorov

See Also:

Redis Arrays

Method Summary

Modifier and Type	Method and Description
RedisFuture<Long>	arcount(K key) Get the count of populated (non-empty) slots in the array.
RedisFuture<Long>	ardel(K key, long... indices) Delete elements at the given indices.
RedisFuture<Long>	ardel(K key, long index) Delete a single element at the given index.
RedisFuture<Long>	ardelrange(K key, ArrayIndexRange... ranges) Delete elements in the given ranges.
RedisFuture<Long>	ardelrange(K key, long start, long end) Delete elements in the given range (inclusive).
RedisFuture<V>	arget(K key, long index) Get the value at the given index in the array stored at key.
RedisFuture<List<V>>	argetrange(K key, long start, long end) Get all values in a range, including null for empty slots.
RedisFuture<List<Long>>	argrep(K key, ArGrepArgs grepArgs) Search for elements matching predicates, returning matching indices.
RedisFuture<List<IndexedValue<V>>>	argrepWithValues(K key, ArGrepArgs grepArgs) Search for elements matching predicates, returning index/value pairs.
RedisFuture<ArrayInfo>	arinfo(K key) Get metadata about the array.
RedisFuture<ArrayInfoFull>	arinfoFull(K key) Get extended metadata about the array (including per-slice stats).
RedisFuture<Long>	arinsert(K key, V... values) Insert one or more values at the next available index.
RedisFuture<Long>	arinsert(K key, V value) Insert a single value at the next available index.
RedisFuture<List<V>>	arlastitems(K key, long count) Get the last N items in insertion order.
RedisFuture<List<V>>	arlastitems(K key, long count, boolean rev) Get the last N items, optionally in reverse order.
RedisFuture<Long>	arlen(K key) Get the logical length of the array (max index + 1).
RedisFuture<List<V>>	armget(K key, long... indices) Get the values at multiple indices in the array stored at key.
RedisFuture<Long>	armset(K key, Map<Long,V> indexValueMap) Set multiple index-value pairs in the array stored at key.
RedisFuture<Long>	arnext(K key) Get the next insert index for the array.
RedisFuture<V>	aropAggregate(K key, long start, long end, ArAggregateType operation) Perform an aggregate operation (SUM, MIN, MAX) over elements in a range.
RedisFuture<Long>	aropBitwise(K key, long start, long end, ArBitwiseType operation) Perform a bitwise operation (AND, OR, XOR) over elements in a range.
RedisFuture<Long>	aropCount(K key, long start, long end) Count the number of non-empty (populated) elements in a range (AROP USED).
RedisFuture<Long>	aropCount(K key, long start, long end, V matchValue) Count occurrences of a value in a range (AROP MATCH).
RedisFuture<Long>	arring(K key, long size, V... values) Insert values in a ring buffer fashion, wrapping around when the size is exceeded.
RedisFuture<Long>	arring(K key, long size, V value) Insert a single value in a ring buffer fashion, wrapping around when the size is exceeded.
RedisFuture<List<IndexedValue<V>>>	arscan(K key, long start, long end) Scan populated entries in a range, returning index/value pairs.
RedisFuture<List<IndexedValue<V>>>	arscan(K key, long start, long end, long limit) Scan populated entries in a range with a limit, returning index/value pairs.
RedisFuture<Long>	arseek(K key, long index) Set the insert cursor to a specific index.
RedisFuture<Long>	arset(K key, long index, V... values) Set one or more contiguous values starting at the given index in the array stored at key.
RedisFuture<Long>	arset(K key, long index, V value) Set a value at the given index in the array stored at key.

Method Detail

arset

@Experimental
RedisFuture<Long> arset(K key,
                                      long index,
                                      V value)

Set a value at the given index in the array stored at key.

Parameters:

key - the key of the array.

index - the index to set.

value - the value to store.

Returns:

the number of new slots created (1 if new, 0 if updated).

Since:

7.6

See Also:

Redis Documentation: ARSET

arset

@Experimental
RedisFuture<Long> arset(K key,
                                      long index,
                                      V... values)

Set one or more contiguous values starting at the given index in the array stored at key.

Parameters:

key - the key of the array.

index - the starting index.

values - the values to store at consecutive indices.

Returns:

the number of new slots created.

Since:

7.6

See Also:

Redis Documentation: ARSET

armset

@Experimental
RedisFuture<Long> armset(K key,
                                       Map<Long,V> indexValueMap)

Set multiple index-value pairs in the array stored at key.

Parameters:

key - the key of the array.

indexValueMap - map of index to value pairs.

Returns:

the number of new slots created.

Since:

7.6

See Also:

Redis Documentation: ARMSET

arget

@Experimental
RedisFuture<V> arget(K key,
                                   long index)

Get the value at the given index in the array stored at key.

Parameters:

key - the key of the array.

index - the index to get.

Returns:

the value at the index, or null if the index is empty or the key does not exist.

Since:

7.6

See Also:

Redis Documentation: ARGET

armget

@Experimental
RedisFuture<List<V>> armget(K key,
                                          long... indices)

Get the values at multiple indices in the array stored at key.

Parameters:

key - the key of the array.

indices - the indices to get.

Returns:

a list of values (with null for empty slots).

Since:

7.6

See Also:

Redis Documentation: ARMGET

ardel

@Experimental
RedisFuture<Long> ardel(K key,
                                      long index)

Delete a single element at the given index. Returns 1 if the element existed, 0 otherwise.

This single-index overload provides boolean-like semantics ("was this element there?"), distinct from the multi-index varargs form which returns a count.

Parameters:

key - the key of the array.

index - the index to delete.

Returns:

1 if the element was deleted, 0 if it was not found.

Since:

7.6

See Also:

Redis Documentation: ARDEL

ardel

@Experimental
RedisFuture<Long> ardel(K key,
                                      long... indices)

Delete elements at the given indices. Returns the count of elements actually deleted.

Parameters:

key - the key of the array.

indices - the indices to delete.

Returns:

the number of elements deleted.

Since:

7.6

See Also:

Redis Documentation: ARDEL

ardelrange

@Experimental
RedisFuture<Long> ardelrange(K key,
                                           long start,
                                           long end)

Delete elements in the given range (inclusive).

Parameters:

key - the key of the array.

start - the start index (inclusive).

end - the end index (inclusive).

Returns:

the number of elements deleted.

Since:

7.6

See Also:

Redis Documentation: ARDELRANGE

ardelrange

@Experimental
RedisFuture<Long> ardelrange(K key,
                                           ArrayIndexRange... ranges)

Delete elements in the given ranges. Each range is a start/end pair (inclusive).

Parameters:

key - the key of the array.

ranges - one or more ranges to delete.

Returns:

the number of elements deleted.

Since:

7.6

See Also:

Redis Documentation: ARDELRANGE

arlen

@Experimental
RedisFuture<Long> arlen(K key)

Get the logical length of the array (max index + 1).

Parameters:

key - the key of the array.

Returns:

the logical length, or 0 if the key does not exist.

Since:

7.6

See Also:

Redis Documentation: ARLEN

arcount

@Experimental
RedisFuture<Long> arcount(K key)

Get the count of populated (non-empty) slots in the array.

Parameters:

key - the key of the array.

Returns:

the count of populated slots, or 0 if the key does not exist.

Since:

7.6

See Also:

Redis Documentation: ARCOUNT

argetrange

@Experimental
RedisFuture<List<V>> argetrange(K key,
                                              long start,
                                              long end)

Get all values in a range, including null for empty slots.

The range must not exceed 1,000,000 items.

Parameters:

key - the key of the array.

start - the start index (inclusive).

end - the end index (inclusive).

Returns:

a list of values (with null for empty slots).

Since:

7.6

See Also:

Redis Documentation: ARGETRANGE

arnext

@Experimental
RedisFuture<Long> arnext(K key)

Get the next insert index for the array.

Parameters:

key - the key of the array.

Returns:

the next insert index, or 0 if the key does not exist, or null if the cursor is exhausted.

Since:

7.6

See Also:

Redis Documentation: ARNEXT

arlastitems

@Experimental
RedisFuture<List<V>> arlastitems(K key,
                                               long count)

Get the last N items in insertion order.

Parameters:

key - the key of the array.

count - the number of items to return.

Returns:

a list of values in insertion order.

Since:

7.6

See Also:

Redis Documentation: ARLASTITEMS

arlastitems

@Experimental
RedisFuture<List<V>> arlastitems(K key,
                                               long count,
                                               boolean rev)

Get the last N items, optionally in reverse order.

Parameters:

key - the key of the array.

count - the number of items to return.

rev - true to return items in reverse insertion order, false for insertion order.

Returns:

a list of values.

Since:

7.6

See Also:

Redis Documentation: ARLASTITEMS

arscan

@Experimental
RedisFuture<List<IndexedValue<V>>> arscan(K key,
                                                        long start,
                                                        long end)

Scan populated entries in a range, returning index/value pairs.

Parameters:

key - the key of the array.

start - the start index (inclusive).

end - the end index (inclusive).

Returns:

a list of IndexedValue pairs.

Since:

7.6

See Also:

Redis Documentation: ARSCAN

arscan

@Experimental
RedisFuture<List<IndexedValue<V>>> arscan(K key,
                                                        long start,
                                                        long end,
                                                        long limit)

Scan populated entries in a range with a limit, returning index/value pairs.

Parameters:

key - the key of the array.

start - the start index (inclusive).

end - the end index (inclusive).

limit - the maximum number of entries to return.

Returns:

a list of IndexedValue pairs.

Since:

7.6

See Also:

Redis Documentation: ARSCAN

argrep

@Experimental
RedisFuture<List<Long>> argrep(K key,
                                             ArGrepArgs grepArgs)

Search for elements matching predicates, returning matching indices.

Parameters:

key - the key of the array.

grepArgs - the grep arguments (range, predicates, flags).

Returns:

a list of matching indices.

Since:

7.6

See Also:

Redis Documentation: ARGREP

argrepWithValues

@Experimental
RedisFuture<List<IndexedValue<V>>> argrepWithValues(K key,
                                                                  ArGrepArgs grepArgs)

Search for elements matching predicates, returning index/value pairs. WITHVALUES is automatically applied.

Parameters:

key - the key of the array.

grepArgs - the grep arguments (range, predicates, flags).

Returns:

a list of matching IndexedValue pairs.

Since:

7.6

See Also:

Redis Documentation: ARGREP

aropAggregate

@Experimental
RedisFuture<V> aropAggregate(K key,
                                           long start,
                                           long end,
                                           ArAggregateType operation)

Perform an aggregate operation (SUM, MIN, MAX) over elements in a range.

Parameters:

key - the key of the array.

start - the start index (inclusive).

end - the end index (inclusive).

operation - the aggregate operation.

Returns:

the result as a value, or null if the range is empty or values are non-numeric.

Since:

7.6

See Also:

Redis Documentation: AROP

aropBitwise

@Experimental
RedisFuture<Long> aropBitwise(K key,
                                            long start,
                                            long end,
                                            ArBitwiseType operation)

Perform a bitwise operation (AND, OR, XOR) over elements in a range.

Parameters:

key - the key of the array.

start - the start index (inclusive).

end - the end index (inclusive).

operation - the bitwise operation.

Returns:

the result as a long.

Since:

7.6

See Also:

Redis Documentation: AROP

aropCount

@Experimental
RedisFuture<Long> aropCount(K key,
                                          long start,
                                          long end)

Count the number of non-empty (populated) elements in a range (AROP USED).

Parameters:

key - the key of the array.

start - the start index (inclusive).

end - the end index (inclusive).

Returns:

the count of non-empty elements.

Since:

7.6

See Also:

Redis Documentation: AROP

aropCount

@Experimental
RedisFuture<Long> aropCount(K key,
                                          long start,
                                          long end,
                                          V matchValue)

Count occurrences of a value in a range (AROP MATCH).

Parameters:

key - the key of the array.

start - the start index (inclusive).

end - the end index (inclusive).

matchValue - the value to match.

Returns:

the count of matching elements.

Since:

7.6

See Also:

Redis Documentation: AROP

arinsert

@Experimental
RedisFuture<Long> arinsert(K key,
                                         V value)

Insert a single value at the next available index.

Parameters:

key - the key of the array.

value - the value to insert.

Returns:

the index used.

Since:

7.6

See Also:

Redis Documentation: ARINSERT

arinsert

@Experimental
RedisFuture<Long> arinsert(K key,
                                         V... values)

Insert one or more values at the next available index.

Parameters:

key - the key of the array.

values - the values to insert.

Returns:

the last index used.

Since:

7.6

See Also:

Redis Documentation: ARINSERT

arring

@Experimental
RedisFuture<Long> arring(K key,
                                       long size,
                                       V value)

Insert a single value in a ring buffer fashion, wrapping around when the size is exceeded.

Parameters:

key - the key of the array.

size - the ring buffer size.

value - the value to insert.

Returns:

the index used.

Since:

7.6

See Also:

Redis Documentation: ARRING

arring

@Experimental
RedisFuture<Long> arring(K key,
                                       long size,
                                       V... values)

Insert values in a ring buffer fashion, wrapping around when the size is exceeded.

Parameters:

key - the key of the array.

size - the ring buffer size.

values - the values to insert.

Returns:

the last index used.

Since:

7.6

See Also:

Redis Documentation: ARRING

arseek

@Experimental
RedisFuture<Long> arseek(K key,
                                       long index)

Set the insert cursor to a specific index.

Parameters:

key - the key of the array.

index - the index to seek to.

Returns:

1 if the key exists, 0 if it does not.

Since:

7.6

See Also:

Redis Documentation: ARSEEK

arinfo

@Experimental
RedisFuture<ArrayInfo> arinfo(K key)

Get metadata about the array. Known fields are available via typed getters; the raw server map is accessible via ArrayInfo.getInfo();

Parameters:

key - the key of the array.

Returns:

the array metadata, or null if the key does not exist.

Since:

7.6

See Also:

Redis Documentation: ARINFO

arinfoFull

@Experimental
RedisFuture<ArrayInfoFull> arinfoFull(K key)

Get extended metadata about the array (including per-slice stats). Known fields are available via typed getters; the raw server map is accessible via ArrayInfo.getInfo();

Parameters:

key - the key of the array.

Returns:

the extended array metadata, or null if the key does not exist.

Since:

7.6

See Also:

Redis Documentation: ARINFO