Mirroristas/etcd
2
0
Fork 0
mirror of https://github.com/etcd-io/etcd.git synced 2024-09-27 06:25:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #9255 from gyuho/snapshot-doc

Browse Source 
snapshot: clarify "Restore" method with conflicting data directory
This commit is contained in:
Gyuho Lee 2018-01-31 10:13:55 -08:00 committed by GitHub
commit dafbc04a73
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
snapshot/v3_snapshot.go
View File

@ -57,6 +57,8 @@ type Manager interface {
Status(dbPath string) (Status, error)
// Restore restores a new etcd data directory from given snapshot file.
// It returns an error if specified data directory already exists, to
// prevent unintended data directory overwrites.
Restore(dbPath string, cfg RestoreConfig) error
}
@ -73,6 +75,9 @@ type RestoreConfig struct {
// Name is the human-readable name of this member.
Name string
// OutputDataDir is the target data directory to save restored data.
// OutputDataDir should not conflict with existing etcd data directory.
// If OutputDataDir already exists, it will return an error to prevent
// unintended data directory overwrites.
// Defaults to "[Name].etcd" if not given.
OutputDataDir string
// OutputWALDir is the target WAL data directory.