Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shomali11/xredis
Go Redis Client
https://github.com/shomali11/xredis
connection-pool easy easy-to-use go golang options redigo redis redis-cache redis-client redis-sentinel sentinel typesafe
Last synced: about 1 month ago
JSON representation
Go Redis Client
- Host: GitHub
- URL: https://github.com/shomali11/xredis
- Owner: shomali11
- License: mit
- Created: 2017-06-14T00:19:26.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2019-06-08T14:36:42.000Z (over 5 years ago)
- Last Synced: 2024-06-18T20:19:17.563Z (3 months ago)
- Topics: connection-pool, easy, easy-to-use, go, golang, options, redigo, redis, redis-cache, redis-client, redis-sentinel, sentinel, typesafe
- Language: Go
- Homepage:
- Size: 153 KB
- Stars: 19
- Watchers: 4
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-go - xredis - Typesafe, customizable, clean & easy to use Redis client. (Database Drivers / NoSQL Database Drivers)
- awesome-go - xredis - Go Redis Client - ★ 9 (Database Drivers)
- awesome-go-extra - xredis - 06-14T00:19:26Z|2019-06-08T14:36:42Z| (Generators / NoSQL Database Drivers)
README
# xredis [](https://travis-ci.com/shomali11/xredis) [](https://goreportcard.com/report/github.com/shomali11/xredis) [](https://godoc.org/github.com/shomali11/xredis) [](https://opensource.org/licenses/MIT)
Built on top of [github.com/garyburd/redigo](https://github.com/garyburd/redigo) with the idea to simplify creating a Redis client, provide type safe calls and encapsulate the low level details to easily integrate with Redis.
## Features
* Type safe client
* Easy to setup using
* Default client
* Custom client via set options
* `redigo`'s `redis.Pool`
* Connection pool provided automatically
* Support for Redis Sentinel
* Writes go to the Master
* Reads go to the Slaves. Falls back on Master if none are available.
* Supports the following Redis commands
* **ECHO**, **INFO**, **PING**, **FLUSH**, **FLUSHALL**, **EXPIRE**, **APPEND**
* **SET**, **SETEX**, **SETNX**, **GET**, **DEL**, **EXISTS**, **KEYS**, **SCAN**, **GETRANGE**, **SETRANGE**
* **HSET**, **HGET**, **HGETALL**, **HDEL**, **HEXISTS**, **HKEYS**, **HSCAN**
* **INCR**, **INCRBY**, **INCRBYFLOAT**, **DECR**, **DECRBY**, **DECRBYFLOAT**
* **HINCR**, **HINCRBY**, **HINCRBYFLOAT**, **HDECR**, **HDECRBY**, **HDECRBYFLOAT**
* _More coming soon_
* Full access to Redigo's API [github.com/garyburd/redigo](https://github.com/garyburd/redigo)
## Dependencies
* `redigo` [github.com/garyburd/redigo](https://github.com/garyburd/redigo)
* `go-sentinel` [github.com/FZambia/go-sentinel](https://github.com/FZambia/go-sentinel)
# Examples
## Example 1
Using `DefaultClient` to create a redis client with default options
```go
package main
import (
"fmt"
"github.com/shomali11/xredis"
)
func main() {
client := xredis.DefaultClient()
defer client.Close()
fmt.Println(client.Ping()) // PONG
}
```
List of default options
```text
defaultHost = "localhost"
defaultPort = 6379
defaultPassword = ""
defaultDatabase = 0
defaultNetwork = "tcp"
defaultConnectTimeout = time.Second
defaultWriteTimeout = time.Second
defaultReadTimeout = time.Second
defaultConnectionIdleTimeout = 240 * time.Second
defaultConnectionMaxIdle = 100
defaultConnectionMaxActive = 10000
defaultConnectionWait = false
defaultTlsConfig = nil
defaultTlsSkipVerify = false
defaultTestOnBorrowTimeout = time.Minute
```
## Example 2
Using `SetupClient` to create a redis client using provided options
```go
package main
import (
"fmt"
"github.com/shomali11/xredis"
)
func main() {
options := &xredis.Options{
Host: "localhost",
Port: 6379,
}
client := xredis.SetupClient(options)
defer client.Close()
fmt.Println(client.Ping()) // PONG
}
```
Available options to set
```go
type Options struct {
Host string
Port int
Password string
Database int
Network string
ConnectTimeout time.Duration
WriteTimeout time.Duration
ReadTimeout time.Duration
ConnectionIdleTimeout time.Duration
ConnectionMaxIdle int
ConnectionMaxActive int
ConnectionWait bool
TlsConfig *tls.Config
TlsSkipVerify bool
TestOnBorrowPeriod time.Duration
}
```
## Example 3
Using `SetupSentinelClient` to create a redis sentinel client using provided options
```go
package main
import (
"fmt"
"github.com/shomali11/xredis"
)
func main() {
options := &xredis.SentinelOptions{
Addresses: []string{"localhost:26379"},
MasterName: "master",
}
client := xredis.SetupSentinelClient(options)
defer client.Close()
fmt.Println(client.Ping()) // PONG
}
```
Available options to set
```go
type SentinelOptions struct {
Addresses []string
MasterName string
Password string
Database int
Network string
ConnectTimeout time.Duration
WriteTimeout time.Duration
ReadTimeout time.Duration
ConnectionIdleTimeout time.Duration
ConnectionMaxIdle int
ConnectionMaxActive int
ConnectionWait bool
TlsConfig *tls.Config
TlsSkipVerify bool
}
```
## Example 4
Using `NewClient` to create a redis client using `redigo`'s `redis.Pool`
```go
package main
import (
"fmt"
"github.com/garyburd/redigo/redis"
"github.com/shomali11/xredis"
)
func main() {
pool := &redis.Pool{
Dial: func() (redis.Conn, error) {
return redis.Dial("tcp", "localhost:6379")
},
}
client := xredis.NewClient(pool)
defer client.Close()
fmt.Println(client.Ping()) // PONG
}
```
## Example 5
Using the `Ping`, `Echo` & `Info` commands to ping, echo messages and return redis' information and statistics
```go
package main
import (
"fmt"
"github.com/shomali11/xredis"
)
func main() {
client := xredis.DefaultClient()
defer client.Close()
fmt.Println(client.Ping()) // PONG
fmt.Println(client.Echo("Hello")) // Hello
fmt.Println(client.FlushDb()) //
fmt.Println(client.FlushAll()) //
fmt.Println(client.Info())
}
```
## Example 6
Using the `Set`, `Keys`, `Get`, `Exists`, `Expire`, `Append`, `GetRange`, `SetRange` and `Del` commands to show how to set, get and delete keys and values.
_Note that the `Get` returns 3 values, a `string` result, a `bool` that determines whether the key exists and an `error`_
```go
package main
import (
"fmt"
"github.com/shomali11/xredis"
)
func main() {
client := xredis.DefaultClient()
defer client.Close()
fmt.Println(client.Set("name", "Raed Shomali")) // true
fmt.Println(client.SetNx("name", "Hello")) // false
fmt.Println(client.SetEx("id", "10", 1)) // true
fmt.Println(client.Expire("name", 1)) // true
fmt.Println(client.Expire("unknown", 1)) // false
fmt.Println(client.Keys("*")) // [id name]
fmt.Println(client.Get("name")) // "Raed Shomali" true
fmt.Println(client.Exists("name")) // true
fmt.Println(client.Del("name")) // 1
fmt.Println(client.Exists("name")) // false
fmt.Println(client.Get("name")) // "" false
fmt.Println(client.Del("name")) // 0
fmt.Println(client.Append("name", "a")) // 1
fmt.Println(client.Append("name", "b")) // 2
fmt.Println(client.Append("name", "c")) // 3
fmt.Println(client.Get("name")) // "abc" true
fmt.Println(client.GetRange("name", 0 , 1)) // "ab"
fmt.Println(client.SetRange("name", 2, "xyz")) // 5
fmt.Println(client.Get("name")) // "abxyz"
fmt.Println(client.Scan(0, "*")) // 0 [name id]
fmt.Println(client.Del("id", "name")) // 2
}
```
## Example 7
Using the `Incr`, `IncrBy`, `IncrByFloat`, `Decr`, `DecrBy`, `DecrByFloat` commands, we can increment and decrement a key's value
```go
package main
import (
"fmt"
"github.com/shomali11/xredis"
)
func main() {
client := xredis.DefaultClient()
defer client.Close()
fmt.Println(client.Set("integer", "10")) // true
fmt.Println(client.Set("float", "5.5")) // true
fmt.Println(client.Get("integer")) // 10 true
fmt.Println(client.Get("float")) // 5.5 true
fmt.Println(client.Incr("integer")) // 11
fmt.Println(client.IncrBy("integer", 10)) // 21
fmt.Println(client.DecrBy("integer", 5)) // 16
fmt.Println(client.Decr("integer")) // 15
fmt.Println(client.IncrByFloat("float", 3.3)) // 8.8
fmt.Println(client.DecrByFloat("float", 1.1)) // 7.7
fmt.Println(client.Get("integer")) // 15 true
fmt.Println(client.Get("float")) // 7.7 true
fmt.Println(client.Del("integer", "float")) // 2
}
```
## Example 8
Using the `HSet`, `HKeys`, `HGet`, `HGetAll`, `HExists` and `HDel` commands to show how to set, get and delete hash keys, fields and values.
_Note that the `HGetAll` returns 2 values, a `map[string]string` result and an `error`_
```go
package main
import (
"fmt"
"github.com/shomali11/xredis"
)
func main() {
client := xredis.DefaultClient()
defer client.Close()
fmt.Println(client.HSet("hash", "name", "Raed Shomali")) // true
fmt.Println(client.HSet("hash", "sport", "Football")) // true
fmt.Println(client.HKeys("hash")) // [name sport]
fmt.Println(client.HScan("hash", 0, "*")) // 0 [name Raed Shomali sport Football]
fmt.Println(client.HGet("hash", "name")) // "Raed Shomali" true
fmt.Println(client.HGetAll("hash")) // map[name:Raed Shomali sport:Football]
fmt.Println(client.HExists("hash", "name")) // true
fmt.Println(client.HDel("hash", "name", "sport")) // 2
fmt.Println(client.HGet("hash", "name")) // "" false
fmt.Println(client.HExists("hash", "name")) // false
fmt.Println(client.HGetAll("hash")) // map[] nil
fmt.Println(client.HDel("hash", "name")) // 0
fmt.Println(client.HKeys("hash")) // []
}
```
## Example 9
Using the `HIncr`, `HIncrBy`, `HIncrByFloat`,`HDecr`, `HDecrBy` and `HDecrByFloat` commands to show how to increment and decrement hash fields' values.
```go
package main
import (
"fmt"
"github.com/shomali11/xredis"
)
func main() {
client := xredis.DefaultClient()
defer client.Close()
fmt.Println(client.HSet("hash", "integer", "10")) // true
fmt.Println(client.HSet("hash", "float", "5.5")) // true
fmt.Println(client.HIncr("hash", "integer")) // 11
fmt.Println(client.HIncrBy("hash", "integer", 10)) // 21
fmt.Println(client.HDecrBy("hash", "integer", 5)) // 16
fmt.Println(client.HDecr("hash", "integer")) // 15
fmt.Println(client.HIncrByFloat("hash", "float", 3.3)) // 8.8
fmt.Println(client.HDecrByFloat("hash", "float", 1.1)) // 7.7
fmt.Println(client.HDel("hash", "integer", "float")) // 2
}
```
## Example 10
Can't find the command you want? You have full access to `redigo`'s API.
```go
package main
import (
"fmt"
"github.com/garyburd/redigo/redis"
"github.com/shomali11/xredis"
)
func main() {
client := xredis.DefaultClient()
defer client.Close()
connection := client.GetConnection()
defer connection.Close()
fmt.Println(redis.String(connection.Do("INFO")))
}
```