Documentation
¶
Overview ¶
Package valkey provides a Valkey/Redis client wrapper with health checking and lifecycle management.
This package wraps the go-redis library to provide connection pooling, health checks, and clean shutdown. It supports both standard Redis and Valkey (Redis fork) servers.
Basic usage:
client, err := valkey.New(&valkey.Config{
Host: "localhost",
Port: 6379,
Database: 0,
})
if err != nil {
log.Fatal(err)
}
defer client.Close()
val, err := client.Get(ctx, "key").Result()
if err != nil {
return err
}
For TLS connections, configure the TLS field in Config. The underlying redis.UniversalClient is exposed via the Client field for direct access to all standard Redis operations.
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var ( ErrValkeyPoolNil = errors.New("valkey: client connection is nil") ErrInvalidHost = errors.New("valkey: host is required") ErrInvalidPort = errors.New("valkey: port must be between 1 and 65535") ErrInvalidDB = errors.New("valkey: database number must be non-negative") ErrInvalidPoolSize = errors.New("valkey: pool size must be positive") ErrConfigNil = errors.New("valkey: configuration must not be nil") ErrCAParseFailure = errors.New("failed to parse CA certificate") ErrHealthCheckNoActiveConns = errors.New("valkey health check failed: no active connections in pool") )
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct {
Host string
Port int
Password string
DB int
DialTimeout time.Duration
MaxIdleConns int
MinIdleConns int
PingTimeout time.Duration
PoolSize int
ReadTimeout time.Duration
WriteTimeout time.Duration
MaxRetries int
MinRetryBackoff time.Duration
MaxRetryBackoff time.Duration
TLSEnabled bool
TLSSkipVerify bool
TLSCertFile string
TLSKeyFile string
TLSCAFile string
}
func (*Config) WithDefaults ¶
Source Files
Click to show internal directories.
Click to hide internal directories.