Actualizar la versión de la librería

Versiones 5.x cambios disruptivos

Esta versión de la librería presenta los siguientes cambios disruptivos:

• El generador de query devuelve los resultados como stdClass objetos en lugar de como arreglos. Este cambio requiere que cambie el acceso a arreglos por acceso a propiedades al interactuar con resultados de queries.

  El siguiente código muestra cómo recuperar un resultado de query y acceder a una propiedad del objeto resultado en versiones antiguas en comparación con la v5.0:

  $document = DB::table('accounts')
      ->where('name', 'Anita Charles')
      ->first();
  // older versions
  $document['balance'];
  // v5.0
  $document->balance;

• Elimina el soporte para las siguientes clases:

  • MongoDB\Laravel\Auth\DatabaseTokenRepository. En cambio, utiliza la clase Illuminate\Queue\Failed\DatabaseFailedJobProvider por defecto y especifica una conexión a MongoDB.

  • MongoDB\Laravel\Queue\Failed\MongoFailedJobProvider. En cambio, utiliza la clase Illuminate\Queue\Failed\DatabaseFailedJobProvider por defecto y especifica una conexión a MongoDB.

• Cuando se utiliza un DateTimeInterface objeto, incluida Carbon, en una consulta, la librería convierte el/la DateTimeInterface en un objeto MongoDB\BSON\UTCDateTime. Esta conversión se aplica a los DateTimeInterface objetos pasados como filtros de query al método where() o como datos pasados a los métodos insert() y update().

  Para ver un ejemplo que pasa un objeto Carbon al método DB::where(), consulta la sección Ejemplo de Fechas Matcheadas de la guía del Generador de query.

• En los resultados de la query, la librería convierte los objetos BSON UTCDateTime a clases de fecha Carbon, aplicando la zona horaria por defecto.

  En v5.1, la librería también realiza esta conversión a los resultados del método Model::raw() antes de hidratar una instancia del Modelo.

• id es un alias para el campo _id en documentos de MongoDB, y la librería convierte automáticamente entre id y _id al consultar datos. El objeto de resultado de la query incluye un campo id que representa el campo _id del documento. Debido a este comportamiento, no puedes tener dos campos id y _id separados en tus documentos.

  En la v5.1, la librería también realiza esta conversión a los resultados del método Model::raw() antes de hidratar una instancia de Modelo. Al pasar un filtro de query complejo, utiliza el método DB::where() en lugar de Model::raw().

  A partir de v5.3, puedes desactivar la conversión automática de id a _id para los documentos incrustados. Para obtener más información, consulte la sección Desactivar el uso de conversión de nombres de campo "id" de la guía Opciones de conexión.

• Se remueve la compatibilidad con la propiedad $collection. El siguiente código muestra cómo asignar una colección de MongoDB a una variable en tu clase User en versiones anteriores a la v5.0:

  use MongoDB\Laravel\Eloquent\Model;
  class User extends Model
  {
      protected $keyType = 'string';
      // older versions
      protected $collection = 'app_user';
      // v5.0
      protected $table = 'app_user';
      ...
  }

  Esta versión también modifica los métodos DB y Schema asociados para acceder a una colección de MongoDB. El siguiente código muestra cómo acceder a la colección app_user en versiones antiguas en comparación con la v5.0:

  use Illuminate\Support\Facades\Schema;
  use Illuminate\Support\Facades\DB;
  use MongoDB\Laravel\Schema\Blueprint;
  // older versions
  Schema::collection('app_user', function (Blueprint $collection) { ... });
  DB::collection('app_user')->find($id);
  // v5.0
  Schema::table('app_user', function (Blueprint $table) { ... });
  DB::table('app_user')->find($id);

Cambios disruptivos en la versión 4.x

Esta versión de la librería presenta los siguientes cambios disruptivos:

• La versión mínima de Laravel ahora es 10.0. Para obtener instrucciones sobre cómo actualizar tu versión de Laravel, consulta la Guía de actualización en la documentación de Laravel.

• El nombre de la dependencia ahora es "mongodb/laravel-mongodb". Asegúrese de que el nombre de la dependencia en su archivo composer.json sea "mongodb/laravel-mongodb": "^4.0". Luego, ejecuta composer update.

• El namespace ahora es MongoDB\Laravel\. Asegúrate de cambiar el namespace de Jenssegers\Mongodb\ a MongoDB\Laravel\ en tus modelos y archivos de configuración.

• Remueve el soporte para proyectos que no sean de Laravel.

• Se elimina el soporte para la propiedad $dates. Asegúrate de cambiar todas las instancias de $dates a $casts en tus archivos de modelo.

• Model::unset($field) no conserva el cambio. Asegúrate de que sigues todas las llamadas a Model::unset($field) con Model::save().

• Elimina el método Query\Builder::whereAll($column, $values). Asegúrese de reemplazar todas las llamadas a Query\Builder::whereAll($column, $values) por Query\Builder::where($column, 'all', $values).

• Query\Builder::delete() puedes borrar uno o todos los documentos. Asegúrate de pasar solo los valores 1 o null a limit().

• whereDate(), whereDay(), whereMonth(), whereYear(), y whereTime() métodos ahora utilizan operadores de MongoDB en campos de fecha.

• Agrega el MongoDB\Laravel\Eloquent\MassPrunable rasgo. Asegúrate de reemplazar todas las instancias de Illuminate\Database\Eloquent\MassPrunable por MongoDB\Laravel\Eloquent\MassPrunable en tus modelos.

• Remueve el soporte para los siguientes métodos de Query\Builder:

  • toSql()

  • toRawSql()

  • whereColumn()

  • whereFullText()

  • groupByRaw()

  • orderByRaw()

  • unionAll()

  • union()

  • having()

  • havingRaw()

  • havingBetween()

  • whereIntegerInRaw()

  • orWhereIntegerInRaw()

  • whereIntegerNotInRaw()

  • orWhereIntegerNotInRaw()

Versión 5.8 Obsolescencias

A partir de Laravel MongoDB v5.8, el tipo de conversión array para los atributos del modelo Eloquent está obsoleto. Usar array como tipo de conversión almacena los valores de los atributos como cadenas codificadas en JSON en MongoDB, que no es el formato BSON nativo. Cuando se escribe en un atributo que utiliza la conversión array, la biblioteca emite el siguiente aviso de obsolescencia:

USER DEPRECATED  The "array" cast on attribute "<attribute>"
of model "<Model>" stores values as a JSON-encoded string in
MongoDB, which is not the native format. Remove the cast to
store native BSON arrays. If you must keep JSON string
storage, use the "json" cast explicitly.

El aviso de obsolescencia incluye el nombre del atributo afectado y la clase del modelo.

Para migrar los atributos de su modelo para futuras versiones, utilice una de las siguientes opciones:

• Elimine la conversión array (recomendado). Sin una conversión de tipo, MongoDB almacena y recupera de forma nativa los arrays de PHP como arrays BSON. El siguiente código muestra cómo actualizar su modelo:

  // Before (deprecated in v5.8)
  protected $casts = [
      'options' => 'array',
  ];
  // After: remove the cast to use native BSON storage
  protected $casts = [
      // other casts...
  ];

• Reemplace array con json para mantener explícitamente el almacenamiento de la cadena JSON:

  protected $casts = [
      'options' => 'json',
  ];

Si un campo ya contiene una matriz BSON nativa y el modelo todavía usa la conversión array, la biblioteca lo lee correctamente.