fs2-redis

Build Status Gitter Chat Maven Central Cats friendly

Redis stream-based client built on top of Cats Effect, Fs2 and the async java client Lettuce.

fs2-redis defines two types of API: one Stream-based using Fs2 and another Effect-based using Cats Effect.

Streams

  • PubSub API implemented on top of fs2 streams.
  • Streams API experimental API, subject to changes (WIP).
    • High-level API offers read and append using the underlying commands XREAD and XADD respectively.
    • Consumer Groups are yet not implemented.

Effects

  • Geo API: geoadd, geohash, geopos, geodist, etc.
  • Hashes API: hgetall, hset, hdel, hincrby, etc.
  • Lists API: rpush, lrange, lpop, etc.
  • Sets API: sadd, scard, srem, spop, etc.
  • Sorted Sets API: zcount, zcard, zrangebyscore, zrank, etc.
  • Strings API: get, set, del, expire, etc (includes some generic methods).

Other features are not considered at the moment but PRs and suggestions are very welcome.

Dependencies

Add this to your build.sbt for the Effects API (depends on cats-effect):

libraryDependencies += "com.github.gvolpe" %% "fs2-redis-effects" % Version

And this for the Streams API (depends on fs2 and cats-effect):

libraryDependencies += "com.github.gvolpe" %% "fs2-redis-streams" % Version

LICENSE

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this project except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.