Range方法

Range方法从键值存储中获取范围内的key.

  1. rpc Range(RangeRequest) returns (RangeResponse) {}

注意: 没有操作单个key的方法，即使是存取单个key，也是需要使用 Range 方法的。

消息体

请求的消息体是 RangeRequest：

  1. message RangeRequest {
  2.   enum SortOrder {
  3.     NONE = 0; // 默认, 不排序
  4.     ASCEND = 1; // 正序，低的值在前
  5.     DESCEND = 2; // 倒序，高的值在前
  6.   }
  7.   enum SortTarget {
  8.     KEY = 0;
  9.     VERSION = 1;
  10.     CREATE = 2;
  11.     MOD = 3;
  12.     VALUE = 4;
  13.   }
  15.   // key是 range 的第一个 key。如果 range_end 没有指定，请求仅查找这个key
  16.   bytes key = 1;
  18.   // range_end 是请求范围的上限 [key, range_end)
  19.   // 如果 range_end 是 '\0'，范围是大于等于 key 的所有 key。
  20.   // 如果 range_end 是 key 加一(例如, "aa"+1 == "ab", "a\xff"+1 == "b")， 那么 range 请求获取以 key 为前缀的所有 key
  21.   // 如果 key 和 range_end 都是'\0'，则 range 查询返回所有 key
  22.   bytes range_end = 2;
  24.   // 请求返回的 key 的数量限制。如果 limit 设置为0，则视为没有限制
  25.   int64 limit = 3;
  27.   // 修订版本是用于 range 的键值对存储的时间点。
  28.   // 如果修订版本小于或等于零，range 是用在最新的键值对存储上。
  29.   // 如果指定修订版本已经被压缩，返回 ErrCompacted 作为应答
  30.   int64 revision = 4;
  32.   // 指定返回结果的排序顺序
  33.   SortOrder sort_order = 5;
  35.   // 用于排序的键值字段
  36.   SortTarget sort_target = 6;
  38.   // 设置 range 请求使用串行化成员本地读(serializable member-local read)。
  39.   // range 请求默认是线性化的;线性化请求相比串行化请求有更高的延迟和低吞吐量，但是反映集群当前的一致性。
  40.   // 为了更好的性能，以可能脏读为交换，串行化范围请求在本地处理，无需和集群中的其他节点达到一致。
  41.   bool serializable = 7;
  43.   // keys_only 被设置时仅返回 key 而不需要 value
  44.   bool keys_only = 8;
  46.   // count_only 被设置时仅仅返回范围内 key 的数量
  47.   bool count_only = 9;
  49.   // min_mod_revision 是返回 key 的 mod revision 的下限；更低 mod revision 的所有 key 都将被过滤掉
  50.   int64 min_mod_revision = 10;
  52.   // max_mod_revision 是返回 key 的 mod revision 的上限；更高 mod revision 的所有 key 都将被过滤掉
  53.   int64 max_mod_revision = 11;
  55.     // min_create_revision 是返回 key 的 create revision 的下限；更低 create revision 的所有 key 都将被过滤掉
  56.   int64 min_create_revision = 12;
  58.   // max_create_revision 是返回 key 的 create revision 的上限；更高 create revision 的所有 key 都将被过滤掉
  59.   int64 max_create_revision = 13;
  60. }

应答的消息体是 RangeResponse：

  1. message RangeResponse {
  2.   ResponseHeader header = 1;
  4.   // kvs 是匹配 range 请求的键值对列表
  5.   // 当 count 时是空的
  6.   repeated mvccpb.KeyValue kvs = 2;
  8.   // more 代表在被请求的范围内是否还有更多的 key
  9.   bool more = 3;
  11.   // count 被设置为在范围内的 key 的数量
  12.   int64 count = 4;
  13. }

mvccpb.KeyValue 来自 kv.proto，消息体定义为：

  1. message KeyValue {
  2.   // key 是 bytes 格式的 key。不容许 key 为空。
  3.   bytes key = 1;
  5.   // create_revision 是这个 key 最后一次创建的修订版本
  6.   int64 create_revision = 2;
  8.   // mod_revision 是这个 key 最后一次修改的修订版本
  9.   int64 mod_revision = 3;
  11.   // version 是 key 的版本。删除会重置版本为0,而任何 key 的修改会增加它的版本。
  12.   int64 version = 4;
  14.   // value 是 key 持有的值，bytes 格式。
  15.   bytes value = 5;
  17.   // lease 是附加给 key 的租约 id。
  18.   // 当附加的租约过期时，key 将被删除。
  19.   // 如果 lease 为0,则没有租约附加到 key。
  20.   int64 lease = 6;
  21. }