Construtor de esquemas

Criar uma classe de migração

Você pode criar classes de migração manualmente ou gerá-las usando o comando php artisan make:migration . Se você gerá-los, deverá fazer as seguintes alterações para executar as alterações de esquema em seu banco de MongoDB database:

• Substitua a importação Illuminate\Database\Schema\Blueprint por MongoDB\Laravel\Schema\Blueprint se ela for referenciada em sua migração

• Use apenas comandos e sintaxe suportados pela integração Laravel

O exemplo de classe de migração a seguir contém os seguintes métodos:

• up(), que cria uma collection e um índice quando você executa a migração

• down(), que descarta a coleção e todos os índices quando você reverte a migração

<?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');
    }
};

Executar ou Reverter uma Migração

Para executar a migração do banco de dados de um arquivo de classe, execute o seguinte comando após substituir o espaço reservado:

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

Este comando executa a função up() no arquivo de classe para criar a coleção e índice no banco de dados especificado no arquivo config/database.php .

Para reverter a migração, execute o seguinte comando depois de substituir o espaço reservado:

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

Este comando executa a função down() no arquivo de classe para soltar a coleção e índices relacionados.

Para saber mais sobre migrações do Laravel, consulte Banco de Dados: Migrações na documentação do Laravel.

Crie um índice

Para criar índices, execute as seguintes ações:

1. Ligue para o método create() na face Schema em seu arquivo de migração.

2. Passe o nome da collection e um método de chamada de resposta com um parâmetro MongoDB\Laravel\Schema\Blueprint.

3. Especifique os detalhes de criação do índice na instância do Blueprint.

O exemplo de migração a seguir cria índices nos seguintes campos de coleção:

• Índice de campo único ativado mission_type

• Índice composto em launch_location e launch_date, especificando uma ordem de classificação decrescente em launch_date

• Índice único no campo mission_id , especificando o nome do índice "unique_mission_id_idx"

Clique no botão VIEW OUTPUT para ver os índices criados pela execução da migração, incluindo o índice padrão no 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
  }
]

Especificar opções de índice

As opções de índice do MongoDB determinam como os índices são usados e armazenados. Você pode especificar opções de índice ao chamar um método de criação de índice, como index(), em uma instância Blueprint .

O código de migração a seguir mostra como adicionar um agrupamento a um índice como uma opção de índice. Clique no botão VIEW OUTPUT para ver os índices criados pela execução da migração, incluindo o índice padrão no 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 saber mais sobre as opções de índice, consulte Opções para todos os tipos de índice no manual do servidor MongoDB.

Criar índices esparsos, TTL e únicos

Você pode usar os métodos assistente do Laravel MongoDB para criar os seguintes tipos de índices:

• Índices esparsos, que permitem entradas de índice somente para documentos que contêm o campo especificado

• Índices de vida útil (TTL), que expiram após um período de tempo definido

• Índices únicos, que impedem a inserção de documentos que contêm valores duplicados para o campo indexado

Para criar esses tipos de índice, execute as seguintes ações:

1. Ligue para o método create() na face Schema em seu arquivo de migração.

2. Passe para create() o nome da collection e um método de chamada de resposta com um parâmetro MongoDB\Laravel\Schema\Blueprint.

3. Chame o método assistente apropriado para o tipo de índice na instância Blueprint e passe os detalhes da criação do índice.

O código de migração a seguir mostra como criar um índice esparso e um índice TTL usando os auxiliares de índice. Clique no botão VIEW OUTPUT para ver os índices criados pela execução da migração, incluindo o índice padrão no 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
  }
]

Você pode especificar índices esparsos, TTL e únicos em um único campo ou índice composto especificando-os nas opções de índice.

O seguinte código de migração mostra como criar todos os três tipos de índices em um único campo. Clique no botão VIEW OUTPUT para ver os índices criados pela execução da migração, incluindo o índice padrão no 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 saber mais sobre esses índices, consulte Propriedades do índice no manual do servidor MongoDB.

Criar um índice geoespacial

No MongoDB, os índices geoespaciais permitem consultar dados de coordenadas geoespaciais para inclusão, interseção e proximidade.

Para criar índices geoespaciais, execute as seguintes ações:

1. Ligue para o método create() na face Schema em seu arquivo de migração.

2. Passe para create() o nome da collection e um método de chamada de resposta com um parâmetro MongoDB\Laravel\Schema\Blueprint.

3. Especifique os detalhes de criação do índice geoespacial na instância do Blueprint.

A seguinte migração de exemplo cria um índice geoespacial 2d e 2dsphere na coleção spaceports . Clique no botão VIEW OUTPUT para ver os índices criados pela execução da migração, incluindo o índice padrão no 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 saber mais sobre índices geoespaciais, consulte Índices geoespaciais no manual do servidor.

Descarte um índice

Para descartar índices de uma coleção, execute as seguintes ações:

1. Ligue para o método table() na face Schema em seu arquivo de migração.

2. Passe o nome da tabela e um método de chamada de resposta com um parâmetro MongoDB\Laravel\Schema\Blueprint.

3. Chame o método dropIndex() com o nome do índice na instância Blueprint.

O exemplo de migração a seguir elimina um índice chamado unique_mission_id_idx da coleção flights :

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

Gerencie índices do Atlas Search e Vector Search

No MongoDB, os índices do Atlas Search oferecem suporte às suas queries de texto completo. Os índices doAtlas Vector Search suportam pesquisas de similaridade que comparam vetores de query para incorporações vetoriais em seus documentos.

Consulte os seguintes guias para saber mais sobre os recursos Atlas Search e Atlas Vector Search :

• Atlas Search guide

• Guia do Atlas Vector Search

Schema::create('galaxies', function (Blueprint $collection) {
    $collection->searchIndex([
        'mappings' => [
            'dynamic' => true,
        ],
    ], 'dynamic_index');
    $collection->searchIndex([
        'mappings' => [
            'fields' => [
                'name' => [
                    ['type' => 'string', 'analyzer' => 'lucene.english'],
                    ['type' => 'autocomplete', 'analyzer' => 'lucene.english'],
                    ['type' => 'token'],
                ],
            ],
        ],
    ], 'auto_index');
});

{
  "id": "...",
  "name": "dynamic_index",
  "type": "search",
  "status": "READY",
  "queryable": true,
  "latestDefinition": {
    "mappings": { "dynamic": true }
  },
  ...
}
{
  "id": "...",
  "name": "auto_index",
  "type": "search",
  "status": "READY",
  "queryable": true,
  "latestDefinition": {
    "mappings": {
      "fields": { "name": [
        { "type": "string", "analyzer": "lucene.english" },
        { "type": "autocomplete", "analyzer": "lucene.english" },
        { "type": "token" }
      ] }
    }
  },
  ...
}

Schema::create('galaxies', function (Blueprint $collection) {
    $collection->vectorSearchIndex([
        'fields' => [
            [
                'type' => 'vector',
                'numDimensions' => 4,
                'path' => 'embeddings',
                'similarity' => 'cosine',
            ],
        ],
    ], 'vs_index');
});

{
  "id": "...",
  "name": "vs_index",
  "type": "vectorSearch",
  "status": "READY",
  "queryable": true,
  "latestDefinition": {
    "fields": [ {
        "type": "vector",
        "numDimensions": 4,
        "path": "embeddings",
        "similarity": "cosine"
    } ]
  },
  ...
}

Schema::table('galaxies', function (Blueprint $collection) {
    $collection->dropSearchIndex('auto_index');
});