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

clientv3: update etcdctl's readme and comment of clientv3.WithSerializable to clarify the use cases

Browse Source 
Signed-off-by: Benjamin Wang <wachao@vmware.com>
This commit is contained in:
Benjamin Wang 2023-02-23 09:58:48 +08:00
parent 1f0d361848
commit 3de346259b
2 changed files with 25 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
client/v3/op.go
View File

@ -418,9 +418,15 @@ func WithFromKey() OpOption {
}
}
// WithSerializable makes 'Get' request serializable. By default,
// it's linearizable. Serializable requests are better for lower latency
// requirement.
// WithSerializable makes `Get` and `MemberList` requests serializable.
// By default, they are linearizable. Serializable requests are better
// for lower latency requirement, but users should be aware that they
// could get stale data with serializable requests.
//
// In some situations users may want to use serializable requests. For
// example, when adding a new member to a one-node cluster, it's reasonable
// and safe to use serializable request before the new added member gets
// started.
func WithSerializable() OpOption {
return func(op *Op) { op.serializable = true }
}

19
etcdctl/README.md
View File

@ -119,15 +119,22 @@ RPC: Range
- print-value-only -- print only value when used with write-out=simple
- consistency -- Linearizable(l) or Serializable(s)
- consistency -- Linearizable(l) or Serializable(s), defaults to Linearizable(l).
- from-key -- Get keys that are greater than or equal to the given key using byte compare
- keys-only -- Get only the keys
#### Output
Prints the data in format below,
```
\<key\>\n\<value\>\n\<next_key\>\n\<next_value\>...
```
Note serializable requests are better for lower latency requirement, but
stale data might be returned if serializable option (`--consistency=s`)
is specified.
#### Examples
@ -712,12 +719,18 @@ MEMBER LIST prints the member details for all members associated with an etcd cl
RPC: MemberList
#### Options
- consistency -- Linearizable(l) or Serializable(s)
- consistency -- Linearizable(l) or Serializable(s), defaults to Linearizable(l).
#### Output
Prints a humanized table of the member IDs, statuses, names, peer addresses, and client addresses.
Note serializable requests are better for lower latency requirement, but
stale member list might be returned if serializable option (`--consistency=s`)
is specified. In some situations users may want to use serializable requests.
For example, when adding a new member to a one-node cluster, it's reasonable
and safe to use serializable request before the new added member gets started.
#### Examples
```bash