Search is configured using the Laravel Scout (opens new window) package. Out the box we have configured the Lunar hub to use our own database Scout driver (see https://github.com/lunarphp/scout-database-engine).
Using Scout allows us to provide search out the box but also make it easy for you as the developer to customise and tailor searching to your needs.
# Initial set up
The database driver provides basic search to get you up and running but you will likely find you want to implement something with a bit more power, such as Meilisearch (opens new window) or Algolia (opens new window).
By default, scout has the setting
soft_delete set to
false. You need to make sure this is set to
true otherwise you will see soft deleted models appear in your search results.
If you want to use other models or your own models in the search engine, you can add the reference for them on the config file.
'models' => [ // These models are required by the system, do not change them. \Lunar\Models\Collection::class, \Lunar\Models\Product::class, \Lunar\Models\ProductOption::class, \Lunar\Models\Order::class, \Lunar\Models\Customer::class, // Below you can add your own models for indexing ]
# Index records
If you installed the Lunar package in an existing project and you would like to use the database records with the search engine, or you just need to do some maintenance on the indexes, you can use the index command.
php artisan lunar:search:index
The command will import the records of the models listed in the
lunar/indexer.php configuration file. Type
--help to see the available options.
# Engine Mapping
By default, Scout will use the driver defined in your .env file as
SCOUT_DRIVER. So if that's set to
meilisearch, all your models will be indexed via the Meilisearch driver. This can present some issues, if you wanted to use a service like Algolia for Products, you wouldn't want all your Orders being indexed there since it will ramp up the record count and the cost.
In Lunar we've made it possible to define what driver you would like to use per model. It's all defined in the
config/lunar/search.php config file and looks like this:
'engine_map' => [ \Lunar\Models\Product::class => 'algolia', \Lunar\Models\Order::class => 'meilisearch', \Lunar\Models\Collection::class => 'meilisearch', ],
It's quite self explanatory, if a model class isn't added to the config, it will take on the Scout default.