# 在CodeArts TestPlan接口脚本中调用MongoDBUpdate关键字
MongoDB更新文档操作使用，根据输入的参数更新集合中的文档。
| 参数         | 是否必选 | 参数类型    | 描述                                                           |
|:---|:---|:---|:---|
| Ip         | 是    | String  | 数据库ip地址                                                      |
| Port       | 是    | Integer | 数据库端口                                                        |
| User Name  | 是    | String  | 用户名                                                          |
| Password   | 是    | String  | 密码（登录密码属于个人敏感信息，须在环境参数中定义为敏感参数）                              |
| DB Name    | 是    | String  | 数据库实例名称                                                      |
| Collection | 是    | String  | 集合名称                                                         |
| Query      | 是    | String  | 更新的查询条件（bson数据）                                              |
| Update     | 是    | String  | 需要更新的文档数据（bson数据）                                            |
| Multi      | 否    | Boolean | 是否更新全部记录（默认是false,只更新找到的第一条记录，如果这个参数为true,就把按条件查出来多条记录全部更新）。 |
   
#### MongoDBUpdate响应
状态：成功
| 参数                 | 参数类型    | 描述        |
|:---|:---|:---|
| affected_row_count | Integer | 更新文档影响的行数 |
   
#### MongoDBUpdate响应示例
```
{
  "affected_row_count" : 1
}
```
#### MongoDBUpdate使用示例
根据输入的查询数据和更新数据对集合中的文档进行更新，系统关键字返回更新的记录数。
![](https://support.huaweicloud.com/usermanual-testman/zh-cn_image_0000001964032681.png "点击放大")
根据multi参数设置为true来更新匹配到的所有文档。
![](https://support.huaweicloud.com/usermanual-testman/zh-cn_image_0000001936914098.png "点击放大")
判断结果是否成功，更新条数是否是预期值。
![](https://support.huaweicloud.com/usermanual-testman/zh-cn_image_0000001964032677.png "点击放大")