键值存储服务 KVS-扫描分区键内kv:请求参数
下载键值存储服务 KVS用户手册完整版
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
table_name |
是 |
String |
表名，仓内唯一。
|
|
hint_index_name |
否 |
String |
create_table时指定的索引名。 |
|
limit |
否 |
Long |
返回的文档个数，最大100个。
说明：
默认100个文档。
|
|
shard_key |
是 |
Document |
要遍历的指定分区键下的kv。 |
|
start_sort_key |
否 |
Document |
起始排序键值，默认空表示从头遍历，左闭。
说明：
分页返回时，该值使用上次响应返回的cursor_sort_key
|
|
end_sort_key |
否 |
Document |
终止主键或索引键值，默认空表示直到最后，右开。 |
|
filter_expression |
否 |
condition_expression object |
过滤表达式。
说明：
|
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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二选一。
说明：
$prefix操作只适用于string和binary类型。
|
|
value_array |
否 |
Array of strings |
"value"和"value_array"二选一。
|
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
logic |
否 |
String |
多字段条件，多个相同优先级的单字段条件。 |
|
expressions |
是 |
Array of single_field_expression objects |
多个相同逻辑操作的单字段条件。 |
