Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nitishm/go-rejson
Golang client for redislabs' ReJSON module with support for multilple redis clients (redigo, go-redis)
https://github.com/nitishm/go-rejson
go-redis golang golang-client json multiclient redigo redis redis-client rejson
Last synced: 1 day ago
JSON representation
Golang client for redislabs' ReJSON module with support for multilple redis clients (redigo, go-redis)
- Host: GitHub
- URL: https://github.com/nitishm/go-rejson
- Owner: nitishm
- License: mit
- Created: 2018-04-23T00:51:05.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-01-17T12:52:03.000Z (11 months ago)
- Last Synced: 2024-07-31T20:50:44.042Z (5 months ago)
- Topics: go-redis, golang, golang-client, json, multiclient, redigo, redis, redis-client, rejson
- Language: Go
- Homepage:
- Size: 4.03 MB
- Stars: 342
- Watchers: 8
- Forks: 46
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-go - go-rejson - Golang client for redislabs' ReJSON module using Redigo golang client. Store and manipulate structs as JSON objects in redis with ease. (Database Drivers / NoSQL Database Drivers)
- awesome-go-extra - go-rejson - redis)|278|44|8|2018-04-23T00:51:05Z|2022-08-11T20:55:23Z| (Generators / NoSQL Database Drivers)
README
> _Note: Currently, go-ReJSON only support redislabs/rejson with version <=1.0.8. If you are using higher versions, some commands might not work as expected_
# Go-ReJSON - a golang client for ReJSON (a JSON data type for Redis)
Go-ReJSON is a [Go](https://golang.org/) client for [ReJSON](https://github.com/RedisLabsModules/rejson) Redis Module.
[](https://pkg.go.dev/github.com/nitishm/go-rejson/v4)
[](https://coveralls.io/github/nitishm/go-rejson?branch=master)
[](https://goreportcard.com/report/github.com/nitishm/go-rejson)
[](https://github.com/nitishm/go-rejson/releases)
> ReJSON is a Redis module that implements ECMA-404 The JSON Data Interchange Standard as a native data type. It allows storing, updating and fetching JSON values from Redis keys (documents).
Primary features of ReJSON Module:
* Full support of the JSON standard
* JSONPath-like syntax for selecting element inside documents
* Documents are stored as binary data in a tree structure, allowing fast access to sub-elements
* Typed atomic operations for all JSON values types
Each and every feature of ReJSON Module is fully incorporated in the project.
Enjoy ReJSON with the type-safe Redis client, [`Go-Redis/Redis`](https://github.com/go-redis/redis) or use the
print-like Redis-api client [`GoModule/Redigo`](https://github.com/gomodule/redigo). Go-ReJSON supports both the
clients. Use any of the above two client you want, Go-ReJSON helps you out with all its features and functionalities in
a more generic and standard way.
Support for `mediocregopher/radix` and other Redis clients is in our RoadMap. Any contributions to the support for other
clients is hearty welcome.
## Installation
go get github.com/nitishm/go-rejson/v4
## Example usage
```golang
package main
import (
"context"
"encoding/json"
"flag"
"fmt"
"log"
"github.com/nitishm/go-rejson/v4"
goredis "github.com/go-redis/redis/v8"
"github.com/gomodule/redigo/redis"
)
// Name - student name
type Name struct {
First string `json:"first,omitempty"`
Middle string `json:"middle,omitempty"`
Last string `json:"last,omitempty"`
}
// Student - student object
type Student struct {
Name Name `json:"name,omitempty"`
Rank int `json:"rank,omitempty"`
}
func Example_JSONSet(rh *rejson.Handler) {
student := Student{
Name: Name{
"Mark",
"S",
"Pronto",
},
Rank: 1,
}
res, err := rh.JSONSet("student", ".", student)
if err != nil {
log.Fatalf("Failed to JSONSet")
return
}
if res.(string) == "OK" {
fmt.Printf("Success: %s\n", res)
} else {
fmt.Println("Failed to Set: ")
}
studentJSON, err := redis.Bytes(rh.JSONGet("student", "."))
if err != nil {
log.Fatalf("Failed to JSONGet")
return
}
readStudent := Student{}
err = json.Unmarshal(studentJSON, &readStudent)
if err != nil {
log.Fatalf("Failed to JSON Unmarshal")
return
}
fmt.Printf("Student read from redis : %#v\n", readStudent)
}
func main() {
var addr = flag.String("Server", "localhost:6379", "Redis server address")
rh := rejson.NewReJSONHandler()
flag.Parse()
// Redigo Client
conn, err := redis.Dial("tcp", *addr)
if err != nil {
log.Fatalf("Failed to connect to redis-server @ %s", *addr)
}
defer func() {
_, err = conn.Do("FLUSHALL")
err = conn.Close()
if err != nil {
log.Fatalf("Failed to communicate to redis-server @ %v", err)
}
}()
rh.SetRedigoClient(conn)
fmt.Println("Executing Example_JSONSET for Redigo Client")
Example_JSONSet(rh)
// GoRedis Client
cli := goredis.NewClient(&goredis.Options{Addr: *addr})
defer func() {
if err := cli.FlushAll(context.Background()).Err(); err != nil {
log.Fatalf("goredis - failed to flush: %v", err)
}
if err := cli.Close(); err != nil {
log.Fatalf("goredis - failed to communicate to redis-server: %v", err)
}
}()
rh.SetGoRedisClient(cli)
fmt.Println("\nExecuting Example_JSONSET for GoRedis Client")
Example_JSONSet(rh)
}
```