Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zio/zio-redis
A ZIO-based redis client
https://github.com/zio/zio-redis
redis zio
Last synced: about 11 hours ago
JSON representation
A ZIO-based redis client
- Host: GitHub
- URL: https://github.com/zio/zio-redis
- Owner: zio
- License: apache-2.0
- Created: 2020-01-07T16:12:24.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-11-28T09:13:04.000Z (about 1 month ago)
- Last Synced: 2025-01-04T17:09:28.860Z (8 days ago)
- Topics: redis, zio
- Language: Scala
- Homepage: https://zio.github.io/zio-redis
- Size: 4.29 MB
- Stars: 123
- Watchers: 14
- Forks: 64
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- awesome-scala - zio-redis - based redis client |   (Table of Contents / Database)
README
[//]: # (This file was autogenerated using `zio-sbt-website` plugin via `sbt generateReadme` command.)
[//]: # (So please do not edit it manually. Instead, change "docs/index.md" file or sbt setting keys)
[//]: # (e.g. "readmeDocumentation" and "readmeSupport".)
# ZIO Redis
[](https://github.com/zio/zio/wiki/Project-Stages)  [](https://oss.sonatype.org/content/repositories/releases/dev/zio/zio-redis_2.13/) [](https://oss.sonatype.org/content/repositories/snapshots/dev/zio/zio-redis_2.13/) [](https://javadoc.io/doc/dev.zio/zio-redis-docs_2.13) [](https://github.com/zio/zio-redis)
## Introduction
[ZIO Redis](https://github.com/zio/zio-redis) is a ZIO-native Redis client.
It aims to provide a **type-safe** and **performant** API for accessing Redis
instances.
## Installation
To use ZIO Redis, add the following line to your `build.sbt`:
```scala
libraryDependencies += "dev.zio" %% "zio-redis" % "1.0.0"
```
## Example
To execute our ZIO Redis effect, we should provide the `RedisExecutor` layer to that effect. To create this layer we
should also provide the following layers:
- **RedisConfig** — Using default one, will connect to the `localhost:6379` Redis instance.
- **BinaryCodec** — In this example, we are going to use the built-in `ProtobufCodec` codec from zio-schema project.
To run this example we should put following dependencies in our `build.sbt` file:
```scala
libraryDependencies ++= Seq(
"dev.zio" %% "zio-redis" % "1.0.0",
"dev.zio" %% "zio-schema-protobuf" % "0.4.9"
)
```
```scala
import zio._
import zio.redis._
import zio.schema._
import zio.schema.codec._
object ZIORedisExample extends ZIOAppDefault {
object ProtobufCodecSupplier extends CodecSupplier {
def get[A: Schema]: BinaryCodec[A] = ProtobufCodec.protobufCodec
}
val myApp: ZIO[Redis, RedisError, Unit] =
for {
redis <- ZIO.service[Redis]
_ <- redis.set("myKey", 8L, Some(1.minutes))
v <- redis.get("myKey").returning[Long]
_ <- Console.printLine(s"Value of myKey: $v").orDie
_ <- redis.hSet("myHash", ("k1", 6), ("k2", 2))
_ <- redis.rPush("myList", 1, 2, 3, 4)
_ <- redis.sAdd("mySet", "a", "b", "a", "c")
} yield ()
override def run =
myApp.provide(Redis.local, ZLayer.succeed[CodecSupplier](ProtobufCodecSupplier))
}
```
## Testing
To test you can use the embedded redis instance by adding to your build:
```scala
libraryDependencies := "dev.zio" %% "zio-redis-embedded" % "1.0.0"
```
Then you can supply `EmbeddedRedis.layer.orDie` as your `RedisConfig` and you're good to go!
```scala
import zio._
import zio.redis._
import zio.redis.embedded.EmbeddedRedis
import zio.schema.{DeriveSchema, Schema}
import zio.schema.codec.{BinaryCodec, ProtobufCodec}
import zio.test._
import zio.test.Assertion._
import java.util.UUID
object EmbeddedRedisSpec extends ZIOSpecDefault {
object ProtobufCodecSupplier extends CodecSupplier {
def get[A: Schema]: BinaryCodec[A] = ProtobufCodec.protobufCodec
}
final case class Item private (id: UUID, name: String, quantity: Int)
object Item {
implicit val itemSchema: Schema[Item] = DeriveSchema.gen[Item]
}
def spec = suite("EmbeddedRedis should")(
test("set and get values") {
for {
redis <- ZIO.service[Redis]
item = Item(UUID.randomUUID, "foo", 2)
_ <- redis.set(s"item.${item.id.toString}", item)
found <- redis.get(s"item.${item.id.toString}").returning[Item]
} yield assert(found)(isSome(equalTo(item)))
}
).provideShared(
EmbeddedRedis.layer,
ZLayer.succeed[CodecSupplier](ProtobufCodecSupplier),
Redis.singleNode
) @@ TestAspect.silentLogging
}
```
## Resources
- [ZIO Redis](https://www.youtube.com/watch?v=yqFt3b3RBkI) by Dejan Mijic — Redis is one of the most commonly used
in-memory data structure stores. In this talk, Dejan will introduce ZIO Redis, a purely functional, strongly typed
client library backed by ZIO, with excellent performance and extensive support for nearly all of Redis' features. He
will explain the library design using the bottom-up approach - from communication protocol to public APIs. Finally, he
will wrap the talk by demonstrating the client's usage and discussing its performance characteristics.
## Documentation
Learn more on the [ZIO Redis homepage](https://zio.dev/zio-redis)!
## Contributing
For the general guidelines, see ZIO [contributor's guide](https://zio.dev/contributor-guidelines).
## Code of Conduct
See the [Code of Conduct](https://zio.dev/code-of-conduct)
## Support
Come chat with us on [![Badge-Discord]][Link-Discord].
[Badge-Discord]: https://img.shields.io/discord/629491597070827530?logo=discord "chat on discord"
[Link-Discord]: https://discord.gg/2ccFBr4 "Discord"
## License
[License](LICENSE)