Function Object

command/keys.go:197–231

Object inspects the internals of Redis Objects

(ctx *Context, txn *db.Transaction)

// Object inspects the internals of Redis Objects
func Object(ctx *Context, txn *db.Transaction) (OnCommit, error) {
	argc := len(ctx.Args)
	subCmd := strings.ToLower(ctx.Args[0])
	cmdErr := fmt.Errorf("ERR Unknown subcommand or wrong number of arguments for '%s'. Try OBJECT help", subCmd)
	if argc == 1 && subCmd == "help" {

		helpInfo := [][]byte{
			[]byte("OBJECT <subcommand> key. Subcommands:"),
			[]byte("ENCODING <key> -- Return the kind of internal representation used in order to store the value associated with a key."),
			[]byte("FREQ <key> -- Return the access frequency index of the key. The returned integer is proportional to the logarithm of the recent access frequency of the key."),
			[]byte("IDLETIME <key> -- Return the idle time of the key, that is the approximated number of seconds elapsed since the last access to the key."),
			[]byte("REFCOUNT <key> -- Return the number of references of the value associated with the specified key."),
		}
		return BytesArray(ctx.Out, helpInfo), nil
	} else if argc == 2 {
		key := []byte(ctx.Args[1])
		obj, err := txn.Object(key)
		if err != nil {
			if err == db.ErrKeyNotFound {
				return NullBulkString(ctx.Out), nil
			}
			return nil, errors.New("ERR " + err.Error())
		}
		switch subCmd {
		case "refcount", "freq":
			return Integer(ctx.Out, 0), nil
		case "idletime":
			sec := int64(time.Since(time.Unix(0, obj.UpdatedAt)).Seconds())
			return Integer(ctx.Out, sec), nil
		case "encoding":
			return SimpleString(ctx.Out, obj.Encoding.String()), nil
		}
	}
	return nil, cmdErr
}

// Type returns the string representation of the type of the value stored at key
func Type(ctx *Context, txn *db.Transaction) (OnCommit, error) {