collection.insertOne()¶

On this page

Definition

Usage
Example
Parameters
Return Value

Definition¶

collection.insertOne()¶

Insert a single document into a collection and return the _id of the inserted document.

Usage¶

Example¶

To call the collection.insertOne() action from a Function, get a collection handle with database.collection() then call the handle's insertOne() method.

const newItem = {
  "name": "Plastic Bricks",
  "quantity": 10,
  "category": "toys",
  "reviews": [{ "username": "legolover", "comment": "These are awesome!" }]
};
itemsCollection.insertOne(newItem)
  .then(result => console.log(`Successfully inserted item with _id: ${result.insertedId}`))
  .catch(err => console.error(`Failed to insert item: ${err}`))

Parameters¶

The collection.insertOne() action has the following form:

insertOne(document)

Parameter	Description
Insert Document `document: <document>`	A document to insert into the collection.
Client Session `session: <ClientSession>`	Optional. A client session that specifies the transaction context in which the operation occurs. To learn more, see Transactions.

Return Value¶

The collection.insertOne() action returns a Promise that resolves to a document that describes the insert operation.

Promise<result: document>

Value	Description
Inserted ID `result.insertedId: <ObjectID>`	The `_id` value of the document that the insert operation added to the collection.

← collection.findOneAndDelete()collection.insertMany() →