ZMPOP and LMPOP

src/StackExchange.Redis/Enums/RedisCommand.cs

@@ -85,6 +85,7 @@ internal enum RedisCommand
  LINSERT,
  LLEN,
  LMOVE,
+ LMPOP,
  LPOP,
  LPOS,
  LPUSH,
@@ -208,6 +209,7 @@ internal enum RedisCommand
  ZMSCORE,
  ZPOPMAX,
  ZPOPMIN,
+ ZMPOP,
  ZRANDMEMBER,
  ZRANGE,
  ZRANGEBYLEX,

src/StackExchange.Redis/Interfaces/IDatabase.cs

@@ -768,6 +768,19 @@ public interface IDatabase : IRedis, IDatabaseAsync
  /// <remarks>https://redis.io/commands/lpop</remarks>
  RedisValue[] ListLeftPop(RedisKey key, long count, CommandFlags flags = CommandFlags.None);
 
+ /// <summary>
+ /// Removes and returns at most specified <paramref name="count"/> of elements from the first non-empty list
+ /// within the set of <paramref name="keys"/> passed into it. Starts on the left side of the list.
+ /// If the Length of the first non-empty list is less than the the <paramref name="count"/> only the elements within that
+ /// list are returned.
+ /// </summary>
+ /// <param name="keys">The keys to look through for popable elements.</param>
+ /// <param name="count">The maximum number of eelemnts to pop out of the list</param>
+ /// <param name="flags"></param>
+ /// <remarks>https://redis.io/commands/lmpop</remarks>
+ /// <returns>A span of contiguous elements from the list. Null if no non-empty lists are encountered</returns>
+ ListSpan? ListLeftPop(RedisKey[] keys, long count, CommandFlags flags = CommandFlags.None);
+
  /// <summary>
  /// Scans through the list stored at <paramref name="key"/> looking for <paramref name="element"/>, returning the 0-based
  /// index of the first matching element.
@@ -905,6 +918,19 @@ public interface IDatabase : IRedis, IDatabaseAsync
  /// <remarks>https://redis.io/commands/rpop</remarks>
  RedisValue[] ListRightPop(RedisKey key, long count, CommandFlags flags = CommandFlags.None);
 
+ /// <summary>
+ /// Removes and returns at most specified <paramref name="count"/> of elements from the first non-empty list
+ /// within the set of <paramref name="keys"/> passed into it. Starts on the right side of the list.
+ /// If the Length of the first non-empty list is less than the the <paramref name="count"/> only the elements within that
+ /// list are returned.
+ /// </summary>
+ /// <param name="keys">The keys to look through for popable elements.</param>
+ /// <param name="count">The maximum number of eelemnts to pop out of the list</param>
+ /// <param name="flags"></param>
+ /// <remarks>https://redis.io/commands/lmpop</remarks>
+ /// <returns>A span of contiguous elements from the list.</returns>
+ ListSpan? ListRightPop(RedisKey[] keys, long count, CommandFlags flags = CommandFlags.None);
+
  /// <summary>
  /// Atomically returns and removes the last element (tail) of the list stored at source, and pushes the element at the first element (head) of the list stored at destination.
  /// </summary>
@@ -1913,6 +1939,18 @@ IEnumerable<SortedSetEntry> SortedSetScan(RedisKey key,
  /// <remarks>https://redis.io/commands/zpopmax</remarks>
  SortedSetEntry[] SortedSetPop(RedisKey key, long count, Order order = Order.Ascending, CommandFlags flags = CommandFlags.None);
 
+ /// <summary>
+ /// Removes and returns up to the the specified <paramref name="count"/> of entries from the first non-empty sorted set specified by <paramref name="keys"/>
+ /// returns <see langword="null"/> if none of the specified <paramref name="keys"/> contain any elements.
+ /// </summary>
+ /// <param name="keys">The keys to check.</param>
+ /// <param name="count">The maximum number of records to pop out of the sorted set.</param>
+ /// <param name="order">The order to sort by when popping items out of the set.</param>
+ /// <param name="flags">The flags to use for the operation.</param>
+ /// <returns>A contiguous portion of sorted set entry with the key they were popped from.</returns>
+ /// <remarks>https://redis.io/commands/zmpop</remarks>
+ SortedSetSpan? SortedSetPop(RedisKey[] keys, long count, Order order = Order.Ascending, CommandFlags flags = CommandFlags.None);
+
  /// <summary>
  /// Allow the consumer to mark a pending message as correctly processed. Returns the number of messages acknowledged.
  /// </summary>

src/StackExchange.Redis/Interfaces/IDatabaseAsync.cs

@@ -744,6 +744,19 @@ public interface IDatabaseAsync : IRedisAsync
  /// <remarks>https://redis.io/commands/lpop</remarks>
  Task<RedisValue[]> ListLeftPopAsync(RedisKey key, long count, CommandFlags flags = CommandFlags.None);
 
+ /// <summary>
+ /// Removes and returns at most specified <paramref name="count"/> of elements from the first non-empty list
+ /// within the set of <paramref name="keys"/> passed into it. Starts on the left side of the list.
+ /// If the Length of the first non-empty list is less than the the <paramref name="count"/> only the elements within that
+ /// list are returned.
+ /// </summary>
+ /// <param name="keys">The keys to look through for popable elements.</param>
+ /// <param name="count">The maximum number of eelemnts to pop out of the list</param>
+ /// <param name="flags"></param>
+ /// <remarks>https://redis.io/commands/lmpop</remarks>
+ /// <returns>A span of contiguous elements from the list.</returns>
+ Task<ListSpan?> ListLeftPopAsync(RedisKey[] keys, long count, CommandFlags flags = CommandFlags.None);
+
  /// <summary>
  /// Scans through the list stored at <paramref name="key"/> looking for <paramref name="element"/>, returning the 0-based
  /// index of the first matching element.
@@ -881,6 +894,19 @@ public interface IDatabaseAsync : IRedisAsync
  /// <remarks>https://redis.io/commands/rpop</remarks>
  Task<RedisValue[]> ListRightPopAsync(RedisKey key, long count, CommandFlags flags = CommandFlags.None);
 
+ /// <summary>
+ /// Removes and returns at most specified <paramref name="count"/> of elements from the first non-empty list
+ /// within the set of <paramref name="keys"/> passed into it. Starts on the right side of the list.
+ /// If the Length of the first non-empty list is less than the the <paramref name="count"/> only the elements within that
+ /// list are returned.
+ /// </summary>
+ /// <param name="keys">The keys to look through for popable elements.</param>
+ /// <param name="count">The maximum number of eelemnts to pop out of the list</param>
+ /// <param name="flags"></param>
+ /// <remarks>https://redis.io/commands/lmpop</remarks>
+ /// <returns>A span of contiguous elements from the list. Null if no non-empty lists are encountered.</returns>
+ Task<ListSpan?> ListRightPopAsync(RedisKey[] keys, long count, CommandFlags flags = CommandFlags.None);
+
  /// <summary>
  /// Atomically returns and removes the last element (tail) of the list stored at source, and pushes the element at the first element (head) of the list stored at destination.
  /// </summary>
@@ -1865,6 +1891,18 @@ IAsyncEnumerable<SortedSetEntry> SortedSetScanAsync(RedisKey key,
  /// <remarks>https://redis.io/commands/zpopmax</remarks>
  Task<SortedSetEntry[]> SortedSetPopAsync(RedisKey key, long count, Order order = Order.Ascending, CommandFlags flags = CommandFlags.None);
 
+ /// <summary>
+ /// Removes and returns up to the the specified <paramref name="count"/> of entries from the first non-empty sorted set specified by <paramref name="keys"/>
+ /// returns <see langword="null"/> if none of the specified <paramref name="keys"/> contain any elements.
+ /// </summary>
+ /// <param name="keys">The keys to check.</param>
+ /// /// <param name="count">The maximum number of records to pop out of the sorted set.</param>
+ /// <param name="order">The order to sort by when popping items out of the set.</param>
+ /// <param name="flags">The flags to use for the operation.</param>
+ /// <returns>A contiguous portion of sorted set entry with the key they were popped from.</returns>
+ /// <remarks>https://redis.io/commands/zmpop</remarks>
+ Task<SortedSetSpan?> SortedSetPopAsync(RedisKey[] keys, long count, Order order = Order.Ascending, CommandFlags flags = CommandFlags.None);
+
  /// <summary>
  /// Allow the consumer to mark a pending message as correctly processed. Returns the number of messages acknowledged.
  /// </summary>

src/StackExchange.Redis/KeyspaceIsolation/DatabaseWrapper.cs

@@ -206,6 +206,9 @@ public RedisValue ListLeftPop(RedisKey key, CommandFlags flags = CommandFlags.No
  public RedisValue[] ListLeftPop(RedisKey key, long count, CommandFlags flags = CommandFlags.None) =>
  Inner.ListLeftPop(ToInner(key), count, flags);
 
+ public ListSpan? ListLeftPop(RedisKey[] keys, long count, CommandFlags flags = CommandFlags.None) =>
+ Inner.ListLeftPop(ToInner(keys), count, flags);
+
  public long ListPosition(RedisKey key, RedisValue element, long rank = 1, long maxLength = 0, CommandFlags flags = CommandFlags.None) =>
  Inner.ListPosition(ToInner(key), element, rank, maxLength, flags);
 
@@ -239,6 +242,9 @@ public RedisValue ListRightPop(RedisKey key, CommandFlags flags = CommandFlags.N
  public RedisValue[] ListRightPop(RedisKey key, long count, CommandFlags flags = CommandFlags.None) =>
  Inner.ListRightPop(ToInner(key), count, flags);
 
+ public ListSpan? ListRightPop(RedisKey[] keys, long count, CommandFlags flags = CommandFlags.None) =>
+ Inner.ListRightPop(ToInner(keys), count, flags);
+
  public RedisValue ListRightPopLeftPush(RedisKey source, RedisKey destination, CommandFlags flags = CommandFlags.None) =>
  Inner.ListRightPopLeftPush(ToInner(source), ToInner(destination), flags);
 
@@ -463,6 +469,9 @@ public long SortedSetRemoveRangeByValue(RedisKey key, RedisValue min, RedisValue
  public SortedSetEntry[] SortedSetPop(RedisKey key, long count, Order order = Order.Ascending, CommandFlags flags = CommandFlags.None) =>
  Inner.SortedSetPop(ToInner(key), count, order, flags);
 
+ public SortedSetSpan? SortedSetPop(RedisKey[] keys, long count, Order order = Order.Ascending, CommandFlags flags = CommandFlags.None) =>
+ Inner.SortedSetPop(ToInner(keys), count, order, flags);
+
  public long StreamAcknowledge(RedisKey key, RedisValue groupName, RedisValue messageId, CommandFlags flags = CommandFlags.None) =>
  Inner.StreamAcknowledge(ToInner(key), groupName, messageId, flags);
 

src/StackExchange.Redis/KeyspaceIsolation/WrapperBase.cs

@@ -217,6 +217,9 @@ public Task<RedisValue> ListLeftPopAsync(RedisKey key, CommandFlags flags = Comm
  public Task<RedisValue[]> ListLeftPopAsync(RedisKey key, long count, CommandFlags flags = CommandFlags.None) =>
  Inner.ListLeftPopAsync(ToInner(key), count, flags);
 
+ public Task<ListSpan?> ListLeftPopAsync(RedisKey[] keys, long count, CommandFlags flags = CommandFlags.None) =>
+ Inner.ListLeftPopAsync(ToInner(keys), count, flags);
+
  public Task<long> ListPositionAsync(RedisKey key, RedisValue element, long rank = 1, long maxLength = 0, CommandFlags flags = CommandFlags.None) =>
  Inner.ListPositionAsync(ToInner(key), element, rank, maxLength, flags);
 
@@ -250,6 +253,9 @@ public Task<RedisValue> ListRightPopAsync(RedisKey key, CommandFlags flags = Com
  public Task<RedisValue[]> ListRightPopAsync(RedisKey key, long count, CommandFlags flags = CommandFlags.None) =>
  Inner.ListRightPopAsync(ToInner(key), count, flags);
 
+ public Task<ListSpan?> ListRightPopAsync(RedisKey[] keys, long count, CommandFlags flags = CommandFlags.None) =>
+ Inner.ListRightPopAsync(ToInner(keys), count, flags);
+
  public Task<RedisValue> ListRightPopLeftPushAsync(RedisKey source, RedisKey destination, CommandFlags flags = CommandFlags.None) =>
  Inner.ListRightPopLeftPushAsync(ToInner(source), ToInner(destination), flags);
 
@@ -480,6 +486,9 @@ public IAsyncEnumerable<SortedSetEntry> SortedSetScanAsync(RedisKey key, RedisVa
  public Task<SortedSetEntry[]> SortedSetPopAsync(RedisKey key, long count, Order order = Order.Ascending, CommandFlags flags = CommandFlags.None) =>
  Inner.SortedSetPopAsync(ToInner(key), count, order, flags);
 
+ public Task<SortedSetSpan?> SortedSetPopAsync(RedisKey[] keys, long count, Order order = Order.Ascending, CommandFlags flags = CommandFlags.None) =>
+ Inner.SortedSetPopAsync(ToInner(keys), count, order, flags);
+
  public Task<long> StreamAcknowledgeAsync(RedisKey key, RedisValue groupName, RedisValue messageId, CommandFlags flags = CommandFlags.None) =>
  Inner.StreamAcknowledgeAsync(ToInner(key), groupName, messageId, flags);
 

src/StackExchange.Redis/ListSpan.cs

@@ -0,0 +1,24 @@
+namespace StackExchange.Redis;
+
+/// <summary>
+/// A contiguous portion of a list.
+/// </summary>
+public readonly struct ListSpan
+{
+ /// <summary>
+ /// The key of the list that this span came form.
+ /// </summary>
+ public RedisKey Key { get; }
+
+
+ /// <summary>
+ /// The values from the list
+ /// </summary>
+ public RedisValue[] Values { get; }
+
+ internal ListSpan(RedisKey key, RedisValue[] values)
+ {
+ Key = key;
+ Values = values;
+ }
+}