gokv/redis

An abstraction over Redis that implements the Store interface defined in gokv/store.

Maturity

This package is not stable because gokv/store is not stable yet. The Store implementations are experimental software.

Use

Initialise calling New with the address and the (optional) password to Redis.

s := redis.New("localhost:6379", "secret")
defer s.Close()

In order to be stored, a type must implement json.Marshaler. Similarly, the Get method of a store accepts a pointer to a json.Unmarshaler. Here is a full example of storing and retrieving a simple User object.

type User struct {
	FirstName, LastName string
}

func (u *User) UnmarshalJSON(data []byte) error {
	var ujson struct {
		FirstName string `json:"first_name"`
		LastName  string `json:"last_name"`
	}

	if err := json.Unmarshal(data, &ujson); err != nil {
		return err
	}

	*u = User{
		FirstName: ujson.FirstName,
		LastName:  ujson.LastName,
	}

	return nil
}

func (u User) MarshalJSON() ([]byte, error) {
	return json.Marshal(struct {
		FirstName string `json:"first_name"`
		LastName  string `json:"last_name"`
	}{
		FirstName: u.FirstName,
		LastName:  u.LastName,
	})
}

func main() {

	// New instantiates a "github.com/go-redis/redis" connection
	s := redis.New(os.Getenv("REDIS_ADDR"), os.Getenv("REDIS_PASS"))
	defer s.Close()

	// Call Ping to check readiness
	if err := s.Ping(); err!=nil {
		panic(err)
	}

	given := User{"Giacomo", "Leopardi"}

	if err := s.Add(123, given); err != nil {
		panic(err)
	}

	var found User
	ok, err := s.Get(123, &found)

	if err != nil {
		panic(fmt.Errorf("failure: %s", err))
	}

	if !ok {
		panic(errors.New("user not found"))
	}

	// given == found
}

Test

An empty and disposable Redis instance must be running at REDIS_ADDR (default localhost:6379) with password REDIS_PASS (empty by default).

With Docker:

docker run -d --name redis -p 6379:6379 redis:4-alpine
go test -v .