redis

Documentation

Index

• type CacheKeys
• type Cmd
  • func Command(name string, args ...interface{}) *Cmd
• type Endpoint
  • func (r *Endpoint) Acquire() redis.Conn
  • func (r *Endpoint) Exec(cmd *Cmd, others ...*Cmd) (interface{}, error)
  • func (r *Endpoint) Init()
  • func (r *Endpoint) Key(key string) string
  • func (r *Endpoint) LivenessCheck() map[string]string
  • func (r *Endpoint) SetDefault()
• type Operator
• type Redis
  • func (r *Redis) Acquire() redis.Conn
  • func (r *Redis) Del(ks ...string) error
  • func (r *Redis) Exec(cmd *Cmd, others ...*Cmd) (interface{}, error)
  • func (r *Redis) Exists(k string) (bool, error)
  • func (r *Redis) Get(k string, v any) error
  • func (r *Redis) IncrBy(k string, count int64) (int64, error)
  • func (r *Redis) Init()
  • func (r *Redis) Key(key string) string
  • func (r *Redis) Keys(pattern string) ([]string, error)
  • func (r *Redis) LivenessCheck() map[string]string
  • func (r *Redis) Name() string
  • func (r *Redis) RawDel(ks ...string) error
  • func (r *Redis) Set(k string, v any) error
  • func (r *Redis) SetDefault()
  • func (r *Redis) SetEx(k string, v any, exp time.Duration) error
  • func (r *Redis) WithDBIndex(n int) *Redis
  • func (r *Redis) WithPrefix(prefix string) *Redis

Types

type CacheKeys

type CacheKeys interface {
	CacheKeys() []string
}

type Cmd

type Cmd struct {
	Name string
	Args []interface{}
}

func Command

func Command(name string, args ...interface{}) *Cmd

type Endpoint

type Endpoint struct {
	Endpoint types.Endpoint `env:""`
	Wait     bool
	Prefix   string
	// contains filtered or unexported fields
}

func (*Endpoint) Acquire

func (r *Endpoint) Acquire() redis.Conn

func (*Endpoint) Exec

func (r *Endpoint) Exec(cmd *Cmd, others ...*Cmd) (interface{}, error)

func (*Endpoint) Init

func (r *Endpoint) Init()

func (*Endpoint) Key

func (r *Endpoint) Key(key string) string

func (*Endpoint) LivenessCheck

func (r *Endpoint) LivenessCheck() map[string]string

func (*Endpoint) SetDefault

func (r *Endpoint) SetDefault()

type Operator

type Operator interface {
	// Key returns key with prefix
	Key(key string) string
	// Acquire redis connection
	Acquire() redis.Conn
	// Exec to execute redis command
	Exec(cmd *Cmd, others ...*Cmd) (interface{}, error)
}

type Redis

type Redis struct {
	Protocol       string
	Host           string
	Port           int
	Password       types.Password
	ConnectTimeout types.Duration
	WriteTimeout   types.Duration
	ReadTimeout    types.Duration
	IdleTimeout    types.Duration
	MaxActive      int
	MaxIdle        int
	Wait           bool
	DB             int

	Prefix string
	// contains filtered or unexported fields
}

func (*Redis) Acquire

func (r *Redis) Acquire() redis.Conn

func (*Redis) Del

func (r *Redis) Del(ks ...string) error

func (*Redis) Exec

func (r *Redis) Exec(cmd *Cmd, others ...*Cmd) (interface{}, error)

func (*Redis) Exists

func (r *Redis) Exists(k string) (bool, error)

func (*Redis) Get

func (r *Redis) Get(k string, v any) error

func (*Redis) IncrBy

func (r *Redis) IncrBy(k string, count int64) (int64, error)

func (*Redis) Init

func (r *Redis) Init()

func (*Redis) Key

func (r *Redis) Key(key string) string

func (*Redis) Keys

func (r *Redis) Keys(pattern string) ([]string, error)

func (*Redis) LivenessCheck

func (r *Redis) LivenessCheck() map[string]string

func (*Redis) Name

func (r *Redis) Name() string

func (*Redis) RawDel

func (r *Redis) RawDel(ks ...string) error

func (*Redis) Set

func (r *Redis) Set(k string, v any) error

func (*Redis) SetDefault

func (r *Redis) SetDefault()

func (*Redis) SetEx

func (r *Redis) SetEx(k string, v any, exp time.Duration) error

func (*Redis) WithDBIndex

func (r *Redis) WithDBIndex(n int) *Redis

func (*Redis) WithPrefix

func (r *Redis) WithPrefix(prefix string) *Redis