ElasticSearch Driver for Laravel Scout

Packages

May 27th, 2021

explorer-elasticsearch-laravel-scout-featured.png

Explorer is a next-gen Elasticsearch driver for Laravel Scout with the power of Elasticsearch’s queries. It provides a compatible Scout driver, as well as additional conveniences. For example, the Explored interface defines a mappableAs() method for getting configuration:

1namespace App\Models;
2
3use Illuminate\Database\Eloquent\Factories\HasFactory;
4use Illuminate\Database\Eloquent\Model;
5use JeroenG\Explorer\Application\Explored;
6use Laravel\Scout\Searchable;
7
8class Post extends Model implements Explored
9{
10 use HasFactory;
11 use Searchable;
12
13 protected $fillable = ['title', 'published'];
14
15 public function mappableAs(): array
16 {
17 return [
18 'id' => 'keyword',
19 'title' => 'text',
20 'published' => 'boolean',
21 'created_at' => 'date',
22 ];
23 }
24}

Then in your explorer config you can reference the model under indexes like so:

1return [
2 'indexes' => [
3 \App\Models\Post::class
4 ],
5];

Apart from the standard features you get out-of-the-box with Laravel Scout, Explorer provides a way to use query builders to write more complex queries. The advanced queries documentation has an example of using the query builder functionality with this package:

1$posts = Post::search('lorem')
2 ->must(new Matching('title', 'ipsum'))
3 ->should(new Terms('tags', ['featured'], 2))
4 ->filter(new Term('published', true))
5 ->get();

The package also provides a few commands to manage indexes and search via the CLI:

1# create indexes
2php artisan elastic:create
3
4# delete indexes
5php artisan elastic:delete
6
7# search indexes
8php artisan elastic:search "App\Models\Post" lorem

Learn More

The Explorer documentation walks you through getting set up through more advanced settings and code. The source code is available on GitHub.

Also, check out Exploring Elasticsearch with Laravel Scout , which explains getting started with Elasticsearch locally via Docker and setting up Explorer and Laravel Scout.

The author of the package also has a demo application that might be helpful to explore how to integrate Explorer in your Laravel application.

Filed in:

Paul Redmond

Full stack web developer. Author of Lumen Programming Guide and Docker for PHP Developers.