table_name

是

String

表名，仓内唯一。

• 长度：[3, 63]

• 取值字符限制：[a-z0-9_-]+

hint_index_name

否

String

create_table时指定的索引名，默认空表示主索引。

• 长度：[3, 63]

• 取值字符限制：[a-z0-9_-]+

limit

否

Integer

返回的文档个数，最大100个。

start_key

否

Document

起始主键或索引键值。

• 默认空，表示从头遍历，左闭。

end_key

否

Document

终止主键或索引键值。

• 默认空，表示直到最后，右开。

filter_expression

否

condition_expression object

过滤表达式。

sample_segments_count

否

Integer

对表进行采样，尽最大努力保证返回的段列表均分整张表。举例：sample_segments_count=4，返回的段列表[MinKey, KV1)、[KV1,KV2)、[KV2,KV3)和[KV3,MaxKey)。用户可以使用scan-kv对这四个分区执行并发扫描，提高遍历效率。

• 范围: [1, 10000]。默认值：不执行采样。

• sample_segments_count仅能和table_name、start_key和end_key字段配合使用。Range分区模式下支持全表采样和范围采样；Hash分区模式仅支持全表扫描。

• 仅支持对Primary key进行采样，不支持本地/全局二级索引。

• 返回的段列表仅包含主键，不包含键值；且段列表是编码后的数据 ，不可修改。

return_count_only

否

Boolean

是否只返回满足条件的KV个数；

• true:响应rsp只返回"returned_count"、"filtered_count"和"cursor_key"（如果有"cursor_key"）。

• false:scan-kv的标准响应体定义返回消息。

returned_segment_items

否

Array of returned_segment_item objects

采样段区间列表。

single_field_expression

否

single_field_expression object

单字段条件。

multi_field_expression

否

multi_field_expression object

多字段条件，多个相同优先级的单字段条件。

composed_expression

否

composed_expression object

组合条件, 逐层同级的子表达式嵌套。

logic

否

String

逻辑关系，取值如"$and", "$or", "$nor"。

expressions

是

Array of expression objects

多个相同优先级且相同逻辑的单字段或多字段条件。

single_field_expression

否

single_field_expression object

单字段条件。

multi_field_expression

否

multi_field_expression object

多字段条件，多个相同优先级的单字段条件。

composed_expression

否

composed_expression object

组合条件, 逐层同级的子表达式嵌套。

field

是

String

条件字段。

func

是

String

条件函数，取值如"$gt", $lt","$gte", $lte" "$eq", "$ne", "$prefix", "$exists"。

value

否

Document

value和value_array二选一。

• value条件值，适用于除"$in", "$nin"外的func。

• 字段名无意义，可以传空，也可以传字段名。

• $exists值为true/false。

value_array

否

Array of strings

"value"和"value_array"二选一。

• "value_array" 条件值列表, 值用于"$in", "$nin"。

logic

否

String

多字段条件，多个相同优先级的单字段条件。

expressions

是

Array of single_field_expression objects

多个相同逻辑操作的单字段条件。

segment_min_key

否

Document

采样段区间起始值。

segment_max_key

否

Document

采样段区间终止值。