redis

README

redis

基于go-redis/redis的易用性封装

Documentation

Index

• Constants
• func NewCmd(ctx context.Context, args ...interface{}) *redis.Cmd
• type Client
  • func Dial(ctx context.Context, url string, dialOptArray ...DialOption) (_ Client, err error)
  • func NewClient(o *Options) Client
• type Cmd
• type Cmdable
• type DialOption
  • func WithPingTest() DialOption
• type Options
  • func ParseURL(redisURL string) (*Options, error)
• type Script
  • func NewScript(src string, args ...interface{}) *Script
  • func (script *Script) Run(ctx context.Context, cli ScriptClient, keys []string, args ...interface{}) (r *Cmd)
  • func (script *Script) Src() string
• type ScriptClient
• type XAddArgs
• type XAutoClaimArgs
• type XClaimArgs
• type XMessage
• type XPendingExtArgs
• type XReadArgs
• type XReadGroupArgs
• type XStream

Constants

const Nil = redis.Nil

Functions

func NewCmd

func NewCmd(ctx context.Context, args ...interface{}) *redis.Cmd

Types

type Client

type Client = redis.Cmdable

func Dial

func Dial(ctx context.Context, url string, dialOptArray ...DialOption) (_ Client, err error)

func NewClient

func NewClient(o *Options) Client

type Cmd

type Cmd = redis.Cmd

type Cmdable

type Cmdable = redis.Cmdable

type DialOption

type DialOption func(*dialOptions)

func WithPingTest

func WithPingTest() DialOption

执行Ping测试

type Options

type Options struct {
	// 集群节点配置，注意顺序
	NodeOptions []*redis.Options
}

func ParseURL

func ParseURL(redisURL string) (*Options, error)

Example: redis://user:password@host1:6379,host2:6479,host3:6579/3?dial_timeout=3&db=1&read_timeout=6s&max_retries=2

type Script

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

func NewScript

func NewScript(src string, args ...interface{}) *Script

func (*Script) Run

func (script *Script) Run(ctx context.Context, cli ScriptClient, keys []string, args ...interface{}) (r *Cmd)

func (*Script) Src

func (script *Script) Src() string

type ScriptClient

type ScriptClient interface {
	EvalSha(ctx context.Context, sha1 string, keys []string, args ...interface{}) *redis.Cmd
	ScriptLoad(ctx context.Context, script string) *redis.StringCmd
}

type XAddArgs

type XAddArgs = redis.XAddArgs

type XAutoClaimArgs

type XAutoClaimArgs = redis.XAutoClaimArgs

type XClaimArgs

type XClaimArgs = redis.XClaimArgs

type XMessage

type XMessage = redis.XMessage

type XPendingExtArgs

type XPendingExtArgs = redis.XPendingExtArgs

type XReadArgs

type XReadArgs = redis.XReadArgs

type XReadGroupArgs

type XReadGroupArgs = redis.XReadGroupArgs

type XStream

type XStream = redis.XStream