Update Documents

Overview

In this guide, you can learn how to use the MongoDB PHP Library to update documents in a MongoDB collection. You can call the MongoDB\Collection::updateOne() method to update a single document or the MongoDB\Collection::updateMany() method to update multiple documents.

$collection = $client->sample_restaurants->restaurants;

Update Operations

You can perform update operations in MongoDB by using the following methods:

• MongoDB\Collection::updateOne(), which updates the first document that matches the search criteria

• MongoDB\Collection::updateMany(), which updates all documents that match the search criteria

Each update method requires the following parameters:

• Query filter document: Specifies which documents to update. For more information about query filters, see the Query Filter Documents section in the MongoDB Server manual.

• Update document: Specifies the update operator, or the kind of update to perform, and the fields and values to change. For a list of update operators and their usage, see the Field Update Operators guide in the MongoDB Server manual.

$result = $collection->updateOne(
    ['name' => 'Bagels N Buns'],
    ['$set' => ['name' => '2 Bagels 2 Buns']],
);

$result = $collection->updateMany(
    ['cuisine' => 'Pizza'],
    ['$set' => ['cuisine' => 'Pasta']],
);

$result = $collection->updateMany(
    ['borough' => 'Manhattan'],
    ['$set' => ['borough' => 'Manhattan (north)']],
    ['upsert' => true],
);

$result = $collection->updateMany(
    ['name' => 'Dunkin\' Donuts'],
    ['$set' => ['name' => 'Dunkin\'']],
);
echo 'Modified documents: ', $result->getModifiedCount();

Modified documents: 206

Update Builder

You can use the MongoDB\Builder\Update class to construct update documents with the support of IDE code completion and PHP type checking. The Update class provides factory methods that correspond to MongoDB update operators such as $set, $inc, and $unset.

To use the update builder, import the following classes into your application:

use MongoDB\Builder\Query;
use MongoDB\Builder\Update;

The following example uses the Update::set() factory method to update the name field to '2 Bagels 2 Buns' in the first matching document with a name value of 'Bagels N Buns' in the restaurants collection:

$result = $collection->updateOne(
    Query::query(name: Query::eq('Bagels N Buns')),
    Update::set(name: '2 Bagels 2 Buns'),
);

To apply multiple update operators in a single operation, pass the operators to the MongoDB\Builder\Update constructor. The following example combines Update::set() and Update::unset() to set the cuisine field to Pasta and remove the grades field from all documents with a cuisine value of 'Pizza':

$result = $collection->updateMany(
    Query::query(cuisine: Query::eq('Pizza')),
    new Update(
        Update::set(cuisine: 'Pasta'),
        Update::unset('grades'),
    ),
);

To learn more about the builder classes and view more examples, see the Operations with Builders guide.

Additional Information

To learn more about creating query filters, see the Specify a Query guide.