rediser

README

Redis'er(Redis Manager)

Installation

go get github.com/go-packagist/rediser

Usage

package main

import (
	"context"
	"github.com/go-packagist/rediser"
	"github.com/redis/go-redis/v9"
)

var ctx = context.Background()

func main() {
	m := rediser.New(&rediser.Config{
		ClientConfig: &rediser.ClientConfig{
			Default: "default",
			Connections: map[string]rediser.ConnectionClientFunc{
				"default": func() *redis.Client {
					return redis.NewClient(&redis.Options{
						Addr:     "localhost:6379",
						Password: "", // no password set
						DB:       0,  // use default DB
					})
				},
				"test": func() *redis.Client {
					return redis.NewClient(&redis.Options{
						Addr:     "localhost:6379",
						Password: "", // no password set
						DB:       1,  // use default DB
					})
				},
			},
		},
		ClusterConfig: &rediser.ClusterConfig{
			Default: "default",
			Connections: map[string]rediser.ConnectionClusterFunc{
				"default": func() *redis.ClusterClient {
					return redis.NewClusterClient(&redis.ClusterOptions{
						Addrs: []string{"localhost:6379"},
					})
				},
			},
		},
		RingConfig: &rediser.RingConfig{
			Default: "default",
			Connections: map[string]rediser.ConnectionRingFunc{
				"default": func() *redis.Ring {
					return redis.NewRing(&redis.RingOptions{
						Addrs: map[string]string{
							"shard1": "localhost:6379",
						},
					})
				},
			},
		},
	})

	// Example for Client
	m.Client().Get(ctx, "aaa").Val()       // use client default config
	m.Client("test").Get(ctx, "bbb").Val() // use client test config

	// Example for Cluster
	m.Cluster().Get(ctx, "aaa").Val() // use cluster default config

	// Example for Ring
	m.Ring().Get(ctx, "aaa").Val() // use ring default config
}

License

The MIT License (MIT). Please see License File for more information.

Documentation

Index

• type ClientConfig
• type ClusterConfig
• type Config
• type ConnectionClientFunc
• type ConnectionClusterFunc
• type ConnectionRingFunc
• type Manager
  • func New(config *Config) *Manager
  • func (m *Manager) Client(name ...string) *redis.Client
  • func (m *Manager) Cluster(name ...string) *redis.ClusterClient
  • func (m *Manager) Ring(name ...string) *redis.Ring
• type RingConfig

Types

type ClientConfig

type ClientConfig struct {
	Default     string
	Connections map[string]ConnectionClientFunc
}

type ClusterConfig

type ClusterConfig struct {
	Default     string
	Connections map[string]ConnectionClusterFunc
}

type Config

type Config struct {
	*ClientConfig
	*ClusterConfig
	*RingConfig
}

type ConnectionClientFunc

type ConnectionClientFunc func() *redis.Client

type ConnectionClusterFunc

type ConnectionClusterFunc func() *redis.ClusterClient

type ConnectionRingFunc

type ConnectionRingFunc func() *redis.Ring

type Manager

type Manager struct {
	// contains filtered or unexported fields
}

func New

func New(config *Config) *Manager

New a redis manager.

func (*Manager) Client

func (m *Manager) Client(name ...string) *redis.Client

Client get client.

func (*Manager) Cluster

func (m *Manager) Cluster(name ...string) *redis.ClusterClient

Cluster get cluster.

func (*Manager) Ring

func (m *Manager) Ring(name ...string) *redis.Ring

Ring get ring.

type RingConfig

type RingConfig struct {
	Default     string
	Connections map[string]ConnectionRingFunc
}