Búsqueda de texto completo con Scout

Instala el paquete Scout

Antes de poder usar Scout en su aplicación, ejecute el siguiente comando desde el directorio raíz de su aplicación para instalar el paquete laravel/scout:

composer require laravel/scout

Agregue el rasgo de búsqueda a su modelo

Agregar el rasgo Laravel\Scout\Searchable a un modelo de Eloquent para hacerlo indexable. El siguiente ejemplo añade esta característica al modelo Movie, que representa documentos en la colección sample_mflix.movies:

<?php
namespace App\Models;
use MongoDB\Laravel\Eloquent\Model;
use Laravel\Scout\Searchable;
class Movie extends Model
{
    use Searchable;
    protected $connection = 'mongodb';
}

También puedes utilizar el atributo Searchable para reformatear documentos, insertar documentos relacionados o transformar valores de documentos. Para obtener más información, consulta la sección Configurando datos buscables de la documentación de Laravel Scout.

Configurar Scout en tu aplicación

Asegúrese de que su aplicación esté configurada para usar MongoDB como conexión a la base de datos. Para saber cómo configurar MongoDB, consulte la sección "Configurar su conexión a MongoDB" de la guía de inicio rápido.

Para configurar Scout en su aplicación, cree un archivo llamado scout.php en el directorio config de su aplicación. Pegue el siguiente código en el archivo para configurar Scout:

<?php
return [
    'driver' => env('SCOUT_DRIVER', 'mongodb'),
    'mongodb' => [
        'connection' => env('SCOUT_MONGODB_CONNECTION', 'mongodb'),
    ],
    'prefix' => env('SCOUT_PREFIX', 'scout_'),
];

El código anterior especifica la siguiente configuración:

• Utiliza el valor de la variable de entorno SCOUT_DRIVER como driver de búsqueda por defecto, o mongodb si la variable de entorno no está configurada

• Especifica scout_ como prefijo para el nombre de la colección de la colección búsqueda.

En el config/scout.php archivo, también puede especificar una definición de índice de búsqueda de MongoDB personalizada. Para obtener más información, consulte el ejemplo de definición de índice personalizado en el siguiente paso.

Establezca la siguiente variable de entorno en el archivo .env de su aplicación para seleccionar mongodb como el controlador de búsqueda por defecto:

SCOUT_DRIVER=mongodb

Crear el índice de MongoDB Search

Después de configurar Scout y configurar su controlador de búsqueda predeterminado, puede crear su colección de búsqueda y su índice de búsqueda ejecutando el siguiente comando desde el directorio raíz de su aplicación:

php artisan scout:index 'App\Models\Movie'

Dado que ha configurado MongoDB como controlador de búsqueda predeterminado, el comando anterior crea la colección de búsqueda con un índice de búsqueda de MongoDB en su base de datos MongoDB. La colección se llama scout_movies, basándose en el prefijo establecido en el paso anterior. El índice de búsqueda de MongoDB se llama scout y tiene la siguiente configuración predeterminada:

{
  "mappings": {
    "dynamic": true
  }
}

Para personalizar la definición del índice, añade la configuración index-definitions a la entrada mongodb en tu archivo config/scout.php. El siguiente código muestra cómo especificar una definición personalizada de índice para crear en la colección scout_movies:

'mongodb' => [
    'connection' => env('SCOUT_MONGODB_CONNECTION', 'mongodb'),
    'index-definitions' => [
        'scout_movies' => [
            'mappings' => [
                'dynamic' => false,
                'fields' => ['title' => ['type' => 'string']]
            ]
        ]
    ]
], ...

Para obtener más información sobre cómo definir definiciones de índices de búsqueda de MongoDB, consulte la guía Definir asignaciones de campos en la documentación de Atlas.

Importa datos en la colección que se puede buscar

Puede usar Scout para replicar datos de una colección de origen modelada por su modelo Eloquent en una colección con capacidad de búsqueda. El siguiente comando replica e indexa datos de la colección movies en la colección scout_movies indexada en el paso anterior:

php artisan scout:import 'App\Models\Movie'

Los documentos se indexan automáticamente para las consultas de MongoDB Search.

class Movie extends Model
{
    ....
    public function toSearchableArray(): array
    {
        return [
            'plot' => $this->plot,
            'title' => $this->title,
        ];
    }
}