insert()

名称

insert - 将单条或者批量记录插入当前集合。

语法

db.collectionspace.collection.insert(<doc|docs>,[flag])

db.collectionspace.collection.insert(<doc|docs>,[options])

类别

Collection

描述

将单条或者批量记录插入当前集合。

参数描述

  • doc|docs ( Object|Object of Array必填 )

    单条或者批量记录。

  • flag ( Int选填 )

    插入标志位,用于控制插入操作的行为及结果。其默认值为 0。可单独使用或者通过“位与”的方式使用如下选项来控制插入操作的行为及结果:

    • SDB_INSERT_RETURN_ID:表示插入成功后返回记录中“_id”字段的内容。
    • SDB_INSERT_CONTONDUP:默认情况下,当发生索引键冲突时,插入操作将失败并且终止。设置该选项后,当发生索引键冲突时,跳过该条记录并继续插入其他记录。
    • SDB_INSERT_REPLACEONDUP:默认情况下,当发生索引键冲突时,插入操作将失败并且终止。设置该选项后,当发生索引键冲突时,将已存在的记录更新为待插入的新记录,并继续插入其他记录。
  • options ( Object选填 )

    插入选项,用于控制插入操作的行为及结果。参数 options 等同于参数 flag,其属性选项如下:

    • ReturnOID ( Bool选填 ):等同于参数 flag 中的 SDB_INSERT_RETURN_ID 选项。
    • ContOnDup ( Bool选填 ):等同于参数 flag 中的 SDB_INSERT_CONTONDUP 选项。
    • ReplaceOnDup ( Bool选填 ):等同于参数 flag 中的 SDB_INSERT_REPLACEONDUP 选项。

Note:

  • 当插入的记录不包含 “_id” 字段时,SequoiaDB 会自动为记录添加一个 “_id” 字段来唯一标识该记录。

  • 参数 flag 中的 SDB_INSERT_CONTONDUP 和 SDB_INSERT_REPLACEONDUP 选项不能同时组合使用。使用参数 options 时的情况与使用参数 flag 的一致。

返回值

  • 成功返回详细结果信息(BSONObj 对象),结构如下:

    1. {
    2. InsertedNum : <INT32> 成功插入的记录数,不包含替代和忽略的记录,
    3. DuplicatedNum : <INT32> 因重复键冲突被忽略或替代的记录数
    4. }

    当用户开启 flag 参数的 SDB_INSERT_RETURN_ID 选项或者 options 参数的 ReturnOID 选项时,详细结果信息中还包含 “_id” 字段,情况如下:

    • 单条插入:直接返回插入记录的“_id”字段的内容。
    • 批量插入:以数组的方式返回插入记录的“_id”字段的内容。
  • 出错抛异常。

错误

insert()函数常见异常如下:

错误码错误类型描述解决方法
-6SDB_INVALIDARG参数错误。查看参数是否填写正确。
-23SDB_DMS_NOTEXIST集合不存在。检查集合是否存在。
-34SDB_DMS_CS_NOTEXIST集合空间不存在。检查集合空间是否存在。
-38SDB_IXM_DUP_KEY索引键已存在。检查插入的记录的索引键是否已经存在。

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

版本

v1.0及以上版本。

示例

  1. 不指定 _id 字段,插入一条记录。

    1. > db.sample.employee.insert( { name: "Tom", age: 20 } )
  2. 插入一条带有 _id 字段的记录。

    1. > db.sample.employee.insert( {_id: 10, age: 20 } )
  3. 插入多条记录,如下操作会在集合employee中插入两条记录。

    1. > db.sample.employee.insert( [ { _id: 20, name: "Mike", age: 15 }, { name: "John", age: 25, phone: 123 } ] )
  4. 插入拥有重复“_id”键的多条记录,如下操作将会在集合employee中插入两条记录。

    1. > db.sample.employee.insert( [ { _id: 1, a: 1 }, { _id: 1, b:2 }, { _id: 3, c: 3 } ], SDB_INSERT_CONTONDUP )
    1. > db.sample.employee.find()
    2. {
    3. "_id": 1,
    4. "a": 1,
    5. }
    6. {
    7. "_id": 3,
    8. "c": 3
    9. }
  5. 插入记录,并以 Json 对象的方式返回结果。

    1. > db.sample.employee.insert({a:1}, {ReturnOID:true, ContOnDup:true})
    2. {
    3. "_id": {
    4. "$oid": "5becec3d6404b9295a63caca"
    5. }
    6. "InsertedNum": 1,
    7. "DuplicatedNum": 0
    8. }
    9. >
    10. > db.sample.employee.insert([{a:1}, {b:1}], {ReturnOID:true, ContOnDup:true})
    11. {
    12. "_id": [
    13. {
    14. "$oid": "5bececdf6404b9295a63cacb"
    15. },
    16. {
    17. "$oid": "5bececdf6404b9295a63cacc"
    18. }
    19. ]
    20. "InsertedNum": 2,
    21. "DuplicatedNum": 0
    22. }