update()

名称

update - 更新集合记录

语法

db.collectionspace.collection.update(<rule>, [cond], [hint], [options])

类别

SdbCollection

描述

该函数用于更新集合记录。

参数

options 选项：

Note:

• 参数 hint 的用法与 find() 的相同。
• 目前分区集合上，不支持更新分区键。如果 KeepShardingKey 为 true，并且更新规则中带有分区键字段，将会报错 -178。
• JustOne 为 true 时，只能在单个分区、单个子表上执行。

返回值

函数执行成功时，将返回一个 BSONObj 类型的对象。通过该对象获取成功更新的记录数信息，字段说明如下：

函数执行失败时，将抛异常并输出错误信息。

错误

update() 函数常见异常如下：

当异常抛出时，可以通过 getLastErrMsg() 获取错误信息或通过 getLastError() 获取错误码。更多错误处理可以参考常见错误处理指南。

版本

v2.0 及以上版本

示例

• 按指定的更新规则更新集合中所有记录，即设置 rule 参数，不设定 cond 和 hint 参数的内容。如下操作更新集合 samle.employee 下的 age 字段，使用 $inc 将 age 字段的值增加 1

  > db.sample.employee.update({$inc: {age: 1}})

• 选择符合匹配条件的记录，对这些记录按更新规则更新，即设定 rule 和 cond 参数。如下操作使用匹配符 $exist 匹配更新集合 sample.employee 中存在 age 字段而不存在 name 字段的记录，使用$unset将这些记录的 age 字段删除

  > db.sample.employee.update({$unset: {age: ""}}, {age: {$exists: 1}, name: {$exists: 0}})

• 按访问计划更新记录，假设集合中存在指定的索引名，如下操作使用索引名为 testIndex 的索引访问集合 sample.employee 中 age 字段值大于 20 的记录，将这些记录的 age 字段名加 1

  > db.sample.employee.update({$inc: {age: 1}}, {age: {$gt: 20}}, {"": "testIndex"})

• 分区集合 sample.employee，分区键为 {a: 1}，含有以下记录

  > db.sample.employee.find()
  {
    "_id": {
      "$oid": "5c6f660ce700db6048677154"
    },
    "a": 1,
    "b": 1
  }
  Return 1 row(s).

• 指定 KeepShardingKey 参数：不保留更新规则中的分区键字段，只更新了非分区键 b 字段，分区键 a 字段的值没有被更新

  > db.sample.employee.update({$set: {a: 9, b: 9}}, {}, {}, {KeepShardingKey: false})
  {
    "UpdatedNum": 1,
    "ModifiedNum": 0,
    "InsertedNum": 0
  }
  > db.sample.employee.find()
  {
    "_id": {
      "$oid": "5c6f660ce700db6048677154"
    },
    "a": 1,
    "b": 9
  }
  Return 1 row(s).

• 指定 KeepShardingKey 参数：保留更新规则中的分区键字段，因为目前不支持更新分区键，所以会报错

  > db.sample.employee.update({$set: {a: 9}}, {}, {}, {KeepShardingKey: true})
  (nofile):0 uncaught exception: -178
  Sharding key cannot be updated