Scout を使用した全文検索

Scoutパッケージをインストールする

アプリケーションで Scout を使用する前に、アプリケーションのルートディレクトリから次のコマンドを実行して laravel/scoutパッケージ をインストールしてください。

composer require laravel/scout

モデルに検索可能な属性を追加する

モデルが検索可能になるようにするには、Laravel\Scout\Searchable トラッキングを実行します。次の例では、sample_mflix.moviesコレクション内のドキュメントを表す Movie モデルにこの特性を追加します。

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

また、Searchable トラートを使用して、ドキュメントの再フォーマット、関連ドキュメントの埋め込み、またはドキュメント値の変換を行います。詳細については、Lambda Scout ドキュメントの「検索可能なデータの構成」セクションを参照してください。

アプリケーションで Scout を設定する

アプリケーションがデータベース接続としてMongoDB を使用するように構成されていることを確認します。MongoDBを構成する方法については、 クイック スタートガイドの「 MongoDB接続の構成 」セクションを参照してください。

アプリケーションで Scout を構成するには、アプリケーションの configディレクトリに scout.php という名前のファイルを作成します。以下のコードをファイルに貼り付けて、Scout を構成します。

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

上記のコードでは、次の構成を指定します。

• SCOUT_DRIVER 環境変数の値をデフォルトの検索ドライバーとして使用します。または、環境変数が設定されていない場合は mongodb

• 検索可能なコレクションのコレクション名のプレフィックスとして scout_ を指定します

config/scout.phpファイルでは、カスタム Atlas Searchインデックス定義を指定することもできます。詳しくは、次のステップのカスタムインデックス定義の例を参照してください。

アプリケーションの .envファイルで次の環境変数を設定して、デフォルトの検索ドライバーとして mongodb を選択します。

SCOUT_DRIVER=mongodb

Atlas Search インデックスの作成

Scout を構成し、デフォルトの検索ドライバーを設定したら、アプリケーションの ルートディレクトリから次のコマンドを実行中、検索可能なコレクションと検索インデックスを作成できます。

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

デフォルトの検索ドライバーとしてMongoDB を設定しているため、上記のコマンドはMongoDBデータベースに Atlas Searchインデックスを持つ検索コレクションを作成します。コレクションの名前は、前の手順で設定されたプレフィックスに基づいて、scout_movies に基づきます。Atlas Searchインデックスの名前は scout で、デフォルトでは次の構成です。

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

インデックス定義をカスタマイズするには、config/scout.phpファイルの mongodb エントリに index-definitions 構成を追加します。次のコードは、scout_moviesコレクションに作成するカスタムインデックス定義を指定する方法を示しています。

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

Atlas Searchインデックス定義の定義の詳細については、Atlas ドキュメントの「 フィールド マッピングの定義 」ガイドを参照してください。

検索可能なコレクションへのデータのインポート

Scout を使用して、Eloquet モデルによってモデル化されたソースコレクションから検索可能なコレクションにデータを複製できます。次のコマンドは、moviesコレクションのデータを、前のステップでインデックス付きの scout_moviesコレクションに複製してインデックスを作成します。

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

Atlas Search クエリのドキュメントは自動的にインデックス化されます。

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