collection.insertOne()¶

On this page

Definition
Usage

Definition¶

collection.insertOne()¶

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

Usage¶

Example¶

Functions
iOS SDK
Android SDK
JavaScript SDKs

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

copy

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}`))

To call the collection.insertOne() action from the Swift/iOS SDK, use the RemoteMongoCollection.insertOne() method.

copy

let newItem: Document = [
    "name": "Plastic Bricks",
    "quantity": 10,
    "category": "toys",
    "reviews": [
        [
            "username": "legolover",
            "comment": "These are awesome!"
        ] as Document
    ],
];

itemsCollection?.insertOne(newItem) { result in
    switch result {
    case .success(let result):
        print("Successfully inserted item with _id: \(result.insertedId))");
    case .failure(let error):
        print("Failed to insert item: \(error)");
    }
}

To call the collection.insertOne() action from the Java/Android SDK, use the RemoteMongoCollection.insertOne() method.

copy

Document newItem = new Document()
    .append("name", "legos")
    .append("quantity", 10)
    .append("category", "toys")
    .append("reviews", Arrays.asList(
        new Document()
        .append("username", "mongolover")
        .append("comment", "this is great")
    ));


final Task <RemoteInsertOneResult> insertTask = itemsCollection.insertOne(newItem);
insertTask.addOnCompleteListener(new OnCompleteListener <RemoteInsertOneResult> () {
    @Override
    public void onComplete(@NonNull Task <RemoteInsertOneResult> task) {
        if (task.isSuccessful()) {
            Log.d("app", String.format("successfully inserted item with id %s",
                task.getResult().getInsertedId()));
        } else {
            Log.e("app", "failed to insert document with: ", task.getException());
        }
    }
});

To call the collection.insertOne() action from a JavaScript SDK, use the RemoteMongoCollection.insertOne() method.

copy

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¶

Functions
iOS SDK
Android SDK
JavaScript SDKs

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

copy

insertOne(document)

Parameter	Description
Insert Document `document: <document>`	A document to insert into the collection.

The insertOne() method has the following form:

copy

insertOne(document)

Parameter	Description
Insert Document `document: <document>`	A document to insert into the collection.

The insertOne() method has the following form:

copy

insertOne(DocumentT document)

Parameter	Description
Insert Document `document: <document>`	A document to insert into the collection.

The insertOne() method has the following form:

copy

insertOne(document)

Parameter	Description
Insert Document `document: <document>`	A document to insert into the collection.

Return Value¶

Functions
iOS SDK
Android SDK
JavaScript SDKs

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

copy

Promise<result: document>

The RemoteMongoCollection.insertOne() method returns a StitchResult enum that resolves to a RemoteInsertOneResult object that describes the insert operation.

copy

enum StitchResult {
  case success(result: RemoteInsertOneResult)
  case failure(error: StitchError)
}

The RemoteMongoCollection.insertOne() method returns a Task that resolves to a RemoteInsertOneResult object that describes the insert operation.

copy

Task<RemoteInsertOneResult result>

The RemoteMongoCollection.insertOne() method returns a Promise that resolves to a RemoteInsertOneResult object that describes the insert operation.

copy

Promise<result: RemoteInsertOneResult>

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

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