redis4cats

Redis client built on top of Cats Effect, Fs2 and the async Java client Lettuce.

NOTE: Neither binary compatibility nor API stability are guaranteed between releases.

redis4cats defines two types of API: an effect-based using Cats Effect and a stream-based using Fs2.

Effects

Connection API: ping
Geo API: geoadd, geohash, geopos, geodist, etc.
Hashes API: hgetall, hset, hdel, hincrby, etc.
Keys API: del, expire, exists, etc.
Lists API: rpush, lrange, lpop, etc.
Scripting API: eval, evalsha, etc.
Server API: flushall, etc.
Sets API: sadd, scard, srem, spop, etc.
Sorted Sets API: zcount, zcard, zrangebyscore, zrank, etc.
Strings API: get, set, etc.

Streams

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

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 += "dev.profunktor" %% "redis4cats-effects" % Version

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

libraryDependencies += "dev.profunktor" %% "redis4cats-streams" % Version

Note: previous artifacts <= 0.8.0-RC1 were published using the com.github.gvolpe group id (see migration guide).

Log4cats support

redis4cats needs a logger for internal use and provides instances for log4cats. It is the recommended logging library:

libraryDependencies += "dev.profunktor" %% "redis4cats-log4cats" % Version

Documentation

Guides and examples can be found on the micro site.

The scala docs can be found here by module:

Core
Effects
Streams
Log4cats

Running the tests locally

Start both a single Redis node and a cluster using docker-compose:

> docker-compose up
> sbt +test

Code of Conduct

See the Code of Conduct

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.

taeguk / redis4cats