Skip to content

Commit 6c4d77a

Browse files
Marked CAS/CAD commands as experimental (#3595)
1 parent 783a151 commit 6c4d77a

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

string_commands.go

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,9 @@ type DelExArgs struct {
8585
// Compare-and-delete with flexible conditions.
8686
//
8787
// Returns the number of keys that were removed (0 or 1).
88+
//
89+
// NOTE DelExArgs is still experimental
90+
// it's signature and behaviour may change
8891
func (c cmdable) DelExArgs(ctx context.Context, key string, a DelExArgs) *IntCmd {
8992
args := []interface{}{"delex", key}
9093

@@ -118,6 +121,9 @@ func (c cmdable) DelExArgs(ctx context.Context, key string, a DelExArgs) *IntCmd
118121
// example/digest-optimistic-locking/
119122
//
120123
// Redis 8.4+. See https://redis.io/commands/digest/
124+
//
125+
// NOTE Digest is still experimental
126+
// it's signature and behaviour may change
121127
func (c cmdable) Digest(ctx context.Context, key string) *DigestCmd {
122128
cmd := NewDigestCmd(ctx, "digest", key)
123129
_ = c(ctx, cmd)
@@ -471,6 +477,9 @@ func (c cmdable) SetXX(ctx context.Context, key string, value interface{}, expir
471477
// Returns "OK" on success.
472478
// Returns nil if the operation was aborted due to condition not matching.
473479
// Zero expiration means the key has no expiration time.
480+
//
481+
// NOTE SetIFEQ is still experimental
482+
// it's signature and behaviour may change
474483
func (c cmdable) SetIFEQ(ctx context.Context, key string, value interface{}, matchValue interface{}, expiration time.Duration) *StatusCmd {
475484
args := []interface{}{"set", key, value}
476485

@@ -498,6 +507,9 @@ func (c cmdable) SetIFEQ(ctx context.Context, key string, value interface{}, mat
498507
// Returns the previous value on success.
499508
// Returns nil if the operation was aborted due to condition not matching.
500509
// Zero expiration means the key has no expiration time.
510+
//
511+
// NOTE SetIFEQGet is still experimental
512+
// it's signature and behaviour may change
501513
func (c cmdable) SetIFEQGet(ctx context.Context, key string, value interface{}, matchValue interface{}, expiration time.Duration) *StringCmd {
502514
args := []interface{}{"set", key, value}
503515

@@ -524,6 +536,9 @@ func (c cmdable) SetIFEQGet(ctx context.Context, key string, value interface{},
524536
// Returns "OK" on success.
525537
// Returns nil if the operation was aborted due to condition not matching.
526538
// Zero expiration means the key has no expiration time.
539+
//
540+
// NOTE SetIFNE is still experimental
541+
// it's signature and behaviour may change
527542
func (c cmdable) SetIFNE(ctx context.Context, key string, value interface{}, matchValue interface{}, expiration time.Duration) *StatusCmd {
528543
args := []interface{}{"set", key, value}
529544

@@ -551,6 +566,9 @@ func (c cmdable) SetIFNE(ctx context.Context, key string, value interface{}, mat
551566
// Returns the previous value on success.
552567
// Returns nil if the operation was aborted due to condition not matching.
553568
// Zero expiration means the key has no expiration time.
569+
//
570+
// NOTE SetIFNEGet is still experimental
571+
// it's signature and behaviour may change
554572
func (c cmdable) SetIFNEGet(ctx context.Context, key string, value interface{}, matchValue interface{}, expiration time.Duration) *StringCmd {
555573
args := []interface{}{"set", key, value}
556574

@@ -584,6 +602,9 @@ func (c cmdable) SetIFNEGet(ctx context.Context, key string, value interface{},
584602
// example/digest-optimistic-locking/
585603
//
586604
// Redis 8.4+. See https://redis.io/commands/set/
605+
//
606+
// NOTE SetIFNEQ is still experimental
607+
// it's signature and behaviour may change
587608
func (c cmdable) SetIFDEQ(ctx context.Context, key string, value interface{}, matchDigest uint64, expiration time.Duration) *StatusCmd {
588609
args := []interface{}{"set", key, value}
589610

@@ -618,6 +639,9 @@ func (c cmdable) SetIFDEQ(ctx context.Context, key string, value interface{}, ma
618639
// example/digest-optimistic-locking/
619640
//
620641
// Redis 8.4+. See https://redis.io/commands/set/
642+
//
643+
// NOTE SetIFNEQGet is still experimental
644+
// it's signature and behaviour may change
621645
func (c cmdable) SetIFDEQGet(ctx context.Context, key string, value interface{}, matchDigest uint64, expiration time.Duration) *StringCmd {
622646
args := []interface{}{"set", key, value}
623647

@@ -651,6 +675,9 @@ func (c cmdable) SetIFDEQGet(ctx context.Context, key string, value interface{},
651675
// example/digest-optimistic-locking/
652676
//
653677
// Redis 8.4+. See https://redis.io/commands/set/
678+
//
679+
// NOTE SetIFDNE is still experimental
680+
// it's signature and behaviour may change
654681
func (c cmdable) SetIFDNE(ctx context.Context, key string, value interface{}, matchDigest uint64, expiration time.Duration) *StatusCmd {
655682
args := []interface{}{"set", key, value}
656683

@@ -685,6 +712,9 @@ func (c cmdable) SetIFDNE(ctx context.Context, key string, value interface{}, ma
685712
// example/digest-optimistic-locking/
686713
//
687714
// Redis 8.4+. See https://redis.io/commands/set/
715+
//
716+
// NOTE SetIFDNEGet is still experimental
717+
// it's signature and behaviour may change
688718
func (c cmdable) SetIFDNEGet(ctx context.Context, key string, value interface{}, matchDigest uint64, expiration time.Duration) *StringCmd {
689719
args := []interface{}{"set", key, value}
690720

0 commit comments

Comments
 (0)