Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/iwanbk/rimcu
Redis server-assisted client side caching Go library
https://github.com/iwanbk/rimcu
client-side-caching go golang in-memory-caching redis redis-client resp3 resp3-client
Last synced: about 1 month ago
JSON representation
Redis server-assisted client side caching Go library
- Host: GitHub
- URL: https://github.com/iwanbk/rimcu
- Owner: iwanbk
- License: mit
- Created: 2019-10-24T14:41:57.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-02T11:04:35.000Z (about 2 years ago)
- Last Synced: 2024-06-19T16:34:18.861Z (6 months ago)
- Topics: client-side-caching, go, golang, in-memory-caching, redis, redis-client, resp3, resp3-client
- Language: Go
- Homepage:
- Size: 174 KB
- Stars: 12
- Watchers: 5
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# rimcu - Redis server-assisted client side caching Go library
[](https://pkg.go.dev/github.com/iwanbk/rimcu)
[](https://codecov.io/gh/iwanbk/rimcu)
[](https://codeclimate.com/github/iwanbk/rimcu/maintainability)
Rimcu is Go library for Redis server-assisted client side caching.
In other words, it is a combination of Redis cient library and in memory cache library.
## System Requirements
Redis 6 or newer, with it's client side caching feature
## How it works
It caches the Redis data in your server's RAM and sync it to Redis server when the data changed.
So you don't need to always ask the Redis server to get your cache data.
It supports three modes:
- RESP2: single node Redis with RESP2 protocol, it is the default one
- RESP2ClusterProxy: Redis cluster with RESP2 protocol and front proxy
- RESP3: single node Redis with RESP3 protocol, not fully tested yet
## Examples
```go
```
## Features
| Features | Status | Description |
|------------------|--------------|-----------------------------|
| Metrics Client | :x: :wrench: | Configurable metrics client |
| Password Support | :x: :wrench: | |
| Strings | :x: :wrench: | redis strings data type |
| list | :x: :wrench: | redis list data type |
| hash | :x: :wrench: | redis hash data type |
Connection Pool
| Features | Status | Description |
|-------------------------------------|--- |--------------------------------------|
| Single Pool | :x: :wrench: | Single conn pool for all cache types |
| Vanilla Redigo Pool | :x: :wrench: | Reuse vanilla redigo pool |
| Max Number of Connections | :white_check_mark: | |
| Waiting for connection with timeout | :white_check_mark: | |
| Idle connection checking | :x: :wrench: | |
| Healthcheck | :x: :wrench: | |
## Caches
We categorize the cache based on the Redis data types mention in https://redis.io/docs/manual/data-types/.
We need to do this because each type of cache will be stored differently.
### StringsCache
StringsCache is cache for redis [`strings`](https://redis.io/topics/data-types#strings) data type.
### Implemented Commands
- [x] Setex
- [x] Get
- [x] Del
- [ ] MSet (waiting support at RESP2)
- [ ] MGet (waiting support at RESP2)
- [ ] Append
## ListCache (RESP2)
**IT IS UNDER REWORK**
Old implementation can be found at https://github.com/iwanbk/rimcu/blob/v0.01/resp2/listcache.go#L33
```
ListCache is cache for Redis list data type which uses RESP2 protocol. It is still in very early development phase. See the godoc page for more explanation.
Implemented commands:
- [x]LPOP
- [x]RPUSH
- [x]GET (it is Rimcu specific command)
- [ ]...
```
# Development
Local Test
```bash
export TEST_REDIS_ADDRESS=127.0.0.1:6379 # replace with your redis 6 server
go test ./...
```
TODO
| Features | Status | Description |
|-------------------|--------------|----------------------------------------------------|
| Unify inmem cache | :x: :wrench: | resp2 & resp3 currently using two different memcache lib |
# CREDITS
- [redigo](https://github.com/gomodule/redigo) redis package is copied and modified to this repo. It is used to provide RESP2 support.