The go-redis-template project came to facilitate the use of the redis driver in your go project, With simplicity in configuration and calls, without needing to implement repetitive conversion interfaces and worrying about pointers, this powerful lib will help you in your day-to-day life. See below some implemented features:
NOTE: first MVP version, if you want to help add features, create a PR and help the community.
- Simplicity in function calls without the need for repetitive conversions and concerns with pointers.
- Use any type of key without worrying about conversions to string.
- Automatic conversions of any type of value.
- Clearer error handling.
- Don't worry about unnecessary errors when using the Get operation.
Use go get.
go get github.com/GabrielHCataldo/go-redis-template
Then import the go-mongo package into your own code.
import "github.com/GabrielHCataldo/go-redis-template/redis"Below we will show some basic examples:
IMPORTANT: Always check the documentation in the structures and functions fields. For more details on the examples, visit All examples link.
To save a value is very simple, you can pass the key and value of any type in the parameters and customize it with the opts parameter, see:
package main
import (
"context"
"github.com/GabrielHCataldo/go-helper/helper"
"github.com/GabrielHCataldo/go-logger/logger"
"github.com/GabrielHCataldo/go-redis-template/redis"
"github.com/GabrielHCataldo/go-redis-template/redis/option"
"os"
"time"
)
type testStruct struct {
Name string
BirthDate time.Time
}
func main() {
key := "example-struct"
value := testStruct{
Name: "Foo bar",
BirthDate: time.Now(),
}
redisTemplate := redis.NewTemplate(option.Client{
Addr: os.Getenv("REDIS_URL"),
Password: os.Getenv("REDIS_PASSWORD"),
DB: 0,
})
defer redisTemplate.SimpleDisconnect()
ctx, cancel := context.WithTimeout(context.TODO(), 5*time.Second)
defer cancel()
opt := option.NewSet()
opt.SetMode(option.SetModeDefault)
opt.SetTTL(5*time.Minute)
opt.SetExpireAt(time.Time{})
opt.SetKeepTTL(false)
err := redisTemplate.Set(ctx, key, value, opt)
if helper.IsNotNil(err) {
logger.Error("error set redis value:", err)
return
}
logger.Info("set", key, "value redis completed successfully!")
}Output:
[INFO 2024/01/07 11:51:38] main.go:41: set example-struct value redis completed successfully!
See all Set examples by accessing the link.
You can get the key value without worrying about string conversions, just pass the dest parameter, see:
package main
import (
"context"
"github.com/GabrielHCataldo/go-helper/helper"
"github.com/GabrielHCataldo/go-logger/logger"
"github.com/GabrielHCataldo/go-redis-template/redis"
"github.com/GabrielHCataldo/go-redis-template/redis/option"
"os"
"time"
)
type testStruct struct {
Name string
BirthDate time.Time
}
func main() {
key := "example-struct"
var dest testStruct
redisTemplate := redis.NewTemplate(option.Client{
Addr: os.Getenv("REDIS_URL"),
Password: os.Getenv("REDIS_PASSWORD"),
DB: 0,
})
defer redisTemplate.SimpleDisconnect()
ctx, cancel := context.WithTimeout(context.TODO(), 5*time.Second)
defer cancel()
err := redisTemplate.Get(ctx, key, &dest,)
if helper.IsNotNil(err) {
logger.Error("error get redis value:", err)
return
}
logger.Info("get", key, "value redis completed successfully!", dest)
}Output:
[INFO 2024/01/07 11:59:46] main.go:33: get example-struct value redis completed successfully! {"Name":"Foo bar","BirthDate":"2024-01-07T11:51:38-03:00"}
See all Get examples by accessing the link.
To check if a key already exists in redis, just do:
package main
import (
"context"
"github.com/GabrielHCataldo/go-helper/helper"
"github.com/GabrielHCataldo/go-logger/logger"
"github.com/GabrielHCataldo/go-redis-template/redis"
"github.com/GabrielHCataldo/go-redis-template/redis/option"
"os"
"time"
)
type testStruct struct {
Name string
BirthDate time.Time
}
func main() {
key := "example-struct"
redisTemplate := redis.NewTemplate(option.Client{
Addr: os.Getenv("REDIS_URL"),
Password: os.Getenv("REDIS_PASSWORD"),
DB: 0,
})
defer redisTemplate.SimpleDisconnect()
ctx, cancel := context.WithTimeout(context.TODO(), 5*time.Second)
defer cancel()
alreadyExists, err := redisTemplate.Exists(ctx, key)
if helper.IsNotNil(err) {
logger.Error("error exists redis value:", err)
return
}
logger.Info("already exists", key, "?", alreadyExists)
}Output:
[INFO 2024/01/07 12:02:01] main.go:32: already exists example-struct ? true
package main
import (
"context"
"github.com/GabrielHCataldo/go-helper/helper"
"github.com/GabrielHCataldo/go-logger/logger"
"github.com/GabrielHCataldo/go-redis-template/redis"
"github.com/GabrielHCataldo/go-redis-template/redis/option"
"os"
"time"
)
func main() {
key1 := "example-struct"
key2 := "example-struct-2"
redisTemplate := redis.NewTemplate(option.Client{
Addr: os.Getenv("REDIS_URL"),
Password: os.Getenv("REDIS_PASSWORD"),
DB: 0,
})
defer redisTemplate.SimpleDisconnect()
ctx, cancel := context.WithTimeout(context.TODO(), 5*time.Second)
defer cancel()
err := redisTemplate.Del(ctx, key1, key2)
if helper.IsNotNil(err) {
logger.Error("error delete redis keys:", err)
return
}
logger.Info("delete redis keys (", key1, "-", key2, ") completed successfully!")
}Output:
[INFO 2024/01/07 12:07:54] main.go:28: delete redis keys ( example-struct - example-struct-2 ) completed successfully!
Make a pull request, or if you find a bug, open it an Issues.
Distributed under MIT license, see the license file within the code for more details.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent