redisconn

Documentation

Index

• type Conn
  • func New(addr string, options ...Option) (*Conn, error)
  • func (c *Conn) HealthCheck(ctx context.Context) error
• type Option
  • func WithClientName(name string) Option
  • func WithCredentials(username, password string) Option

Types

type Conn

type Conn struct{ *redis.Client }

Conn wraps connection with the Redis.

func New

func New(addr string, options ...Option) (*Conn, error)

New returns a pointer to a new instance of the Conn struct.

func (*Conn) HealthCheck

func (c *Conn) HealthCheck(ctx context.Context) error

type Option

type Option func(o *redis.Options)

Option modifies the redis.Options.

func WithClientName

func WithClientName(name string) Option

WithClientName sets the client name for the Redis connection.

func WithCredentials

func WithCredentials(username, password string) Option

WithCredentials sets the credentials for the Redis connection.