文档中心

SequoiaDB 简介

快速入门

安装部署

数据库实例

分布式引擎

SAC管控中心

SequoiaPerf性能分析工具

参考手册

常见问题及解答(FAQ)

版本信息

upsert()

名称

upsert - 更新集合记录

语法

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

类别

SdbCollection

描述

该函数用于更新集合记录。upsert 方法跟 update 方法都是对记录进行更新,不同的是当使用 cond 参数在集合中匹配不到记录时,update 不做任何操作,而 upsert 方法会做一次插入操作。

参数

参数名 参数类型 描述 是否必填
rule Json 对象 更新规则。记录按 rule 的内容更新。
cond Json 对象 选择条件。为空时,更新所有记录,不为空时,更新符合条件的记录。
hint Json 对象 指定访问计划。
setOnInsert Json 对象 在做插入操作时向插入的记录中追加字段。
options Json 对象 可选项,详见options选项说明。

options 选项:

参数名 参数类型 描述 默认值
KeepShardingKey bool 为 false 时,将不保留更新规则中的分区键字段,只更新非分区键字段。
为 true 时,将会保留更新规则中的分区键字段。
false
JustOne bool 为 true 时,将只更新一条符合条件的记录。
为 false 时,将会更新所有符合条件的记录。
false

Note:

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

  • cond 参数在集合中匹配不到记录时,upsert 会生成一条记录插入到集合中。记录生成规则为:首先从 cond 参数中取出 $et 和 $all 操作符对应的键值对,没有的时候生成空记录。然后使用 rule 规则对其做更新操作,最后加入 setOnInsert 中的键值对。

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

  • JustOne为 true 时,只能在单个分区、单个子表上执行。

返回值

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

字段名 类型 描述
UpdatedNum int64 成功更新的记录数,包括匹配但未发生数据变化的记录
ModifiedNum int64 成功更新且发生数据变化的记录数
InsertedNum int64 成功插入的记录数

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

错误

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

错误码 可能的原因 解决方法
-178 分区集合上不支持更新分区键 KeepShardingKey 设置为 false,不更新分区键
-345 JustOne 跨多个分区或者多个子表 修改匹配条件,或者不使用 JustOne

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

版本

v2.0 及以上版本

示例

假设集合 employee 中有两条记录:

{
  "_id": {
    "$oid": "516a76a1c9565daf06030000"
  },
  "age": 10,
  "name": "Tom"
}
{
  "_id": {
    "$oid": "516a76a1c9565daf06050000"
  },
  "a": 10,
  "age": 21
}
  • 按指定的更新规则更新集合中所有记录,即设置 rule 参数,不设定 cond 和 hint 参数的内容。如下操作等效于使用 update 方法,更新集合 employee 中的所有记录,使用 $inc 将记录的 age 字段值加1,name 字段值更改为“Mike”,对不存在 name 字段的记录,$set 操作符会将 name 字段和其设定的值插入到记录中,可使用 find 方法查看更新结果。

    > db.sample.employee.upsert( { $inc: { age: 1 }, $set: { name: "Mike" } } )
    {
      "UpdatedNum": 2,
      "ModifiedNum": 2,
      "InsertedNum": 0
    }
    >
    > db.sample.employee.find()
    {
         "_id": {
         "$oid": "516a76a1c9565daf06030000"
         },
         "age": 11,
         "name": "Mike"
    }
    {
         "_id": {
         "$oid": "516a76a1c9565daf06050000"
         },
         "a": 10,
         "age": 22,
         "name":"Mike"
    }
    Return 2 row(s).
  • 选择符合匹配条件的记录,对这些记录按更新规则更新,即设定 rule 和 cond 参数。如下操作使用 $exists 匹配存在 type 字段的记录,使用 $inc 将这些记录的 age 字段值加3。在上面给出的两条记录中,都没有 type 字段,此时,upsert 操作会插入一条新的记录,新记录只有 _id 字段和 age 字段名,_id 字段值自动生成,而 age 字段值为3。

    > db.sample.employee.upsert( { $inc: { age: 3 } }, { type: { $exists: 1 } } )
    {
      "UpdatedNum": 0,
      "ModifiedNum": 0,
      "InsertedNum": 1
    }
    >
    > db.sample.employee.find()
    {
         "_id": {
         "$oid": "516a76a1c9565daf06030000"
         },
         "age": 11,
         "name": "Mike"
    }
    {
         "_id": {
         "$oid": "516a76a1c9565daf06050000"
         },
         "a": 10,
         "age": 22,
         "name":"Mike"
    }
    {
         "_id": {
         "$oid": "516cfc334630a7f338c169b0"
         },
         "age": 3
    }
    Return 3 row(s).
  • 按访问计划更新记录,假设集合中存在指定的索引名 testIndex,此操作等效于使用 update 方法,使用索引名为 testIndex 的索引访问集合 employee 中 age 字段值大于20的记录,将这些记录的 age 字段名加1。

    > db.sample.employee.upsert( { $inc: { age: 1 } }, { age: { $gt: 20 } }, { "": "testIndex" } )
    {
      "UpdatedNum": 1,
      "ModifiedNum": 1,
      "InsertedNum": 0
    }
    >
    > db.sample.employee.find()
    {
         "_id": {
         "$oid": "516a76a1c9565daf06050000"
         },
         "a": 10,
         "age": 23,
         "name":"Mike"
    }
    Return 1 row(s).
  • 使用setOnInsert更新记录,由于集合 employee 中 age 字段值大于30的记录为空,upsert在做插入操作时向插入的记录中追加字段{"name":"Mike"}。

    > db.sample.employee.upsert( { $inc: { age: 1 } }, { age: { $gt: 30 } }, {}, { "name": "Mike" } )
    {
      "UpdatedNum": 0,
      "ModifiedNum": 0,
      "InsertedNum": 1
    }
    >
    > db.sample.employee.find( { "age" : 1, "name": "Mike" } )
    {
         "_id": {
         "$oid": "516a76a1c9565daf06050000"
         },
         "age":1,
         "name":"Mike"
    } 
    Return 1 row(s).
  • 分区集合 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.upsert( { $set: { a: 9, b: 9 } }, {}, {}, {}, { KeepShardingKey: false } )
    {
      "UpdatedNum": 1,
      "ModifiedNum": 1,
      "InsertedNum": 0
    }
    >
    > db.sample.employee.find()
    {
      "_id": {
        "$oid": "5c6f660ce700db6048677154"
      },
      "a": 1,
      "b": 9
    }
    Return 1 row(s).

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

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