redis

type ACLLogCmd ¶

type ACLLogCmd = redis.ACLLogCmd

ACLLogCmd 表示返回 ACL 日志的 Redis 命令。

type ACLLogEntry ¶

type ACLLogEntry = redis.ACLLogEntry

ACLLogEntry 表示 ACL 日志条目类型。

type BitCount ¶

type BitCount = redis.BitCount

BitCount 表示位计数参数类型。

type BoolCmd ¶

type BoolCmd = redis.BoolCmd

BoolCmd 表示返回布尔类型的 Redis 命令。

type BoolSliceCmd ¶

type BoolSliceCmd = redis.BoolSliceCmd

BoolSliceCmd 表示返回布尔切片类型的 Redis 命令。

type ClientFlags ¶

type ClientFlags = redis.ClientFlags

ClientFlags 表示客户端标志类型。

type ClientInfo ¶

type ClientInfo = redis.ClientInfo

ClientInfo 表示客户端信息类型。

type ClientInfoCmd ¶

type ClientInfoCmd = redis.ClientInfoCmd

ClientInfoCmd 表示返回客户端信息的 Redis 命令。

type ClusterLink ¶

type ClusterLink = redis.ClusterLink

ClusterLink 表示集群链接类型。

type ClusterLinksCmd ¶

type ClusterLinksCmd = redis.ClusterLinksCmd

ClusterLinksCmd 表示返回集群链接信息的 Redis 命令。

type ClusterNode ¶

type ClusterNode = redis.ClusterNode

ClusterNode 表示集群节点信息类型。

type ClusterShard ¶

type ClusterShard = redis.ClusterShard

ClusterShard 表示集群分片类型。

type ClusterShardsCmd ¶

type ClusterShardsCmd = redis.ClusterShardsCmd

ClusterShardsCmd 表示返回集群分片信息的 Redis 命令。

type ClusterSlot ¶

type ClusterSlot = redis.ClusterSlot

ClusterSlot 表示集群槽位信息类型。

type ClusterSlotsCmd ¶

type ClusterSlotsCmd = redis.ClusterSlotsCmd

ClusterSlotsCmd 表示返回集群槽位信息的 Redis 命令。

type Cmd ¶

type Cmd = redis.Cmd

Cmd 表示通用的 Redis 命令。

type Cmder ¶

type Cmder = redis.Cmder

Cmder 表示 Redis 命令的基础接口。

type CommandInfo ¶

type CommandInfo = redis.CommandInfo

CommandInfo 表示命令信息类型。

type CommandsInfoCmd ¶

type CommandsInfoCmd = redis.CommandsInfoCmd

CommandsInfoCmd 表示返回命令信息的 Redis 命令。

type DurationCmd ¶

type DurationCmd = redis.DurationCmd

DurationCmd 表示返回时间间隔类型的 Redis 命令。

type Engine ¶

type Engine = redis.Engine

Engine 表示脚本引擎类型。

type FilterBy ¶

type FilterBy = redis.FilterBy

FilterBy 表示过滤条件类型。

type FloatCmd ¶

type FloatCmd = redis.FloatCmd

FloatCmd 表示返回浮点数类型的 Redis 命令。

type FloatSliceCmd ¶

type FloatSliceCmd = redis.FloatSliceCmd

FloatSliceCmd 表示返回浮点数切片类型的 Redis 命令。

type Function ¶

type Function = redis.Function

Function 表示 Redis 函数类型。

type FunctionListCmd ¶

type FunctionListCmd = redis.FunctionListCmd

FunctionListCmd 表示返回函数列表的 Redis 命令。

type FunctionListQuery ¶

type FunctionListQuery = redis.FunctionListQuery

FunctionListQuery 表示函数列表查询参数类型。

type FunctionStats ¶

type FunctionStats = redis.FunctionStats

FunctionStats 表示函数统计信息类型。

type FunctionStatsCmd ¶

type FunctionStatsCmd = redis.FunctionStatsCmd

FunctionStatsCmd 表示返回函数统计信息的 Redis 命令。

type GeoLocation ¶

type GeoLocation = redis.GeoLocation

GeoLocation 表示地理位置信息类型。

type GeoLocationCmd ¶

type GeoLocationCmd = redis.GeoLocationCmd

GeoLocationCmd 表示返回地理位置信息的 Redis 命令。

type GeoPos ¶

type GeoPos = redis.GeoPos

GeoPos 表示地理位置坐标类型。

type GeoPosCmd ¶

type GeoPosCmd = redis.GeoPosCmd

GeoPosCmd 表示返回地理位置坐标的 Redis 命令。

type GeoRadiusQuery ¶

type GeoRadiusQuery = redis.GeoRadiusQuery

GeoRadiusQuery 表示地理位置半径查询类型。

type GeoSearchLocationCmd ¶

type GeoSearchLocationCmd = redis.GeoSearchLocationCmd

GeoSearchLocationCmd 表示返回地理位置搜索结果的 Redis 命令。

type GeoSearchLocationQuery ¶

type GeoSearchLocationQuery = redis.GeoSearchLocationQuery

GeoSearchLocationQuery 表示地理位置搜索位置查询类型。

type GeoSearchQuery ¶

type GeoSearchQuery = redis.GeoSearchQuery

GeoSearchQuery 表示地理位置搜索查询类型。

type GeoSearchStoreQuery ¶

type GeoSearchStoreQuery = redis.GeoSearchStoreQuery

GeoSearchStoreQuery 表示地理位置搜索存储查询类型。

type IntCmd ¶

type IntCmd = redis.IntCmd

IntCmd 表示返回整数类型的 Redis 命令。

type IntSliceCmd ¶

type IntSliceCmd = redis.IntSliceCmd

IntSliceCmd 表示返回整数切片类型的 Redis 命令。

type KeyFlags ¶

type KeyFlags = redis.KeyFlags

KeyFlags 表示键标志类型。

type KeyFlagsCmd ¶

type KeyFlagsCmd = redis.KeyFlagsCmd

KeyFlagsCmd 表示返回键标志的 Redis 命令。

type KeyValue ¶

type KeyValue = redis.KeyValue

KeyValue 表示键值对类型。

type KeyValueSliceCmd ¶

type KeyValueSliceCmd = redis.KeyValueSliceCmd

KeyValueSliceCmd 表示返回键值对切片类型的 Redis 命令。

type KeyValuesCmd ¶

type KeyValuesCmd = redis.KeyValuesCmd

KeyValuesCmd 表示返回键值对类型的 Redis 命令。

type LCSCmd ¶

type LCSCmd = redis.LCSCmd

LCSCmd 表示返回最长公共子序列的 Redis 命令。

type LCSMatch ¶

type LCSMatch = redis.LCSMatch

LCSMatch 表示最长公共子序列匹配类型。

type LCSMatchedPosition ¶

type LCSMatchedPosition = redis.LCSMatchedPosition

LCSMatchedPosition 表示最长公共子序列匹配位置类型。

type LCSPosition ¶

type LCSPosition = redis.LCSPosition

LCSPosition 表示最长公共子序列位置类型。

type LCSQuery ¶

type LCSQuery = redis.LCSQuery

LCSQuery 表示最长公共子序列查询类型。

type LPosArgs ¶

type LPosArgs = redis.LPosArgs

LPosArgs 表示列表位置查询参数类型。

type Library ¶

type Library = redis.Library

Library 表示 Redis 库类型。

type MapStringIntCmd ¶

type MapStringIntCmd = redis.MapStringIntCmd

MapStringIntCmd 表示返回字符串到整数映射类型的 Redis 命令。

type MapStringInterfaceCmd ¶

type MapStringInterfaceCmd = redis.MapStringInterfaceCmd

MapStringInterfaceCmd 表示返回字符串到接口映射类型的 Redis 命令。

type MapStringStringCmd ¶

type MapStringStringCmd = redis.MapStringStringSliceCmd

MapStringStringCmd 表示返回字符串到字符串映射切片类型的 Redis 命令。

type MapStringStringSliceCmd ¶

type MapStringStringSliceCmd = redis.MapStringStringSliceCmd

MapStringStringSliceCmd 表示返回字符串到字符串切片映射类型的 Redis 命令。

type Message ¶

type Message = redis.Message

Message 表示消息类型。

type ModuleLoadexConfig ¶

type ModuleLoadexConfig = redis.ModuleLoadexConfig

ModuleLoadexConfig 表示模块加载配置类型。

type Node ¶

type Node = redis.Node

Node 表示节点类型。

type Option ¶

type Option func(*redisClient)

Option 定义 NewRedis 的函数式配置项。

参数：

• *redisClient: 待修改的 Redis 客户端配置实例，调用方不应直接传入 nil。

func WithAddr(addr string) Option

func WithPassword(password string) Option

type Pipeliner ¶

type Pipeliner = redis.Pipeliner

Pipeliner 表示 Redis 管道操作接口。

type Pong ¶

type Pong = redis.Pong

Pong 表示 PING 命令响应类型。

type PubSub ¶

type PubSub = redis.PubSub

PubSub 表示发布订阅客户端类型。

type RankScore ¶

type RankScore = redis.RankScore

RankScore 表示排名分数类型。

type RankWithScoreCmd ¶

type RankWithScoreCmd = redis.RankWithScoreCmd

RankWithScoreCmd 表示返回带分数的排名的 Redis 命令。

type Redis ¶

type Redis interface {
	Scripter

	// Do 执行任意 Redis 命令。
	//
	// 参数：
	//   - ctx: 控制命令执行生命周期的上下文。
	//   - args: 命令名称及其参数，按 Redis 协议顺序传递。
	//
	// 返回：
	//   - *Cmd: 通用命令结果；执行错误由返回值的 Err 方法承载。
	Do(ctx context.Context, args ...interface{}) *Cmd

	// Pipelined 在管道中执行多个命令。
	//
	// 参数：
	//   - ctx: 控制管道执行生命周期的上下文。
	//   - fn: 向管道追加命令的回调；返回错误会中止管道执行。
	//
	// 返回：
	//   - []Cmder: 管道内各命令的执行结果，顺序与追加顺序一致；调用方仍应检查各 Cmder.Err。
	//   - error: fn 返回错误、上下文取消、网络异常或管道执行失败时返回错误。
	Pipelined(ctx context.Context, fn func(Pipeliner) error) ([]Cmder, error)

	// TxPipelined 在 Redis 事务管道中执行多个命令。
	//
	// 参数：
	//   - ctx: 控制事务管道执行生命周期的上下文。
	//   - fn: 向事务管道追加命令的回调；返回错误会中止事务管道执行。
	//
	// 返回：
	//   - []Cmder: 事务管道内各命令的执行结果，顺序与追加顺序一致；调用方仍应检查各 Cmder.Err。
	//   - error: fn 返回错误、上下文取消、网络异常或事务管道执行失败时返回错误。
	TxPipelined(ctx context.Context, fn func(Pipeliner) error) ([]Cmder, error)

	// Subscribe 订阅一个或多个 Redis 频道。
	//
	// 参数：
	//   - ctx: 控制订阅创建过程的上下文。
	//   - channels: 要订阅的频道名称列表。
	//
	// 返回：
	//   - *PubSub: 发布订阅客户端；调用方在不再接收消息时应关闭该客户端。
	Subscribe(ctx context.Context, channels ...string) *PubSub

	// PSubscribe 按模式订阅一个或多个 Redis 频道。
	//
	// 参数：
	//   - ctx: 控制订阅创建过程的上下文。
	//   - channels: 要订阅的频道模式列表。
	//
	// 返回：
	//   - *PubSub: 发布订阅客户端；调用方在不再接收消息时应关闭该客户端。
	PSubscribe(ctx context.Context, channels ...string) *PubSub

	// Close 关闭 Redis 客户端并释放底层连接资源。
	//
	// 参数：无。
	//
	// 返回：
	//   - error: 底层 go-redis 客户端关闭失败时返回错误。
	Close() error
}

Redis 定义本包暴露的 Redis 客户端基础能力。

Redis 复用 go-redis/v9 的命令结果类型，单命令执行错误通常保存在返回的 Cmd 对象中； 管道和事务管道还会通过返回的 error 承载回调、上下文或执行错误，调用方仍应检查各 Cmder.Err。Redis 实例持有底层连接资源，不再使用时应调用 Close。

func NewRedis(opts ...Option) Redis

type RedisExtension ¶

type RedisExtension interface {
	Redis

	// Get 获取指定键的值。
	//
	// 参数：
	//   - ctx: 控制命令执行生命周期的上下文。
	//   - key: 要读取的 Redis 键名。
	//
	// 返回：
	//   - *Cmd: GET 命令结果；键不存在时 Err 通常为 ErrNil。
	Get(ctx context.Context, key string) *Cmd

	// Set 设置指定键的值和可选过期时间。
	//
	// 参数：
	//   - ctx: 控制命令执行生命周期的上下文。
	//   - key: 要写入的 Redis 键名。
	//   - value: 要写入的值，编码规则由底层 go-redis 客户端决定。
	//   - expiration: 键过期时间；非正值表示不设置过期时间，整秒使用 EX，非整秒向上取整为毫秒并使用 PX。
	//
	// 返回：
	//   - *Cmd: SET 命令结果；执行错误由返回值的 Err 方法承载。
	Set(ctx context.Context, key string, value interface{}, expiration time.Duration) *Cmd

	// Del 删除指定键。
	//
	// 参数：
	//   - ctx: 控制命令执行生命周期的上下文。
	//   - key: 要删除的 Redis 键名。
	//
	// 返回：
	//   - *Cmd: DEL 命令结果；执行错误由返回值的 Err 方法承载。
	Del(ctx context.Context, key string) *Cmd

	// Expire 设置指定键的过期时间。
	//
	// 参数：
	//   - ctx: 控制命令执行生命周期的上下文。
	//   - key: 要设置过期语义的 Redis 键名。
	//   - expiration: 键过期时间；正整秒使用 EXPIRE，正非整秒向上取整为毫秒并使用 PEXPIRE，非正值使用 EXPIRE 0。
	//
	// 返回：
	//   - *Cmd: 过期命令结果；执行错误由返回值的 Err 方法承载。
	Expire(ctx context.Context, key string, expiration time.Duration) *Cmd

	// ScriptFlush 按底层客户端能力清空脚本缓存。
	//
	// 当底层 Redis 实现提供 ScriptFlush(context.Context) *StatusCmd 时委托调用；否则返回 nil，调用方应处理 nil 返回值。
	//
	// 参数：
	//   - ctx: 控制命令执行生命周期的上下文。
	//
	// 返回：
	//   - *StatusCmd: 底层支持脚本缓存管理时返回对应命令；否则返回 nil。
	ScriptFlush(ctx context.Context) *StatusCmd

	// ScriptKill 按底层客户端能力终止当前正在执行的脚本。
	//
	// 当底层 Redis 实现提供 ScriptKill(context.Context) *StatusCmd 时委托调用；否则返回 nil，调用方应处理 nil 返回值。
	//
	// 参数：
	//   - ctx: 控制命令执行生命周期的上下文。
	//
	// 返回：
	//   - *StatusCmd: 底层支持脚本终止能力时返回对应命令；否则返回 nil。
	ScriptKill(ctx context.Context) *StatusCmd
}

RedisExtension 定义在 Redis 基础能力之上的常用扩展操作。

RedisExtension 通过 Do 组合 GET、SET、DEL 和过期命令，并保留 Redis 的脚本、管道和订阅能力。 扩展方法返回的命令对象遵循 go-redis/v9 约定，执行错误由命令结果的 Err 方法承载。

func NewRedisExtension(redis Redis) RedisExtension

type RunningScript ¶

type RunningScript = redis.RunningScript

RunningScript 表示运行中的脚本类型。

type ScanCmd ¶

type ScanCmd = redis.ScanCmd

ScanCmd 表示扫描操作的 Redis 命令。

type Scripter ¶

type Scripter = redis.Scripter

Scripter 表示 Redis 脚本操作接口。

type SetArgs ¶

type SetArgs = redis.SetArgs

SetArgs 表示设置命令的参数类型。

type SliceCmd ¶

type SliceCmd = redis.SliceCmd

SliceCmd 表示返回切片类型的 Redis 命令。

type SlotRange ¶

type SlotRange = redis.SlotRange

SlotRange 表示槽位范围类型。

type SlowLog ¶

type SlowLog = redis.SlowLog

SlowLog 表示慢查询日志类型。

type SlowLogCmd ¶

type SlowLogCmd = redis.SlowLogCmd

SlowLogCmd 表示返回慢查询日志的 Redis 命令。

type Sort ¶

type Sort = redis.Sort

Sort 表示排序参数类型。

type StatusCmd ¶

type StatusCmd = redis.StatusCmd

StatusCmd 表示返回状态类型的 Redis 命令。

type StringCmd ¶

type StringCmd = redis.StringCmd

StringCmd 表示返回字符串类型的 Redis 命令。

type StringSliceCmd ¶

type StringSliceCmd = redis.StringSliceCmd

StringSliceCmd 表示返回字符串切片类型的 Redis 命令。

type StringStructMapCmd ¶

type StringStructMapCmd = redis.StringStructMapCmd

StringStructMapCmd 表示返回字符串到结构体映射类型的 Redis 命令。

type Subscription ¶

type Subscription = redis.Subscription

Subscription 表示订阅信息类型。

type TimeCmd ¶

type TimeCmd = redis.TimeCmd

TimeCmd 表示返回时间类型的 Redis 命令。

type XAddArgs ¶

type XAddArgs = redis.XAddArgs

XAddArgs 表示 Stream 添加消息的参数类型。

type XAutoClaimCmd ¶

type XAutoClaimCmd = redis.XAutoClaimCmd

XAutoClaimCmd 表示自动认领消息的 Redis 命令。

type XAutoClaimJustIDCmd ¶

type XAutoClaimJustIDCmd = redis.XAutoClaimJustIDCmd

XAutoClaimJustIDCmd 表示仅返回自动认领消息 ID 的 Redis 命令。

type XClaimArgs ¶

type XClaimArgs = redis.XClaimArgs

XClaimArgs 表示消息认领参数类型。

type XInfoConsumer ¶

type XInfoConsumer = redis.XInfoConsumer

XInfoConsumer 表示消费者信息类型。

type XInfoConsumersCmd ¶

type XInfoConsumersCmd = redis.XInfoConsumersCmd

XInfoConsumersCmd 表示返回消费者信息的 Redis 命令。

type XInfoGroup ¶

type XInfoGroup = redis.XInfoGroup

XInfoGroup 表示消费者组信息类型。

type XInfoGroupsCmd ¶

type XInfoGroupsCmd = redis.XInfoGroupsCmd

XInfoGroupsCmd 表示返回消费者组信息的 Redis 命令。

type XInfoStream ¶

type XInfoStream = redis.XInfoStream

XInfoStream 表示 Stream 信息类型。

type XInfoStreamCmd ¶

type XInfoStreamCmd = redis.XInfoStreamCmd

XInfoStreamCmd 表示返回 Stream 信息的 Redis 命令。

type XInfoStreamConsumer ¶

type XInfoStreamConsumer = redis.XInfoStreamConsumer

XInfoStreamConsumer 表示 Stream 消费者信息类型。

type XInfoStreamConsumerPending ¶

type XInfoStreamConsumerPending = redis.XInfoStreamConsumerPending

XInfoStreamConsumerPending 表示 Stream 消费者待处理消息信息类型。

type XInfoStreamFull ¶

type XInfoStreamFull = redis.XInfoStreamFull

XInfoStreamFull 表示完整 Stream 信息类型。

type XInfoStreamFullCmd ¶

type XInfoStreamFullCmd = redis.XInfoStreamFullCmd

XInfoStreamFullCmd 表示返回完整 Stream 信息的 Redis 命令。

type XInfoStreamGroup ¶

type XInfoStreamGroup = redis.XInfoStreamGroup

XInfoStreamGroup 表示 Stream 组信息类型。

type XInfoStreamGroupPending ¶

type XInfoStreamGroupPending = redis.XInfoStreamGroupPending

XInfoStreamGroupPending 表示 Stream 组待处理消息信息类型。

type XMessage ¶

type XMessage = redis.XMessage

XMessage 表示 Redis Stream 消息类型。

type XMessageSliceCmd ¶

type XMessageSliceCmd = redis.XMessageSliceCmd

XMessageSliceCmd 表示返回 Stream 消息切片类型的 Redis 命令。

type XPending ¶

type XPending = redis.XPending

XPending 表示待处理消息类型。

type XPendingCmd ¶

type XPendingCmd = redis.XPendingCmd

XPendingCmd 表示返回待处理消息类型的 Redis 命令。

type XPendingExt ¶

type XPendingExt = redis.XPendingExt

XPendingExt 表示扩展的待处理消息类型。

type XPendingExtArgs ¶

type XPendingExtArgs = redis.XPendingExtArgs

XPendingExtArgs 表示扩展待处理消息查询参数类型。

type XPendingExtCmd ¶

type XPendingExtCmd = redis.XPendingExtCmd

XPendingExtCmd 表示返回扩展待处理消息类型的 Redis 命令。

type XReadArgs ¶

type XReadArgs = redis.XReadArgs

XReadArgs 表示 Stream 读取消息的参数类型。

type XReadGroupArgs ¶

type XReadGroupArgs = redis.XReadGroupArgs

XReadGroupArgs 表示 Stream 消费者组读取消息的参数类型。

type XStream ¶

type XStream = redis.XStream

XStream 表示 Redis Stream 类型。

type XStreamSliceCmd ¶

type XStreamSliceCmd = redis.XStreamSliceCmd

XStreamSliceCmd 表示返回 Stream 切片类型的 Redis 命令。

type Z ¶

type Z = redis.Z

Z 表示有序集合元素类型。

type ZAddArgs ¶

type ZAddArgs = redis.ZAddArgs

ZAddArgs 表示有序集合添加元素的参数类型。

type ZRangeArgs ¶

type ZRangeArgs = redis.ZRangeArgs

ZRangeArgs 表示有序集合范围查询参数类型。

type ZRangeBy ¶

type ZRangeBy = redis.ZRangeBy

ZRangeBy 表示有序集合范围查询参数类型。

type ZSliceCmd ¶

type ZSliceCmd = redis.ZSliceCmd

ZSliceCmd 表示返回有序集合切片类型的 Redis 命令。

type ZSliceWithKeyCmd ¶

type ZSliceWithKeyCmd = redis.ZSliceWithKeyCmd

ZSliceWithKeyCmd 表示返回带键的有序集合切片类型的 Redis 命令。

type ZStore ¶

type ZStore = redis.ZStore

ZStore 表示有序集合存储参数类型。

type ZWithKey ¶

type ZWithKey = redis.ZWithKey

ZWithKey 表示带键的有序集合元素类型。

type ZWithKeyCmd ¶

type ZWithKeyCmd = redis.ZWithKeyCmd

ZWithKeyCmd 表示返回带键的有序集合类型的 Redis 命令。