redisKit

package

v0.2.15 Latest Latest Go to latest Published: Apr 7, 2024 License: MIT Imports: 10 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/xingcxb/goKit

Links

Open Source Insights

Documentation ¶

Overview ¶

Package redisKit redis连接信息

Package redisKit Redis 字符串(Hash)

Package redisKit Redis 字符串(String)

Index ¶

Variables
func ChangeDb(ctx context.Context, dbId int) error
func Decr(ctx context.Context, key string) (int64, error)
func GetBaseAllInfo(ctx context.Context) map[string]string
func GetDbCount(ctx context.Context, dbId int) int
func GetDbKeys(ctx context.Context, cursor uint64) ([]string, error)
func GetKeyInfo(ctx context.Context, key string) (string, error)
func GetList(ctx context.Context, key string) []string
func GetRange(ctx context.Context, key string, start, end int64) (string, error)
func GetSet(ctx context.Context, key, newValue string) (string, error)
func GetStr(ctx context.Context, key string) (string, error)
func GetTTL(ctx context.Context, key string) string
func GetType(ctx context.Context, key string) string
func HMGet(ctx context.Context, key string, fields ...string) (interface{}, error)
func HMSet(ctx context.Context, key string, value ...interface{}) (bool, error)
func Incr(ctx context.Context, key string) (int64, error)
func Incrby(ctx context.Context, key string, value interface{}) (interface{}, error)
func NewRedisClient(config *RedisConfig) error
func Ping(ctx context.Context) error
func SetNX(ctx context.Context, key, value string, seconds int) (bool, error)
func SetRange(ctx context.Context, key, replaceValue string, start int64) (bool, error)
func SetStr(ctx context.Context, key, value string) (bool, error)
func SetStrEX(ctx context.Context, key, value string, seconds int) (bool, error)
func StrLen(ctx context.Context, key string) (int64, error)
type RedisConfig
type VObj

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	Rdb *redis.Client
)

Functions ¶

func ChangeDb ¶

func ChangeDb(ctx context.Context, dbId int) error

ChangeDb 切换Redis数据库

@param ctx 上下文
@param dbId redis数据库id

func Decr ¶

func Decr(ctx context.Context, key string) (int64, error)

Decr 将 key 中储存的数字值减一 *

@param key 键
@return 返回减少后的值，错误信息

func GetBaseAllInfo ¶

func GetBaseAllInfo(ctx context.Context) map[string]string

GetBaseAllInfo 获取redis基础信息

@param ctx 上下文
@return 返回redis的基础信息

func GetDbCount ¶

func GetDbCount(ctx context.Context, dbId int) int

GetDbCount 获取单个库的数量

@param ctx 上下文
@param dbId redis数据库id
@return 返回该库下的数量

func GetDbKeys ¶

func GetDbKeys(ctx context.Context, cursor uint64) ([]string, error)

GetDbKeys 获取指定库中的key

@param ctx 上下文
@param cursor 游标

func GetKeyInfo ¶

func GetKeyInfo(ctx context.Context, key string) (string, error)

GetKeyInfo 通过key获取该键下值的所有信息

@param ctx 上下文
@param key 键
@return 返回值的所有信息,如果获取失败，返回错误信息

func GetList ¶

func GetList(ctx context.Context, key string) []string

GetList 获取redis list类型的数据，返回值和大小

@param ctx 上下文
@param key 键
@return 返回值和大小

func GetRange ¶

func GetRange(ctx context.Context, key string, start, end int64) (string, error)

GetRange 返回 key 中字符串值的子字符 *

@param key 键
@param start 起始下标
@param end 结束下标
@return 返回值，错误信息

func GetSet ¶

func GetSet(ctx context.Context, key, newValue string) (string, error)

GetSet 将给定 key 的值设为 value ，并返回 key 的旧值(old value) *

@param key 键
@param newValue 新值
@return 返回值，错误信息

func GetStr ¶

func GetStr(ctx context.Context, key string) (string, error)

GetStr 获取redis string类型的数据 *

@param key 键
@return 返回值，错误信息

func GetTTL ¶

func GetTTL(ctx context.Context, key string) string

GetTTL 获取redis数据剩余时间，返回剩余时间的秒数；如果是永久有效，返回-1

@param ctx 上下文
@param key 键

func GetType ¶

func GetType(ctx context.Context, key string) string

GetType 获取值类型，返回类型

@param ctx 上下文
@param key 键
@return 返回值的类型

func HMGet ¶

func HMGet(ctx context.Context, key string, fields ...string) (interface{}, error)

HMGet 同时将多个 field-value (域-值)对设置到哈希表 key 中 *

@param key 键
@param fields... 值
@return 返回的值

func HMSet ¶

func HMSet(ctx context.Context, key string, value ...interface{}) (bool, error)

HMSet 同时将多个 field-value (域-值)对设置到哈希表 key 中 *

@param key 键
@param value... 值
@return 返回的值

func Incr ¶

func Incr(ctx context.Context, key string) (int64, error)

Incr 将 key 中储存的数字值增1 *

@param key 键
@return 返回增加后的值，错误信息

func Incrby ¶

func Incrby(ctx context.Context, key string, value interface{}) (interface{}, error)

Incrby 将 key 中储存的数字值增加指定的数 *

@param key 键
@param value 类型仅仅支持浮点和整数
@return 返回增加后的值，错误信息

func NewRedisClient ¶

func NewRedisClient(config *RedisConfig) error

NewRedisClient *新建一个redis客户端

注意：Timeout的单位是s，默认超时时间为1s
@param config redis配置文件

func Ping ¶

func Ping(ctx context.Context) error

Ping redis测试是否联通

@param ctx 上下文
@return 正常返回nil，错误返回错误信息

func SetNX ¶

func SetNX(ctx context.Context, key, value string, seconds int) (bool, error)

SetNX （SET if Not eXists）只有在 key 不存在时设置 key 的值 *

@param key 键
@param value 值
@param seconds 数据存活时间，当值为-1或0时为永久有效

@return 返回成功还是失败，错误信息

func SetRange ¶

func SetRange(ctx context.Context, key, replaceValue string, start int64) (bool, error)

SetRange 用 value 参数覆写给定 key 所储存的字符串值，从偏移量 offset 开始 *

@param key 键
@param replaceValue 替换字符串
@param start 替换开始的下标

@return 返回成功还是失败，错误信息

func SetStr ¶

func SetStr(ctx context.Context, key, value string) (bool, error)

SetStr 设置redis中的值，该值永久有效 *

@param key 键
@param value 值
@return 返回成功还是失败，错误信息

func SetStrEX ¶

func SetStrEX(ctx context.Context, key, value string, seconds int) (bool, error)

SetStrEX 设置redis中的值 *

@param key 键
@param value 值
@param seconds 数据存活时间，当值为-1或0时为永久有效

@return 返回成功还是失败，错误信息

func StrLen ¶

func StrLen(ctx context.Context, key string) (int64, error)

StrLen 返回 key 所储存的字符串值的长度 *

@param key 键
@return 返回字符串的长度

Types ¶

type RedisConfig ¶

type RedisConfig struct {
	Addr     string //redis链接地址
	Username string //用户名
	Password string //密码
	Port     string `default:"6379"` //端口号
	Db       int    `default:"0"`    //操作数据库
	Timeout  int    `default:"10"`   // 超时时间单位s
	PoolSize int    `default:"10"`   // 连接池大小
}

RedisConfig redis连接信息

type VObj ¶

type VObj struct {
	Size  int    `json:"size"`  //值的大小
	Value string `json:"value"` //值的内容
	Ttl   string `json:"ttl"`   //过期时间
	Type  string `json:"type"`  //值的类型
}

VObj 值信息

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL