redis

Documentation

Index

• Variables
• func IsEnabled(cfg *Config) bool
• func NewCache(opts *cache.Options) *cache.Cache
• func NewClient(params ClientParams) gr.Client
• func NewOptions(params OptionsParams) (*cache.Options, error)
• func NewRingOptions(cfg *Config) *redis.RingOptions
• type ClientParams
• type Config
• type OptionsParams

Variables

var Module = fx.Options(
	fx.Provide(NewClient),
	fx.Provide(NewOptions),
	fx.Provide(NewCache),
	fx.Provide(NewRingOptions),
	fx.Invoke(metrics.Register),
)

Module for fx.

Functions

func IsEnabled

func IsEnabled(cfg *Config) bool

IsEnabled for redis.

func NewCache

func NewCache(opts *cache.Options) *cache.Cache

NewCache from config. The cache is based on https://github.com/go-redis/cache

func NewClient

func NewClient(params ClientParams) gr.Client

NewClient for redis.

func NewOptions

func NewOptions(params OptionsParams) (*cache.Options, error)

NewOptions for redis.

func NewRingOptions

func NewRingOptions(cfg *Config) *redis.RingOptions

NewRingOptions for redis.

Types

type ClientParams

type ClientParams struct {
	fx.In

	Lifecycle   fx.Lifecycle
	RingOptions *redis.RingOptions
	Tracer      trace.Tracer
	Logger      *zap.Logger
}

ClientParams for redis.

type Config

type Config struct {
	Compressor string            `yaml:"compressor,omitempty" json:"compressor,omitempty" toml:"compressor,omitempty"`
	Marshaller string            `yaml:"marshaller,omitempty" json:"marshaller,omitempty" toml:"marshaller,omitempty"`
	Addresses  map[string]string `yaml:"addresses,omitempty" json:"addresses,omitempty" toml:"addresses,omitempty"`
	Username   string            `yaml:"username,omitempty" json:"username,omitempty" toml:"username,omitempty"`
	Password   string            `yaml:"password,omitempty" json:"password,omitempty" toml:"password,omitempty"`
	DB         int               `yaml:"db,omitempty" json:"db,omitempty" toml:"db,omitempty"`
}

Config for redis.

type OptionsParams

type OptionsParams struct {
	fx.In

	Client     gr.Client
	Config     *Config
	Marshaller *marshaller.Factory
	Compressor *compressor.Factory
}

OptionsParams for redis.