redis

README

REDIS

One redis service for fns

Install

go get github.com/aacfactory/fns-contrib/databases/redis

Usage

Config

• Standalone type
  • addr size is one
• Cluster type
  • all in addr is members

Example

redis:
  db:
    addr: 
      - "ip:port"
    username: ""
    password: ""
    db: 0
    poolSize: 0

Deploy

app.Deply(redis.Service())

Use service client

// get
result, err := redis.Get(ctx, key)

Documentation

Index

• func Decr(ctx context.Context, key string) (v int64, err errors.CodeError)
• func DecrBy(ctx context.Context, param DecrByParam) (v int64, err errors.CodeError)
• func Del(ctx context.Context, keys []string) (err errors.CodeError)
• func Discard(ctx context.Context) (err errors.CodeError)
• func Exists(ctx context.Context, key string) (has bool, err errors.CodeError)
• func Expire(ctx context.Context, param ExpireParam) (err errors.CodeError)
• func Incr(ctx context.Context, key string) (v int64, err errors.CodeError)
• func IncrBy(ctx context.Context, param IncrByParam) (v int64, err errors.CodeError)
• func Keys(ctx context.Context, pattern string) (values []string, err errors.CodeError)
• func MGet(ctx context.Context, keys []string) (v map[string]string, err errors.CodeError)
• func MSet(ctx context.Context, param MSetParam) (err errors.CodeError)
• func Persist(ctx context.Context, key string) (err errors.CodeError)
• func Pipeline(ctx context.Context, tx bool) (err errors.CodeError)
• func Service(databases ...string) service.Service
• func Set(ctx context.Context, param SetParam) (err errors.CodeError)
• func SetEx(ctx context.Context, param SetParam) (err errors.CodeError)
• func SetNx(ctx context.Context, param SetParam) (err errors.CodeError)
• func Sort(ctx context.Context, param SortParam) (v []string, err errors.CodeError)
• func WithOptions(ctx context.Context, options ...ProxyOption) context.Context
• func ZAdd(ctx context.Context, param ZAddParam) (v int64, err errors.CodeError)
• func ZCard(ctx context.Context, param ZCardParam) (v int64, err errors.CodeError)
• func ZCount(ctx context.Context, param ZCountParam) (v int64, err errors.CodeError)
• func ZRange(ctx context.Context, param ZRangeParam) (v []string, err errors.CodeError)
• func ZRangeByScore(ctx context.Context, param ZRangeByScoreParam) (v []string, err errors.CodeError)
• func ZRem(ctx context.Context, param ZRemParam) (v int64, err errors.CodeError)
• func ZRemRangeByRank(ctx context.Context, param ZRemByRangeParam) (v int64, err errors.CodeError)
• func ZRemRangeByScore(ctx context.Context, param ZRemByScoreParam) (v int64, err errors.CodeError)
• type DecrByParam
• type ExecResult
• type ExecResultCmder
  • func Exec(ctx context.Context) (v []ExecResultCmder, err errors.CodeError)
• type ExpireParam
• type GetResult
  • func Get(ctx context.Context, key string) (v GetResult, err errors.CodeError)
  • func GetSet(ctx context.Context, param GetSetParam) (v GetResult, err errors.CodeError)
• type GetSetParam
• type IncrByParam
• type KeyPair
• type KeysParam
• type KeysResult
• type MSetParam
• type PipelineParam
• type ProxyOption
  • func Database(name string) ProxyOption
• type ProxyOptions
• type ScanParam
• type ScanResult
  • func Scan(ctx context.Context, param ScanParam) (r ScanResult, err errors.CodeError)
• type SetParam
• type SortParam
• type Z
• type ZAddParam
• type ZCardParam
• type ZCountParam
• type ZRangeByScoreParam
• type ZRangeParam
• type ZRemByRangeParam
• type ZRemByScoreParam
• type ZRemParam

Functions

func Decr

func Decr(ctx context.Context, key string) (v int64, err errors.CodeError)

func DecrBy

func DecrBy(ctx context.Context, param DecrByParam) (v int64, err errors.CodeError)

func Del

func Del(ctx context.Context, keys []string) (err errors.CodeError)

func Discard

func Discard(ctx context.Context) (err errors.CodeError)

func Exists

func Exists(ctx context.Context, key string) (has bool, err errors.CodeError)

func Expire

func Expire(ctx context.Context, param ExpireParam) (err errors.CodeError)

func Incr

func Incr(ctx context.Context, key string) (v int64, err errors.CodeError)

func IncrBy

func IncrBy(ctx context.Context, param IncrByParam) (v int64, err errors.CodeError)

func Keys

func Keys(ctx context.Context, pattern string) (values []string, err errors.CodeError)

func MGet

func MGet(ctx context.Context, keys []string) (v map[string]string, err errors.CodeError)

func MSet

func MSet(ctx context.Context, param MSetParam) (err errors.CodeError)

func Persist

func Persist(ctx context.Context, key string) (err errors.CodeError)

func Pipeline

func Pipeline(ctx context.Context, tx bool) (err errors.CodeError)

func Service

func Service(databases ...string) service.Service

func Set

func Set(ctx context.Context, param SetParam) (err errors.CodeError)

func SetEx

func SetEx(ctx context.Context, param SetParam) (err errors.CodeError)

func SetNx

func SetNx(ctx context.Context, param SetParam) (err errors.CodeError)

func Sort

func Sort(ctx context.Context, param SortParam) (v []string, err errors.CodeError)

func WithOptions

func WithOptions(ctx context.Context, options ...ProxyOption) context.Context

func ZAdd

func ZAdd(ctx context.Context, param ZAddParam) (v int64, err errors.CodeError)

func ZCard

func ZCard(ctx context.Context, param ZCardParam) (v int64, err errors.CodeError)

func ZCount

func ZCount(ctx context.Context, param ZCountParam) (v int64, err errors.CodeError)

func ZRange

func ZRange(ctx context.Context, param ZRangeParam) (v []string, err errors.CodeError)

func ZRangeByScore

func ZRangeByScore(ctx context.Context, param ZRangeByScoreParam) (v []string, err errors.CodeError)

func ZRem

func ZRem(ctx context.Context, param ZRemParam) (v int64, err errors.CodeError)

func ZRemRangeByRank

func ZRemRangeByRank(ctx context.Context, param ZRemByRangeParam) (v int64, err errors.CodeError)

func ZRemRangeByScore

func ZRemRangeByScore(ctx context.Context, param ZRemByScoreParam) (v int64, err errors.CodeError)

Types

type DecrByParam

type DecrByParam struct {
	Key   string
	Value int64
}

type ExecResult

type ExecResult struct {
	Finished bool
	Cmders   []ExecResultCmder
}

type ExecResultCmder

type ExecResultCmder struct {
	Name  string
	Error string
}

func Exec

func Exec(ctx context.Context) (v []ExecResultCmder, err errors.CodeError)

type ExpireParam

type ExpireParam struct {
	Key        string
	Expiration time.Duration
}

type GetResult

type GetResult struct {
	Has   bool
	Value string
}

func Get

func Get(ctx context.Context, key string) (v GetResult, err errors.CodeError)

func GetSet

func GetSet(ctx context.Context, param GetSetParam) (v GetResult, err errors.CodeError)

type GetSetParam

type GetSetParam struct {
	Key   string
	Value string
}

type IncrByParam

type IncrByParam struct {
	Key   string
	Value int64
}

type KeyPair

type KeyPair struct {
	Key   string
	Value string
}

type KeysParam

type KeysParam struct {
	Pattern string
}

type KeysResult

type KeysResult struct {
	Values []string
}

type MSetParam

type MSetParam []KeyPair

type PipelineParam

type PipelineParam struct {
	Tx bool
}

type ProxyOption

type ProxyOption func(*ProxyOptions)

func Database

func Database(name string) ProxyOption

type ProxyOptions

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

type ScanParam

type ScanParam struct {
	Cursor uint64
	Match  string
	Count  int64
}

type ScanResult

type ScanResult struct {
	Keys []string
	Next uint64
}

func Scan

func Scan(ctx context.Context, param ScanParam) (r ScanResult, err errors.CodeError)

type SetParam

type SetParam struct {
	Key        string
	Value      string
	Expiration time.Duration
}

type SortParam

type SortParam struct {
	Key    string
	By     string
	Offset int64
	Count  int64
	Get    []string
	Order  string
	Alpha  bool
}

type Z

type Z struct {
	Score float64
	Value string
}

type ZAddParam

type ZAddParam struct {
	Key    string
	Values []Z
}

type ZCardParam

type ZCardParam struct {
	Key string
}

type ZCountParam

type ZCountParam struct {
	Key string
	Min string
	Max string
}

type ZRangeByScoreParam

type ZRangeByScoreParam struct {
	Key    string
	Min    string
	Max    string
	Offset int64
	Count  int64
}

type ZRangeParam

type ZRangeParam struct {
	Key   string
	Start int64
	Stop  int64
}

type ZRemByRangeParam

type ZRemByRangeParam struct {
	Key   string
	Start int64
	Stop  int64
}

type ZRemByScoreParam

type ZRemByScoreParam struct {
	Key string
	Min string
	Max string
}

type ZRemParam

type ZRemParam struct {
	Key    string
	Values []string
}