検索可能なデータの構成
• #モデル ID の構成

• Search

Laravel Scout

• はじめに
• インストール
  • キュー
  • ドライバー必要条件
• 構成
  • 構成モデルインデックス
  • 検索可能なデータの構成
  • #モデル ID の構成
## インデックス
• バッチインポート
  レコードの追加
  レコードの更新
  レコードの削除
  インデックスの一時停止
  • ##条件付き検索可能なモデル インスタンス
  検索
• Where条件
  • ページング
  • ソフト削除
  • カスタム エンジン検索
  カスタム エンジン
• ジェネレーター マクロ

#はじめに

現在、Scout には

ドライバーが付属しています。ただし、カスタム ドライバーの作成も簡単で、独自の検索実装を使用して Scout を簡単に拡張できます。

インストール

composer require laravel/scout

vendor:publish

config

scout.php 構成ファイルを生成します。

php artisan vendor:publish --provider="Laravel\Scout\ScoutServiceProvider"

config/scout.php 構成ファイルの queue

true# に設定する必要があります。 ## :

<?php
    namespace App;
    use Laravel\Scout\Searchable;
    use Illuminate\Database\Eloquent\Model;
    class Post extends Model{
        use Searchable;
      }

##

ドライバーの必要条件

Algolia

Algolia ドライバーを使用する場合は、config/scout.php で Algolia を設定する必要があります。構成ファイル id および secret 資格情報。資格情報を構成した後、Composer パッケージ マネージャーを使用して Algolia PHP SDK をインストールする必要もあります:

'queue' => true,

#Configuration

モデル インデックスの設定

Eloquent の各モデルは、検索可能なすべてのモデル レコードが含まれる特定の「インデックス」を通じて同期されます。言い換えれば、各「インデックス」を MySQL データ テーブルと考えることができます。デフォルトでは、各モデルは、モデルの「テーブル」名 (通常はモデル名の複数形) に一致するインデックスに永続化されます。モデルの searchableAs メソッドをオーバーライドすることで、モデルのインデックスをカスタマイズすることもできます。

composer require algolia/algoliasearch-client-php:^2.2

Configurable検索データ

デフォルトでは、モデルは完全な toArray 形式で検索インデックスに保存されます。検索インデックスに同期されるデータをカスタマイズする場合は、モデルの toSearchableArray メソッドをオーバーライドできます:

<?php
    namespace App;
    use Laravel\Scout\Searchable;
    use Illuminate\Database\Eloquent\Model;
    class Post extends Model{
        use Searchable;    
      /**
     * 获取索引名称
     *
     * @return string
     */   
     public function searchableAs()  
       {   
            return 'posts_index';  
       }
    }

getScoutKey メソッドを使用してカスタマイズできます:

<?php
    namespace App;
    use Laravel\Scout\Searchable;
    use Illuminate\Database\Eloquent\Model;
    class Post extends Model{ 
       use Searchable;    
     /**
     * 获取模型的可搜索数据
     *
     * @return array
     */ 
      public function toSearchableArray() 
        {      
          $array = $this->toArray();       
           // Customize array...       
           return $array;    
          }
       }

import を提供します。

<?php
    namespace App;
    use Laravel\Scout\Searchable;
    use Illuminate\Database\Eloquent\Model;
    class User extends Model{
        use Searchable;    
     /**
     *  获取模型主键
     *
     * @return mixed
     */   
     public function getScoutKey()  
       {    
           return $this->email;  
         }
     }

flush コマンドを使用して、検索インデックスからすべてのモデル レコードを削除できます。 . :

php artisan scout:import "App\Post"

Laravel\Scout\Searchable traitを追加するとき

save するだけです。モデル インスタンスは自動的に検索インデックスに追加されます。 キューを使用するように Scout を構成した場合、この操作はキュー ワーカー プロセスによってバックグラウンドで実行されます:

php artisan scout:flush "App\Post"

$order = new App\Order;// ...$order->save();

データベースに保存します。 Scout は更新を検索インデックスに自動的に同期します:

// 通过 Eloquent 查询构造器增加..
App\Order::where('price', '>', 100)->searchable();
// 你也可以通过模型关系增加记录...
$user->orders()->searchable();
// 你也可以通过集合增加记录...
$orders->searchable();

searchable メソッドを使用して、モデルのコレクションを更新することもできます。このモデルが検索しているインデックスに存在しない場合は、次のように作成されます:

$order = App\Order::find(1);
// 更新订单...
$order->save();

delete を使用してデータベースからモデルを削除し、インデックス内のレコードを削除します。この形式の削除は論理的な削除モデルとも互換性があります:

// 通过 Eloquent 查询更新...
App\Order::where('price', '>', 100)->searchable();
// 你也可以通过数据间的关联进行更新...
$user->orders()->searchable();
// 你也可以通过数据集合进行更新...
$orders->searchable();

unsearchable メソッドを使用できます。インスタンスまたはコレクション:

$order = App\Order::find(1);
$order->delete();

バッチを実行するときに、検索するためにモデル データの同期を解除する必要がある場合があります。雄弁な操作インデックス。この時点で、

メソッドを使用してこれを行うことができます。このメソッドは、すぐに実行されるコールバックを受け入れます。このコールバックのすべての操作はモデル インデックスと同期されません:

// 通过 Eloquent 查询删除...
App\Order::where('price', '>', 100)->unsearchable();
//  你可以通过数据间的关系进行删除...
$user->orders()->unsearchable();
// 你可以通过数据集合进行删除...
$orders->unsearchable();

App\Post

ShouldBeSearchable メソッドを定義する必要があります。

App\Order::withoutSyncingToSearch(function () { 
   // 执行模型操作...
  });

shouldBeSearchable メソッド。 searchable メソッドを直接使用すると、モデルまたはコレクションの検索可能な結果が ShouldBeSearchable メソッドの結果をオーバーライドします:

public function shouldBeSearchable(){
    return $this->isPublished();
   }

Search

search メソッドを使用してモデルを検索できます。 search メソッドは、モデルを検索するための文字列を受け取ります。また、検索クエリで get メソッドを連鎖させ、特定の検索ステートメントで一致する Eloquent モデルをクエリする必要があります。

// 此处将遵循 "shouldBeSearchable" 结果...
App\Order::where('price', '>', 100)->searchable();
$user->orders()->searchable();$order->save();
// 此处将覆盖 "shouldBeSearchable" 结果...
$orders->searchable();
$order->searchable();

Scout 検索では Eloquent モデルのコレクションが返されるため、次のことが可能です。ルートまたはコントローラーから直接結果を返すと、自動的に JSON 形式に変換されます:

$orders = App\Order::search('Star Trek')->get();

Eloquent モデルに返される前に元の結果を取得したい場合は、raw を使用する必要があります。 メソッド:

use Illuminate\Http\Request;
Route::get('/search', function (Request $request) {
    return App\Order::search($request->search)->get();
   });

検索クエリは通常、モデルの searchableAs メソッドで指定されたインデックスで実行されます。もちろん、within メソッドを使用して検索するカスタム インデックスを指定することもできます:

$orders = App\Order::search('Star Trek')->raw();

Where ステートメント

単純な「where」ステートメントを検索クエリに追加できます。現在、これらのステートメントは基本的な数値的等価性チェックのみをサポートしており、主にテナント ID に基づく範囲検索クエリを目的としています。検索インデックスはリレーショナル データベースではないため、より高度な "where" ステートメントは現在サポートされていません:

$orders = App\Order::search('Star Trek') 
   ->within('tv_shows_popularity_desc')    
   ->get();

paginate メソッドを使用して検索結果をページ分割することもできます。このメソッドは、従来の Eloquent クエリのページネーションと同じように、Paginator インスタンスを返します。

$orders = App\Order::search('Star Trek')->where('user_id', 1)->get();

paginate メソッドに渡します。各ページで取得するモデルの数:

$orders = App\Order::search('Star Trek')->paginate();

$orders = App\Order::search('Star Trek')->paginate(15);

config の値を設定します。 /scout.php 設定ファイルの soft_delete オプションは true:

<div class="container">
    @foreach ($orders as $order) 
           {{ $order->price }}
    @endforeach
    </div>
  {{ $orders->links() }}

true の場合、Scout は論理的に削除されたモデルを検索インデックスから削除しません。代わりに、インデックス レコードに非表示の __soft_deleted 属性を設定します。その後、検索時に、withTrashed または onlyTrashed メソッドを使用して、論理的に削除されたレコードを取得できます。

'soft_delete' => true,

{ヒント} モデルを完全に削除するには、次のようにします。

forceDelete を使用して削除すると、Scout は検索インデックスからモデルを自動的に削除します。

カスタム検索エンジン

エンジンの検索動作をカスタマイズする必要がある場合は、コールバックを 2 番目のパラメーターとして search メソッドに渡すことができます。たとえば、このコールバックを使用して、Algolia に渡す前に検索リクエストに地理位置情報データを追加できます:

// 搜索结果包括已删除的记录...
$orders = App\Order::withTrashed()->search('Star Trek')->get();
// 搜索结果只含已删除的记录...
$orders = App\Order::onlyTrashed()->search('Star Trek')->get();

Custom Engine

エンジンの作成

#組み込みの Scout 検索エンジンがニーズを満たせない場合は、カスタム エンジンを作成して Scout に登録できます。エンジンは Laravel\Scout\Engines\Engine 抽象クラスを継承する必要があります。この抽象クラスには、カスタマイズされたエンジンが実装する必要がある 7 つのメソッドが含まれています:

use Algolia\AlgoliaSearch\SearchIndex;
App\Order::search('Star Trek', function (SearchIndex $algolia, string $query, array $options) {
    $options['body']['query']['bool']['filter']['geo_distance'] = [
            'distance' => '1000km',        
            'location' => ['lat' => 36, 'lon' => 111],  
          ];    
     return $algolia->search($query, $options);
  })->get();

in Laravel\Scout\Engines\AlgoliaEngine クラスでこれらのメソッドの実装を確認するのに非常に役立ちます。このクラスは、カスタム エンジンでこれらのメソッドを実装する方法を学習するための良い出発点となります。

エンジンの登録

カスタム エンジンを作成したら、Scout エンジン管理の extend メソッドを使用して、それを Scout に登録できます。 AppServiceProvider またはアプリケーションで使用されているサービス プロバイダーの boot メソッドから extend メソッドを呼び出すだけです。たとえば、MySqlSearchEngine を作成した場合は、次のように登録できます。

use Laravel\Scout\Builder;
abstract public function update($models);
abstract public function delete($models);
abstract public function search(Builder $builder);
abstract public function paginate(Builder $builder, $perPage, $page);
abstract public function mapIds($results);
abstract public function map($results, $model);
abstract public function getTotalCount($results);
abstract public function flush($model);

エンジンが登録されたら、config/scout.php## にアクセスできます。 # 設定ファイルでデフォルトの Scout として指定します driver:

use Laravel\Scout\EngineManager;
/**
 * 启动任何的服务
 *
 * @return void
 */
 public function boot(){ 
    resolve(EngineManager::class)->extend('mysql', function () {
            return new MySqlSearchEngine;   
         });
      }

Laravel\Scout\Builder クラスの macro メソッドを使用できます。通常、「マクロ」を定義する場合、サービス プロバイダーの boot メソッドを実装する必要があります。

'driver' => 'mysql',

macro この関数は最初のパラメータとして名前を受け取り、 2 番目のパラメータはクロージャ関数です。 が
Laravel\Scout\Builder マクロ コマンドを呼び出すと、この関数が呼び出されます。

<?php
    namespace App\Providers;
    use Laravel\Scout\Builder;
    use Illuminate\Support\ServiceProvider;
    use Illuminate\Support\Facades\Response;
    class ScoutMacroServiceProvider extends ServiceProvider{  
      /**
     * 注册应用的Scout 宏命令.
     *
     * @return void
     */  
       public function boot()  
         {     
            Builder::macro('count', function () {
                 return $this->engine->getTotalCount(           
                      $this->engine()->search($this)    
                           );     
                     });   
           }
        }