db.collection.insertOne()

On this page本页内容

Definition定义

db.collection.insertOne()
Important重要
mongosh Method

This is a mongosh method. This is not the documentation for Node.js or other programming language specific driver methods.

In most cases, mongosh methods work the same way as the legacy mongo shell methods. However, some legacy methods are unavailable in mongosh.

For the legacy mongo shell documentation, refer to the documentation for the corresponding MongoDB Server release:

For MongoDB API drivers, refer to the language specific MongoDB driver documentation.

Inserts a single document into a collection.将单个文档插入到集合中。

The insertOne() method has the following syntax:insertOne()方法具有以下语法:

db.collection.insertOne(
   <document>,
   {
      writeConcern: <document>
   }
)
Parameter参数Type类型Description描述
documentdocumentA document to insert into the collection.要插入集合的文档。
writeConcerndocument

Optional. 可选。A document expressing the write concern. 表达写入关注点的文档。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.要对事务使用写关注点,请参阅事务和写关注点

Returns:返回:A document containing:包含以下内容的文档:
  • A boolean acknowledged as true if the operation ran with write concern or false if write concern was disabled.如果操作运行时存在写入问题,则acknowledgedtrue;如果禁用写入关注,则acknowledgedfalse
  • A field insertedId with the _id value of the inserted document.带有插入文档的_id值的insertedId字段。

Behaviors行为

Collection Creation集合创建

If the collection does not exist, then the insertOne() method creates the collection.如果集合不存在,则insertOne()方法将创建集合。

_id Field字段

If the document does not specify an _id field, then mongod will add the _id field and assign a unique ObjectId() for the document before inserting. 如果文档没有指定_id字段,则mongod将添加_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值在集合中必须唯一,以避免重复的键错误。

Explainability可解释性

insertOne() is not compatible with db.collection.explain().insertOne()db.collection.explain()不兼容。

Error Handling错误处理

On error, db.collection.insertOne() throws either a writeError or writeConcernError exception.出错时,db.collection.insertOne()抛出writeErrorwriteConcernError异常。

Transactions事务

db.collection.insertOne() can be used inside multi-document transactions.可以在多文档事务中使用。

Important重要

In most cases, multi-document transaction incurs a greater performance cost over single document writes, and the availability of multi-document 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 multi-document transactions.也就是说,对于许多场景,适当地建模数据将最小化多文档事务的需要。

For additional transactions usage considerations (such as runtime limit and oplog size limit), see also Production Considerations.有关其他事务使用注意事项(如运行时限制和oplog大小限制),请参阅生产注意事项

Collection Creation in Transactions事务记录中的集合创建

Starting in MongoDB 4.4, you can create collections and indexes inside a multi-document transaction if the transaction is not a cross-shard write transaction.从MongoDB 4.4开始,如果事务不是跨分片写入事务,则可以在多文档事务内创建集合和索引。

Specifically, in MongoDB 4.4 and greater, if you specify an insert on a non-existing collection in a transaction, the collection is implicitly created.具体来说,在MongoDB 4.4及更高版本中,如果在事务中的不存在集合上指定插入,则会隐式创建集合。

In MongoDB 4.4 and earlier, the operation must be run on an existing collection.在MongoDB 4.4及更早版本中,操作必须在现有集合上运行。

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.要对事务使用写关注点,请参阅事务和写关注点

Examples示例

Insert a Document without Specifying an _id Field插入文档而不指定_id字段

In the following example, the document passed to the insertOne() method does not contain the _id field:在以下示例中,传递给insertOne()方法的文档不包含_id字段:

try {
   db.products.insertOne( { item: "card", qty: 15 } );
} catch (e) {
   print (e);
};

The operation returns the following document:该操作返回以下文档:

{
   "acknowledged" : true,
   "insertedId" : ObjectId("56fc40f9d735c28df206d078")
}

Because the documents did not include _id, mongod creates and adds the _id field and assigns it a unique ObjectId() value.因为文档不包含_id,所以mongod创建并添加_id字段,并为其分配一个唯一的ObjectId()值。

The ObjectId values are specific to the machine and time when the operation is run. ObjectId值特定于运行操作时的计算机和时间。As such, your values may differ from those in the example.因此,您的值可能与示例中的值不同。

Insert a Document Specifying an _id Field插入指定_id字段的文档

In the following example, the document passed to the insertOne() method includes the _id field. 在下面的示例中,传递给insertOne()方法的文档包含_id字段。The value of _id must be unique within the collection to avoid duplicate key error._id的值在集合中必须是唯一的,以避免重复的键错误。

try {
   db.products.insertOne( { _id: 10, item: "box", qty: 20 } );
} catch (e) {
   print (e);
}

The operation returns the following:该操作返回以下结果:

{ "acknowledged" : true, "insertedId" : 10 }

Inserting an duplicate value for any key that is part of a unique index, such as _id, throws an exception. 为作为唯一索引一部分的任何键(如_id)插入重复值会引发异常。The following attempts to insert a document with a _id value that already exists:以下操作尝试插入已存在_id值的文档:

try {
   db.products.insertOne( { _id: 10, "item" : "packing peanuts", "qty" : 200 } );
} catch (e) {
   print (e);
}

Since _id: 10 already exists, the following exception is thrown:由于_id:10已存在,将引发以下异常:

WriteError({
   "index" : 0,
   "code" : 11000,
   "errmsg" : "E11000 duplicate key error collection: inventory.products index: _id_ dup key: { : 10.0 }",
   "op" : {
      "_id" : 10,
      "item" : "packing peanuts",
      "qty" : 200
   }
})

Increase Write Concern增加写入问题

Given a three member replica set, the following operation specifies a w of majority, wtimeout of 100:给定一个三成员副本集,以下操作指定w为多数,wtimeout100

try {
   db.products.insertOne(
       { "item": "envelopes", "qty": 100, type: "Self-Sealing" },
       { writeConcern: { w : "majority", wtimeout : 100 } }
   );
} catch (e) {
   print (e);
}

If the acknowledgement takes longer than the wtimeout limit, the following exception is thrown:如果确认花费的时间超过wtimeout限制,将引发以下异常:

WriteConcernError({
   "code" : 64,
   "errmsg" : "waiting for replication timed out",
   "errInfo" : {
     "wtimeout" : true,
     "writeConcern" : {
    // Added in MongoDB 4.4
       "w" : "majority",
       "wtimeout" : 100,
       "provenance" : "getLastErrorDefaults"
     }
   }
})
Tip提示
See also: 参阅:
←  db.collection.insert()db.collection.insertMany() →