adonisjs scout

AdonisJs スカウト

Adonis Scout は、Laravel Scout および Scout Elasticsearch Driver から大きく影響を受けた、Lucid モデルを検索するためのドライバーベースのソリューションを提供します。

設置

npm または Yarn を使用してパッケージをインストールします。

npm -i @brainnit/adonisjs-scout
# or
yarn add @brainnit/adonisjs-scout

start/app.jsにあるサービス プロバイダーのリストに Scout を追加します。

 const providers = [
  // ...
  '@brainnit/adonisjs-scout/providers/ScoutProvider' ,
  '@brainnit/adonisjs-scout/providers/IndexKeeperProvider'
] ; 

設定

config/index.jsアプリの構成フォルダーにコピーし、 scout.js名前を付けます。環境変数を設定することを忘れないでください。

使用する検索エンジン ドライバーによっては、追加の依存関係をインストールする必要がある場合もあります。たとえば、Elasticsearch を使用するには、次のものが必要です。

npm i --save elasticsearch bodybuilder
# or
yarn add elasticsearch bodybuilder

使用法

@provider:Searchableトレイトをモデルに追加し、デフォルトの動作を変更するためにオーバーライドするメソッドのみを定義します。

 /** @type {typeof import('@adonisjs/lucid/src/Lucid/Model')} */
const Model = use ( 'Model' ) ;

class User extends Model {
  static get traits ( ) {
    return [ '@provider:Searchable' ]
  }
}

module . exports = Users

その後、最初の IndexKeeper を作成し、次のコマンドを実行してアプリケーションのインデックスを作成/削除します。

 # if you want to create your indexes
adonis scout:up
# or this if you want to drop indexes
adonis scout:down

検索ルール

検索ルールは、検索クエリの実行方法を記述するクラスであり、 Builderインスタンスのサポートにより、複雑で再利用可能な検索を構築できるようになります。

検索ルールを作成するには、次のコマンドを使用します。

adonis make:searchableRule MySearchRule

ファイル app/Models/SearchableRules/MySearchRule.js にクラス定義があります。

 'use strict'

/** @type {typeof import('@brainnit/adonisjs-scout/src/SearchRule')} */
const SearchRule = use ( 'Scout/SearchRule' )

class MySearchRule extends SearchRule {
  buildQuery ( ) {
    return {
      'must' : {
        'match' : {
          'name' : this . builder . query
        }
      }
    }
  }
}

module . exports = MySearchRule

モデルがサポートする検索ルールを Scout に伝えるには、次のメソッドを追加するだけです。

  /**
   * Specify what search rules the model supports.
   * 
   * The return value(s) must always class namespaces that will be
   * resolved by IoC Container.
   *
   * @static
   * 
   * @method searchableRules
   * 
   * @return {Array|String} ES6 Class
   */
  static searchableRules ( ) {
    return [ 'App/Models/SearchRules/MySearchRule' ]
  } 

やり残し

• インデックスの作成/更新操作をインデックス作成メソッドから切り離します (Elasticsearch)
• コマンドの追加 (make:scout:searchableModel、make:scout:searchRule、make:scout:indexKeeper)
• すべてのエラーコードを文書化する
• セットアップ手順を追加する
• npm バージョン、ビルドステータス、カバーオールのバッジを追加
• ライセンススキャンを追加
• より良い wiki/ドキュメントを追加する

ほかに何か？提案が必要な場合は、問題を開いてください。