|
@@ -40,8 +40,6 @@ This is a generated documentation. Please read the proto files for more.
|
|
|
|
|
|
|
|
##### service `KV` (etcdserver/etcdserverpb/rpc.proto)
|
|
##### service `KV` (etcdserver/etcdserverpb/rpc.proto)
|
|
|
|
|
|
|
|
-for grpc-gateway
|
|
|
|
|
-
|
|
|
|
|
| Method | Request Type | Response Type | Description |
|
|
| Method | Request Type | Response Type | Description |
|
|
|
| ------ | ------------ | ------------- | ----------- |
|
|
| ------ | ------------ | ------------- | ----------- |
|
|
|
| Range | RangeRequest | RangeResponse | Range gets the keys in the range from the key-value store. |
|
|
| Range | RangeRequest | RangeResponse | Range gets the keys in the range from the key-value store. |
|
|
@@ -94,8 +92,6 @@ for grpc-gateway
|
|
|
|
|
|
|
|
##### message `AlarmRequest` (etcdserver/etcdserverpb/rpc.proto)
|
|
##### message `AlarmRequest` (etcdserver/etcdserverpb/rpc.proto)
|
|
|
|
|
|
|
|
-default, used to query if any alarm is active space quota is exhausted
|
|
|
|
|
-
|
|
|
|
|
| Field | Description | Type |
|
|
| Field | Description | Type |
|
|
|
| ----- | ----------- | ---- |
|
|
| ----- | ----------- | ---- |
|
|
|
| action | action is the kind of alarm request to issue. The action may GET alarm statuses, ACTIVATE an alarm, or DEACTIVATE a raised alarm. | AlarmAction |
|
|
| action | action is the kind of alarm request to issue. The action may GET alarm statuses, ACTIVATE an alarm, or DEACTIVATE a raised alarm. | AlarmAction |
|
|
@@ -637,7 +633,7 @@ Empty field.
|
|
|
|
|
|
|
|
| Field | Description | Type |
|
|
| Field | Description | Type |
|
|
|
| ----- | ----------- | ---- |
|
|
| ----- | ----------- | ---- |
|
|
|
-| key | default, no sorting lowest target value first highest target value first key is the first key for the range. If range_end is not given, the request only looks up key. | bytes |
|
|
|
|
|
|
|
+| key | key is the first key for the range. If range_end is not given, the request only looks up key. | bytes |
|
|
|
| range_end | range_end is the upper bound on the requested range [key, range_end). If range_end is '\0', the range is all keys >= key. If range_end is key plus one (e.g., "aa"+1 == "ab", "a\xff"+1 == "b"), then the range request gets all keys prefixed with key. If both key and range_end are '\0', then the range request returns all keys. | bytes |
|
|
| range_end | range_end is the upper bound on the requested range [key, range_end). If range_end is '\0', the range is all keys >= key. If range_end is key plus one (e.g., "aa"+1 == "ab", "a\xff"+1 == "b"), then the range request gets all keys prefixed with key. If both key and range_end are '\0', then the range request returns all keys. | bytes |
|
|
|
| limit | limit is a limit on the number of keys returned for the request. When limit is set to 0, it is treated as no limit. | int64 |
|
|
| limit | limit is a limit on the number of keys returned for the request. When limit is set to 0, it is treated as no limit. | int64 |
|
|
|
| revision | revision is the point-in-time of the key-value store to use for the range. If revision is less or equal to zero, the range is over the newest key-value store. If the revision has been compacted, ErrCompacted is returned as a response. | int64 |
|
|
| revision | revision is the point-in-time of the key-value store to use for the range. If revision is less or equal to zero, the range is over the newest key-value store. If the revision has been compacted, ErrCompacted is returned as a response. | int64 |
|
|
@@ -770,7 +766,7 @@ From google paxosdb paper: Our implementation hinges around a powerful primitive
|
|
|
| range_end | range_end is the end of the range [key, range_end) to watch. If range_end is not given, only the key argument is watched. If range_end is equal to '\0', all keys greater than or equal to the key argument are watched. If the range_end is one bit larger than the given key, then all keys with the prefix (the given key) will be watched. | bytes |
|
|
| range_end | range_end is the end of the range [key, range_end) to watch. If range_end is not given, only the key argument is watched. If range_end is equal to '\0', all keys greater than or equal to the key argument are watched. If the range_end is one bit larger than the given key, then all keys with the prefix (the given key) will be watched. | bytes |
|
|
|
| start_revision | start_revision is an optional revision to watch from (inclusive). No start_revision is "now". | int64 |
|
|
| start_revision | start_revision is an optional revision to watch from (inclusive). No start_revision is "now". | int64 |
|
|
|
| progress_notify | progress_notify is set so that the etcd server will periodically send a WatchResponse with no events to the new watcher if there are no recent events. It is useful when clients wish to recover a disconnected watcher starting from a recent known revision. The etcd server may decide how often it will send notifications based on current load. | bool |
|
|
| progress_notify | progress_notify is set so that the etcd server will periodically send a WatchResponse with no events to the new watcher if there are no recent events. It is useful when clients wish to recover a disconnected watcher starting from a recent known revision. The etcd server may decide how often it will send notifications based on current load. | bool |
|
|
|
-| filters | filter out put event. filter out delete event. filters filter the events at server side before it sends back to the watcher. | (slice of) FilterType |
|
|
|
|
|
|
|
+| filters | filters filter the events at server side before it sends back to the watcher. | (slice of) FilterType |
|
|
|
| prev_kv | If prev_kv is set, created watcher gets the previous KV before the event happens. If the previous KV is already compacted, nothing will be returned. | bool |
|
|
| prev_kv | If prev_kv is set, created watcher gets the previous KV before the event happens. If the previous KV is already compacted, nothing will be returned. | bool |
|
|
|
|
|
|
|
|
|
|
|