Documentation ¶
Index ¶
- func Init(conf *gjson.Result) error
- type GeoOptions
- type GeoResult
- type Redis
- func (r *Redis) BLPop(key string, timeout int) (interface{}, error)
- func (r *Redis) BLPopBool(key string, timeout int) (bool, error)
- func (r *Redis) BLPopInt(key string, timeout int) (int, error)
- func (r *Redis) BLPopInt64(key string, timeout int) (int64, error)
- func (r *Redis) BLPopObject(key string, timeout int, val interface{}) error
- func (r *Redis) BLPopString(key string, timeout int) (string, error)
- func (r *Redis) BRPop(key string, timeout int) (interface{}, error)
- func (r *Redis) BRPopBool(key string, timeout int) (bool, error)
- func (r *Redis) BRPopInt(key string, timeout int) (int, error)
- func (r *Redis) BRPopInt64(key string, timeout int) (int64, error)
- func (r *Redis) BRPopObject(key string, timeout int, val interface{}) error
- func (r *Redis) BRPopString(key string, timeout int) (string, error)
- func (r *Redis) Bool(reply interface{}, err error) (bool, error)
- func (r *Redis) Decr(key string) (val int64, err error)
- func (r *Redis) DecrBy(key string, amount int64) (val int64, err error)
- func (r *Redis) Del(key string) error
- func (r *Redis) Do(commandName string, args ...interface{}) (reply interface{}, err error)
- func (r *Redis) Exists(key string) (bool, error)
- func (r *Redis) Expire(key string, expire int64) error
- func (r *Redis) Float64(reply interface{}, err error) (float64, error)
- func (r *Redis) Flush() error
- func (r *Redis) GeoAdd(key string, longitude, latitude float64, member string) error
- func (r *Redis) GeoDist(key string, member1, member2, unit string) (float64, error)
- func (r *Redis) GeoHash(key string, members ...interface{}) ([]string, error)
- func (r *Redis) GeoPos(key string, members ...interface{}) ([]*[2]float64, error)
- func (r *Redis) GeoRadius(key string, longitude, latitude, radius float64, unit string, ...) ([]*GeoResult, error)
- func (r *Redis) GeoRadiusByMember(key string, member string, radius float64, unit string, options GeoOptions) ([]*GeoResult, error)
- func (r *Redis) Get(key string) (interface{}, error)
- func (r *Redis) GetBool(key string) (bool, error)
- func (r *Redis) GetInt(key string) (int, error)
- func (r *Redis) GetInt64(key string) (int64, error)
- func (r *Redis) GetObject(key string, val interface{}) error
- func (r *Redis) GetString(key string) (string, error)
- func (r *Redis) HGet(key, field string) (reply interface{}, err error)
- func (r *Redis) HGetAll(key string, val interface{}) error
- func (r *Redis) HGetBool(key, field string) (reply bool, err error)
- func (r *Redis) HGetInt(key, field string) (reply int, err error)
- func (r *Redis) HGetInt64(key, field string) (reply int64, err error)
- func (r *Redis) HGetObject(key, field string, val interface{}) error
- func (r *Redis) HGetString(key, field string) (reply string, err error)
- func (r *Redis) HMSet(key string, val interface{}, expire int) (err error)
- func (r *Redis) HSet(key, field string, val interface{}) (interface{}, error)
- func (r *Redis) Incr(key string) (val int64, err error)
- func (r *Redis) IncrBy(key string, amount int64) (val int64, err error)
- func (r *Redis) Int(reply interface{}, err error) (int, error)
- func (r *Redis) Int64(reply interface{}, err error) (int64, error)
- func (r *Redis) LLen(key string) (int64, error)
- func (r *Redis) LPop(key string) (interface{}, error)
- func (r *Redis) LPopBool(key string) (bool, error)
- func (r *Redis) LPopInt(key string) (int, error)
- func (r *Redis) LPopInt64(key string) (int64, error)
- func (r *Redis) LPopObject(key string, val interface{}) error
- func (r *Redis) LPopString(key string) (string, error)
- func (r *Redis) LPush(key string, member interface{}) error
- func (r *Redis) LREM(key string, count int, member interface{}) (int, error)
- func (r *Redis) LRange(key string, start, end int) (interface{}, error)
- func (r *Redis) Publish(channel, message string) (int, error)
- func (r *Redis) RPop(key string) (interface{}, error)
- func (r *Redis) RPopBool(key string) (bool, error)
- func (r *Redis) RPopInt(key string) (int, error)
- func (r *Redis) RPopInt64(key string) (int64, error)
- func (r *Redis) RPopObject(key string, val interface{}) error
- func (r *Redis) RPopString(key string) (string, error)
- func (r *Redis) RPush(key string, member interface{}) error
- func (r *Redis) Set(key string, val interface{}, expire int64) error
- func (r *Redis) String(reply interface{}, err error) (string, error)
- func (r *Redis) Strings(reply interface{}, err error) ([]string, error)
- func (r *Redis) Subscribe(onMessage func(channel string, data []byte) error, channels ...string) error
- func (r *Redis) TTL(key string) (ttl int64, err error)
- func (r *Redis) ZAdd(key string, score int64, member string) (reply interface{}, err error)
- func (r *Redis) ZRange(key string, from, to int64) (map[string]int64, error)
- func (r *Redis) ZRangeByScore(key string, from, to, offset int64, count int) (map[string]int64, error)
- func (r *Redis) ZRank(key, member string) (int64, error)
- func (r *Redis) ZRem(key string, member string) (reply interface{}, err error)
- func (r *Redis) ZRevrange(key string, from, to int64) (map[string]int64, error)
- func (r *Redis) ZRevrangeByScore(key string, from, to, offset int64, count int) (map[string]int64, error)
- func (r *Redis) ZRevrank(key, member string) (int64, error)
- func (r *Redis) ZScore(key string, member string) (int64, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type GeoOptions ¶
type GeoOptions struct { WithCoord bool WithDist bool WithHash bool Order string // ASC从近到远,DESC从远到近 Count int }
GeoOptions 用于GEORADIUS和GEORADIUSBYMEMBER命令的参数
type Redis ¶
type Redis struct {
// contains filtered or unexported fields
}
func (*Redis) BLPop ¶
BLPop 它是 LPOP 命令的阻塞版本,当给定列表内没有任何元素可供弹出的时候,连接将被 BLPOP 命令阻塞,直到等待超时或发现可弹出元素为止。 超时参数 timeout 接受一个以秒为单位的数字作为值。超时参数设为 0 表示阻塞时间可以无限期延长(block indefinitely) 。
func (*Redis) BLPopInt64 ¶
BLPopInt64 BLPop的工具方法,元素类型为int64时
func (*Redis) BLPopObject ¶
BLPopObject BLPop的工具方法,元素类型为object时
func (*Redis) BLPopString ¶
BLPopString BLPop的工具方法,元素类型为string时
func (*Redis) BRPop ¶
BRPop 它是 RPOP 命令的阻塞版本,当给定列表内没有任何元素可供弹出的时候,连接将被 BRPOP 命令阻塞,直到等待超时或发现可弹出元素为止。 超时参数 timeout 接受一个以秒为单位的数字作为值。超时参数设为 0 表示阻塞时间可以无限期延长(block indefinitely) 。
func (*Redis) BRPopInt64 ¶
BRPopInt64 BRPop的工具方法,元素类型为int64时
func (*Redis) BRPopObject ¶
BRPopObject BRPop的工具方法,元素类型为object时
func (*Redis) BRPopString ¶
BRPopString BRPop的工具方法,元素类型为string时
func (*Redis) GeoDist ¶
GeoDist 返回两个给定位置之间的距离。 如果两个位置之间的其中一个不存在, 那么命令返回空值。 指定单位的参数 unit 必须是以下单位的其中一个: m 表示单位为米。 km 表示单位为千米。 mi 表示单位为英里。 ft 表示单位为英尺。 如果用户没有显式地指定单位参数, 那么 GEODIST 默认使用米作为单位。
func (*Redis) GeoRadius ¶
func (r *Redis) GeoRadius(key string, longitude, latitude, radius float64, unit string, options GeoOptions) ([]*GeoResult, error)
GeoRadius 以给定的经纬度为中心, 返回键包含的位置元素当中, 与中心的距离不超过给定最大距离的所有位置元素。
func (*Redis) GeoRadiusByMember ¶
func (r *Redis) GeoRadiusByMember(key string, member string, radius float64, unit string, options GeoOptions) ([]*GeoResult, error)
GeoRadiusByMember 这个命令和 GEORADIUS 命令一样, 都可以找出位于指定范围内的元素, 但是 GEORADIUSBYMEMBER 的中心点是由给定的位置元素决定的, 而不是像 GEORADIUS 那样, 使用输入的经度和纬度来决定中心点。
func (*Redis) Get ¶
Get 获取键值。一般不直接使用该值,而是配合下面的工具类方法获取具体类型的值,或者直接使用github.com/gomodule/redigo/redis包的工具方法。
func (*Redis) HGetObject ¶
HGetObject HGet的工具方法,当字段值为非基本类型的stuct时使用
func (*Redis) HGetString ¶
HGetString HGet的工具方法,当字段值为字符串类型时使用
func (*Redis) HMSet ¶
HMSet 将一个map存到Redis hash,同时设置有效期,单位:秒 Example:
```golang m := make(map[string]interface{}) m["name"] = "corel" m["age"] = 23 err := r.HMSet("user", m, 10) ```
func (*Redis) HSet ¶
HSet 将哈希表 key 中的字段 field 的值设为 val Example:
```golang _, err := r.HSet("user", "age", 23) ```
func (*Redis) LPopObject ¶
LPopObject 移出并获取列表中的第一个元素(表头,左边),元素类型为非基本类型的struct
func (*Redis) LPopString ¶
LPopString 移出并获取列表中的第一个元素(表头,左边),元素类型为string
func (*Redis) LREM ¶
LREM 根据参数 count 的值,移除列表中与参数 member 相等的元素。 count 的值可以是以下几种: count > 0 : 从表头开始向表尾搜索,移除与 member 相等的元素,数量为 count 。 count < 0 : 从表尾开始向表头搜索,移除与 member 相等的元素,数量为 count 的绝对值。 count = 0 : 移除表中所有与 member 相等的值。 返回值:被移除元素的数量。
func (*Redis) LRange ¶
LRange 返回列表 key 中指定区间内的元素,区间以偏移量 start 和 stop 指定。 下标(index)参数 start 和 stop 都以 0 为底,也就是说,以 0 表示列表的第一个元素,以 1 表示列表的第二个元素,以此类推。 你也可以使用负数下标,以 -1 表示列表的最后一个元素, -2 表示列表的倒数第二个元素,以此类推。 和编程语言区间函数的区别:end 下标也在 LRANGE 命令的取值范围之内(闭区间)。
func (*Redis) RPopObject ¶
RPopObject 移出并获取列表中的最后一个元素(表尾,右边),元素类型为非基本类型的struct
func (*Redis) RPopString ¶
RPopString 移出并获取列表中的最后一个元素(表尾,右边),元素类型为string
func (*Redis) Subscribe ¶
func (r *Redis) Subscribe(onMessage func(channel string, data []byte) error, channels ...string) error
Subscribe 订阅给定的一个或多个频道的信息。 支持redis服务停止或网络异常等情况时,自动重新订阅。 一般的程序都是启动后开启一些固定channel的订阅,也不会动态的取消订阅,这种场景下可以使用本方法。 复杂场景的使用可以直接参考 https://godoc.org/github.com/gomodule/redigo/redis#hdr-Publish_and_Subscribe
func (*Redis) ZRange ¶
ZRange 返回有序集中,指定区间内的成员。其中成员的位置按分数值递增(从小到大)来排序。具有相同分数值的成员按字典序(lexicographical order )来排列。 以 0 表示有序集第一个成员,以 1 表示有序集第二个成员,以此类推。或 以 -1 表示最后一个成员, -2 表示倒数第二个成员,以此类推。
func (*Redis) ZRangeByScore ¶
func (r *Redis) ZRangeByScore(key string, from, to, offset int64, count int) (map[string]int64, error)
ZRangeByScore 返回有序集合中指定分数区间的成员列表。有序集成员按分数值递增(从小到大)次序排列。 具有相同分数值的成员按字典序来排列
func (*Redis) ZRevrange ¶
ZRevrange 返回有序集中,指定区间内的成员。其中成员的位置按分数值递减(从大到小)来排列。具有相同分数值的成员按字典序(lexicographical order )来排列。 以 0 表示有序集第一个成员,以 1 表示有序集第二个成员,以此类推。或 以 -1 表示最后一个成员, -2 表示倒数第二个成员,以此类推。
func (*Redis) ZRevrangeByScore ¶
func (r *Redis) ZRevrangeByScore(key string, from, to, offset int64, count int) (map[string]int64, error)
ZRevrangeByScore 返回有序集中指定分数区间内的所有的成员。有序集成员按分数值递减(从大到小)的次序排列。 具有相同分数值的成员按字典序来排列