Skip to content

etcdctl: add --from-key to watch command #22383

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
avanish-garg wants to merge 1 commit into
base: main
Choose a base branch
from
+26 −5
Open

etcdctl: add --from-key to watch command #22383

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 20 additions & 5 deletions etcdctl/ctlv3/command/watch_command.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ var (
var (
watchRev int64
watchPrefix bool
watchFromKey bool
watchInteractive bool
watchPrevKey bool
progressNotify bool
Expand All @@ -55,6 +56,7 @@ func NewWatchCommand() *cobra.Command {

cmd.Flags().BoolVarP(&watchInteractive, "interactive", "i", false, "Interactive mode")
cmd.Flags().BoolVar(&watchPrefix, "prefix", false, "Watch on a prefix if prefix is set")
cmd.Flags().BoolVar(&watchFromKey, "from-key", false, "Watch keys that are greater than or equal to the given key using byte compare")
cmd.Flags().Int64Var(&watchRev, "rev", 0, "Revision to start watching")
cmd.Flags().BoolVar(&watchPrevKey, "prev-kv", false, "get the previous key-value pair before the event happens")
cmd.Flags().BoolVar(&progressNotify, "progress-notify", false, "get periodic watch progress notification from server")
Expand Down Expand Up @@ -149,11 +151,20 @@ func getWatchChan(c *clientv3.Client, args []string) (clientv3.WatchChan, error)
if watchPrefix {
return nil, fmt.Errorf("`range_end` and `--prefix` are mutually exclusive")
}
if watchFromKey {
return nil, fmt.Errorf("`range_end` and `--from-key` are mutually exclusive")
}
opts = append(opts, clientv3.WithRange(args[1]))
}
if watchPrefix && watchFromKey {
return nil, fmt.Errorf("`--prefix` and `--from-key` are mutually exclusive")
}
if watchPrefix {
opts = append(opts, clientv3.WithPrefix())
}
if watchFromKey {
opts = append(opts, clientv3.WithFromKey())
}
if watchPrevKey {
opts = append(opts, clientv3.WithPrevKV())
}
Expand Down Expand Up @@ -217,7 +228,7 @@ func parseWatchArgs(osArgs, commandArgs []string, envKey, envRange string, inter
if interactive {
if watchArgs[0] != "watch" {
// "watch" not found
watchPrefix, watchRev, watchPrevKey = false, 0, false
watchPrefix, watchFromKey, watchRev, watchPrevKey = false, false, 0, false
return nil, nil, errBadArgsInteractiveWatch
}
watchArgs = watchArgs[1:]
Expand Down Expand Up @@ -272,28 +283,28 @@ func parseWatchArgs(osArgs, commandArgs []string, envKey, envRange string, inter
}
if execExist && execIdx == len(watchArgs)-1 {
// "watch foo bar --" should error
watchPrefix, watchRev, watchPrevKey = false, 0, false
watchPrefix, watchFromKey, watchRev, watchPrevKey = false, false, 0, false
return nil, nil, errBadArgsNumSeparator
}

flagset := NewWatchCommand().Flags()
if perr := flagset.Parse(watchArgs); perr != nil {
watchPrefix, watchRev, watchPrevKey = false, 0, false
watchPrefix, watchFromKey, watchRev, watchPrevKey = false, false, 0, false
return nil, nil, perr
}
pArgs := flagset.Args()

// "watch" with no argument should error
if !execExist && envKey == "" && len(pArgs) < 1 {
watchPrefix, watchRev, watchPrevKey = false, 0, false
watchPrefix, watchFromKey, watchRev, watchPrevKey = false, false, 0, false
return nil, nil, errBadArgsNum
}
// check conflicting arguments
// e.g. "watch --rev 1 -- echo Hello World" has no conflict
if !execExist && len(pArgs) > 0 && envKey != "" {
// "ETCDCTL_WATCH_KEY=foo watch foo" should error
// (watchArgs==["foo"])
watchPrefix, watchRev, watchPrevKey = false, 0, false
watchPrefix, watchFromKey, watchRev, watchPrevKey = false, false, 0, false
return nil, nil, errBadArgsNumConflictEnv
}
}
Expand Down Expand Up @@ -326,6 +337,10 @@ func parseWatchArgs(osArgs, commandArgs []string, envKey, envRange string, inter
if err != nil {
return nil, nil, err
}
watchFromKey, err = flagset.GetBool("from-key")
if err != nil {
return nil, nil, err
}
watchRev, err = flagset.GetInt64("rev")
if err != nil {
return nil, nil, err
Expand Down
6 changes: 6 additions & 0 deletions tests/e2e/ctl_v3_watch_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,12 @@ func watchTest(cx ctlCtx) {
args: []string{"--rev", "1", "--prefix"},
wkv: []kvExec{{key: "key1", val: "val1"}, {key: "key2", val: "val2"}, {key: "key3", val: "val3"}},
},
{ // watch keys from a given key onward (>=), with env
puts: []kv{{"key1", "val1"}, {"key2", "val2"}, {"key3", "val3"}},
envKey: "key1",
args: []string{"--rev", "1", "--from-key"},
wkv: []kvExec{{key: "key1", val: "val1"}, {key: "key2", val: "val2"}, {key: "key3", val: "val3"}},
},
{ // watch 3 keys by range, with env
puts: []kv{{"key1", "val1"}, {"key3", "val3"}, {"key2", "val2"}},
envKey: "key",
Expand Down