clientv3, ctlv3: document range end requirement
parent
396a71ee9e
commit
9dd75a946f
|
@ -223,7 +223,7 @@ func WithSort(target SortTarget, order SortOrder) OpOption {
|
||||||
// If order != SortNone, server fetches the entire key-space,
|
// If order != SortNone, server fetches the entire key-space,
|
||||||
// and then applies the sort and limit, if provided.
|
// and then applies the sort and limit, if provided.
|
||||||
// Since current mvcc.Range implementation returns results
|
// Since current mvcc.Range implementation returns results
|
||||||
// sorted by keys in lexiographically ascending order,
|
// sorted by keys in lexicographically ascending order,
|
||||||
// client should ignore SortOrder if the target is SortByKey.
|
// client should ignore SortOrder if the target is SortByKey.
|
||||||
order = SortNone
|
order = SortNone
|
||||||
}
|
}
|
||||||
|
@ -261,14 +261,15 @@ func WithPrefix() OpOption {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// WithRange specifies the range of 'Get' or 'Delete' requests.
|
// WithRange specifies the range of 'Get', 'Delete', 'Watch' requests.
|
||||||
// For example, 'Get' requests with 'WithRange(end)' returns
|
// For example, 'Get' requests with 'WithRange(end)' returns
|
||||||
// the keys in the range [key, end).
|
// the keys in the range [key, end).
|
||||||
|
// endKey must be lexicographically greater than start key.
|
||||||
func WithRange(endKey string) OpOption {
|
func WithRange(endKey string) OpOption {
|
||||||
return func(op *Op) { op.end = []byte(endKey) }
|
return func(op *Op) { op.end = []byte(endKey) }
|
||||||
}
|
}
|
||||||
|
|
||||||
// WithFromKey specifies the range of 'Get' or 'Delete' requests
|
// WithFromKey specifies the range of 'Get', 'Delete', 'Watch' requests
|
||||||
// to be equal or greater than the key in the argument.
|
// to be equal or greater than the key in the argument.
|
||||||
func WithFromKey() OpOption { return WithRange("\x00") }
|
func WithFromKey() OpOption { return WithRange("\x00") }
|
||||||
|
|
||||||
|
|
|
@ -329,7 +329,7 @@ put key2 "some extra key"
|
||||||
|
|
||||||
### WATCH [options] [key or prefix] [range_end]
|
### WATCH [options] [key or prefix] [range_end]
|
||||||
|
|
||||||
Watch watches events stream on keys or prefixes, [key or prefix, range_end) if `range-end` is given. The watch command runs until it encounters an error or is terminated by the user.
|
Watch watches events stream on keys or prefixes, [key or prefix, range_end) if `range-end` is given. The watch command runs until it encounters an error or is terminated by the user. If range_end is given, it must be lexicographically greater than key or "\x00".
|
||||||
|
|
||||||
#### Options
|
#### Options
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue