Important
Deprecated mongosh Method弃用的mongosh方法
This method is deprecated in mongosh. For alternative methods, see Compatibility Changes with Legacy mongo Shell.mongosh中已弃用此方法。有关替代方法,请参阅与旧版mongo Shell的兼容性更改。
Definition定义
db.collection.insert()Inserts a document or documents into a collection.将一个或多个文档插入到集合中。Returns:返回A WriteResult object for single inserts.用于单次插入的WriteResult对象。A BulkWriteResult object for bulk inserts.用于批量插入的BulkWriteResult对象。
Syntax语法
The insert() method has the following syntax:insert()方法具有以下语法:
db.collection.insert(
<document or array of documents>,
{
writeConcern: <document>,
ordered: <boolean>
}
)
document | ||
writeConcern |
| |
ordered |
|
The insert() returns an object that contains the status of the operation.insert()返回一个包含操作状态的对象。
Behaviors行为
Write Concern写关注
The insert() method uses the insert command, which uses the default write concern. insert()方法使用insert命令,该命令使用默认的写关注。To specify a different write concern, include the write concern in the options parameter.要指定不同的写入关注,请将写入关注包含在options参数中。
Create Collection创建集合
If the collection does not exist, then the 如果该集合不存在,则insert() method will create the collection.insert()方法将创建该集合。
_id Field字段
If the document does not specify an _id field, then MongoDB will add the 如果文档没有指定_id field and assign a unique ObjectId() for the document before inserting. _id字段,则MongoDB将添加_id字段,并在插入之前为文档分配一个唯一的ObjectId()。Most drivers create an ObjectId and insert the 大多数驱动程序创建一个_id field, but the mongod will create and populate the _id if the driver or application does not.ObjectId并插入_id字段,但如果驱动程序或应用程序没有创建并填充_id,mongod将创建并填充该_id。
If the document contains an 如果文档包含_id field, the _id value must be unique within the collection to avoid duplicate key error._id字段,则_id值在集合中必须是唯一的,以避免重复键错误。
Transactions事务
db.collection.insert() can be used inside distributed transactions.可以在分布式事务中使用。
Important
In most cases, a distributed transaction incurs a greater performance cost over single document writes, and the availability of distributed transactions should not be a replacement for effective schema design. 在大多数情况下,分布式事务比单文档写入产生更大的性能成本,分布式事务的可用性不应取代有效的模式设计。For many scenarios, the denormalized data model (embedded documents and arrays) will continue to be optimal for your data and use cases. 对于许多场景,非规范化数据模型(嵌入式文档和数组)将继续是数据和用例的最佳选择。That is, for many scenarios, modeling your data appropriately will minimize the need for distributed transactions.也就是说,对于许多场景,适当地对数据进行建模将最大限度地减少对分布式事务的需求。
For additional transactions usage considerations (such as runtime limit and oplog size limit), see also Production Considerations.有关其他事务使用注意事项(如运行时限制和oplog大小限制),另请参阅生产注意事项。
Collection Creation in Transactions事务中的集合创建
You can create collections and indexes inside a distributed transaction if the transaction is not a cross-shard write transaction.如果分布式事务不是跨分片写入事务,则可以在该事务内创建集合和索引。
If you specify an insert on a non-existing collection in a transaction, MongoDB creates the collection implicitly.如果在事务中不存在的集合上指定插入,MongoDB将隐式创建该集合。
Write Concerns and Transactions撰写入关注和事务
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.如果在事务中运行,则不要显式设置操作的写入关注。要对事务使用写关注,请参阅事务和写关注。
Oplog Entries操作日志条目
If a 如果db.collection.insert() operation successfully inserts a document, the operation adds an entry on the oplog (operations log). db.collection.insert()操作成功插入文档,则该操作会在oplog(操作日志)上添加一个条目。If the operation fails, the operation does not add an entry on the oplog.如果操作失败,则操作不会在oplog上添加条目。
Examples示例
The following examples insert documents into the 以下示例将文档插入到products collection. If the collection does not exist, the insert() method creates the collection.products集合中。如果集合不存在,insert()方法将创建集合。
Insert a Document without Specifying an _id Field插入文档而不指定_id字段
_id FieldIn the following example, the document passed to the 在以下示例中,传递给insert() method does not contain the _id field:insert()方法的文档不包含_id字段:
db.products.insert( { item: "card", qty: 15 } )
During the insert, 在插入过程中,mongod will create the _id field and assign it a unique ObjectId() value, as verified by the inserted document:mongod将创建_id字段并为其分配一个唯一的ObjectId()值,由插入的文档验证:
{ "_id" : ObjectId("5063114bd386d8fadbd6b004"), "item" : "card", "qty" : 15 }
The ObjectId值特定于运行操作的机器和时间。因此,值可能与示例中的值不同。ObjectId values are specific to the machine and time when the operation is run. As such, your values may differ from those in the example.
Insert a Document Specifying an _id Field插入指定_id字段的文档
_id FieldIn the following example, the document passed to the 在以下示例中,传递给insert() method includes the _id field. The value of _id must be unique within the collection to avoid duplicate key error.insert()方法的文档包含_id字段。_id的值在集合中必须是唯一的,以避免重复键错误。
db.products.insert( { _id: 10, item: "box", qty: 20 } )
The operation inserts the following document in the 该操作在products collection:products集合中插入以下文档:
{ "_id" : 10, "item" : "box", "qty" : 20 }Insert Multiple Documents插入多个文档
The following example performs a bulk insert of three documents by passing an array of documents to the 以下示例通过向insert() method. insert()方法传递一个文档数组来执行三个文档的批量插入。By default, MongoDB performs an ordered insert. With ordered inserts, if an error occurs during an insert of one of the documents, MongoDB returns on error without processing the remaining documents in the array.默认情况下,MongoDB执行有序插入。使用有序插入,如果在插入其中一个文档时发生错误,MongoDB将返回错误,而不处理数组中的其余文档。
The documents in the array do not need to have the same fields. For instance, the first document in the array has an 数组中的文档不需要具有相同的字段。例如,数组中的第一个文档有一个_id field and a type field. _id字段和一个type字段。Because the second and third documents do not contain an 由于第二个和第三个文档不包含_id field, mongod will create the _id field for the second and third documents during the insert:_id字段,mongod将在插入过程中为第二个及第三个文档创建_id字段:
db.products.insert(
[
{ _id: 11, item: "pencil", qty: 50, type: "no.2" },
{ item: "pen", qty: 20 },
{ item: "eraser", qty: 25 }
]
)
The operation inserted the following three documents:该操作插入了以下三个文档:
{ "_id" : 11, "item" : "pencil", "qty" : 50, "type" : "no.2" }
{ "_id" : ObjectId("51e0373c6f35bd826f47e9a0"), "item" : "pen", "qty" : 20 }
{ "_id" : ObjectId("51e0373c6f35bd826f47e9a1"), "item" : "eraser", "qty" : 25 }Perform an Unordered Insert执行无序插入
The following example performs an unordered insert of three documents. With unordered inserts, if an error occurs during an insert of one of the documents, MongoDB continues to insert the remaining documents in the array.以下示例执行三个文档的无序插入。对于无序插入,如果在插入其中一个文档时发生错误,MongoDB将继续插入数组中的其余文档。
db.products.insert(
[
{ _id: 20, item: "lamp", qty: 50, type: "desk" },
{ _id: 21, item: "lamp", qty: 20, type: "floor" },
{ _id: 22, item: "bulk", qty: 100 }
],
{ ordered: false }
)Override Default Write Concern覆盖默认写入关注
The following operation to a replica set specifies a write concern of 以下对副本集的操作指定了w: 2 with a wtimeout of 5000 milliseconds. w:2的写入关注,wtimeout为5000毫秒。This operation either returns after the write propagates to both the primary and one secondary, or times out after 5 seconds.此操作要么在写入传播到主服务器和一个辅助服务器后返回,要么在5秒后超时。
db.products.insert(
{ item: "envelopes", qty : 100, type: "Clasp" },
{ writeConcern: { w: 2, wtimeout: 5000 } }
)WriteResult
When passed a single document, 当传递单个文档时,insert() returns a WriteResult object.insert()返回一个WriteResult对象。
Successful Results成功的结果
The insert() returns a WriteResult() object that contains the status of the operation. insert()返回一个包含操作状态的WriteResult()对象。Upon success, the 成功后,WriteResult() object contains information on the number of documents inserted:WriteResult()对象包含插入文档数量的信息:
WriteResult({ "nInserted" : 1 })Write Concern Errors写入关注错误
If the 如果insert() method encounters write concern errors, the results include the WriteResult.writeConcernError field:insert()方法遇到写关注错误,则结果包括WriteResult.writeConcernError字段:
WriteResult({
"nInserted" : 1,
"writeConcernError"({
"code" : 64,
"errmsg" : "waiting for replication timed out",
"errInfo" : {
"wtimeout" : true,
"writeConcern" : {
"w" : "majority",
"wtimeout" : 100,
"provenance" : "getLastErrorDefaults"
}
}
})
Errors Unrelated to Write Concern与写入关注无关的错误
If the 如果insert() method encounters a non-write concern error, the results include the WriteResult.writeError field:insert()方法遇到非写入关注错误,则结果包括WriteResult.writeError字段:
WriteResult({
"nInserted" : 0,
"writeError" : {
"code" : 11000,
"errmsg" : "insertDocument :: caused by :: 11000 E11000 duplicate key error index: test.foo.$_id_ dup key: { : 1.0 }"
}
})BulkWriteResult
When passed an array of documents, 当传递一个文档数组时,insert() returns a BulkWriteResult() object. insert()返回一个BulkWriteResult()对象。See 有关详细信息,请参阅BulkWriteResult() for details.BulkWriteResult()。