扫描所有kv
功能介绍
指定表，扫描表下所有kv；允许指定过滤条件。
URI
POST /v1/scan-kv
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
store_name |
否 |
String |
仓名，全域唯一，不同租户的仓名不能相同。
说明：
"-"不能出现在名字头部或尾部 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
table_name |
是 |
String |
表名，仓内唯一。
|
hint_index_name |
否 |
String |
create_table时指定的索引名，默认空表示主索引。
|
limit |
否 |
Integer |
数据量不超过1MB时，返回的文档个数，最大100个，默认1MB或者100个文档。 |
start_key |
否 |
Document |
起始主键或索引键值。
说明：
分页返回时，该值使用上次响应返回的cursor_key。 |
end_key |
否 |
Document |
终止主键或索引键值。
|
filter_expression |
否 |
condition_expression object |
过滤表达式，同condition_expression。
说明：
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
single_field_expression |
否 |
single_field_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"二选一。
|
响应参数
状态码： 200
参数 |
参数类型 |
描述 |
|---|---|---|
returned_count |
Integer |
返回的文档数量，为0不表示结束。
说明：
如果filtered_count超过500仍无匹配，则返回0。 |
filtered_count |
Integer |
被过滤掉的文档数量。 |
cursor_key |
Document |
下次请求时的start_key，该值为空时，表示指定范围或者指定filter条件所有kv已经返回。 |
returned_kv_items |
Array of returned_kv_item objects |
返回的kv数据。 |
请求示例
扫描所有kv，扫描条件为分区键的值为user2
POST https://{endpoint}/v1/scan-kv
{
"table_name" : "test_table_1",
"filter_expression" : {
"single_field_expr" : {
"field" : "owner",
"func" : "$eq",
"value" : {
"value" : "user_2"
}
}
}
}
响应示例
状态码： 200
表示扫描所有kv请求成功
{
"returned_count" : 1,
"filtered_count" : 0,
"returned_kv_items" : [ {
"kv_doc" : {
"owner" : "user_2",
"filename" : "test_file_2",
"otherKey" : "otherValue"
}
} ]
}
状态码
状态码 |
描述 |
|---|---|
200 |
表示扫描所有kv请求成功 |
400 |
Bad Request |
错误码
请参见错误码。
