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, error)
• type ClientParams
• type Config
  • func (c *Config) GetURL() (string, error)
• 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, error)

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"`
	Encoder    string            `yaml:"encoder,omitempty" json:"encoder,omitempty" toml:"encoder,omitempty"`
	Addresses  map[string]string `yaml:"addresses,omitempty" json:"addresses,omitempty" toml:"addresses,omitempty"`
	URL        string            `yaml:"url,omitempty" json:"url,omitempty" toml:"url,omitempty"`
}

Config for redis.

func (*Config) GetURL

func (c *Config) GetURL() (string, error)

GetURL for redis.

type OptionsParams

type OptionsParams struct {
	fx.In

	Client     gr.Client
	Config     *Config
	Encoder    *encoding.Map
	Pool       *sync.BufferPool
	Compressor *compress.Map
}

OptionsParams for redis.