package redis import ( "fmt" "gopkg.in/redis.v5/internal" "gopkg.in/redis.v5/internal/pool" "gopkg.in/redis.v5/internal/proto" ) // Redis transaction failed. const TxFailedErr = internal.RedisError("redis: transaction failed") // Tx implements Redis transactions as described in // http://redis.io/topics/transactions. It's NOT safe for concurrent use // by multiple goroutines, because Exec resets list of watched keys. // If you don't need WATCH it is better to use Pipeline. type Tx struct { cmdable statefulCmdable baseClient closed bool } var _ Cmdable = (*Tx)(nil) func (c *Client) newTx() *Tx { tx := Tx{ baseClient: baseClient{ opt: c.opt, connPool: pool.NewStickyConnPool(c.connPool.(*pool.ConnPool), true), }, } tx.cmdable.process = tx.Process tx.statefulCmdable.process = tx.Process return &tx } func (c *Client) Watch(fn func(*Tx) error, keys ...string) error { tx := c.newTx() if len(keys) > 0 { if err := tx.Watch(keys...).Err(); err != nil { _ = tx.close() return err } } firstErr := fn(tx) if err := tx.close(); err != nil && firstErr == nil { firstErr = err } return firstErr } // close closes the transaction, releasing any open resources. func (c *Tx) close() error { if c.closed { return nil } c.closed = true if err := c.Unwatch().Err(); err != nil { internal.Logf("Unwatch failed: %s", err) } return c.baseClient.Close() } // Watch marks the keys to be watched for conditional execution // of a transaction. func (c *Tx) Watch(keys ...string) *StatusCmd { args := make([]interface{}, 1+len(keys)) args[0] = "WATCH" for i, key := range keys { args[1+i] = key } cmd := NewStatusCmd(args...) c.Process(cmd) return cmd } // Unwatch flushes all the previously watched keys for a transaction. func (c *Tx) Unwatch(keys ...string) *StatusCmd { args := make([]interface{}, 1+len(keys)) args[0] = "UNWATCH" for i, key := range keys { args[1+i] = key } cmd := NewStatusCmd(args...) c.Process(cmd) return cmd } func (c *Tx) Pipeline() *Pipeline { pipe := Pipeline{ exec: c.exec, } pipe.cmdable.process = pipe.Process pipe.statefulCmdable.process = pipe.Process return &pipe } // Pipelined executes commands queued in the fn in a transaction // and restores the connection state to normal. // // When using WATCH, EXEC will execute commands only if the watched keys // were not modified, allowing for a check-and-set mechanism. // // Exec always returns list of commands. If transaction fails // TxFailedErr is returned. Otherwise Exec returns error of the first // failed command or nil. func (c *Tx) Pipelined(fn func(*Pipeline) error) ([]Cmder, error) { return c.Pipeline().pipelined(fn) } func (c *Tx) exec(cmds []Cmder) error { if c.closed { return pool.ErrClosed } cn, _, err := c.conn() if err != nil { setCmdsErr(cmds, err) return err } multiExec := make([]Cmder, 0, len(cmds)+2) multiExec = append(multiExec, NewStatusCmd("MULTI")) multiExec = append(multiExec, cmds...) multiExec = append(multiExec, NewSliceCmd("EXEC")) err = c.execCmds(cn, multiExec) c.putConn(cn, err, false) return err } func (c *Tx) execCmds(cn *pool.Conn, cmds []Cmder) error { cn.SetWriteTimeout(c.opt.WriteTimeout) err := writeCmd(cn, cmds...) if err != nil { setCmdsErr(cmds[1:len(cmds)-1], err) return err } // Set read timeout for all commands. cn.SetReadTimeout(c.opt.ReadTimeout) // Omit last command (EXEC). cmdsLen := len(cmds) - 1 // Parse queued replies. statusCmd := cmds[0] for i := 0; i < cmdsLen; i++ { if err := statusCmd.readReply(cn); err != nil { setCmdsErr(cmds[1:len(cmds)-1], err) return err } } // Parse number of replies. line, err := cn.Rd.ReadLine() if err != nil { if err == Nil { err = TxFailedErr } setCmdsErr(cmds[1:len(cmds)-1], err) return err } if line[0] != proto.ArrayReply { err := fmt.Errorf("redis: expected '*', but got line %q", line) setCmdsErr(cmds[1:len(cmds)-1], err) return err } var firstErr error // Parse replies. // Loop starts from 1 to omit MULTI cmd. for i := 1; i < cmdsLen; i++ { cmd := cmds[i] if err := cmd.readReply(cn); err != nil { if firstErr == nil { firstErr = err } } } return firstErr }