insert

Definition定义

insert

The insert command inserts one or more documents and returns a document containing the status of all inserts. insert命令插入一个或多个文档，并返回包含所有插入状态的文档。The insert methods provided by the MongoDB drivers use this command internally.MongoDB驱动程序提供的插入方法在内部使用此命令。

The command has the following syntax:该命令具有以下语法：

{
   insert: <collection>,
   documents: [ <document>, <document>, <document>, ... ],
   ordered: <boolean>,
   writeConcern: { <write concern> },
   bypassDocumentValidation: <boolean>,
   comment: <any>
}

The insert command takes the following fields:insert命令接受以下字段：

Field字段	Type类型	Description描述
insert	string	The name of the target collection.目标集合的名称。
documents	array	An array of one or more documents to insert into the named collection.要插入到命名集合中的一个或多个文档的数组。
ordered	boolean	Optional. 可选。If true, then when an insert of a document fails, return without inserting any remaining documents listed in the inserts array. 如果为true，则当插入文档失败时，返回而不插入inserts数组中列出的任何剩余文档。If false, then when an insert of a document fails, continue to insert the remaining documents. 如果为false，则当插入文档失败时，继续插入其余文档。Defaults to true. 默认为true。
writeConcern	document	Optional. 可选。A document that expresses the write concern of the insert command. 表示insert命令的写入关注的文档。Omit to use the default write concern.忽略则使用默认的写入关注。 Do not explicitly set the write concern for the operation if run in a transaction. 如果在事务中运行，请不要显式设置操作的写入关注点。To use write concern with transactions, see Transactions and Write Concern.要对事务使用写问题，请参阅事务和写入关注。
bypassDocumentValidation	boolean	Optional. 可选。Enables insert to bypass document validation during the operation. 允许insert在操作期间绕过文档验证。This lets you insert documents that do not meet the validation requirements. 这允许您插入不符合验证要求的文档。
comment	any	Optional. 可选。A user-provided comment to attach to this command. 用户提供了附加到此命令的注释。Once set, this comment appears alongside records of this command in the following locations:设置后，此注释将与此命令的记录一起显示在以下位置： mongod log messages, in the attr.command.cursor.comment field.mongod日志消息，在attr.command.cursor.comment字段中。 Database profiler output, in the command.comment field.数据库探查器输出，在command.comment字段中。 currentOp output, in the command.comment field.currentOp输出，在command.comment字段中。 A comment can be any valid BSON type(string, integer, object, array, etc).注释可以是任何有效的BSON类型（字符串、整数、对象、数组等）。 New in version 4.4.在版本4.4中新增。

Returns:返回：	A document that contains the status of the operation. 包含操作状态的文档。See Output for details.有关详细信息，请参阅输出。

Behavior行为

Examples示例

db.runCommand(
   {
      insert: "users",
      documents: [ { _id: 1, user: "abc123", status: "A" } ]
   }
)

{ "ok" : 1, "n" : 1 }

db.runCommand(
   {
      insert: "users",
      documents: [
         { _id: 2, user: "ijk123", status: "A" },
         { _id: 3, user: "xyz123", status: "P" },
         { _id: 4, user: "mop123", status: "P" }
      ],
      ordered: false,
      writeConcern: { w: "majority", wtimeout: 5000 }
   }
)

{ "ok" : 1, "n" : 3 }

db.createCollection("users", {
   validator:
      {
         status: {
            $in: [ "Unknown", "Incomplete" ]
         }
      }
})

db.runCommand({
      insert: "users",
      documents: [ {user: "123", status: "Active" } ]
})

{
   n: 0,
   writeErrors: [
      {
         index: 0,
         code: 121,
         errInfo: {
            failingDocumentId: ObjectId('6197a7f2d84e85d1cc90d270'),
            details: {
               operatorName: '$in',
               specifiedAs: { status: { '$in': [Array] } },
               reason: 'no matching value found in array',
               consideredValue: 'Active'
            }
         },
         errmsg: 'Document failed validation'
      }
   ],
   ok: 1
}

db.runCommand({
   insert: "users",
   documents: [ {user: "123", status: "Active" } ],
   bypassDocumentValidation: true
})

Output输出

The returned document contains a subset of the following fields:返回的文档包含以下字段的子集：

insert.ok

The status of the command.命令的状态。

insert.n

The number of documents inserted.插入的文档数。

insert.writeErrors

An array of documents that contains information regarding any error encountered during the insert operation. 包含插入操作期间遇到的任何错误信息的文档数组。The writeErrors array contains an error document for each insert that errors.writeErrors数组包含每个插入错误的错误文档。

Each error document contains the following fields:每个错误文档包含以下字段：

insert.writeErrors.index

An integer that identifies the document in the documents array, which uses a zero-based index.标识documents数组中文档的整数，该数组使用从零开始的索引。

insert.writeErrors.code

An integer value identifying the error.标识错误的整数值。

insert.writeErrors.errmsg

A description of the error.错误的描述。

insert.writeConcernError

Document that describe error related to write concern and contains the field:描述与写入问题相关的错误并包含以下字段的文档：

insert.writeConcernError.code

An integer value identifying the cause of the write concern error.标识写入问题错误原因的整数值。

insert.writeConcernError.errmsg

A description of the cause of the write concern error.写入问题错误原因的描述。

insert.writeConcernError.errInfo.writeConcern

New in version 4.4.在版本4.4中新增。

The write concern object used for the corresponding operation. 用于相应操作的写关注点对象。For information on write concern object fields, see Write Concern Specification.有关写入问题对象字段的信息，请参阅写入关注规范。

The write concern object may also contain the following field, indicating the source of the write concern:写问题对象还可以包含以下字段，指示写问题的来源：

insert.writeConcernError.errInfo.writeConcern.provenance

A string value indicating where the write concern originated (known as write concern provenance). 一个字符串值，指示写关注点的起源（称为写关注点provenance）。The following table shows the possible values for this field and their significance:下表显示了该字段的可能值及其意义：

Provenance	Description描述
clientSupplied	The write concern was specified in the application.应用程序中指定了写入问题。
customDefault	The write concern originated from a custom defined default value. 写入问题源自自定义定义的默认值。See setDefaultRWConcern. 请参阅setDefaultRWConcern。
getLastErrorDefaults	The write concern originated from the replica set's settings.getLastErrorDefaults field. 写入问题源自副本集的settings.getLastErrorDefaults字段。
implicitDefault	The write concern originated from the server in absence of all other write concern specifications. 在没有所有其他写问题规范的情况下，写问题源于服务器。

The following is an example document returned for a successful insert of a single document:以下是成功insert单个文档时返回的示例文档：

{ ok: 1, n: 1 }

The following is an example document returned for an insert of two documents that successfully inserted one document but encountered an error with the other document:以下是insert两个文档时返回的示例文档，成功插入了一个文档，但在另一个文档中遇到错误：

{
   "ok" : 1,
   "n" : 1,
   "writeErrors" : [
      {
         "index" : 1,
         "code" : 11000,
         "errmsg" : "insertDocument :: caused by :: 11000 E11000 duplicate key error index: test.users.$_id_  dup key: { : 1.0 }"
      }
   ]
}