• update()
    • 语法
    • 参数描述
    • options选项
    • 返回值
    • 错误
    • 示例

    update()

    语法

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

    更新集合记录。

    参数描述

    参数名参数类型描述是否必填
    ruleJson 对象更新规则。记录按 rule 的内容更新。
    condJson 对象选择条件。为空时,更新所有记录,不为空时,更新符合条件的记录。
    hintJson 对象指定访问计划。
    optionsJson 对象可选项,详见options选项说明。

    options选项

    参数名参数类型描述默认值
    KeepShardingKeybool为 false 时,将不保留更新规则中的分区键字段,只更新非分区键字段。为 true 时,将会保留更新规则中的分区键字段。false

    Note:

    • 参数hint的用法与find()的相同。

    • 目前分区集合上,不支持更新分区键。如果 KeepShardingKey 为 true,并且更新规则中带有分区键字段,将会报错-178。

    返回值

    • 成功返回详细结果信息(BSONObj 对象),结构如下:
    1. {
    2. UpdatedNum : <INT64> 成功更新的记录数,包括匹配但未发生数据变化的记录,
    3. ModifiedNum : <INT64> 成功更新且发生数据变化的记录数,
    4. InsertedNum : <INT32> 成功插入的记录数,仅在 upsert 下生效
    5. }
    • 出错抛异常,并输出错误信息,可以通过getLastErrMsg()获取错误信息或通过getLastError()获取错误信息码。错误信息对象包括详细结果信息。

    错误

    错误信息记录在节点诊断日志(diaglog)中,可参考错误码。

    错误码可能的原因解决方法
    -178分区集合上不支持更新分区键KeepShardingKey 设置为 false,不更新分区键

    示例

    • 按指定的更新规则更新集合中所有记录,即设置 rule 参数,不设定 cond 和 hint 参数的内容。如下操作更新集合 bar 下的 age 字段,使用$inc将 age 字段的值增加1。
    1. > db.foo.bar.update( { $inc: { age: 1 } } )
    • 选择符合匹配条件的记录,对这些记录按更新规则更新,即设定 rule 和 cond 参数。如下操作使用匹配符$exist匹配更新集合 bar 中存在 age 字段而不存在 name 字段的记录,使用$unset将这些记录的 age 字段删除。
    1. > db.foo.bar.update( { $unset: { age: "" } }, { age: { $exists: 1 }, name: { $exists: 0 } } )
    • 按访问计划更新记录,假设集合中存在指定的索引名。如下操作使用索引名为 testIndex 的索引访问集合 bar 中 age 字段值大于20的记录,将这些记录的 age 字段名加1。
    1. > db.foo.bar.update( { $inc: { age: 1 } }, { age: { $gt: 20 } }, { "": "testIndex" } )
    • 分区集合 foo.bar,分区键为 { a: 1 },含有以下记录
    1. > db.foo.bar.find()
    2. {
    3. "_id": {
    4. "$oid": "5c6f660ce700db6048677154"
    5. },
    6. "a": 1,
    7. "b": 1
    8. }
    9. Return 1 row(s).

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

    1. > db.foo.bar.update( { $set: { a: 9, b: 9 } }, {}, {}, { KeepShardingKey: false } )
    2. {
    3. "UpdatedNum": 1,
    4. "ModifiedNum": 0,
    5. "InsertedNum": 0
    6. }
    7. Takes 0.038184s.
    8. >
    9. > db.foo.bar.find()
    10. {
    11. "_id": {
    12. "$oid": "5c6f660ce700db6048677154"
    13. },
    14. "a": 1,
    15. "b": 9
    16. }
    17. Return 1 row(s).
    18. Takes 0.006393s.

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

    1. > db.foo.bar.update( { $set: { a: 9 } }, {}, {}, { KeepShardingKey: true } )
    2. (nofile):0 uncaught exception: -178
    3. Sharding key cannot be updated
    4. Takes 0.002696s.