gredis

Documentation

Overview

Package gredis provides convenient client for redis server.

Redis Client.

Redis Commands Official: https://redis.io/commands

Redis Chinese Documentation: http://redisdoc.com/

Index

• Constants
• func ClearConfig()
• func RemoveConfig(name ...string)
• func SetConfig(config Config, name ...string)
• func SetConfigByStr(str string, name ...string) error
• type Config
  • func ConfigFromStr(str string) (config Config, err error)
  • func GetConfig(name ...string) (config Config, ok bool)
• type Conn
  • func (c *Conn) DoVar(command string, args ...interface{}) (*gvar.Var, error)
  • func (c *Conn) ReceiveVar() (*gvar.Var, error)
• type PoolStats
• type Redis
  • func Instance(name ...string) *Redis
  • func New(config Config) *Redis
  • func NewFromStr(str string) (*Redis, error)
  • func (r *Redis) Close() error
  • func (r *Redis) Conn() *Conn
  • func (r *Redis) Do(command string, args ...interface{}) (interface{}, error)
  • func (r *Redis) DoVar(command string, args ...interface{}) (*gvar.Var, error)
  • func (r *Redis) GetConn() *Conn
  • 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 (r *Redis) Stats() *PoolStats

Constants

const (
	DEFAULT_GROUP_NAME = "default" // Default configuration group name.
	DEFAULT_REDIS_PORT = 6379      // Default redis port configuration if not passed.
)

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

func SetConfig(config Config, name ...string)

SetConfig sets the global configuration for specified group. If <name> is not passed, it sets configuration for the default group name.

func SetConfigByStr

func SetConfigByStr(str string, name ...string) error

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.
}

Redis configuration.

func ConfigFromStr

func ConfigFromStr(str string) (config Config, err error)

ConfigFromStr parses and returns config from given str. Eg: host:port[,db,pass?maxIdle=x&maxActive=x&idleTimeout=x&maxConnLifetime=x]

func GetConfig

func GetConfig(name ...string) (config Config, ok bool)

GetConfig returns the global configuration with specified group name. If <name> is not passed, it returns configuration of the default group name.

type Conn

type Conn struct {
	redis.Conn
}

Redis connection.

func (*Conn) DoVar

func (c *Conn) DoVar(command string, args ...interface{}) (*gvar.Var, error)

DoVar returns value from Do as gvar.Var.

func (*Conn) ReceiveVar

func (c *Conn) ReceiveVar() (*gvar.Var, error)

ReceiveVar receives a single reply as gvar.Var from the Redis server.

type PoolStats

type PoolStats struct {
	redis.PoolStats
}

Pool statistics.

type Redis

type Redis struct {
	// contains filtered or unexported fields
}

Redis client.

func Instance

func Instance(name ...string) *Redis

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

func New(config Config) *Redis

New creates a redis client object with given configuration. Redis client maintains a connection pool automatically.

func NewFromStr

func NewFromStr(str string) (*Redis, error)

NewFromStr creates a redis client object with given configuration string. Redis client maintains a connection pool automatically.

func (*Redis) Close

func (r *Redis) Close() error

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) Conn

func (r *Redis) Conn() *Conn

Conn returns a raw underlying connection object, which expose more methods to communicate with server. **You should call Close function manually if you do not use this connection any further.**

func (*Redis) Do

func (r *Redis) Do(command string, args ...interface{}) (interface{}, error)

Do sends a command to the server and returns the received reply. Do automatically get a connection from pool, and close it when the reply received. It does not really "close" the connection, but drops it back to the connection pool.

func (*Redis) DoVar

func (r *Redis) DoVar(command string, args ...interface{}) (*gvar.Var, error)

DoVar returns value from Do as gvar.Var.

func (*Redis) GetConn

func (r *Redis) GetConn() *Conn

Alias of Conn, see Conn.

func (*Redis) SetIdleTimeout

func (r *Redis) SetIdleTimeout(value time.Duration)

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

func (r *Redis) SetMaxActive(value int)

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

func (r *Redis) SetMaxConnLifetime(value time.Duration)

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

func (r *Redis) SetMaxIdle(value int)

SetMaxIdle sets the maximum number of idle connections in the pool.

func (*Redis) Stats

func (r *Redis) Stats() *PoolStats

Stats returns pool's statistics.