mirror of
https://github.com/etcd-io/etcd.git
synced 2024-09-27 06:25:44 +00:00
02236b2773
Add missing install commands. Update benchmark to go install as go get usage is deprecated. Also, improve overall instructions and experience. related #13991
105 lines
2.3 KiB
Markdown
105 lines
2.3 KiB
Markdown
# etcd-dump-db
|
|
|
|
`etcd-dump-db` inspects etcd db files.
|
|
|
|
## Installation
|
|
|
|
Install the tool by running the following command from the etcd source directory.
|
|
|
|
```
|
|
$ go install -v ./tools/etcd-dump-db
|
|
```
|
|
|
|
The installation will place executables in the $GOPATH/bin. If $GOPATH environment variable is not set, the tool will be installed into the $HOME/go/bin. You can also find out the installed location by running the following command from the etcd source directory. Make sure that $PATH is set accordingly in your environment.
|
|
|
|
```
|
|
$ go list -f "{{.Target}}" ./tools/etcd-dump-db
|
|
```
|
|
|
|
Alternatively, instead of installing the tool, you can use it by simply running the following command from the etcd source directory.
|
|
|
|
```
|
|
$ go run ./tools/etcd-dump-db
|
|
```
|
|
|
|
## Usage
|
|
|
|
The following command should output the usage per the latest development.
|
|
|
|
```
|
|
$ etcd-dump-db --help
|
|
```
|
|
|
|
An example of usage detail is provided below.
|
|
|
|
```
|
|
Usage:
|
|
etcd-dump-db [command]
|
|
|
|
Available Commands:
|
|
list-bucket bucket lists all buckets.
|
|
iterate-bucket iterate-bucket lists key-value pairs in reverse order.
|
|
hash hash computes the hash of db file.
|
|
|
|
Flags:
|
|
-h, --help[=false]: help for etcd-dump-db
|
|
|
|
Use "etcd-dump-db [command] --help" for more information about a command.
|
|
```
|
|
|
|
|
|
#### list-bucket [data dir or db file path]
|
|
|
|
Lists all buckets.
|
|
|
|
```
|
|
$ etcd-dump-db list-bucket agent01/agent.etcd
|
|
|
|
alarm
|
|
auth
|
|
authRoles
|
|
authUsers
|
|
cluster
|
|
key
|
|
lease
|
|
members
|
|
members_removed
|
|
meta
|
|
```
|
|
|
|
|
|
#### hash [data dir or db file path]
|
|
|
|
Computes the hash of db file.
|
|
|
|
```
|
|
$ etcd-dump-db hash agent01/agent.etcd
|
|
db path: agent01/agent.etcd/member/snap/db
|
|
Hash: 3700260467
|
|
|
|
|
|
$ etcd-dump-db hash agent02/agent.etcd
|
|
|
|
db path: agent02/agent.etcd/member/snap/db
|
|
Hash: 3700260467
|
|
|
|
|
|
$ etcd-dump-db hash agent03/agent.etcd
|
|
|
|
db path: agent03/agent.etcd/member/snap/db
|
|
Hash: 3700260467
|
|
```
|
|
|
|
|
|
#### iterate-bucket [data dir or db file path]
|
|
|
|
Lists key-value pairs in reverse order.
|
|
|
|
```
|
|
$ etcd-dump-db iterate-bucket agent03/agent.etcd key --limit 3
|
|
|
|
key="\x00\x00\x00\x00\x005@x_\x00\x00\x00\x00\x00\x00\x00\tt", value="\n\x153640412599896088633_9"
|
|
key="\x00\x00\x00\x00\x005@x_\x00\x00\x00\x00\x00\x00\x00\bt", value="\n\x153640412599896088633_8"
|
|
key="\x00\x00\x00\x00\x005@x_\x00\x00\x00\x00\x00\x00\x00\at", value="\n\x153640412599896088633_7"
|
|
```
|