redisutil

Documentation

Index

• Constants
• func Check(ctx context.Context, config *Config) error
• func NewRedisClient(ctx context.Context, config *Config) (redis.UniversalClient, error)
• type Config
• type Sentinel

Constants

const (
	ClusterMode    = "cluster"    // Cluster mode for Redis.
	SentinelMode   = "sentinel"   // Sentinel mode for Redis.
	StandaloneMode = "standalone" // Standalone mode for Redis.
)

RedisMode

Functions

func Check

func Check(ctx context.Context, config *Config) error

CheckRedis checks the Redis connection.

func NewRedisClient

func NewRedisClient(ctx context.Context, config *Config) (redis.UniversalClient, error)

Types

type Config

type Config struct {
	RedisMode string             // RedisMode can be "cluster", "sentinel", or "standalone".
	Address   []string           // List of Redis server addresses (host:port).
	Username  string             // Username for Redis authentication (Redis 6 ACL).
	Password  string             // Password for Redis authentication.
	MaxRetry  int                // Maximum number of retries for a command.
	DB        int                // Database number to connect to, for non-cluster mode.
	PoolSize  int                // Number of connections to pool.
	TLS       *xtls.ClientConfig // TLS configuration for secure connections.
	Sentinel  *Sentinel          // Sentinel configuration for high availability.
}

Config defines the configuration parameters for a Redis client, including options for both single-node and cluster mode connections.

type Sentinel

type Sentinel struct {
	MasterName    string   `yaml:"masterName"`
	SentinelAddrs []string `yaml:"sentinelsAddrs"`
}