Skip to content

Commit

Permalink
docs: rueidisaside
Browse files Browse the repository at this point in the history
  • Loading branch information
rueian committed Jul 17, 2023
1 parent 587c677 commit f752ea3
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 4 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,11 @@ A fast Golang Redis client that does auto pipelining and supports client side ca
## Features

* [Auto pipelining for non-blocking redis commands](https://redis.io/docs/manual/pipelining/)
* [Client side caching in RESP3](https://redis.io/docs/manual/client-side-caching/)
* [Client Side Caching in RESP3](https://redis.io/docs/manual/client-side-caching/)
* Pub/Sub, Sharded Pub/Sub, Streams
* Redis Cluster, Sentinel, RedisJSON, RedisBloom, RediSearch, RedisTimeseries, etc.
* [Generic Object Mapping with client side caching and optimistic locking](./om)
* [Generic Object Mapping with client side caching](./om)
* [Cache-Aside Pattern with client side caching](./rueidislock)
* [Distributed Locks with client side caching](./rueidislock)
* [Helpers for writing tests with rueidis mock](./mock)
* [OpenTelemetry integration](./rueidisotel)
Expand Down
6 changes: 5 additions & 1 deletion rueidisaside/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,4 +52,8 @@ func main() {
// ...
}
}
```
```

## Limitation

Currently, requires Redis >= 7.0.
2 changes: 1 addition & 1 deletion rueidisaside/aside.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import (

type ClientOption struct {
ClientOption rueidis.ClientOption
ClientTTL time.Duration //
ClientTTL time.Duration // TTL for the client marker, refreshed every 1/2 TTL. Defaults to 10s. The marker allows other client to know if this client is still alive.
}

type CacheAsideClient interface {
Expand Down

0 comments on commit f752ea3

Please sign in to comment.