10 "github.com/go-redis/redis/internal"
11 "github.com/go-redis/redis/internal/pool"
12 "github.com/go-redis/redis/internal/proto"
13 "github.com/go-redis/redis/internal/util"
16 type Cmder interface {
21 readReply(*pool.Conn) error
24 readTimeout() *time.Duration
30 func setCmdsErr(cmds []Cmder, e error) {
31 for _, cmd := range cmds {
38 func firstCmdsErr(cmds []Cmder) error {
39 for _, cmd := range cmds {
40 if err := cmd.Err(); err != nil {
47 func writeCmd(cn *pool.Conn, cmds ...Cmder) error {
49 for _, cmd := range cmds {
50 if err := cn.Wb.Append(cmd.Args()); err != nil {
55 _, err := cn.Write(cn.Wb.Bytes())
59 func cmdString(cmd Cmder, val interface{}) string {
61 for _, arg := range cmd.Args() {
62 ss = append(ss, fmt.Sprint(arg))
64 s := strings.Join(ss, " ")
65 if err := cmd.Err(); err != nil {
66 return s + ": " + err.Error()
69 switch vv := val.(type) {
71 return s + ": " + string(vv)
73 return s + ": " + fmt.Sprint(val)
80 func cmdFirstKeyPos(cmd Cmder, info *CommandInfo) int {
82 case "eval", "evalsha":
83 if cmd.stringArg(2) != "0" {
94 return int(info.FirstKeyPos)
97 //------------------------------------------------------------------------------
103 _readTimeout *time.Duration
106 var _ Cmder = (*Cmd)(nil)
108 func (cmd *baseCmd) Err() error {
112 func (cmd *baseCmd) Args() []interface{} {
116 func (cmd *baseCmd) stringArg(pos int) string {
117 if pos < 0 || pos >= len(cmd._args) {
120 s, _ := cmd._args[pos].(string)
124 func (cmd *baseCmd) Name() string {
125 if len(cmd._args) > 0 {
126 // Cmd name must be lower cased.
127 s := internal.ToLower(cmd.stringArg(0))
134 func (cmd *baseCmd) readTimeout() *time.Duration {
135 return cmd._readTimeout
138 func (cmd *baseCmd) setReadTimeout(d time.Duration) {
139 cmd._readTimeout = &d
142 func (cmd *baseCmd) setErr(e error) {
146 //------------------------------------------------------------------------------
154 func NewCmd(args ...interface{}) *Cmd {
156 baseCmd: baseCmd{_args: args},
160 func (cmd *Cmd) Val() interface{} {
164 func (cmd *Cmd) Result() (interface{}, error) {
165 return cmd.val, cmd.err
168 func (cmd *Cmd) String() string {
169 return cmdString(cmd, cmd.val)
172 func (cmd *Cmd) readReply(cn *pool.Conn) error {
173 cmd.val, cmd.err = cn.Rd.ReadReply(sliceParser)
177 if b, ok := cmd.val.([]byte); ok {
178 // Bytes must be copied, because underlying memory is reused.
184 //------------------------------------------------------------------------------
186 type SliceCmd struct {
192 var _ Cmder = (*SliceCmd)(nil)
194 func NewSliceCmd(args ...interface{}) *SliceCmd {
196 baseCmd: baseCmd{_args: args},
200 func (cmd *SliceCmd) Val() []interface{} {
204 func (cmd *SliceCmd) Result() ([]interface{}, error) {
205 return cmd.val, cmd.err
208 func (cmd *SliceCmd) String() string {
209 return cmdString(cmd, cmd.val)
212 func (cmd *SliceCmd) readReply(cn *pool.Conn) error {
214 v, cmd.err = cn.Rd.ReadArrayReply(sliceParser)
218 cmd.val = v.([]interface{})
222 //------------------------------------------------------------------------------
224 type StatusCmd struct {
230 var _ Cmder = (*StatusCmd)(nil)
232 func NewStatusCmd(args ...interface{}) *StatusCmd {
234 baseCmd: baseCmd{_args: args},
238 func (cmd *StatusCmd) Val() string {
242 func (cmd *StatusCmd) Result() (string, error) {
243 return cmd.val, cmd.err
246 func (cmd *StatusCmd) String() string {
247 return cmdString(cmd, cmd.val)
250 func (cmd *StatusCmd) readReply(cn *pool.Conn) error {
251 cmd.val, cmd.err = cn.Rd.ReadStringReply()
255 //------------------------------------------------------------------------------
263 var _ Cmder = (*IntCmd)(nil)
265 func NewIntCmd(args ...interface{}) *IntCmd {
267 baseCmd: baseCmd{_args: args},
271 func (cmd *IntCmd) Val() int64 {
275 func (cmd *IntCmd) Result() (int64, error) {
276 return cmd.val, cmd.err
279 func (cmd *IntCmd) String() string {
280 return cmdString(cmd, cmd.val)
283 func (cmd *IntCmd) readReply(cn *pool.Conn) error {
284 cmd.val, cmd.err = cn.Rd.ReadIntReply()
288 //------------------------------------------------------------------------------
290 type DurationCmd struct {
294 precision time.Duration
297 var _ Cmder = (*DurationCmd)(nil)
299 func NewDurationCmd(precision time.Duration, args ...interface{}) *DurationCmd {
301 baseCmd: baseCmd{_args: args},
302 precision: precision,
306 func (cmd *DurationCmd) Val() time.Duration {
310 func (cmd *DurationCmd) Result() (time.Duration, error) {
311 return cmd.val, cmd.err
314 func (cmd *DurationCmd) String() string {
315 return cmdString(cmd, cmd.val)
318 func (cmd *DurationCmd) readReply(cn *pool.Conn) error {
320 n, cmd.err = cn.Rd.ReadIntReply()
324 cmd.val = time.Duration(n) * cmd.precision
328 //------------------------------------------------------------------------------
330 type TimeCmd struct {
336 var _ Cmder = (*TimeCmd)(nil)
338 func NewTimeCmd(args ...interface{}) *TimeCmd {
340 baseCmd: baseCmd{_args: args},
344 func (cmd *TimeCmd) Val() time.Time {
348 func (cmd *TimeCmd) Result() (time.Time, error) {
349 return cmd.val, cmd.err
352 func (cmd *TimeCmd) String() string {
353 return cmdString(cmd, cmd.val)
356 func (cmd *TimeCmd) readReply(cn *pool.Conn) error {
358 v, cmd.err = cn.Rd.ReadArrayReply(timeParser)
362 cmd.val = v.(time.Time)
366 //------------------------------------------------------------------------------
368 type BoolCmd struct {
374 var _ Cmder = (*BoolCmd)(nil)
376 func NewBoolCmd(args ...interface{}) *BoolCmd {
378 baseCmd: baseCmd{_args: args},
382 func (cmd *BoolCmd) Val() bool {
386 func (cmd *BoolCmd) Result() (bool, error) {
387 return cmd.val, cmd.err
390 func (cmd *BoolCmd) String() string {
391 return cmdString(cmd, cmd.val)
394 var ok = []byte("OK")
396 func (cmd *BoolCmd) readReply(cn *pool.Conn) error {
398 v, cmd.err = cn.Rd.ReadReply(nil)
399 // `SET key value NX` returns nil when key already exists. But
400 // `SETNX key value` returns bool (0/1). So convert nil to bool.
401 // TODO: is this okay?
410 switch v := v.(type) {
415 cmd.val = bytes.Equal(v, ok)
418 cmd.err = fmt.Errorf("got %T, wanted int64 or string", v)
423 //------------------------------------------------------------------------------
425 type StringCmd struct {
431 var _ Cmder = (*StringCmd)(nil)
433 func NewStringCmd(args ...interface{}) *StringCmd {
435 baseCmd: baseCmd{_args: args},
439 func (cmd *StringCmd) Val() string {
440 return util.BytesToString(cmd.val)
443 func (cmd *StringCmd) Result() (string, error) {
444 return cmd.Val(), cmd.err
447 func (cmd *StringCmd) Bytes() ([]byte, error) {
448 return cmd.val, cmd.err
451 func (cmd *StringCmd) Int64() (int64, error) {
455 return strconv.ParseInt(cmd.Val(), 10, 64)
458 func (cmd *StringCmd) Uint64() (uint64, error) {
462 return strconv.ParseUint(cmd.Val(), 10, 64)
465 func (cmd *StringCmd) Float64() (float64, error) {
469 return strconv.ParseFloat(cmd.Val(), 64)
472 func (cmd *StringCmd) Scan(val interface{}) error {
476 return proto.Scan(cmd.val, val)
479 func (cmd *StringCmd) String() string {
480 return cmdString(cmd, cmd.val)
483 func (cmd *StringCmd) readReply(cn *pool.Conn) error {
484 cmd.val, cmd.err = cn.Rd.ReadBytesReply()
488 //------------------------------------------------------------------------------
490 type FloatCmd struct {
496 var _ Cmder = (*FloatCmd)(nil)
498 func NewFloatCmd(args ...interface{}) *FloatCmd {
500 baseCmd: baseCmd{_args: args},
504 func (cmd *FloatCmd) Val() float64 {
508 func (cmd *FloatCmd) Result() (float64, error) {
509 return cmd.Val(), cmd.Err()
512 func (cmd *FloatCmd) String() string {
513 return cmdString(cmd, cmd.val)
516 func (cmd *FloatCmd) readReply(cn *pool.Conn) error {
517 cmd.val, cmd.err = cn.Rd.ReadFloatReply()
521 //------------------------------------------------------------------------------
523 type StringSliceCmd struct {
529 var _ Cmder = (*StringSliceCmd)(nil)
531 func NewStringSliceCmd(args ...interface{}) *StringSliceCmd {
532 return &StringSliceCmd{
533 baseCmd: baseCmd{_args: args},
537 func (cmd *StringSliceCmd) Val() []string {
541 func (cmd *StringSliceCmd) Result() ([]string, error) {
542 return cmd.Val(), cmd.Err()
545 func (cmd *StringSliceCmd) String() string {
546 return cmdString(cmd, cmd.val)
549 func (cmd *StringSliceCmd) ScanSlice(container interface{}) error {
550 return proto.ScanSlice(cmd.Val(), container)
553 func (cmd *StringSliceCmd) readReply(cn *pool.Conn) error {
555 v, cmd.err = cn.Rd.ReadArrayReply(stringSliceParser)
559 cmd.val = v.([]string)
563 //------------------------------------------------------------------------------
565 type BoolSliceCmd struct {
571 var _ Cmder = (*BoolSliceCmd)(nil)
573 func NewBoolSliceCmd(args ...interface{}) *BoolSliceCmd {
574 return &BoolSliceCmd{
575 baseCmd: baseCmd{_args: args},
579 func (cmd *BoolSliceCmd) Val() []bool {
583 func (cmd *BoolSliceCmd) Result() ([]bool, error) {
584 return cmd.val, cmd.err
587 func (cmd *BoolSliceCmd) String() string {
588 return cmdString(cmd, cmd.val)
591 func (cmd *BoolSliceCmd) readReply(cn *pool.Conn) error {
593 v, cmd.err = cn.Rd.ReadArrayReply(boolSliceParser)
601 //------------------------------------------------------------------------------
603 type StringStringMapCmd struct {
606 val map[string]string
609 var _ Cmder = (*StringStringMapCmd)(nil)
611 func NewStringStringMapCmd(args ...interface{}) *StringStringMapCmd {
612 return &StringStringMapCmd{
613 baseCmd: baseCmd{_args: args},
617 func (cmd *StringStringMapCmd) Val() map[string]string {
621 func (cmd *StringStringMapCmd) Result() (map[string]string, error) {
622 return cmd.val, cmd.err
625 func (cmd *StringStringMapCmd) String() string {
626 return cmdString(cmd, cmd.val)
629 func (cmd *StringStringMapCmd) readReply(cn *pool.Conn) error {
631 v, cmd.err = cn.Rd.ReadArrayReply(stringStringMapParser)
635 cmd.val = v.(map[string]string)
639 //------------------------------------------------------------------------------
641 type StringIntMapCmd struct {
647 var _ Cmder = (*StringIntMapCmd)(nil)
649 func NewStringIntMapCmd(args ...interface{}) *StringIntMapCmd {
650 return &StringIntMapCmd{
651 baseCmd: baseCmd{_args: args},
655 func (cmd *StringIntMapCmd) Val() map[string]int64 {
659 func (cmd *StringIntMapCmd) Result() (map[string]int64, error) {
660 return cmd.val, cmd.err
663 func (cmd *StringIntMapCmd) String() string {
664 return cmdString(cmd, cmd.val)
667 func (cmd *StringIntMapCmd) readReply(cn *pool.Conn) error {
669 v, cmd.err = cn.Rd.ReadArrayReply(stringIntMapParser)
673 cmd.val = v.(map[string]int64)
677 //------------------------------------------------------------------------------
679 type StringStructMapCmd struct {
682 val map[string]struct{}
685 var _ Cmder = (*StringStructMapCmd)(nil)
687 func NewStringStructMapCmd(args ...interface{}) *StringStructMapCmd {
688 return &StringStructMapCmd{
689 baseCmd: baseCmd{_args: args},
693 func (cmd *StringStructMapCmd) Val() map[string]struct{} {
697 func (cmd *StringStructMapCmd) Result() (map[string]struct{}, error) {
698 return cmd.val, cmd.err
701 func (cmd *StringStructMapCmd) String() string {
702 return cmdString(cmd, cmd.val)
705 func (cmd *StringStructMapCmd) readReply(cn *pool.Conn) error {
707 v, cmd.err = cn.Rd.ReadArrayReply(stringStructMapParser)
711 cmd.val = v.(map[string]struct{})
715 //------------------------------------------------------------------------------
717 type XStream struct {
722 type XMessage struct {
724 Values map[string]interface{}
727 //------------------------------------------------------------------------------
729 type XStreamSliceCmd struct {
735 var _ Cmder = (*XStreamSliceCmd)(nil)
737 func NewXStreamSliceCmd(args ...interface{}) *XStreamSliceCmd {
738 return &XStreamSliceCmd{
739 baseCmd: baseCmd{_args: args},
743 func (cmd *XStreamSliceCmd) Val() []*XStream {
747 func (cmd *XStreamSliceCmd) Result() ([]*XStream, error) {
748 return cmd.val, cmd.err
751 func (cmd *XStreamSliceCmd) String() string {
752 return cmdString(cmd, cmd.val)
755 func (cmd *XStreamSliceCmd) readReply(cn *pool.Conn) error {
757 v, cmd.err = cn.Rd.ReadArrayReply(xStreamSliceParser)
761 cmd.val = v.([]*XStream)
765 // Implements proto.MultiBulkParse
766 func xStreamSliceParser(rd *proto.Reader, n int64) (interface{}, error) {
767 xx := make([]*XStream, n)
768 for i := int64(0); i < n; i++ {
769 v, err := rd.ReadArrayReply(xStreamParser)
778 // Implements proto.MultiBulkParse
779 func xStreamParser(rd *proto.Reader, n int64) (interface{}, error) {
781 return nil, fmt.Errorf("got %d, wanted 2", n)
784 stream, err := rd.ReadStringReply()
789 v, err := rd.ReadArrayReply(xMessageSliceParser)
796 Messages: v.([]*XMessage),
800 //------------------------------------------------------------------------------
802 type XMessageSliceCmd struct {
808 var _ Cmder = (*XMessageSliceCmd)(nil)
810 func NewXMessageSliceCmd(args ...interface{}) *XMessageSliceCmd {
811 return &XMessageSliceCmd{
812 baseCmd: baseCmd{_args: args},
816 func (cmd *XMessageSliceCmd) Val() []*XMessage {
820 func (cmd *XMessageSliceCmd) Result() ([]*XMessage, error) {
821 return cmd.val, cmd.err
824 func (cmd *XMessageSliceCmd) String() string {
825 return cmdString(cmd, cmd.val)
828 func (cmd *XMessageSliceCmd) readReply(cn *pool.Conn) error {
830 v, cmd.err = cn.Rd.ReadArrayReply(xMessageSliceParser)
834 cmd.val = v.([]*XMessage)
838 // Implements proto.MultiBulkParse
839 func xMessageSliceParser(rd *proto.Reader, n int64) (interface{}, error) {
840 msgs := make([]*XMessage, n)
841 for i := int64(0); i < n; i++ {
842 v, err := rd.ReadArrayReply(xMessageParser)
846 msgs[i] = v.(*XMessage)
851 // Implements proto.MultiBulkParse
852 func xMessageParser(rd *proto.Reader, n int64) (interface{}, error) {
853 id, err := rd.ReadStringReply()
858 v, err := rd.ReadArrayReply(xKeyValueParser)
865 Values: v.(map[string]interface{}),
869 // Implements proto.MultiBulkParse
870 func xKeyValueParser(rd *proto.Reader, n int64) (interface{}, error) {
871 values := make(map[string]interface{}, n)
872 for i := int64(0); i < n; i += 2 {
873 key, err := rd.ReadStringReply()
878 value, err := rd.ReadStringReply()
888 //------------------------------------------------------------------------------
890 type ZSliceCmd struct {
896 var _ Cmder = (*ZSliceCmd)(nil)
898 func NewZSliceCmd(args ...interface{}) *ZSliceCmd {
900 baseCmd: baseCmd{_args: args},
904 func (cmd *ZSliceCmd) Val() []Z {
908 func (cmd *ZSliceCmd) Result() ([]Z, error) {
909 return cmd.val, cmd.err
912 func (cmd *ZSliceCmd) String() string {
913 return cmdString(cmd, cmd.val)
916 func (cmd *ZSliceCmd) readReply(cn *pool.Conn) error {
918 v, cmd.err = cn.Rd.ReadArrayReply(zSliceParser)
926 //------------------------------------------------------------------------------
928 type ScanCmd struct {
934 process func(cmd Cmder) error
937 var _ Cmder = (*ScanCmd)(nil)
939 func NewScanCmd(process func(cmd Cmder) error, args ...interface{}) *ScanCmd {
941 baseCmd: baseCmd{_args: args},
946 func (cmd *ScanCmd) Val() (keys []string, cursor uint64) {
947 return cmd.page, cmd.cursor
950 func (cmd *ScanCmd) Result() (keys []string, cursor uint64, err error) {
951 return cmd.page, cmd.cursor, cmd.err
954 func (cmd *ScanCmd) String() string {
955 return cmdString(cmd, cmd.page)
958 func (cmd *ScanCmd) readReply(cn *pool.Conn) error {
959 cmd.page, cmd.cursor, cmd.err = cn.Rd.ReadScanReply()
963 // Iterator creates a new ScanIterator.
964 func (cmd *ScanCmd) Iterator() *ScanIterator {
965 return &ScanIterator{
970 //------------------------------------------------------------------------------
972 type ClusterNode struct {
977 type ClusterSlot struct {
983 type ClusterSlotsCmd struct {
989 var _ Cmder = (*ClusterSlotsCmd)(nil)
991 func NewClusterSlotsCmd(args ...interface{}) *ClusterSlotsCmd {
992 return &ClusterSlotsCmd{
993 baseCmd: baseCmd{_args: args},
997 func (cmd *ClusterSlotsCmd) Val() []ClusterSlot {
1001 func (cmd *ClusterSlotsCmd) Result() ([]ClusterSlot, error) {
1002 return cmd.Val(), cmd.Err()
1005 func (cmd *ClusterSlotsCmd) String() string {
1006 return cmdString(cmd, cmd.val)
1009 func (cmd *ClusterSlotsCmd) readReply(cn *pool.Conn) error {
1011 v, cmd.err = cn.Rd.ReadArrayReply(clusterSlotsParser)
1015 cmd.val = v.([]ClusterSlot)
1019 //------------------------------------------------------------------------------
1021 // GeoLocation is used with GeoAdd to add geospatial location.
1022 type GeoLocation struct {
1024 Longitude, Latitude, Dist float64
1028 // GeoRadiusQuery is used with GeoRadius to query geospatial index.
1029 type GeoRadiusQuery struct {
1031 // Can be m, km, ft, or mi. Default is km.
1037 // Can be ASC or DESC. Default is no sort order.
1043 type GeoLocationCmd struct {
1047 locations []GeoLocation
1050 var _ Cmder = (*GeoLocationCmd)(nil)
1052 func NewGeoLocationCmd(q *GeoRadiusQuery, args ...interface{}) *GeoLocationCmd {
1053 args = append(args, q.Radius)
1055 args = append(args, q.Unit)
1057 args = append(args, "km")
1060 args = append(args, "withcoord")
1063 args = append(args, "withdist")
1066 args = append(args, "withhash")
1069 args = append(args, "count", q.Count)
1072 args = append(args, q.Sort)
1075 args = append(args, "store")
1076 args = append(args, q.Store)
1078 if q.StoreDist != "" {
1079 args = append(args, "storedist")
1080 args = append(args, q.StoreDist)
1082 return &GeoLocationCmd{
1083 baseCmd: baseCmd{_args: args},
1088 func (cmd *GeoLocationCmd) Val() []GeoLocation {
1089 return cmd.locations
1092 func (cmd *GeoLocationCmd) Result() ([]GeoLocation, error) {
1093 return cmd.locations, cmd.err
1096 func (cmd *GeoLocationCmd) String() string {
1097 return cmdString(cmd, cmd.locations)
1100 func (cmd *GeoLocationCmd) readReply(cn *pool.Conn) error {
1102 v, cmd.err = cn.Rd.ReadArrayReply(newGeoLocationSliceParser(cmd.q))
1106 cmd.locations = v.([]GeoLocation)
1110 //------------------------------------------------------------------------------
1112 type GeoPos struct {
1113 Longitude, Latitude float64
1116 type GeoPosCmd struct {
1122 var _ Cmder = (*GeoPosCmd)(nil)
1124 func NewGeoPosCmd(args ...interface{}) *GeoPosCmd {
1126 baseCmd: baseCmd{_args: args},
1130 func (cmd *GeoPosCmd) Val() []*GeoPos {
1131 return cmd.positions
1134 func (cmd *GeoPosCmd) Result() ([]*GeoPos, error) {
1135 return cmd.Val(), cmd.Err()
1138 func (cmd *GeoPosCmd) String() string {
1139 return cmdString(cmd, cmd.positions)
1142 func (cmd *GeoPosCmd) readReply(cn *pool.Conn) error {
1144 v, cmd.err = cn.Rd.ReadArrayReply(geoPosSliceParser)
1148 cmd.positions = v.([]*GeoPos)
1152 //------------------------------------------------------------------------------
1154 type CommandInfo struct {
1164 type CommandsInfoCmd struct {
1167 val map[string]*CommandInfo
1170 var _ Cmder = (*CommandsInfoCmd)(nil)
1172 func NewCommandsInfoCmd(args ...interface{}) *CommandsInfoCmd {
1173 return &CommandsInfoCmd{
1174 baseCmd: baseCmd{_args: args},
1178 func (cmd *CommandsInfoCmd) Val() map[string]*CommandInfo {
1182 func (cmd *CommandsInfoCmd) Result() (map[string]*CommandInfo, error) {
1183 return cmd.Val(), cmd.Err()
1186 func (cmd *CommandsInfoCmd) String() string {
1187 return cmdString(cmd, cmd.val)
1190 func (cmd *CommandsInfoCmd) readReply(cn *pool.Conn) error {
1192 v, cmd.err = cn.Rd.ReadArrayReply(commandInfoSliceParser)
1196 cmd.val = v.(map[string]*CommandInfo)
1200 //------------------------------------------------------------------------------
1202 type cmdsInfoCache struct {
1203 fn func() (map[string]*CommandInfo, error)
1206 cmds map[string]*CommandInfo
1209 func newCmdsInfoCache(fn func() (map[string]*CommandInfo, error)) *cmdsInfoCache {
1210 return &cmdsInfoCache{
1215 func (c *cmdsInfoCache) Get() (map[string]*CommandInfo, error) {
1216 err := c.once.Do(func() error {