redis

Documentation

Index

• Constants
• Variables
• func Set(r *Connection)
• type Client
• type Connection
  • func Default() (*Connection, error)
  • func Get() (*Connection, error)
  • func NewRedisClient(config *ConnectionConfig) *Connection
  • func (c Connection) Get(ctx context.Context, key string) (string, bool, error)
  • func (c Connection) Set(ctx context.Context, key, value string, expiration time.Duration) error
  • func (c Connection) Stop() error
• type ConnectionConfig
  • func GetConnectionConfigFromEnv() (*ConnectionConfig, error)

Constants

const EnvPrefix = "REDIS"

Variables

var ErrConnectionIsNotSet = errors.New("connection is not set")

Functions

func Set

func Set(r *Connection)

Set global client

Types

type Client

type Client interface {
	Get(ctx context.Context, key string) (result string, present bool, err error)
	Set(ctx context.Context, key, value string, ttl time.Duration) error
	Stop() error
}

type Connection

type Connection struct {
	*redis.Client
}

func Default

func Default() (*Connection, error)

Default return default client

func Get

func Get() (*Connection, error)

Get return redis client

func NewRedisClient

func NewRedisClient(config *ConnectionConfig) *Connection

func (Connection) Get

func (c Connection) Get(ctx context.Context, key string) (string, bool, error)

func (Connection) Set

func (c Connection) Set(ctx context.Context, key, value string, expiration time.Duration) error

func (Connection) Stop

func (c Connection) Stop() error

type ConnectionConfig

type ConnectionConfig struct {
	Host     string `env:"_HOST" envDefault:"localhost"`
	Port     string `env:"_PORT" envDefault:"6379"`
	User     string `env:"_USER" envDefault:""`
	Pass     string `env:"_PASS" envDefault:""`
	Database int    `env:"_DATABASE" envDefault:"0"`
}

func GetConnectionConfigFromEnv

func GetConnectionConfigFromEnv() (*ConnectionConfig, error)