open-consul/command/kv_delete.go

148 lines
3.7 KiB
Go
Raw Normal View History

2016-09-26 15:12:40 +00:00
package command
import (
"fmt"
"strings"
"github.com/hashicorp/consul/api"
"github.com/hashicorp/consul/command/base"
2016-09-26 15:12:40 +00:00
)
2016-09-26 15:22:50 +00:00
// KVDeleteCommand is a Command implementation that is used to delete a key or
// prefix of keys from the key-value store.
2016-09-26 15:12:40 +00:00
type KVDeleteCommand struct {
base.Command
2016-09-26 15:12:40 +00:00
}
func (c *KVDeleteCommand) Help() string {
helpText := `
Usage: consul kv delete [options] KEY_OR_PREFIX
Removes the value from Consul's key-value store at the given path. If no
key exists at the path, no action is taken.
To delete the value for the key named "foo" in the key-value store:
$ consul kv delete foo
To delete all keys which start with "foo", specify the -recurse option:
$ consul kv delete -recurse foo
This will delete the keys named "foo", "food", and "foo/bar/zip" if they
existed.
` + c.Command.Help()
2016-09-26 15:12:40 +00:00
return strings.TrimSpace(helpText)
}
func (c *KVDeleteCommand) Run(args []string) int {
f := c.Command.NewFlagSet(c)
cas := f.Bool("cas", false,
"Perform a Check-And-Set operation. Specifying this value also requires "+
"the -modify-index flag to be set. The default value is false.")
modifyIndex := f.Uint64("modify-index", 0,
"Unsigned integer representing the ModifyIndex of the key. This is "+
"used in combination with the -cas flag.")
recurse := f.Bool("recurse", false,
"Recursively delete all keys with the path. The default value is false.")
if err := c.Command.Parse(args); err != nil {
2016-09-26 15:12:40 +00:00
return 1
}
key := ""
// Check for arg validation
args = f.Args()
2016-09-26 15:12:40 +00:00
switch len(args) {
case 0:
key = ""
case 1:
key = args[0]
default:
2017-04-21 00:02:42 +00:00
c.UI.Error(fmt.Sprintf("Too many arguments (expected 1, got %d)", len(args)))
2016-09-26 15:12:40 +00:00
return 1
}
// This is just a "nice" thing to do. Since pairs cannot start with a /, but
// users will likely put "/" or "/foo", lets go ahead and strip that for them
// here.
if len(key) > 0 && key[0] == '/' {
key = key[1:]
}
// If the key is empty and we are not doing a recursive delete, this is an
// error.
if key == "" && !*recurse {
2017-04-21 00:02:42 +00:00
c.UI.Error("Error! Missing KEY argument")
2016-09-26 15:12:40 +00:00
return 1
}
// ModifyIndex is required for CAS
if *cas && *modifyIndex == 0 {
2017-04-21 00:02:42 +00:00
c.UI.Error("Must specify -modify-index with -cas!")
return 1
}
// Specifying a ModifyIndex for a non-CAS operation is not possible.
if *modifyIndex != 0 && !*cas {
2017-04-21 00:02:42 +00:00
c.UI.Error("Cannot specify -modify-index without -cas!")
}
2016-09-26 15:12:40 +00:00
// It is not valid to use a CAS and recurse in the same call
if *recurse && *cas {
2017-04-21 00:02:42 +00:00
c.UI.Error("Cannot specify both -cas and -recurse!")
2016-09-26 15:12:40 +00:00
return 1
}
// Create and test the HTTP client
client, err := c.Command.HTTPClient()
2016-09-26 15:12:40 +00:00
if err != nil {
2017-04-21 00:02:42 +00:00
c.UI.Error(fmt.Sprintf("Error connecting to Consul agent: %s", err))
2016-09-26 15:12:40 +00:00
return 1
}
switch {
case *recurse:
if _, err := client.KV().DeleteTree(key, nil); err != nil {
2017-04-21 00:02:42 +00:00
c.UI.Error(fmt.Sprintf("Error! Did not delete prefix %s: %s", key, err))
2016-09-26 15:12:40 +00:00
return 1
}
2017-04-21 00:02:42 +00:00
c.UI.Info(fmt.Sprintf("Success! Deleted keys with prefix: %s", key))
2016-09-26 15:12:40 +00:00
return 0
case *cas:
pair := &api.KVPair{
Key: key,
ModifyIndex: *modifyIndex,
}
success, _, err := client.KV().DeleteCAS(pair, nil)
2016-09-26 15:12:40 +00:00
if err != nil {
2017-04-21 00:02:42 +00:00
c.UI.Error(fmt.Sprintf("Error! Did not delete key %s: %s", key, err))
2016-09-26 15:12:40 +00:00
return 1
}
if !success {
2017-04-21 00:02:42 +00:00
c.UI.Error(fmt.Sprintf("Error! Did not delete key %s: CAS failed", key))
2016-09-26 15:12:40 +00:00
return 1
}
2017-04-21 00:02:42 +00:00
c.UI.Info(fmt.Sprintf("Success! Deleted key: %s", key))
2016-09-26 15:12:40 +00:00
return 0
default:
if _, err := client.KV().Delete(key, nil); err != nil {
2017-04-21 00:02:42 +00:00
c.UI.Error(fmt.Sprintf("Error deleting key %s: %s", key, err))
2016-09-26 15:12:40 +00:00
return 1
}
2017-04-21 00:02:42 +00:00
c.UI.Info(fmt.Sprintf("Success! Deleted key: %s", key))
2016-09-26 15:12:40 +00:00
return 0
}
}
func (c *KVDeleteCommand) Synopsis() string {
return "Removes data from the KV store"
}