rediscluster

Documentation

Overview

Package rediscluster provides configuration options and utilities for Redis Cluster backend implementation.

Index

• func ApplyOptions(opt *redis.ClusterOptions, options ...Option)
• type Option
  • func WithAddrs(addrs ...string) Option
  • func WithMaxRetries(maxRetries int) Option
  • func WithMinIdleConns(minIdle int) Option
  • func WithPassword(password string) Option
  • func WithPoolSize(size int) Option
  • func WithPoolTimeout(d time.Duration) Option
  • func WithReadTimeout(readTimeout time.Duration) Option
  • func WithTLSConfig(tlsConfig *tls.Config) Option
  • func WithUsername(username string) Option
  • func WithWriteTimeout(writeTimeout time.Duration) Option
• type Store
  • func New(opts ...Option) (*Store, error)

Functions

func ApplyOptions

func ApplyOptions(opt *redis.ClusterOptions, options ...Option)

ApplyOptions applies a list of options to the provided ClusterOptions.

Types

type Option

type Option func(*redis.ClusterOptions)

Option is a function type that can be used to configure the redis ClusterClient Options.

func WithAddrs

func WithAddrs(addrs ...string) Option

WithAddrs sets the Addrs for cluster nodes.

func WithMaxRetries

func WithMaxRetries(maxRetries int) Option

WithMaxRetries sets MaxRetries.

func WithMinIdleConns

func WithMinIdleConns(minIdle int) Option

WithMinIdleConns sets MinIdleConns.

func WithPassword

func WithPassword(password string) Option

WithPassword sets Password.

func WithPoolSize

func WithPoolSize(size int) Option

WithPoolSize sets PoolSize.

func WithPoolTimeout

func WithPoolTimeout(d time.Duration) Option

WithPoolTimeout sets PoolTimeout.

func WithReadTimeout

func WithReadTimeout(readTimeout time.Duration) Option

WithReadTimeout sets ReadTimeout.

func WithTLSConfig

func WithTLSConfig(tlsConfig *tls.Config) Option

WithTLSConfig sets TLSConfig.

func WithUsername

func WithUsername(username string) Option

WithUsername sets Username.

func WithWriteTimeout

func WithWriteTimeout(writeTimeout time.Duration) Option

WithWriteTimeout sets WriteTimeout.

type Store

type Store struct {
	Client *redis.ClusterClient
}

Store is a redis cluster store instance with a ClusterClient.

func New

func New(opts ...Option) (*Store, error)

New creates a redis cluster store instance with given options.