mirror of
https://github.com/etcd-io/etcd.git
synced 2024-09-27 06:25:44 +00:00
Merge pull request #6505 from sinsharat/compaction_options_update
etcdctlv3: updated compaction options
This commit is contained in:
commit
804e215981
@ -647,12 +647,16 @@ The lease length of a leader defaults to 60 seconds. If a candidate is abnormall
|
||||
progress may be delayed by up to 60 seconds.
|
||||
|
||||
|
||||
### COMPACTION \<revision\>
|
||||
### COMPACTION [options] \<revision\>
|
||||
|
||||
COMPACTION discards all etcd event history prior to a given revision. Since etcd uses a multiversion concurrency control
|
||||
model, it preserves all key updates as event history. When the event history up to some revision is no longer needed,
|
||||
all superseded keys may be compacted away to reclaim storage space in the etcd backend database.
|
||||
|
||||
#### Options
|
||||
|
||||
- physical -- 'true' to wait for compaction to physically remove all old revisions
|
||||
|
||||
#### Return value
|
||||
|
||||
- On success, prints the compacted revision and returns a zero exit code.
|
||||
|
@ -27,7 +27,7 @@ var compactPhysical bool
|
||||
// NewCompactionCommand returns the cobra command for "compaction".
|
||||
func NewCompactionCommand() *cobra.Command {
|
||||
cmd := &cobra.Command{
|
||||
Use: "compaction <revision>",
|
||||
Use: "compaction [options] <revision>",
|
||||
Short: "Compacts the event history in etcd",
|
||||
Run: compactionCommandFunc,
|
||||
}
|
||||
|
Loading…
x
Reference in New Issue
Block a user