Documentation
¶
Index ¶
- Constants
- func ClearConfig()
- func RemoveConfig(name ...string)
- func SetConfig(config Config, name ...string)
- func SetConfigByStr(str string, name ...string) error
- type BoolCmd
- type Cmd
- type Config
- type Conn
- type Options
- type Redis
- func (db *Redis) AddHMObject(ctx context.Context, entity, key string, value interface{}) error
- func (db *Redis) AddObject(ctx context.Context, key string, value interface{}, duration time.Duration) error
- func (r *Redis) Close() error
- func (db *Redis) DeleteHMObject(ctx context.Context, entity, key string) error
- func (db *Redis) DeleteObject(ctx context.Context, key string) error
- func (db *Redis) GetAllHMObjects(ctx context.Context, entity string) (map[string]string, error)
- func (r *Redis) GetClient() *redis.Client
- func (db *Redis) GetHMObject(ctx context.Context, entity, key string, value interface{}) error
- func (db *Redis) GetObject(ctx context.Context, key string, value interface{}) error
- func (db *Redis) HMSetEX(key string, fields map[string]interface{}, expiration time.Duration) *Cmd
- func (db *Redis) HMSetMapInfo(ctx context.Context, key string, values map[string]interface{}) *BoolCmd
- func (db *Redis) HScanIter(key, match string, count int64) *ScansCmd
- func (db *Redis) HSetEX(key, field string, value interface{}, expiration time.Duration) *Cmd
- func (db *Redis) IsReady(ctx context.Context) bool
- func (db *Redis) LPushTrim(key string, length int64, values ...interface{}) *Cmd
- func (db *Redis) RPushTrim(key string, length int64, values ...interface{}) *Cmd
- func (db *Redis) SScanIter(key, match string, count int64) *ScansCmd
- func (db *Redis) ScanIter(pattern string, count int64) *ScansCmd
- func (r *Redis) SetIdleTimeout(value time.Duration)
- func (r *Redis) SetMaxActive(value int)
- func (r *Redis) SetMaxConnLifetime(value time.Duration)
- func (r *Redis) SetMaxIdle(value int)
- func (db *Redis) ZAddRemByRank(key string, length int64, members ...Z) *Cmd
- func (db *Redis) ZScanIter(key, match string, count int64) *ScansCmd
- type ScanCmd
- type ScansCmd
- type Z
Constants ¶
const ( DefaultGroupName = "default" // Default configuration group name. DefaultRedisPort = 6379 // Default redis port configuration if not passed. DefaultMaxActive = 50 // Default redis max active connections. )
Variables ¶
This section is empty.
Functions ¶
func ClearConfig ¶
func ClearConfig()
ClearConfig removes all configurations and instances of redis.
func RemoveConfig ¶
func RemoveConfig(name ...string)
RemoveConfig removes the global configuration with specified group. If <name> is not passed, it removes configuration of the default group name.
func SetConfig ¶
SetConfig sets the global configuration for specified group. If <name> is not passed, it sets configuration for the default group name.
func SetConfigByStr ¶
SetConfigByStr sets the global configuration for specified group with string. If <name> is not passed, it sets configuration for the default group name.
Types ¶
type Config ¶
type Config struct {
Host string
Port int
Db int
Pass string // Password for AUTH.
MaxIdle int // Maximum number of connections allowed to be idle (default is 10)
MaxActive int // Maximum number of connections limit (default is 0 means no limit).
IdleTimeout time.Duration // Maximum idle time for connection (default is 10 seconds, not allowed to be set to 0)
MaxConnLifetime time.Duration // Maximum lifetime of the connection (default is 30 seconds, not allowed to be set to 0)
ConnectTimeout time.Duration // Dial connection timeout.
TLS bool // Specifies the config to use when a TLS connection is dialed.
TLSSkipVerify bool // Disables server name verification when connecting over TLS
}
Redis configuration.
func ConfigFromStr ¶
ConfigFromStr parses and returns config from given str. Eg: host:port[,db,pass?maxIdle=x&maxActive=x&idleTimeout=x&maxConnLifetime=x]
type Redis ¶
type Redis struct {
// contains filtered or unexported fields
}
Redis client.
func Instance ¶
Instance returns an instance of redis client with specified group. The <name> param is unnecessary, if <name> is not passed, it returns a redis instance with default configuration group.
func New ¶
New creates a redis client object with given configuration. Redis client maintains a connection pool automatically.
func NewFromStr ¶
NewFromStr creates a redis client object with given configuration string. Redis client maintains a connection pool automatically. The parameter <str> like: 127.0.0.1:6379,0 127.0.0.1:6379,0,password
func (*Redis) AddHMObject ¶
AddHMObject add an object to a hash map table. It returns an error if occurs.
func (*Redis) AddObject ¶
func (db *Redis) AddObject(ctx context.Context, key string, value interface{}, duration time.Duration) error
AddObject add object for a key. It returns an error if occurs.
func (*Redis) Close ¶
Close closes the redis connection pool, it will release all connections reserved by this pool. It is not necessary to call Close manually.
func (*Redis) DeleteHMObject ¶
DeleteHMObject delete an object from a hash map table. It returns an error if occurs.
func (*Redis) DeleteObject ¶
DeleteObject delete object from key. It returns an error if occurs.
func (*Redis) GetAllHMObjects ¶
GetAllHMObjects get all objects from a hash map table. It returns the objects and an error if occurs.
func (*Redis) GetHMObject ¶
GetHMObject get an object from a hash map table. It returns an error if occurs.
func (*Redis) HMSetMapInfo ¶ added in v0.0.11
func (*Redis) SetIdleTimeout ¶
SetIdleTimeout sets the IdleTimeout attribute of the connection pool. It closes connections after remaining idle for this duration. If the value is zero, then idle connections are not closed. Applications should set the timeout to a value less than the server's timeout.
func (*Redis) SetMaxActive ¶
SetMaxActive sets the maximum number of connections allocated by the pool at a given time. When zero, there is no limit on the number of connections in the pool.
Note that if the pool is at the MaxActive limit, then all the operations will wait for a connection to be returned to the pool before returning.
func (*Redis) SetMaxConnLifetime ¶
SetMaxConnLifetime sets the MaxConnLifetime attribute of the connection pool. It closes connections older than this duration. If the value is zero, then the pool does not close connections based on age.
func (*Redis) SetMaxIdle ¶
SetMaxIdle sets the maximum number of idle connections in the pool.
func (*Redis) ZAddRemByRank ¶
ZAddRemByRank 向zset中插入成员并剪切，并截取只保留分数最高的length个成员
Source Files