redis

Documentation

Index

• func ConfigDocs() docs.FieldSpecs
• type Config
  • func NewConfig() Config
  • func (r Config) Client() (redis.UniversalClient, error)

Functions

func ConfigDocs

func ConfigDocs() docs.FieldSpecs

ConfigDocs returns a documentation field spec for fields within a Config.

Types

type Config

type Config struct {
	URL    string      `json:"url" yaml:"url"`
	Kind   string      `json:"kind" yaml:"kind"`
	Master string      `json:"master" yaml:"master"`
	TLS    btls.Config `json:"tls" yaml:"tls"`
}

Config is a config struct for a redis connection.

func NewConfig

func NewConfig() Config

NewConfig returns a Config with default values.

func (Config) Client

func (r Config) Client() (redis.UniversalClient, error)

Client returns a new redis client based on the configuration parameters.