multi_get_opt

同时读一条hashkey的多条sortkey数据, 读取的数据根据multi_get_options参数指定的模式确定。

  1. def multi_get_opt(self, hash_key,
  2.                   start_sort_key, stop_sort_key,
  3.                   multi_get_options,
  4.                   max_kv_count=100,
  5.                   max_kv_size=1000000,
  6.                   timeout=0):
  7.     """
  8.     Get multiple values stored in hash_key, and sort key range in [start_sort_key, stop_sort_key) as default.
  10.     :param hash_key: (str) which hash key used for this API.
  11.     :param start_sort_key: (str) returned k-v pairs is start from start_sort_key.
  12.     :param stop_sort_key: (str) returned k-v pairs is stop at stop_sort_key.
  13.     :param multi_get_options: (MultiGetOptions) configurable multi_get options.
  14.     :param max_kv_count: (int) max count of k-v pairs to be fetched. max_fetch_count <= 0 means no limit.
  15.     :param max_kv_size: (int) max total data size of k-v pairs to be fetched. max_fetch_size <= 0 means no limit.
  16.     :param timeout: (int) how long will the operation timeout in milliseconds.
  17.                     if timeout > 0, it is a timeout value for current operation,
  18.                     else the timeout value specified to create the instance will be used.
  19.     :return: (tuple<error_types.code.value, dict>) (code, kvs)
  20.              code: error_types.ERR_OK.value when data got succeed.
  21.              kvs: <sort_key, value> pairs in dict.
  22.     """

其中，MultiGetOptions可以指定sortkey的范围、是否包含边界、子串匹配、是否返回value、是否逆序等，具体定义如下：

  1. class MultiGetOptions(object):
  2.     """
  3.     configurable options for multi_get.
  4.     """
  6.     def __init__(self):
  7.         self.start_inclusive = True
  8.         self.stop_inclusive = False
  9.         self.sortkey_filter_type = filter_type.FT_NO_FILTER
  10.         self.sortkey_filter_pattern = ""
  11.         self.no_value = False
  12.         self.reverse = False
  14. class filter_type:
  15.   FT_NO_FILTER = 0
  16.   FT_MATCH_ANYWHERE = 1
  17.   FT_MATCH_PREFIX = 2
  18.   FT_MATCH_POSTFIX = 3