redisx

Documentation

Index

• Constants
• Variables
• type Client
  • func NewClient(opt *Options) *Client
  • func (c *Client) GetBytes(ctx context.Context, key string) ([]byte, error)
  • func (c *Client) GetString(ctx context.Context, key string) (string, error)
  • func (c *Client) GetStruct(ctx context.Context, key string, target interface{}) error
  • func (c *Client) RLTransaction(ctx context.Context, lock string, fn func(context.Context, *Client) error) error
  • func (c *Client) SetStruct(ctx context.Context, key string, any interface{}, ttl time.Duration) error
• type Options

Constants

const (
	KeySupportedSymbols = "supported_symbols"
)

Variables

var (
	ErrDoesNotExist = errors.New("value does not exist by this key")
)

Types

type Client

type Client struct {
	redis.UniversalClient
	// contains filtered or unexported fields
}

Client wraps redis.UniversalClient

func NewClient

func NewClient(opt *Options) *Client

func (*Client) GetBytes

func (c *Client) GetBytes(ctx context.Context, key string) ([]byte, error)

func (*Client) GetString

func (c *Client) GetString(ctx context.Context, key string) (string, error)

func (*Client) GetStruct

func (c *Client) GetStruct(ctx context.Context, key string, target interface{}) error

GetStruct will unmarshal json bytes stored by key to target DEPRECATED

func (*Client) RLTransaction

func (c *Client) RLTransaction(ctx context.Context, lock string, fn func(context.Context, *Client) error) error

RLTransaction performs pessimistic-lock transaction using Redlock algorithm https://redis.io/topics/distlock lock is the name of the lock (i.e. name of redis key used to lock the operation)

func (*Client) SetStruct

func (c *Client) SetStruct(ctx context.Context, key string, any interface{}, ttl time.Duration) error

SetStruct will marshal to json bytes any go struct and save it by key DEPRECATED

type Options

type Options struct {
	Addr     string
	Password string
	DB       int
}