Packages

trait RedisStream extends AnyRef

The Stream is a new data type introduced recently, wwhich models a log data structure in a more abstract way, like a log file often implemented as a file open in apend only mode, Redis streams are primarily an append only data structure. At least conceptually, because being Redis streams an abstract data type represented in memory, they implement more powerful opperations, to overcome the limits of the log file itself. Check the official documentation to see the available operations at: https://redis.io/commands#stream

See also

The reference to lettuce api: io.lettuce.core.api.reactive.RedisStreamReactiveCommands

Linear Supertypes
AnyRef, Any
Known Subclasses
Redis, RedisStream
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RedisStream
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  20. def xack[K, V](key: K, group: K, messageIds: String*)(implicit connection: StatefulRedisConnection[K, V]): Task[Long]

    Acknowledge one or more messages as processed.

    Acknowledge one or more messages as processed.

    returns

    simple-reply the lenght of acknowledged messages.

  21. def xadd[K, V](key: K, body: Map[K, V])(implicit connection: StatefulRedisConnection[K, V]): Task[String]

    Append a message to the stream key.

    Append a message to the stream key.

    returns

    simple-reply the message Id.

  22. def xclaim[K, V](key: K, consumer: Consumer[K], minIdleTime: Long, messageIds: String*)(implicit connection: StatefulRedisConnection[K, V]): Observable[StreamMessage[K, V]]

    Gets ownership of one or multiple messages in the Pending Entries List of a given stream consumer group.

    Gets ownership of one or multiple messages in the Pending Entries List of a given stream consumer group.

    returns

    simple-reply the { @link StreamMessage}

  23. def xdel[K, V](key: K, messageIds: String*)(implicit connection: StatefulRedisConnection[K, V]): Task[String]

    Removes the specified entries from the stream.

    Removes the specified entries from the stream. Returns the number of items deleted, that may be different from the number of IDs passed in case certain IDs do not exist.

    returns

    simple-reply number of removed entries.

  24. def xgroupCreate[K, V](streamOffset: StreamOffset[K], group: K)(implicit connection: StatefulRedisConnection[K, V]): Task[String]

    Create a consumer group.

    Create a consumer group.

    returns

    simple-reply { @literal true} if successful.

  25. def xgroupDelconsumer[K, V](key: K, consumer: Consumer[K])(implicit connection: StatefulRedisConnection[K, V]): Task[Boolean]

    Delete a consumer from a consumer group.

    Delete a consumer from a consumer group.

    returns

    simple-reply { @literal true} if successful.

  26. def xgroupDestroy[K, V](key: K, group: K)(implicit connection: StatefulRedisConnection[K, V]): Task[Boolean]

    Destroy a consumer group.

    Destroy a consumer group.

    returns

    simple-reply { @literal true} if successful.

  27. def xgroupSetid[K, V](streamOffset: StreamOffset[K], group: K)(implicit connection: StatefulRedisConnection[K, V]): Task[String]

    Set the current group id.

    Set the current group id.

    returns

    simple-reply OK

  28. def xlen[K, V](key: K)(implicit connection: StatefulRedisConnection[K, V]): Task[Long]

    Get the length of a steam.

    Get the length of a steam.

    returns

    simple-reply the lenght of the stream.

  29. def xpending[K, V](key: K, consumer: Consumer[K], range: Range[String], limit: Limit)(implicit connection: StatefulRedisConnection[K, V]): Observable[Any]

    Read pending messages from a stream within a specific Range.

    Read pending messages from a stream within a specific Range.

    returns

    List<Object> array-reply list with members of the resulting stream.

  30. def xpending[K, V](key: K, group: K, range: Range[String], limit: Limit)(implicit connection: StatefulRedisConnection[K, V]): Observable[Any]

    Read pending messages from a stream within a specific Range.

    Read pending messages from a stream within a specific Range.

    returns

    List<Object> array-reply list with members of the resulting stream.

  31. def xpending[K, V](key: K, group: K)(implicit connection: StatefulRedisConnection[K, V]): Observable[Any]

    Read pending messages from a stream for a group.

    Read pending messages from a stream for a group.

    returns

    List<Object> array-reply list pending entries.

  32. def xrange[K, V](key: K, range: Range[String], limit: Limit)(implicit connection: StatefulRedisConnection[K, V]): Observable[StreamMessage[K, V]]

    Read messages from a stream within a specific Range applying a Limit.

    Read messages from a stream within a specific Range applying a Limit.

    returns

    Members of the resulting stream.

  33. def xrange[K, V](key: K, range: Range[String])(implicit connection: StatefulRedisConnection[K, V]): Observable[StreamMessage[K, V]]

    Read messages from a stream within a specific Range.

    Read messages from a stream within a specific Range.

    returns

    Members of the resulting stream.

  34. def xread[K, V](streams: StreamOffset[K]*)(implicit connection: StatefulRedisConnection[K, V]): Observable[StreamMessage[K, V]]

    Read messages from one or more StreamOffsets.

    Read messages from one or more StreamOffsets.

    returns

    Members of the resulting stream.

  35. def xreadgroup[K, V](consumer: Consumer[K], streams: StreamOffset[K]*)(implicit connection: StatefulRedisConnection[K, V]): Observable[StreamMessage[K, V]]

    Read messages from one or more StreamOffsets using a consumer group.

    Read messages from one or more StreamOffsets using a consumer group.

    returns

    List<StreamMessage> array-reply list with members of the resulting stream.

  36. def xrevrange[K, V](key: K, range: Range[String], limit: Limit)(implicit connection: StatefulRedisConnection[K, V]): Observable[StreamMessage[K, V]]

    Read messages from a stream within a specific Range applying a Limit in reverse order.

    Read messages from a stream within a specific Range applying a Limit in reverse order.

    returns

    Meembers of the resulting stream.

  37. def xrevrange[K, V](key: K, range: Range[String])(implicit connection: StatefulRedisConnection[K, V]): Observable[StreamMessage[K, V]]

    Read messages from a stream within a specific Range in reverse order.

    Read messages from a stream within a specific Range in reverse order.

    returns

    Members of the resulting stream.

  38. def xtrim[K, V](key: K, approximateTrimming: Boolean, count: Long)(implicit connection: StatefulRedisConnection[K, V]): Task[Long]

    Trims the stream to count elements.

    Trims the stream to count elements.

    returns

    Number of removed entries.

  39. def xtrim[K, V](key: K, count: Long)(implicit connection: StatefulRedisConnection[K, V]): Task[Long]

    Trims the stream to count elements.

    Trims the stream to count elements.

    returns

    Number of removed entries.

Inherited from AnyRef

Inherited from Any

Ungrouped