ArrayCommands (Jedis 8.0.0-beta1 API)

All Known Subinterfaces:

JedisCommands

All Known Implementing Classes:

Jedis, JedisCluster, MultiDbClient, RedisClient, RedisClusterClient, RedisSentinelClient, UnifiedJedis
```
public interface ArrayCommands
```
Commands for the Redis array data type.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`long`	`arcount(java.lang.String key)` ARCOUNT Command Returns the number of non-empty elements in an array.
`long`	`ardel(java.lang.String key, long... indices)` ARDEL Command Deletes elements at the specified indices in an array.
`long`	`ardel(java.lang.String key, long index)` ARDEL Command Deletes the element at a single index in an array.
`long`	`ardelrange(java.lang.String key, long start, long end)` ARDELRANGE Command Convenience single-range overload of `ardelrange(String, LongRange...)` that accepts the inclusive `[start, end]` range as primitives.
`long`	`ardelrange(java.lang.String key, LongRange... ranges)` ARDELRANGE Command Deletes elements in one or more inclusive `LongRange` ranges of indices.
`java.lang.String`	`arget(java.lang.String key, long index)` ARGET Command Returns the value stored at a single index in an array.
`java.util.List<java.lang.String>`	`argetrange(java.lang.String key, long start, long end)` ARGETRANGE Command Returns the values at a contiguous range of indices.
`java.util.List<java.lang.Long>`	`argrep(java.lang.String key, ArgrepParams params)` ARGREP Command Searches array elements within an inclusive index range (carried by `ArgrepParams`) using one or more textual predicates and returns the matching indices.
`java.util.List<KeyValue<java.lang.Long,java.lang.String>>`	`argrepWithValues(java.lang.String key, ArgrepParams params)` ARGREP Command Searches array elements within an inclusive index range (carried by `ArgrepParams`) and returns the matching index/value pairs.
`ArrayInfo`	`arinfo(java.lang.String key)` ARINFO Command Returns metadata describing an array (counts, length, insertion cursor).
`ArrayFullInfo`	`arinfoFull(java.lang.String key)` ARINFO Command Returns the `FULL` variant of the array metadata: the top-level fields plus the per-slice statistics block.
`long`	`arinsert(java.lang.String key, java.lang.String... values)` ARINSERT Command Inserts one or more values at consecutive indices, beginning at the current insert cursor position.
`long`	`arinsert(java.lang.String key, java.lang.String value)` ARINSERT Command Convenience single-value overload of `arinsert(String, String...)`.
`java.util.List<java.lang.String>`	`arlastitems(java.lang.String key, long count)` ARLASTITEMS Command Returns the most recently inserted elements in oldest-first order.
`java.util.List<java.lang.String>`	`arlastitems(java.lang.String key, long count, boolean rev)` ARLASTITEMS Command Returns the most recently inserted elements.
`long`	`arlen(java.lang.String key)` ARLEN Command Returns the length of an array (max index + 1).
`java.util.List<java.lang.String>`	`armget(java.lang.String key, long... indices)` ARMGET Command Returns the values at multiple indices.
`long`	`armset(java.lang.String key, java.util.Map<java.lang.Long,java.lang.String> indexValueMap)` ARMSET Command Sets multiple index-value pairs.
`java.lang.Long`	`arnext(java.lang.String key)` ARNEXT Command Returns the next index that `ARINSERT` would use.
`java.lang.String`	`aropAggregate(java.lang.String key, long start, long end, ArrayAggregate op)` AROP Command Applies a numeric aggregate (`SUM`, `MIN`, `MAX`) over the non-empty elements in the inclusive `[start, end]` range.
`long`	`aropBitwise(java.lang.String key, long start, long end, ArrayBitwise op)` AROP Command Applies a bitwise operation (`AND`, `OR`, `XOR`) over the non-empty elements in the inclusive `[start, end]` range.
`long`	`aropCount(java.lang.String key, long start, long end)` AROP Command Counts the number of non-empty elements in the inclusive `[start, end]` range using the `USED` subcommand.
`long`	`aropCount(java.lang.String key, long start, long end, java.lang.String match)` AROP Command Counts elements in the inclusive `[start, end]` range whose value equals `match` using the `MATCH` subcommand.
`long`	`arring(java.lang.String key, long size, java.lang.String... values)` ARRING Command Inserts one or more values into an array as a fixed-size ring buffer.
`long`	`arring(java.lang.String key, long size, java.lang.String value)` ARRING Command Convenience single-value overload of `arring(String, long, String...)`.
`java.util.List<KeyValue<java.lang.Long,java.lang.String>>`	`arscan(java.lang.String key, long start, long end)` ARSCAN Command Iterates existing elements in an inclusive index range and returns the index/value pairs in traversal order.
`java.util.List<KeyValue<java.lang.Long,java.lang.String>>`	`arscan(java.lang.String key, long start, long end, long limit)` ARSCAN Command Iterates existing elements in an inclusive index range with a cap on the number of pairs returned.
`long`	`arseek(java.lang.String key, long index)` ARSEEK Command Sets the insert cursor of an array to a specific index.
`long`	`arset(java.lang.String key, long index, java.lang.String... values)` ARSET Command Sets one or more contiguous values starting at `index`.
`long`	`arset(java.lang.String key, long index, java.lang.String value)` ARSET Command Convenience single-value overload of `arset(String, long, String...)`.

- Method Detail
  - arcount
```
@Experimental
long arcount(java.lang.String key)
```
    ARCOUNT Command Returns the number of non-empty elements in an array.
    Time complexity: O(1)
    Wire: ARCOUNT key
    
    Parameters:
    
    key - the name of the key that holds the array
    
    Returns:
    
    the number of non-empty elements, or 0 if key does not exist
    
    Since:
    
    8.0
  - ardel
```
@Experimental
long ardel(java.lang.String key,
                         long index)
```
    ARDEL Command Deletes the element at a single index in an array. If the index does not exist the array is unchanged.
    Time complexity: O(1)
    Wire: ARDEL key index
    
    Parameters:
    
    key - the name of the key that holds the array
    
    index - the zero-based index to delete
    
    Returns:
    
    1 if an element was deleted, 0 otherwise
    
    Since:
    
    8.0
  - ardel
```
@Experimental
long ardel(java.lang.String key,
                         long... indices)
```
    ARDEL Command Deletes elements at the specified indices in an array. Indices that do not exist count as zero elements deleted and leave the array unchanged.
    Time complexity: O(N) where N is the number of indices supplied.
    Wire: ARDEL key index1 [index2 ...]
    
    Parameters:
    
    key - the name of the key that holds the array
    
    indices - one or more zero-based indices to delete
    
    Returns:
    
    the number of elements actually deleted
    
    Since:
    
    8.0
  - ardelrange
```
@Experimental
long ardelrange(java.lang.String key,
                              LongRange... ranges)
```
    ARDELRANGE Command Deletes elements in one or more inclusive LongRange ranges of indices. Each range is processed in ascending order even if start > end; overlapping ranges count each element at most once.
    Time complexity: O(M + N) where M is the number of ranges and N the total number of elements they cover.
    Wire: ARDELRANGE key r1.start r1.end [r2.start r2.end ...]
    
    Parameters:
    
    key - the name of the key that holds the array
    
    ranges - one or more inclusive index ranges
    
    Returns:
    
    the number of elements deleted
    
    Since:
    
    8.0
  - ardelrange
```
@Experimental
long ardelrange(java.lang.String key,
                              long start,
                              long end)
```
    ARDELRANGE Command Convenience single-range overload of ardelrange(String, LongRange...) that accepts the inclusive [start, end] range as primitives.
    Wire: ARDELRANGE key start end
    
    Parameters:
    
    key - the name of the key that holds the array
    
    start - zero-based start index (inclusive)
    
    end - zero-based end index (inclusive)
    
    Returns:
    
    the number of elements deleted
    
    Since:
    
    8.0
  - arget
```
@Experimental
java.lang.String arget(java.lang.String key,
                                     long index)
```
    ARGET Command Returns the value stored at a single index in an array.
    Time complexity: O(1)
    Wire: ARGET key index
    
    Parameters:
    
    key - the name of the key that holds the array
    
    index - the zero-based index of the element to retrieve
    
    Returns:
    
    the value at the given index, or null if the key or index does not exist
    
    Since:
    
    8.0
  - argetrange
```
@Experimental
java.util.List<java.lang.String> argetrange(java.lang.String key,
                                                          long start,
                                                          long end)
```
    ARGETRANGE Command Returns the values at a contiguous range of indices. When start > end, elements are returned in reverse index order.
    Time complexity: O(N) where N is the number of elements in the range.
    Wire: ARGETRANGE key start end
    
    Parameters:
    
    key - the name of the key that holds the array
    
    start - zero-based start index of the range
    
    end - zero-based end index of the range (inclusive)
    
    Returns:
    
    the list of values in traversal order; empty slots appear as null entries
    
    Since:
    
    8.0
  - argrep
```
@Experimental
java.util.List<java.lang.Long> argrep(java.lang.String key,
                                                    ArgrepParams params)
```
    ARGREP Command Searches array elements within an inclusive index range (carried by ArgrepParams) using one or more textual predicates and returns the matching indices. Empty slots are skipped. Multiple predicates can be combined with AND/OR via ArgrepParams. Use argrepWithValues(String, ArgrepParams) to also return the matching values.
    Time complexity: O(N) where N is the number of elements scanned.
    Wire: ARGREP key start end <params>
    
    Parameters:
    
    key - the name of the key that holds the array
    
    params - the search range, predicates and options to apply
    
    Returns:
    
    the matching indices in traversal order; empty when no match
    
    Since:
    
    8.0
  - argrepWithValues
```
@Experimental
java.util.List<KeyValue<java.lang.Long,java.lang.String>> argrepWithValues(java.lang.String key,
                                                                                         ArgrepParams params)
```
    ARGREP Command Searches array elements within an inclusive index range (carried by ArgrepParams) and returns the matching index/value pairs. Empty slots are skipped. This overload appends the WITHVALUES keyword to the wire arguments; do not also request it on ArgrepParams.
    Time complexity: O(N) where N is the number of elements scanned.
    Wire: ARGREP key start end <params> WITHVALUES
    
    Parameters:
    
    key - the name of the key that holds the array
    
    params - the search range, predicates and options to apply
    
    Returns:
    
    the matching index/value pairs in traversal order; empty when no match
    
    Since:
    
    8.0
  - arinfo
```
@Experimental
ArrayInfo arinfo(java.lang.String key)
```
    ARINFO Command Returns metadata describing an array (counts, length, insertion cursor). Use arinfoFull(String) for the per-slice statistics.
    Time complexity: O(1)
    Wire: ARINFO key
    
    Parameters:
    
    key - the name of the key that holds the array
    
    Returns:
    
    a typed ArrayInfo, or null if the key does not exist
    
    Since:
    
    8.0
  - arinfoFull
```
@Experimental
ArrayFullInfo arinfoFull(java.lang.String key)
```
    ARINFO Command Returns the FULL variant of the array metadata: the top-level fields plus the per-slice statistics block.
    Time complexity: O(S) where S is the number of slices.
    Wire: ARINFO key FULL
    
    Parameters:
    
    key - the name of the key that holds the array
    
    Returns:
    
    a typed ArrayFullInfo, or null if the key does not exist
    
    Since:
    
    8.0
  - arinsert
```
@Experimental
long arinsert(java.lang.String key,
                            java.lang.String... values)
```
    ARINSERT Command Inserts one or more values at consecutive indices, beginning at the current insert cursor position. The cursor advances by one for each value inserted.
    Time complexity: O(N) where N is the number of values inserted.
    Wire: ARINSERT key value1 [value2 ...]
    
    Parameters:
    
    key - the name of the key that holds the array
    
    values - one or more values to insert
    
    Returns:
    
    the last index at which a value was inserted
    
    Since:
    
    8.0
  - arinsert
```
@Experimental
long arinsert(java.lang.String key,
                            java.lang.String value)
```
    ARINSERT Command Convenience single-value overload of arinsert(String, String...).
    Wire: ARINSERT key value
    
    Parameters:
    
    key - the name of the key that holds the array
    
    value - the value to insert at the current insert cursor
    
    Returns:
    
    the index at which the value was inserted
    
    Since:
    
    8.0
  - arlastitems
```
@Experimental
java.util.List<java.lang.String> arlastitems(java.lang.String key,
                                                           long count)
```
    ARLASTITEMS Command Returns the most recently inserted elements in oldest-first order.
    Time complexity: O(N) where N is the number of returned elements.
    Wire: ARLASTITEMS key count
    
    Parameters:
    
    key - the name of the key that holds the array
    
    count - the maximum number of elements to return
    
    Returns:
    
    the list of last-inserted values
    
    Since:
    
    8.0
  - arlastitems
```
@Experimental
java.util.List<java.lang.String> arlastitems(java.lang.String key,
                                                           long count,
                                                           boolean rev)
```
    ARLASTITEMS Command Returns the most recently inserted elements. When rev is true, elements are returned in reverse chronological order (most recent first) instead of the default oldest-first order.
    Time complexity: O(N) where N is the number of returned elements.
    Wire: ARLASTITEMS key count [REV] (REV is appended when rev is true).
    
    Parameters:
    
    key - the name of the key that holds the array
    
    count - the maximum number of elements to return
    
    rev - whether to request the REV variant
    
    Returns:
    
    the list of last-inserted values
    
    Since:
    
    8.0
  - arlen
```
@Experimental
long arlen(java.lang.String key)
```
    ARLEN Command Returns the length of an array (max index + 1).
    Time complexity: O(1)
    Wire: ARLEN key
    
    Parameters:
    
    key - the name of the key that holds the array
    
    Returns:
    
    the array length, or 0 if the key does not exist
    
    Since:
    
    8.0
  - armget
```
@Experimental
java.util.List<java.lang.String> armget(java.lang.String key,
                                                      long... indices)
```
    ARMGET Command Returns the values at multiple indices. The reply preserves the order of the requested indices and contains null for any index that is not set.
    Time complexity: O(N) where N is the number of requested indices.
    Wire: ARMGET key index1 [index2 ...]
    
    Parameters:
    
    key - the name of the key that holds the array
    
    indices - one or more zero-based indices to retrieve
    
    Returns:
    
    the list of values aligned with indices
    
    Since:
    
    8.0
  - armset
```
@Experimental
long armset(java.lang.String key,
                          java.util.Map<java.lang.Long,java.lang.String> indexValueMap)
```
    ARMSET Command Sets multiple index-value pairs. Pairs may be non-contiguous and in any order; the map's iteration order is used as the wire order.
    Time complexity: O(N) where N is the number of pairs.
    Wire: ARMSET key index1 value1 [index2 value2 ...]
    
    Parameters:
    
    key - the name of the key that holds the array
    
    indexValueMap - the index-to-value pairs to write
    
    Returns:
    
    the number of slots that were previously empty
    
    Since:
    
    8.0
  - arnext
```
@Experimental
java.lang.Long arnext(java.lang.String key)
```
    ARNEXT Command Returns the next index that ARINSERT would use.
    Time complexity: O(1)
    Wire: ARNEXT key
    
    Parameters:
    
    key - the name of the key that holds the array
    
    Returns:
    
    0L for a missing key or when no insert has happened yet; the next insert index when one is available; null when the insertion cursor is exhausted
    
    Since:
    
    8.0
  - aropBitwise
```
@Experimental
long aropBitwise(java.lang.String key,
                               long start,
                               long end,
                               ArrayBitwise op)
```
    AROP Command Applies a bitwise operation (AND, OR, XOR) over the non-empty elements in the inclusive [start, end] range.
    Time complexity: O(N) where N is the number of elements scanned.
    Wire: AROP key start end AND|OR|XOR
    
    Parameters:
    
    key - the name of the key that holds the array
    
    start - zero-based start index (inclusive)
    
    end - zero-based end index (inclusive)
    
    op - the bitwise operator to apply
    
    Returns:
    
    the operation's numeric result
    
    Since:
    
    8.0
  - aropAggregate
```
@Experimental
java.lang.String aropAggregate(java.lang.String key,
                                             long start,
                                             long end,
                                             ArrayAggregate op)
```
    AROP Command Applies a numeric aggregate (SUM, MIN, MAX) over the non-empty elements in the inclusive [start, end] range.
    Time complexity: O(N) where N is the number of elements scanned.
    Wire: AROP key start end SUM|MIN|MAX
    
    Parameters:
    
    key - the name of the key that holds the array
    
    start - zero-based start index (inclusive)
    
    end - zero-based end index (inclusive)
    
    op - the aggregate operator to apply
    
    Returns:
    
    the aggregate value, or null when the range is empty
    
    Since:
    
    8.0
  - aropCount
```
@Experimental
long aropCount(java.lang.String key,
                             long start,
                             long end)
```
    AROP Command Counts the number of non-empty elements in the inclusive [start, end] range using the USED subcommand.
    Time complexity: O(N) where N is the number of elements scanned.
    Wire: AROP key start end USED
    
    Parameters:
    
    key - the name of the key that holds the array
    
    start - zero-based start index (inclusive)
    
    end - zero-based end index (inclusive)
    
    Returns:
    
    the count of non-empty elements
    
    Since:
    
    8.0
  - aropCount
```
@Experimental
long aropCount(java.lang.String key,
                             long start,
                             long end,
                             java.lang.String match)
```
    AROP Command Counts elements in the inclusive [start, end] range whose value equals match using the MATCH subcommand.
    Time complexity: O(N) where N is the number of elements scanned.
    Wire: AROP key start end MATCH match
    
    Parameters:
    
    key - the name of the key that holds the array
    
    start - zero-based start index (inclusive)
    
    end - zero-based end index (inclusive)
    
    match - the value to match
    
    Returns:
    
    the count of matching elements
    
    Since:
    
    8.0
  - arring
```
@Experimental
long arring(java.lang.String key,
                          long size,
                          java.lang.String... values)
```
    ARRING Command Inserts one or more values into an array as a fixed-size ring buffer. Each value is placed at the next ring position and the cursor advances accordingly.
    Time complexity: O(N) where N is the number of values inserted.
    Wire: ARRING key size value1 [value2 ...]
    
    Parameters:
    
    key - the name of the key that holds the array
    
    size - the ring buffer window size
    
    values - one or more values to insert
    
    Returns:
    
    the last index at which a value was inserted
    
    Since:
    
    8.0
  - arring
```
@Experimental
long arring(java.lang.String key,
                          long size,
                          java.lang.String value)
```
    ARRING Command Convenience single-value overload of arring(String, long, String...).
    Wire: ARRING key size value
    
    Parameters:
    
    key - the name of the key that holds the array
    
    size - the ring buffer window size
    
    value - the value to insert
    
    Returns:
    
    the index at which the value was inserted
    
    Since:
    
    8.0
  - arscan
```
@Experimental
java.util.List<KeyValue<java.lang.Long,java.lang.String>> arscan(java.lang.String key,
                                                                               long start,
                                                                               long end)
```
    ARSCAN Command Iterates existing elements in an inclusive index range and returns the index/value pairs in traversal order. Empty slots are excluded.
    Time complexity: O(N) where N is the number of populated elements.
    Wire: ARSCAN key start end
    
    Parameters:
    
    key - the name of the key that holds the array
    
    start - zero-based start index; when start > end the iteration is reversed
    
    end - zero-based end index (inclusive)
    
    Returns:
    
    the populated (index, value) pairs; empty when the key does not exist
    
    Since:
    
    8.0
  - arscan
```
@Experimental
java.util.List<KeyValue<java.lang.Long,java.lang.String>> arscan(java.lang.String key,
                                                                               long start,
                                                                               long end,
                                                                               long limit)
```
    ARSCAN Command Iterates existing elements in an inclusive index range with a cap on the number of pairs returned. Empty slots are excluded.
    Time complexity: O(N) where N is the number of populated elements returned.
    Wire: ARSCAN key start end LIMIT limit
    
    Parameters:
    
    key - the name of the key that holds the array
    
    start - zero-based start index; when start > end the iteration is reversed
    
    end - zero-based end index (inclusive)
    
    limit - cap on the number of returned populated elements
    
    Returns:
    
    the populated (index, value) pairs
    
    Since:
    
    8.0
  - arseek
```
@Experimental
long arseek(java.lang.String key,
                          long index)
```
    ARSEEK Command Sets the insert cursor of an array to a specific index.
    Time complexity: O(1)
    Wire: ARSEEK key index
    
    Parameters:
    
    key - the name of the key that holds the array
    
    index - the zero-based index to set as the new insert cursor
    
    Returns:
    
    1 if the cursor was set, 0 if the key does not exist
    
    Since:
    
    8.0
  - arset
```
@Experimental
long arset(java.lang.String key,
                         long index,
                         java.lang.String... values)
```
    ARSET Command Sets one or more contiguous values starting at index. When multiple values are provided, they are stored at consecutive indices.
    Time complexity: O(N) where N is the number of values written.
    Wire: ARSET key index value1 [value2 ...]
    
    Parameters:
    
    key - the name of the key that holds the array
    
    index - zero-based starting index
    
    values - one or more values to write at consecutive indices
    
    Returns:
    
    the number of slots that were previously empty
    
    Since:
    
    8.0
  - arset
```
@Experimental
long arset(java.lang.String key,
                         long index,
                         java.lang.String value)
```
    ARSET Command Convenience single-value overload of arset(String, long, String...).
    Wire: ARSET key index value
    
    Parameters:
    
    key - the name of the key that holds the array
    
    index - zero-based index at which to store the value
    
    value - the value to write
    
    Returns:
    
    the number of slots that were previously empty (0 or 1)
    
    Since:
    
    8.0

Interface ArrayCommands

Method Summary

Method Detail

arcount

ardel

ardel

ardelrange

ardelrange

arget

argetrange

argrep

argrepWithValues

arinfo

arinfoFull

arinsert

arinsert

arlastitems

arlastitems

arlen

armget

armset

arnext

aropBitwise

aropAggregate

aropCount

aropCount

arring

arring

arscan

arscan

arseek

arset

arset