Modificar documentos

Overview

En esta guía, aprenderá a modificar documentos de su colección MongoDB desde su aplicación Laravel usando Laravel MongoDB. Utilice operaciones de actualización para modificar documentos existentes o para insertar uno si ninguno coincide con los criterios de búsqueda.

Puede conservar los cambios en una instancia de un modelo Eloquent o utilizar la sintaxis fluida de Eloquent para encadenar una operación de actualización en métodos que devuelven un objeto de colección de Laravel.

Esta guía proporciona ejemplos de las siguientes operaciones de actualización:

• Actualizar un documento

• Actualizar varios documentos

• Actualizar o insertar en una sola operación

• Actualizar matrices en un documento

<?php
namespace App\Models;
use MongoDB\Laravel\Eloquent\Model;
class Concert extends Model
{
    protected $connection = 'mongodb';
    protected $fillable = ['performer', 'venue', 'genres', 'ticketsSold', 'performanceDate'];
    protected $casts = ['performanceDate' => 'datetime'];
}

Actualizar un documento

Puede actualizar un documento de las siguientes maneras:

• Modifique una instancia del modelo y guarde los cambios llamando al método save().

• Métodos de cadena para recuperar una instancia de un modelo y realizar actualizaciones en él llamando al método update().

El siguiente ejemplo muestra cómo actualizar un documento modificando una instancia del modelo y llamando a su método save():

$concert = Concert::first();
$concert->venue = 'Manchester Arena';
$concert->ticketsSold = 9543;
$concert->save();

Cuando el método save() tiene éxito, la instancia del modelo en la que llamó al método contiene los valores actualizados.

Si la operación falla, la integración de Laravel asigna a la instancia del modelo un valor null.

El siguiente ejemplo muestra cómo actualizar un documento encadenando métodos para recuperar y actualizar el primer documento coincidente:

$concert = Concert::where(['performer' => 'Brad Mehldau'])
    ->orderBy('id')
    ->first()
    ->update(['venue' => 'Manchester Arena', 'ticketsSold' => 9543]);

Cuando el método update() tiene éxito, la operación devuelve el número de documentos actualizados.

Si la parte de recuperación de la llamada no coincide con ningún documento, la integración de Laravel devuelve el siguiente error:

Error: Call to a member function update() on null

Actualiza varios documentos

Para realizar una actualización en uno o más documentos, encadene el método update() a los resultados de un método que recupere los documentos como un objeto de colección de Laravel, como where().

El siguiente ejemplo muestra cómo encadenar llamadas para recuperar documentos coincidentes y actualizarlos:

Concert::whereIn('venue', ['Philharmonie de Paris', 'Soldier Field'])
    ->update(['venue' => 'Concertgebouw', 'ticketsSold' => 0]);

Cuando el método update() tiene éxito, la operación devuelve el número de documentos actualizados.

Si la parte de recuperación de la llamada no coincide con ningún documento de la colección, la integración de Laravel devuelve el siguiente error:

Error: Call to a member function update() on null

Actualizar o insertar en una sola operación

Una operación upsert permite realizar una actualización o inserción en una sola operación. Esta operación agiliza la tarea de actualizar un documento o insertar uno si no existe.

A partir de v4.7, puede realizar una operación de inserción y actualización mediante cualquiera de los siguientes métodos:

• upsert():Cuando utiliza este método, puede realizar una inserción y actualización por lotes para cambiar o insertar varios documentos en una sola operación.

• update()Al usar este método, debe especificar la opción upsert para actualizar todos los documentos que coincidan con el filtro de consulta o insertar un documento si no hay coincidencias. Este método upsert solo es compatible con las versiones v4.6 y anteriores.

YourModel::upsert(
   [/* documents to update or insert */],
   '/* unique field */',
   [/* fields to update */],
);

Concert::upsert([
    ['performer' => 'Angel Olsen', 'venue' => 'Academy of Music', 'ticketsSold' => 275],
    ['performer' => 'Darondo', 'venue' => 'Cafe du Nord', 'ticketsSold' => 300],
], 'performer', ['ticketsSold']);

{
  "_id": "...",
  "performer": "Angel Olsen",
  "venue": "State Theatre",
  "genres": [
    "indie",
    "rock"
  ],
  "ticketsSold": 275,
  "updated_at": ...
},
{
  "_id": "...",
  "performer": "Darondo",
  "venue": "Cafe du Nord",
  "ticketsSold": 300,
  "updated_at": ...
}

YourModel::where(/* match criteria */)
   ->update(
       [/* update data */],
       ['upsert' => true]);

Concert::where(['performer' => 'Jon Batiste', 'venue' => 'Radio City Music Hall'])
    ->update(
        ['genres' => ['R&B', 'soul'], 'ticketsSold' => 4000],
        ['upsert' => true],
    );

{
  "_id": "660c...",
  "performer": "Jon Batiste",
  "venue": "Radio City Music Hall",
  "genres": [
    "R&B",
    "soul"
  ],
  "ticketsSold": 4000,
  "updated_at": ...
}

Actualizar matrices en un documento

En esta sección, puede ver ejemplos de las siguientes operaciones que actualizan valores de matriz en un documento MongoDB:

• Agregar valores a una matriz

• Eliminar valores de una matriz

• Actualizar el valor de un elemento de arreglo

Estos ejemplos modifican el documento de muestra creado mediante la siguiente operación de inserción:

Concert::create([
    'performer' => 'Mitsuko Uchida',
    'genres' => ['classical', 'dance-pop'],
]);

YourModel::where(<match criteria>)
   ->push(
       <field name>,
       [<values>], // array or single value to add
       unique: true); // whether to skip existing values

Concert::where('performer', 'Mitsuko Uchida')
    ->push(
        'genres',
        ['baroque'],
    );

{
  "_id": "660eb...",
  "performer": "Mitsuko Uchida",
  "genres": [
      "classical",
      "dance-pop",
  ],
  "updated_at": ...,
  "created_at": ...
}

YourModel::where(<match criteria>)
   ->pull(
       <field name>,
       [<values>]); // array or single value to remove

Concert::where('performer', 'Mitsuko Uchida')
    ->pull(
        'genres',
        ['dance-pop', 'classical'],
    );

{
  "_id": "660e...",
  "performer": "Mitsuko Uchida",
  "genres": [],
  "updated_at": ...,
  "created_at": ...
}

DB::connection('mongodb')
   ->getCollection(<collection name>)
   ->updateOne(
       <match criteria>,
       ['$set' => ['<array field>.$' => <replacement value>]]);

$match = ['performer' => 'Mitsuko Uchida', 'genres' => 'dance-pop'];
$update = ['$set' => ['genres.$' => 'contemporary']];
DB::connection('mongodb')
    ->getCollection('concerts')
    ->updateOne($match, $update);

{
  "_id": "660e...",
  "performer": "Mitsuko Uchida",
  "genres": [
    "classical",
    "contemporary"
  ],
  "updated_at": ...,
  "created_at": ...
}

Información Adicional

Para ver ejemplos de código ejecutable que demuestran cómo actualizar documentos utilizando la integración de Laravel, consulte los siguientes ejemplos de uso:

• Actualizar un documento

• Actualiza varios documentos

Para aprender cómo insertar documentos en una colección MongoDB, consulta la guía Insertar documentos.