key_helper

package
v1.1.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 21, 2026 License: MIT Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type KeyHelper 

type KeyHelper struct {
	*base.Base
}

KeyHelper Redis String类型助手类

func NewKeyHelper 

func NewKeyHelper(b *base.Base) *KeyHelper

NewKeyHelper 实例化

func (KeyHelper) ClearAllDatabases added in v1.1.0 

func (s KeyHelper) ClearAllDatabases() (v *gvar.Var, err error)

ClearAllDatabases 清空所有数据库（谨慎使用）

func (KeyHelper) ClearDatabase added in v1.1.0 

func (s KeyHelper) ClearDatabase() (v *gvar.Var, err error)

ClearDatabase 清空当前数据库（谨慎使用）

func (KeyHelper) Copy added in v1.1.0 

func (s KeyHelper) Copy(sourceKey, destinationKey string, replace bool) (v *gvar.Var, err error)

Copy 将key复制到另一个key（Redis 6.2+）

func (KeyHelper) Del 

func (s KeyHelper) Del(key string) (v *gvar.Var, err error)

func (KeyHelper) DelM 

func (s KeyHelper) DelM(keys []string) (v *gvar.Var, err error)

func (KeyHelper) DelOnlyError 

func (s KeyHelper) DelOnlyError(key string) (err error)

func (KeyHelper) DelWithPrefix added in v1.1.0 

func (s KeyHelper) DelWithPrefix(key string) (v *gvar.Var, err error)

DelWithPrefix 删除带前缀的key

func (KeyHelper) DeleteByPattern added in v1.1.0 

func (s KeyHelper) DeleteByPattern(pattern string) (deletedCount int64, err error)

DeleteByPattern 根据模式删除所有匹配的key

func (KeyHelper) Dump added in v1.1.0 

func (s KeyHelper) Dump(key string) (v *gvar.Var, err error)

Dump 序列化给定 key ，并返回被序列化的值

func (KeyHelper) Exists 

func (s KeyHelper) Exists(key string) (v *gvar.Var, err error)

func (KeyHelper) ExistsBool added in v1.0.19 

func (s KeyHelper) ExistsBool(key string) (b bool, err error)

func (KeyHelper) ExistsM added in v1.1.0 

func (s KeyHelper) ExistsM(keys []string) (count int64, err error)

ExistsM 检查多个key是否存在，返回存在的数量

func (KeyHelper) ExistsNoError 

func (s KeyHelper) ExistsNoError(key string) (v *gvar.Var)

func (KeyHelper) ExistsWithPrefix added in v1.1.0 

func (s KeyHelper) ExistsWithPrefix(key string) (v *gvar.Var, err error)

ExistsWithPrefix 检查带前缀的key是否存在

func (KeyHelper) Expire added in v1.0.16 

func (s KeyHelper) Expire(key string, seconds time.Duration) (v *gvar.Var, err error)

func (KeyHelper) ExpireAt added in v1.0.18 

func (s KeyHelper) ExpireAt(key string, timestamp time.Time) (v *gvar.Var, err error)

func (KeyHelper) ExpireTime added in v1.1.0 

func (s KeyHelper) ExpireTime(key string) (v *gvar.Var, err error)

ExpireTime 获取key的过期时间戳（秒）（Redis 7.0+）

func (KeyHelper) GetEncoding added in v1.1.0 

func (s KeyHelper) GetEncoding(key string) (v *gvar.Var, err error)

GetEncoding 获取key的内部编码

func (KeyHelper) GetFrequency added in v1.1.0 

func (s KeyHelper) GetFrequency(key string) (v *gvar.Var, err error)

GetFrequency 获取key的访问频率（Redis 4.0+）

func (KeyHelper) GetIdleTime added in v1.1.0 

func (s KeyHelper) GetIdleTime(key string) (v *gvar.Var, err error)

GetIdleTime 获取key的空闲时间（秒）

func (KeyHelper) GetKeysByPattern added in v1.1.0 

func (s KeyHelper) GetKeysByPattern(pattern string) (keys []string, err error)

GetKeysByPattern 根据模式获取所有匹配的key（使用SCAN替代KEYS，避免阻塞）

func (KeyHelper) GetKeysCountByPattern added in v1.1.0 

func (s KeyHelper) GetKeysCountByPattern(pattern string) (count int64, err error)

GetKeysCountByPattern 根据模式获取匹配的key数量

func (KeyHelper) GetRefCount added in v1.1.0 

func (s KeyHelper) GetRefCount(key string) (v *gvar.Var, err error)

GetRefCount 获取key的引用计数

func (KeyHelper) GetTtlInMillis added in v1.1.0 

func (s KeyHelper) GetTtlInMillis(key string) (ttl int64, err error)

GetTtlInMillis 获取key的剩余生存时间（毫秒）

func (KeyHelper) GetTtlInSeconds added in v1.1.0 

func (s KeyHelper) GetTtlInSeconds(key string) (ttl int64, err error)

GetTtlInSeconds 获取key的剩余生存时间（秒），key不存在返回-2，永久key返回-1

func (KeyHelper) GetTypeString added in v1.1.0 

func (s KeyHelper) GetTypeString(key string) (typeStr string, err error)

GetTypeString 获取key的类型（字符串形式）

func (KeyHelper) IsExpired added in v1.1.0 

func (s KeyHelper) IsExpired(key string) (expired bool, err error)

IsExpired 检查key是否已过期（TTL <= 0）

func (KeyHelper) IsHash added in v1.1.0 

func (s KeyHelper) IsHash(key string) (bool, error)

IsHash 检查key是否为hash类型

func (KeyHelper) IsList added in v1.1.0 

func (s KeyHelper) IsList(key string) (bool, error)

IsList 检查key是否为list类型

func (KeyHelper) IsPermanent added in v1.1.0 

func (s KeyHelper) IsPermanent(key string) (permanent bool, err error)

IsPermanent 检查key是否为永久key（无过期时间）

func (KeyHelper) IsSet added in v1.1.0 

func (s KeyHelper) IsSet(key string) (bool, error)

IsSet 检查key是否为set类型

func (KeyHelper) IsString added in v1.1.0 

func (s KeyHelper) IsString(key string) (bool, error)

IsString 检查key是否为string类型

func (KeyHelper) IsType added in v1.1.0 

func (s KeyHelper) IsType(key, expectedType string) (isType bool, err error)

IsType 检查key是否为指定类型

func (KeyHelper) IsZSet added in v1.1.0 

func (s KeyHelper) IsZSet(key string) (bool, error)

IsZSet 检查key是否为zset类型

func (KeyHelper) Keys added in v1.1.0 

func (s KeyHelper) Keys(pattern string) (v *gvar.Var, err error)

Keys 查找所有符合给定模式 pattern 的 key（谨慎使用，生产环境建议用Scan）

func (KeyHelper) Migrate added in v1.1.0 

func (s KeyHelper) Migrate(host string, port int, key string, destinationDb int, timeout time.Duration) (v *gvar.Var, err error)

Migrate 将 key 原子性地从当前实例传送到目标实例的指定数据库上

func (KeyHelper) MigrateWithOptions added in v1.1.0 

func (s KeyHelper) MigrateWithOptions(host string, port int, key string, destinationDb int, timeout time.Duration, options ...interface{}) (v *gvar.Var, err error)

MigrateWithOptions 带有选项的迁移命令 options: COPY, REPLACE, AUTH, AUTH2

func (KeyHelper) Move added in v1.1.0 

func (s KeyHelper) Move(key string, db int) (v *gvar.Var, err error)

Move 将当前数据库的 key 移动到给定的数据库 db 当中

func (KeyHelper) Object added in v1.1.0 

func (s KeyHelper) Object(subcommand, key string) (v *gvar.Var, err error)

Object 允许从内部察看给定 key 的 Redis 对象 subcommand: REFCOUNT, ENCODING, IDLETIME, FREQ

func (KeyHelper) PExpire added in v1.1.0 

func (s KeyHelper) PExpire(key string, milliseconds time.Duration) (v *gvar.Var, err error)

PExpire 以毫秒为单位设置 key 的过期时间

func (KeyHelper) PExpireAt added in v1.1.0 

func (s KeyHelper) PExpireAt(key string, timestamp time.Time) (v *gvar.Var, err error)

PExpireAt 以毫秒为单位设置 key 的过期 Unix 时间戳

func (KeyHelper) PExpireTime added in v1.1.0 

func (s KeyHelper) PExpireTime(key string) (v *gvar.Var, err error)

PExpireTime 获取key的过期时间戳（毫秒）（Redis 7.0+）

func (KeyHelper) PTtl added in v1.1.0 

func (s KeyHelper) PTtl(key string) (v *gvar.Var, err error)

PTtl 以毫秒为单位返回 key 的剩余过期时间

func (KeyHelper) Persist added in v1.0.18 

func (s KeyHelper) Persist(key string) (v *gvar.Var, err error)

func (KeyHelper) RandomKey added in v1.1.0 

func (s KeyHelper) RandomKey() (v *gvar.Var, err error)

RandomKey 从当前数据库中随机返回一个 key

func (KeyHelper) Rename added in v1.1.0 

func (s KeyHelper) Rename(oldKey, newKey string) (v *gvar.Var, err error)

Rename 修改 key 的名称

func (KeyHelper) RenameNx added in v1.1.0 

func (s KeyHelper) RenameNx(oldKey, newKey string) (v *gvar.Var, err error)

RenameNx 仅当 newkey 不存在时，将 key 改名为 newkey

func (KeyHelper) RenameWithPrefix added in v1.1.0 

func (s KeyHelper) RenameWithPrefix(oldKey, newKey string) (v *gvar.Var, err error)

RenameWithPrefix 重命名key，自动添加前缀

func (KeyHelper) Restore added in v1.1.0 

func (s KeyHelper) Restore(key string, ttl time.Duration, serializedValue string) (v *gvar.Var, err error)

Restore 反序列化给定的序列化值，并将它和给定的 key 关联

func (KeyHelper) Scan 

func (s KeyHelper) Scan(key string, callback func(keys []string) error, count ...int) (err error)

Scan 批量获取key 【注意】key里需要有通配符 比如：a:*

func (KeyHelper) ScanOnce added in v1.1.0 

func (s KeyHelper) ScanOnce(cursor int64, pattern string, count int64) (v *gvar.Var, err error)

ScanOnce 执行一次扫描，返回下一个游标和当前扫描结果

func (KeyHelper) SetExpireInDays added in v1.1.0 

func (s KeyHelper) SetExpireInDays(key string, days int64) (v *gvar.Var, err error)

SetExpireInDays 设置过期时间（天）

func (KeyHelper) SetExpireInHours added in v1.1.0 

func (s KeyHelper) SetExpireInHours(key string, hours int64) (v *gvar.Var, err error)

SetExpireInHours 设置过期时间（小时）

func (KeyHelper) SetExpireInMinutes added in v1.1.0 

func (s KeyHelper) SetExpireInMinutes(key string, minutes int64) (v *gvar.Var, err error)

SetExpireInMinutes 设置过期时间（分钟）

func (KeyHelper) SetExpireInSeconds added in v1.1.0 

func (s KeyHelper) SetExpireInSeconds(key string, seconds int64) (v *gvar.Var, err error)

SetExpireInSeconds 设置过期时间（秒）

func (KeyHelper) Sort added in v1.1.0 

func (s KeyHelper) Sort(key string, options ...interface{}) (v *gvar.Var, err error)

Sort 返回或保存给定列表、集合、有序集合 key 中经过排序的元素

func (KeyHelper) SortStore added in v1.1.0 

func (s KeyHelper) SortStore(key, storeKey string, options ...interface{}) (v *gvar.Var, err error)

SortStore 对 key 进行排序，并将结果存储到 storeKey 中

func (KeyHelper) Touch added in v1.1.0 

func (s KeyHelper) Touch(keys ...string) (v *gvar.Var, err error)

Touch 修改 key 的最后访问时间（仅当 key 存在时）

func (KeyHelper) Ttl added in v1.0.16 

func (s KeyHelper) Ttl(key string) (v *gvar.Var, err error)

func (KeyHelper) TtlInt added in v1.0.18 

func (s KeyHelper) TtlInt(key string) (ttl int64, err error)

func (KeyHelper) Type added in v1.1.0 

func (s KeyHelper) Type(key string) (v *gvar.Var, err error)

Type 返回 key 所储存的值的类型 

func (s KeyHelper) Unlink(keys ...string) (v *gvar.Var, err error)

Unlink 非阻塞删除 key（仅将 keys 从 keyspace 元数据中删除，真正的删除会在后续异步操作）

func (KeyHelper) UnlinkByPattern added in v1.1.0 

func (s KeyHelper) UnlinkByPattern(pattern string) (deletedCount int64, err error)

UnlinkByPattern 根据模式异步删除所有匹配的key

func (KeyHelper) Wait added in v1.1.0 

func (s KeyHelper) Wait(numreplicas int, timeout time.Duration) (v *gvar.Var, err error)

Wait 阻塞当前客户端，直到所有先前的写命令都成功的传输和同步到至少指定数量的副本中

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.