script.go

Documentation: github.com/redis/go-redis/v9

     1  package redis
     2  
     3  import (
     4  	"context"
     5  	"crypto/sha1"
     6  	"encoding/hex"
     7  	"io"
     8  )
     9  
    10  type Scripter interface {
    11  	Eval(ctx context.Context, script string, keys []string, args ...interface{}) *Cmd
    12  	EvalSha(ctx context.Context, sha1 string, keys []string, args ...interface{}) *Cmd
    13  	EvalRO(ctx context.Context, script string, keys []string, args ...interface{}) *Cmd
    14  	EvalShaRO(ctx context.Context, sha1 string, keys []string, args ...interface{}) *Cmd
    15  	ScriptExists(ctx context.Context, hashes ...string) *BoolSliceCmd
    16  	ScriptLoad(ctx context.Context, script string) *StringCmd
    17  }
    18  
    19  var (
    20  	_ Scripter = (*Client)(nil)
    21  	_ Scripter = (*Ring)(nil)
    22  	_ Scripter = (*ClusterClient)(nil)
    23  )
    24  
    25  type Script struct {
    26  	src, hash string
    27  }
    28  
    29  func NewScript(src string) *Script {
    30  	h := sha1.New()
    31  	_, _ = io.WriteString(h, src)
    32  	return &Script{
    33  		src:  src,
    34  		hash: hex.EncodeToString(h.Sum(nil)),
    35  	}
    36  }
    37  
    38  func (s *Script) Hash() string {
    39  	return s.hash
    40  }
    41  
    42  func (s *Script) Load(ctx context.Context, c Scripter) *StringCmd {
    43  	return c.ScriptLoad(ctx, s.src)
    44  }
    45  
    46  func (s *Script) Exists(ctx context.Context, c Scripter) *BoolSliceCmd {
    47  	return c.ScriptExists(ctx, s.hash)
    48  }
    49  
    50  func (s *Script) Eval(ctx context.Context, c Scripter, keys []string, args ...interface{}) *Cmd {
    51  	return c.Eval(ctx, s.src, keys, args...)
    52  }
    53  
    54  func (s *Script) EvalRO(ctx context.Context, c Scripter, keys []string, args ...interface{}) *Cmd {
    55  	return c.EvalRO(ctx, s.src, keys, args...)
    56  }
    57  
    58  func (s *Script) EvalSha(ctx context.Context, c Scripter, keys []string, args ...interface{}) *Cmd {
    59  	return c.EvalSha(ctx, s.hash, keys, args...)
    60  }
    61  
    62  func (s *Script) EvalShaRO(ctx context.Context, c Scripter, keys []string, args ...interface{}) *Cmd {
    63  	return c.EvalShaRO(ctx, s.hash, keys, args...)
    64  }
    65  
    66  // Run optimistically uses EVALSHA to run the script. If script does not exist
    67  // it is retried using EVAL.
    68  func (s *Script) Run(ctx context.Context, c Scripter, keys []string, args ...interface{}) *Cmd {
    69  	r := s.EvalSha(ctx, c, keys, args...)
    70  	if HasErrorPrefix(r.Err(), "NOSCRIPT") {
    71  		return s.Eval(ctx, c, keys, args...)
    72  	}
    73  	return r
    74  }
    75  
    76  // RunRO optimistically uses EVALSHA_RO to run the script. If script does not exist
    77  // it is retried using EVAL_RO.
    78  func (s *Script) RunRO(ctx context.Context, c Scripter, keys []string, args ...interface{}) *Cmd {
    79  	r := s.EvalShaRO(ctx, c, keys, args...)
    80  	if HasErrorPrefix(r.Err(), "NOSCRIPT") {
    81  		return s.EvalRO(ctx, c, keys, args...)
    82  	}
    83  	return r
    84  }
    85
View as plain text