adonisjs scout

Pramuka Adonis

Adonis Scout memberikan solusi berbasis driver untuk mencari model Lucid Anda, sangat terinspirasi oleh Laravel Scout dan Scout Elasticsearch Driver.

Instalasi

Gunakan npm atau benang untuk menginstal paket:

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

Tambahkan Scout ke daftar penyedia layanan di start/app.js :

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

Pengaturan

Salin config/index.js ke folder konfigurasi aplikasi Anda dan beri nama scout.js . Jangan lupa untuk mengatur variabel lingkungan Anda.

Anda mungkin juga perlu menginstal dependensi tambahan tergantung pada driver mesin pencari yang akan Anda gunakan. Misalnya, untuk menggunakan Elasticsearch Anda memerlukan:

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

Penggunaan

Tambahkan @provider:Searchable ke model Anda dan tentukan hanya metode yang ingin Anda timpa untuk mengubah perilaku default:

 /** @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

Setelah itu, buat IndexKeeper pertama Anda dan jalankan perintah berikut untuk membuat/menghapus indeks pada aplikasi Anda:

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

Aturan Pencarian

Aturan pencarian adalah kelas yang menjelaskan bagaimana permintaan pencarian akan dieksekusi dan memungkinkan Anda membuat pencarian yang kompleks dan dapat digunakan kembali dengan dukungan instance Builder .

Untuk membuat aturan pencarian gunakan perintah berikut:

adonis make:searchableRule MySearchRule

Dalam file app/Models/SearchableRules/MySearchRule.js Anda akan menemukan definisi kelas:

 '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

Untuk memberi tahu Scout tentang aturan pencarian yang didukung model Anda, cukup tambahkan metode berikut:

  /**
   * 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' ]
  } 

Jaminan simpanan

• Matikan operasi pembuatan/perbarui indeks dari metode pengindeksan (Elasticsearch)
• Tambahkan perintah (make:scout:searchableModel, make:scout:searchRule, make:scout:indexKeeper)
• Dokumentasikan semua kode kesalahan
• Tambahkan instruksi pengaturan
• Tambahkan lencana untuk versi npm, status pembuatan, sampul
• Tambahkan pemindaian lisensi
• Tambahkan wiki/dokumen yang lebih baik

Apa lagi? Silakan buka Masalah untuk mendapatkan saran.