Constructor de esquema

Crear una clase de migración

Puedes crear clases de migración manualmente o generarlas usando el comando php artisan make:migration. Si los generas, debes realizar los siguientes cambios para aplicar los cambios de esquema en tu base de datos MongoDB:

• Reemplace la importación Illuminate\Database\Schema\Blueprint con MongoDB\Laravel\Schema\Blueprint si se hace referencia a ella en su migración

• Utilice únicamente comandos y sintaxis compatibles con la Integración de Laravel

La siguiente clase de migración de ejemplo contiene los siguientes métodos:

• up(), lo que crea una colección y un índice cuando ejecutas la migración

• down(), la cual descarta la colección y todos sus índices cuando se revierte la migración

<?php
declare(strict_types=1);
use Illuminate\Database\Migrations\Migration;
use Illuminate\Support\Facades\Schema;
use MongoDB\Laravel\Schema\Blueprint;
return new class extends Migration
{
    protected $connection = 'mongodb';
    /**
     * Run the migrations.
     */
    public function up(): void
    {
        Schema::create('astronauts', function (Blueprint $collection) {
            $collection->index('name');
        });
    }
    /**
     * Reverse the migrations.
     */
    public function down(): void
    {
        Schema::drop('astronauts');
    }
};

Ejecuta o revierte una migración

Para ejecutar la migración de la base de datos desde un archivo de clase, ejecuta el siguiente comando después de substituir el marcador de posición:

php artisan migrate --path=<path to your migration class file>

Este comando ejecuta la función up() en el archivo de clase para crear la colección e índice en la base de datos especificada en el archivo config/database.php.

Para revertir la migración, ejecute el siguiente comando después de reemplazar el texto de marcador de posición:

php artisan migrate:rollback --path=<path to your migration class file>

Este comando ejecuta la función down() en el archivo de clase para descartar la colección y los índices relacionados.

Para obtener más información sobre las migraciones de Laravel, consulte Base de datos: Migraciones en la documentación de Laravel.

Crear un índice

Para crear índices, llame al método create() sobre la fachada Schema en su archivo de migración. Pásale el nombre de la colección y una función de retorno con un parámetro MongoDB\Laravel\Schema\Blueprint. Especifique los detalles de creación del índice en la instancia Blueprint.

El siguiente ejemplo de migración crea índices en los siguientes campos de colección:

• Índice de campo único activado mission_type

• Índice compuesto en launch_location y launch_date, especificando un orden de clasificación descendente en launch_date

• Índice único en el campo mission_id, especificando el nombre del índice "unique_mission_id_idx"

Haga clic en el VIEW OUTPUT Botón para ver los índices creados al ejecutar la migración, incluido el índice predeterminado en el campo _id:

Schema::create('flights', function (Blueprint $collection) {
    $collection->index('mission_type');
    $collection->index(['launch_location' => 1, 'launch_date' => -1]);
    $collection->unique('mission_id', options: ['name' => 'unique_mission_id_idx']);
});

[
  { v: 2, key: { _id: 1 }, name: '_id_' },
  { v: 2, key: { mission_type: 1 }, name: 'mission_type_1' },
  {
    v: 2,
    key: { launch_location: 1, launch_date: -1 },
    name: 'launch_location_1_launch_date_-1'
  },
  {
    v: 2,
    key: { mission_id: 1 },
    name: 'unique_mission_id_idx',
    unique: true
  }
]

Especifica las opciones del índice

Las opciones de índice de MongoDB determinan cómo se utilizan y almacenan los índices. Puedes especificar opciones de índice al llamar a un método de creación de índice, como index(), en una instancia de Blueprint.

El siguiente código de migración muestra cómo añadir una intercalación a un índice como opción de índice. Haga clic en el botón VIEW OUTPUT para ver los índices creados al ejecutar la migración, incluido el índice predeterminado en el campo _id:

Schema::create('passengers', function (Blueprint $collection) {
    $collection->index(
        'last_name',
        name: 'passengers_collation_idx',
        options: [
            'collation' => [ 'locale' => 'de@collation=phonebook', 'numericOrdering' => true ],
        ],
    );
});

[
  { v: 2, key: { _id: 1 }, name: '_id_' },
  {
    v: 2,
    key: { last_name: 1 },
    name: 'passengers_collation_idx',
    collation: {
      locale: 'de@collation=phonebook',
      caseLevel: false,
      caseFirst: 'off',
      strength: 3,
      numericOrdering: true,
      alternate: 'non-ignorable',
      maxVariable: 'punct',
      normalization: false,
      backwards: false,
      version: '57.1'
    }
  }
]

Para obtener más información sobre las opciones de índice, consulte Opciones para todos los tipos de índice en el manual del servidor.

Crear índices únicos, TTL y dispersos

Puedes usar los métodos asistentes de MongoDB para Laravel para crear los siguientes tipos de índices:

• Índices dispersos, que permiten entradas de índice solo para documentos que contienen el campo especificado

• Índices de tiempo de vida (TTL), que expiran después de un tiempo establecido.

• Índices únicos, los cuales evitan que se inserten documentos que contengan valores duplicados para el campo indexado

Para crear estos tipos de índice, llame al método create() en la fachada Schema de su archivo de migración. Pase a create() el nombre de la colección y un método de devolución de llamada con un parámetro MongoDB\Laravel\Schema\Blueprint. Llame al método auxiliar correspondiente en la instancia Blueprint y pase los detalles de creación del índice.

El siguiente código de migración muestra cómo crear un índice disperso y un índice TTL usando los asistentes de índice. Haz clic en el botón VIEW OUTPUT para ver los índices creados al ejecutar la migración, incluido el índice por defecto en el campo _id:

Schema::create('planets', function (Blueprint $collection) {
    $collection->sparse('rings');
    $collection->expire('last_visible_dt', 86400);
});

[
  { v: 2, key: { _id: 1 }, name: '_id_' },
  { v: 2, key: { rings: 1 }, name: 'rings_1', sparse: true },
  {
    v: 2,
    key: { last_visible_dt: 1 },
    name: 'last_visible_dt_1',
    expireAfterSeconds: 86400
  }
]

Puedes especificar índices dispersos, TTL y únicos en un solo campo o índice compuesto especificándolos en las opciones del índice.

El siguiente código de migración muestra cómo crear los tres tipos de índices en un solo campo. Haga clic en el botón VIEW OUTPUT para ver los índices creados al ejecutar la migración, incluido el índice predeterminado en el campo _id:

Schema::create('planet_systems', function (Blueprint $collection) {
    $collection->index('last_visible_dt', options: ['sparse' => true, 'expireAfterSeconds' => 3600, 'unique' => true]);
});

[
  { v: 2, key: { _id: 1 }, name: '_id_' },
  {
    v: 2,
    key: { last_visible_dt: 1 },
    name: 'last_visible_dt_1',
    unique: true,
    sparse: true,
    expireAfterSeconds: 3600
  }
]

Para obtener más información sobre estos índices, consulte Propiedades de índice en el manual del servidor.

Crear un índice geoespacial

En MongoDB, los índices geoespaciales le permiten consultar datos de coordenadas geoespaciales para inclusión, intersección y proximidad.

Para crear índices geoespaciales, llama al método create() en la fachada Schema en tu archivo de migración. Pasa create() el nombre de la colección y un método de función de retorno con un parámetro MongoDB\Laravel\Schema\Blueprint. Especifica los detalles de creación del índice geoespacial en la instancia Blueprint.

La siguiente migración de ejemplo crea un índice geoespacial 2d y 2dsphere en la colección spaceports. Haga clic en el botón VIEW OUTPUT para ver los índices creados al ejecutar la migración, incluido el índice predeterminado en el campo _id:

Schema::create('spaceports', function (Blueprint $collection) {
    $collection->geospatial('launchpad_location', '2dsphere');
    $collection->geospatial('runway_location', '2d');
});

[
  { v: 2, key: { _id: 1 }, name: '_id_' },
  {
    v: 2,
    key: { launchpad_location: '2dsphere' },
    name: 'launchpad_location_2dsphere',
    '2dsphereIndexVersion': 3
  },
  { v: 2, key: { runway_location: '2d' }, name: 'runway_location_2d' }
]

Para obtener más información sobre los índices geoespaciales, consulte Índices geoespaciales en el manual del servidor.

Descartar un índice

Para eliminar índices de una colección, llame al método table() en la fachada Schema del archivo de migración. Pásele el nombre de la tabla y un método de devolución de llamada con un parámetro MongoDB\Laravel\Schema\Blueprint. Llame al método dropIndex() con el nombre del índice en la instancia Blueprint.

El siguiente ejemplo de migración elimina un índice llamado unique_mission_id_idx de la colección flights:

Schema::table('flights', function (Blueprint $collection) {
    $collection->dropIndex('unique_mission_id_idx');
});