adonisjs scout

АдонисДжс Скаут

Adonis Scout предоставляет решение на основе драйверов для поиска ваших моделей Lucid, вдохновленное Laravel Scout и Scout Elasticsearch Driver.

Установка

Используйте npm или Yarn для установки пакета:

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

Добавьте Scout в список поставщиков услуг в start/app.js :

 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, статуса сборки, комбинезонов.
• Добавить скан лицензии
• Добавьте лучшую вики/документацию

Что еще? Пожалуйста, откройте вопрос для предложений.