Laravel Packages

ElasticSearch Driver for Laravel Scout

Published Updated
ElasticSearch Driver for Laravel Scout image

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:

namespace App\Models;
 
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use JeroenG\Explorer\Application\Explored;
use Laravel\Scout\Searchable;
 
class Post extends Model implements Explored
{
use HasFactory;
use Searchable;
 
protected $fillable = ['title', 'published'];
 
public function mappableAs(): array
{
return [
'id' => 'keyword',
'title' => 'text',
'published' => 'boolean',
'created_at' => 'date',
];
}
}

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

return [
'indexes' => [
\App\Models\Post::class
],
];

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:

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

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

# create indexes
php artisan elastic:create
 
# delete indexes
php artisan elastic:delete
 
# search indexes
php 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.

Related: Map Laravel Eloquent models to Elasticsearch types

Paul Redmond photo

Staff writer at Laravel News. Full stack web developer and author.

Sponsored

serpapi logo
SerpApi

The Web Search API for Your LLM and AI Applications

Visit SerpApi

The latest

View all →
Screenshot: Capture Images and PDFs with PHP and Laravel image

Screenshot: Capture Images and PDFs with PHP and Laravel

Read article
Reset Sticky Database Connections Between Laravel Queue Jobs image

Reset Sticky Database Connections Between Laravel Queue Jobs

Read article
PHP Security Releases Fix Two Critical RCE Vulnerabilities image

PHP Security Releases Fix Two Critical RCE Vulnerabilities

Read article
Prevent Stale Database Reads in Laravel 13.38 image

Prevent Stale Database Reads in Laravel 13.38

Read article
Critical PHP Security Release Coming Tomorrow (October 21) image

Critical PHP Security Release Coming Tomorrow (October 21)

Read article
Critical Token Guard Auth Bypass Fixed in Laravel 13.29 and 12.68 image

Critical Token Guard Auth Bypass Fixed in Laravel 13.29 and 12.68

Read article