Skip to content

Commit

Permalink
NR PR fixes 2
Browse files Browse the repository at this point in the history
  • Loading branch information
@rustagir
rustagir committed Feb 3, 2025
1 parent e7b0fe3 commit 45a7e79
Showing 1 changed file with 155 additions and 150 deletions.
305 changes: 155 additions & 150 deletions docs/scout.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,17 @@ Full-Text Search with Scout
===========================

.. facet::
:name: genre
:values: reference
:name: genre
:values: reference

.. meta::
:keywords: php framework, odm, code example, text search, atlas
:keywords: php framework, odm, code example, text search, atlas

.. contents:: On this page
:local:
:backlinks: none
:depth: 2
:class: singlecol
:local:
:backlinks: none
:depth: 2
:class: singlecol

Overview
--------
Expand All @@ -41,9 +41,9 @@ functionality:

.. note:: Deployment Compatibility

You can use Laravel Scout only when you connect to MongoDB Atlas
clusters. This feature is not available for self-managed or
serverless deployments.
You can use Laravel Scout only when you connect to MongoDB Atlas
clusters. This feature is not available for self-managed or
serverless deployments.

Scout for Atlas Search Tutorial
-------------------------------
Expand All @@ -52,146 +52,151 @@ This section demonstrates how to use the Scout integration in your
application to support Atlas Search queries.

.. procedure::
:style: connected

.. step:: Install Scout package

Before you can use Scout in your application, run the following
command from your application's root directory to install Laravel Scout:

.. code-block:: bash

composer require laravel/scout

.. step:: Add the Searchable trait to your model

Add the ``Laravel\Scout\Searchable`` trait to an Eloquent model to make
it searchable. The following example adds this trait to the ``Movie``
model, which represents documents in the ``sample_mflix.movies``
collection:

.. code-block:: php
:emphasize-lines: 6, 10

<?php

namespace App\Models;

use MongoDB\Laravel\Eloquent\Model;
use Laravel\Scout\Searchable;

class Movie extends Model
{
use Searchable;

protected $connection = 'mongodb';
}

.. step:: Configure Scout in your application

Ensure that your application is configured to use MongoDB as its
database connection. To learn how to configure MongoDB, see the
:ref:`laravel-quick-start-connect-to-mongodb` section of the Quick Start
guide.

To configure Scout in your application, create a file named
``scout.php`` in your application's ``config`` directory. Paste the
following code into the file to configure Scout:

.. code-block:: php
:caption: config/scout.php

<?php

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

The preceding code specifies the following configuration:

- Uses MongoDB as the default search driver
- Specifies ``scout_`` as the prefix for the collection name of the
searchable collection

.. tip:: Queueing

When using Scout, consider configuring a queue driver to reduce
response times for your application's web interface. To learn more,
see the `Queuing section
<https://laravel.com/docs/{+laravel-docs-version+}/scout#queueing>`__
of the Laravel Scout documentation and the :ref:`laravel-queues` guide.

.. step:: Create the Atlas Search index

After you configure Scout and set your default search driver, you can
create your searchable collection and search index by running the
following command from your application's root directory:

.. code-block:: bash

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

Because you set MongoDB as the default search driver, the preceding
command creates the search collection with an Atlas Search index in your
MongoDB database. The collection is named ``scout_movies``, based on the prefix
set in the preceding section. The Atlas Search index is named ``scout``
and has the following configuration:

.. code-block:: json

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

.. note::

MongoDB can take up to a minute to create and finalize
an Atlas Search index, so the ``scout:index`` command might not
return a success message immediately.

.. step:: Import data into the searchable collection

You can use Scout to replicate data from a source collection into a
searchable collection. The following command replicates and indexes data
from the ``movies`` collection into the ``scout_movies`` collection
created in the preceding section:

.. code-block:: bash

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

The documents are automatically indexed for Atlas Search queries.

.. tip:: Select Fields to Import

You might not need all the fields from your source documents in your
searchable collection. Limiting the fields you replicate can improve
your application's speed and performance.

You can select specific fields to import by defining the
``toSearchableArray()`` method in your Eloquent model class. The
following code demonstrates how to define ``toSearchableArray()`` to
select only the ``plot`` and ``title`` fields for replication:

.. code-block:: php

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

.. step:: Install the Scout package

Before you can use Scout in your application, run the following
command from your application's root directory to install Laravel Scout:

.. code-block:: bash

composer require laravel/scout

.. step:: Add the Searchable trait to your model

Add the ``Laravel\Scout\Searchable`` trait to an Eloquent model to make
it searchable. The following example adds this trait to the ``Movie``
model, which represents documents in the ``sample_mflix.movies``
collection:

.. code-block:: php
:emphasize-lines: 6, 10

<?php

namespace App\Models;

use MongoDB\Laravel\Eloquent\Model;
use Laravel\Scout\Searchable;

class Movie extends Model
{
use Searchable;

protected $connection = 'mongodb';
}

.. step:: Configure Scout in your application

Ensure that your application is configured to use MongoDB as its
database connection. To learn how to configure MongoDB, see the
:ref:`laravel-quick-start-connect-to-mongodb` section of the Quick Start
guide.

To configure Scout in your application, create a file named
``scout.php`` in your application's ``config`` directory. Paste the
following code into the file to configure Scout:

.. code-block:: php
:caption: config/scout.php

<?php

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

The preceding code specifies the following configuration:

- Uses MongoDB as the default search driver
- Specifies ``scout_`` as the prefix for the collection name of the
searchable collection

.. tip:: Queueing

When using Scout, consider configuring a queue driver to reduce
response times for your application's web interface. To learn more,
see the `Queuing section
<https://laravel.com/docs/{+laravel-docs-version+}/scout#queueing>`__
of the Laravel Scout documentation and the :ref:`laravel-queues` guide.

.. step:: Create the Atlas Search index

After you configure Scout and set your default search driver, you can
create your searchable collection and search index by running the
following command from your application's root directory:

.. code-block:: bash

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

Because you set MongoDB as the default search driver, the preceding
command creates the search collection with an Atlas Search index in your
MongoDB database. The collection is named ``scout_movies``, based on the prefix
set in the preceding step. The Atlas Search index is named ``scout``
and has the following configuration:

.. code-block:: json

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

.. note::

MongoDB can take up to a minute to create and finalize
an Atlas Search index, so the ``scout:index`` command might not
return a success message immediately.

.. step:: Import data into the searchable collection

You can use Scout to replicate data from a source collection into a
searchable collection. The following command replicates and indexes data
from the ``movies`` collection into the ``scout_movies`` collection
created in the preceding step:

.. code-block:: bash

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

The documents are automatically indexed for Atlas Search queries.

.. tip:: Select Fields to Import

You might not need all the fields from your source documents in your
searchable collection. Limiting the fields you replicate can improve
your application's speed and performance.

You can select specific fields to import by defining the
``toSearchableArray()`` method in your Eloquent model class. The
following code demonstrates how to define ``toSearchableArray()`` to
select only the ``plot`` and ``title`` fields for replication:

.. code-block:: php

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

After completing these steps, you can perform Atlas Search queries on the
``scout_movies`` collection in your {+odm-long+} application.

.. TODO add link to Atlas Search guide

.. TODO Use an External Search Engine
.. -----------------------------
Expand Down

0 comments on commit 45a7e79

Please sign in to comment.