Búsqueda de texto completo con Scout

Instala el paquete Scout

Antes de que puedas utilizar Scout en tu aplicación, ejecuta el siguiente comando desde el directorio raíz de tu aplicación para instalar el paquete laravel/scout:

composer require laravel/scout

Agrega el atributo Searchable a tu 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.

Configurando Scout en tu aplicación

Asegúrate de que tu aplicación esté configurada para utilizar MongoDB como su conexión de base de datos. Para aprender cómo configurar MongoDB, consulta la sección Configura tu conexión de 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. Pega 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 archivo config/scout.php, también puede especificar una definición personalizada de índice de búsqueda de MongoDB. Para obtener más información, consulta 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 establecer tu controlador de búsqueda predeterminado, puedes crear tu colección buscable e índice de búsqueda ejecutando el siguiente comando desde el directorio raíz de tu aplicación:

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

Dado que has configurado MongoDB como el driver de búsqueda por defecto, el comando anterior crea la colección de búsqueda con un índice MongoDB Search en tu base de datos MongoDB. La colección se llama scout_movies, en función del prefijo establecido en el paso anterior. El índice MongoDB Search se llama scout y tiene la siguiente configuración por defecto:

{
  "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 saber más sobre cómo definir definiciones de índice de MongoDB Search, consulta la guía definir mapeos de campos en la documentación de Atlas.

Importa datos en la colección que se puede buscar

Puedes utilizar Scout para replicar datos de una colección de origen modelada por tu modelo de Eloquent en una colección que se pueda buscar. 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,
        ];
    }
}