键值存储服务 KVS-更新单个kv:请求参数
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
table_name |
是 |
String |
表名,仓内唯一。
|
primary_key |
是 |
Document |
用户自定义的主键名及值。 说明:
内容字段:主键字段名和值,组合索引多个元素。 |
condition_expression |
否 |
condition_expression object |
条件表达式,参见conditional小节,禁止携带主键字段。 |
kv_options |
否 |
kv_options object |
选项字段。
|
update_fields |
否 |
update_fields object |
对kv_doc有效。 |
projection_fields |
否 |
Array of strings |
对kv_doc有效,返回哪些字段列表,默认全部。 说明:
字段名或嵌套字段路径用'/'分割 ,e_name为下标。 |
update_blob |
否 |
update_blob object |
对kv_blob有效,修改局部数据。 |
projection_blob |
否 |
projection_blob object |
对kv_blob有效,返回局部数据。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
single_field_expression |
否 |
single_field_expression object |
单字段条件。 |
multi_field_expression |
否 |
multi_field_expression object |
多字段条件,多个相同优先级的单字段条件。 |
single_kv_expression |
否 |
single_kv_expression object |
文档表达式。 |
composed_expression |
否 |
composed_expression object |
组合条件, 逐层同级的子表达式嵌套。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
logic |
否 |
String |
逻辑关系,取值如"$and", "$or", "$nor"。 |
expressions |
是 |
Array of expression objects |
多个相同优先级且相同逻辑的单字段或多字段条件。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
single_kv_expression |
否 |
single_kv_expression object |
单KV条件。 |
single_field_expression |
否 |
single_field_expression object |
单字段条件。 |
multi_field_expression |
否 |
multi_field_expression object |
多字段条件。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
func |
是 |
String |
取值:"is_doc", "is_blob", "is_exist", "not_exist"。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
field |
是 |
String |
条件字段。 |
func |
是 |
String |
条件函数,取值如"$gt", $lt","$gte", $lte" "$eq", "$ne", "$prefix", "$in","$nin", "$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 |
多个相同逻辑操作的单字段条件。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
set |
否 |
Document |
新增字段或覆盖某字段的值1个或多个字段。 说明:
禁止修改sortkey的字段。 |
add |
否 |
Document |
对某个字段做加法运算,并更新为运算后的值1个或多个字段。 |
rmv |
否 |
Array of strings |
删除1个或多个字段。
|