Module: Redis::Commands::Streams

Included in:
Redis::Commands
Defined in:
sig/redis.rbs

Instance Method Summary collapse

Instance Method Details

#_xreadObject

Parameters:

  • args (Object)
  • keys (Object)
  • ids (Object)
  • blocking_timeout_msec (Object)

Returns:

  • (Object)


684
# File 'sig/redis.rbs', line 684

def _xread: (untyped args, untyped keys, untyped ids, untyped blocking_timeout_msec) -> untyped

#xackInteger

Parameters:

  • key (Object)
  • group (Object)
  • ids (Object)

Returns:

  • (Integer)


674
# File 'sig/redis.rbs', line 674

def xack: (untyped key, untyped group, *untyped ids) -> Integer

#xaddString

Parameters:

  • key (Object)
  • entry (Object)
  • approximate: (Object, nil)
  • maxlen: (Object, nil)
  • minid: (Object, nil)
  • nomkstream: (Object, nil)
  • id: (::String)

Returns:

  • (String)


656
# File 'sig/redis.rbs', line 656

def xadd: (untyped key, untyped entry, ?approximate: untyped?, ?maxlen: untyped?, ?minid: untyped?, ?nomkstream: untyped?, ?id: ::String) -> String

#xautoclaimArray[String]

Parameters:

  • key (Object)
  • group (Object)
  • consumer (Object)
  • min_idle_time (Object)
  • start (Object)
  • count: (Object, nil)
  • justid: (Boolean)

Returns:

  • (Array[String])


678
# File 'sig/redis.rbs', line 678

def xautoclaim: (untyped key, untyped group, untyped consumer, untyped min_idle_time, untyped start, ?count: untyped?, ?justid: bool) -> Array[String]

#xclaimArray[String]

Parameters:

  • key (Object)
  • group (Object)
  • consumer (Object)
  • min_idle_time (Object)
  • ids (Object)
  • opts (Object)

Returns:

  • (Array[String])


676
# File 'sig/redis.rbs', line 676

def xclaim: (untyped key, untyped group, untyped consumer, untyped min_idle_time, *untyped ids, **untyped opts) -> Array[String]

#xdelInteger

Parameters:

  • key (Object)
  • ids (Object)

Returns:

  • (Integer)


660
# File 'sig/redis.rbs', line 660

def xdel: (untyped key, *untyped ids) -> Integer

#xgroupInteger

Parameters:

  • subcommand (Object)
  • key (Object)
  • group (Object)
  • id_or_consumer (Object, nil)
  • mkstream: (Boolean)

Returns:

  • (Integer)


670
# File 'sig/redis.rbs', line 670

def xgroup: (untyped subcommand, untyped key, untyped group, ?untyped? id_or_consumer, ?mkstream: bool) -> Integer

#xinfoArray[Hash[untyped, untyped]]

Parameters:

  • subcommand (Object)
  • key (Object)
  • group (Object, nil)

Returns:

  • (Array[Hash[untyped, untyped]])


654
# File 'sig/redis.rbs', line 654

def xinfo: (untyped subcommand, untyped key, ?untyped? group) -> Array[Hash[untyped, untyped]]

#xlenInteger

Parameters:

  • key (Object)

Returns:

  • (Integer)


666
# File 'sig/redis.rbs', line 666

def xlen: (untyped key) -> Integer

#xpendingArray[Hash[untyped, untyped]]

Parameters:

  • key (Object)
  • group (Object)
  • args (Object)
  • idle: (Object, nil)

Returns:

  • (Array[Hash[untyped, untyped]])


680
# File 'sig/redis.rbs', line 680

def xpending: (untyped key, untyped group, *untyped args, ?idle: untyped?) -> Array[Hash[untyped, untyped]]

#xrangeArray[Array[(String | Hash[untyped, untyped])]]

Parameters:

  • key (Object)
  • start (::String)
  • range_end (::String)
  • count: (Object, nil)

Returns:

  • (Array[Array[(String | Hash[untyped, untyped])]])


662
# File 'sig/redis.rbs', line 662

def xrange: (untyped key, ?::String start, ?::String range_end, ?count: untyped?) -> Array[Array[(String | Hash[untyped, untyped])]]

#xreadHash[String, Hash[String, Hash[untyped, untyped]]]

Parameters:

  • keys (Object)
  • ids (Object)
  • count: (Object, nil)
  • block: (Object, nil)

Returns:

  • (Hash[String, Hash[String, Hash[untyped, untyped]]])


668
# File 'sig/redis.rbs', line 668

def xread: (untyped keys, untyped ids, ?count: untyped?, ?block: untyped?) -> Hash[String, Hash[String, Hash[untyped, untyped]]]

#xreadgroupHash[String, Hash[String, Hash[untyped, untyped]]]

Parameters:

  • group (Object)
  • consumer (Object)
  • keys (Object)
  • ids (Object)
  • count: (Object, nil)
  • block: (Object, nil)
  • noack: (Object, nil)

Returns:

  • (Hash[String, Hash[String, Hash[untyped, untyped]]])


672
# File 'sig/redis.rbs', line 672

def xreadgroup: (untyped group, untyped consumer, untyped keys, untyped ids, ?count: untyped?, ?block: untyped?, ?noack: untyped?) -> Hash[String, Hash[String, Hash[untyped, untyped]]]

#xrevrangeArray[Array[(String | Hash[untyped, untyped])]]

Parameters:

  • key (Object)
  • range_end (::String)
  • start (::String)
  • count: (Object, nil)

Returns:

  • (Array[Array[(String | Hash[untyped, untyped])]])


664
# File 'sig/redis.rbs', line 664

def xrevrange: (untyped key, ?::String range_end, ?::String start, ?count: untyped?) -> Array[Array[(String | Hash[untyped, untyped])]]

#xtrimInteger

Parameters:

  • key (Object)
  • len_or_id (Object)
  • strategy: (::String)
  • approximate: (Boolean)
  • limit: (Object, nil)

Returns:

  • (Integer)


658
# File 'sig/redis.rbs', line 658

def xtrim: (untyped key, untyped len_or_id, ?strategy: ::String, ?approximate: bool, ?limit: untyped?) -> Integer