Search your Laravel models with the convenience of Eloquent and the power of Elasticsearch

ElasticLens for Laravel uses Elasticsearch to create and sync a searchable index of your Laravel models.

User::viaIndex()->searchPhrase('loves dogs')->where('status','active')->get();

Wait, isn't this what Laravel Scout does?

Yes, but mostly no.

ElasticLens is built from the ground up around Elasticsearch.

It integrates directly with the Laravel-Elasticsearch package (Elasticsearch using Eloquent), creating a dedicated Index-Model that is fully accessible and automatically synced with your Base-Model.

How?

The Index-Model acts as a separate Elasticsearch model managed by ElasticLens, yet you retain full control over it, just like any other Laravel model. In addition to working directly with the Index-Model, ElasticLens offers tools for mapping fields (with embedding relationships) during the build process, and managing index migrations.

For Example, a base User Model will sync with an Elasticsearch IndexedUser Model that provides all the features from Laravel-Elasticsearch to search your Base-Model.

Requirements

• Laravel 10.x/11.x/12.x
• Elasticsearch 8.x

Installation

NB: Before you start, set the Laravel-Elasticsearch DB Config (click to expand)

See Laravel-Elasticsearch for more details

Update .env

ES_AUTH_TYPE=http
ES_HOSTS="http://localhost:9200"
ES_USERNAME=
ES_PASSWORD=
ES_CLOUD_ID=
ES_API_ID=
ES_API_KEY=
ES_SSL_CA=
ES_INDEX_PREFIX=my_app_
# prefix will be added to all indexes created by the package with an underscore
# ex: my_app_user_logs for UserLog model
ES_SSL_CERT=
ES_SSL_CERT_PASSWORD=
ES_SSL_KEY=
ES_SSL_KEY_PASSWORD=
# Options
ES_OPT_ID_SORTABLE=false
ES_OPT_VERIFY_SSL=true
ES_OPT_RETRIES=
ES_OPT_META_HEADERS=true
ES_ERROR_INDEX=
ES_OPT_BYPASS_MAP_VALIDATION=false
ES_OPT_DEFAULT_LIMIT=1000

Update config/database.php

'elasticsearch' => [
   'driver' => 'elasticsearch',
   'auth_type' => env('ES_AUTH_TYPE', 'http'), //http or cloud
   'hosts' => explode(',', env('ES_HOSTS', 'http://localhost:9200')),
   'username' => env('ES_USERNAME', ''),
   'password' => env('ES_PASSWORD', ''),
   'cloud_id' => env('ES_CLOUD_ID', ''),
   'api_id' => env('ES_API_ID', ''),
   'api_key' => env('ES_API_KEY', ''),
   'ssl_cert' => env('ES_SSL_CA', ''),
   'ssl' => [
       'cert' => env('ES_SSL_CERT', ''),
       'cert_password' => env('ES_SSL_CERT_PASSWORD', ''),
       'key' => env('ES_SSL_KEY', ''),
       'key_password' => env('ES_SSL_KEY_PASSWORD', ''),
   ],
   'index_prefix' => env('ES_INDEX_PREFIX', false),
   'options' => [
       'bypass_map_validation' => env('ES_OPT_BYPASS_MAP_VALIDATION', false),
       'logging' => env('ES_OPT_LOGGING', false),
       'ssl_verification' => env('ES_OPT_VERIFY_SSL', true),
       'retires' => env('ES_OPT_RETRIES', null),
       'meta_header' => env('ES_OPT_META_HEADERS', true),
       'default_limit' => env('ES_OPT_DEFAULT_LIMIT', 1000),
       'allow_id_sort' => env('ES_OPT_ID_SORTABLE', false),
   ],
],

Install the package via composer:

composer require pdphilip/elasticlens

Publish the config file:

php artisan lens:install

Run the migrations to create the index build and migration logs indexes:

php artisan migrate

Read the Documentation

Features

• Zero config setup: Start indexing with minimal configuration. Docs
• Eloquent Querying: Search your models with Eloquent and the full power of Elasticsearch. Docs
• Custom Field Mapping: Control how your index is built, including mapping model relationships as embedded fields. Docs
• Manage Elasticsearch Migrations: Define a required blueprint for your index migrations. Docs
• Control Observed models: Tailor which models are observed for changes. Docs
• Comprehensive CLI Tools: Manage index health, migrate/rebuild indexes, and more with Artisan commands. Docs
• Built-in IndexableBuildState model: Track the build states of your indexes. Docs
• Built-in Migration Logs: Track the build states of your indexes. Docs

Example Usage

The Walkthrough below will demonstrate all the features by way of an example. In this example, we'll index a User model.

Step 1: Zero config setup

Docs → Indexing your Base-Model

1. Add the Indexable Trait to Your Base-Model:

use PDPhilip\ElasticLens\Indexable;

class User extends Eloquent implements Authenticatable, CanResetPassword
{
    use Indexable;

2. Create an Index-Model for Your Base-Model:

ElasticLens expects the Index-Model to be named as Indexed + BaseModelName and located in the App\Models\Indexes directory.

2(a) Create the User index with artisan:

php artisan lens:make User

2(b) or create the User index directly:

/**
 * Create: App\Models\Indexes\IndexedUser.php
 */
namespace App\Models\Indexes;

use PDPhilip\ElasticLens\IndexModel;

class IndexedUser extends IndexModel{}

• That's it! Your User model will now automatically sync with the IndexedUser model whenever changes occur. You can search your User model effortlessly, like:

User::viaIndex()->searchTerm('running')->orSearchTerm('swimming')->get();

Step 2: Search your models

Docs → Full-text base-model search

Perform quick and easy full-text searches:

User::search('loves espressos');

Search for the phrase loves espressos across all fields and return the base User models

Cute. But that's not why we're here...

To truly harness the power of Laravel-Elasticsearch for eloquent-like querying, you can use more advanced queries:

BaseModel::viaIndex()->{build_your_es_eloquent_query}->first();
BaseModel::viaIndex()->{build_your_es_eloquent_query}->get();
BaseModel::viaIndex()->{build_your_es_eloquent_query}->paginate();
BaseModel::viaIndex()->{build_your_es_eloquent_query}->avg('orders');
BaseModel::viaIndex()->{build_your_es_eloquent_query}->distinct();
BaseModel::viaIndex()->{build_your_es_eloquent_query}->{etc}

Examples:

1. Basic Term Search:

User::viaIndex()->searchTerm('nara')
    ->where('state','active')
    ->limit(3)->get();

This searches all users who are active for the term 'nara' across all fields and returns the top 3 results.

• https://elasticsearch.pdphilip.com/full-text-search#term-search-term

2. Phrase Search:

User::viaIndex()->searchPhrase('Ice bathing')
    ->orderByDesc('created_at')
    ->limit(5)->get();

Searches all fields for the phrase 'Ice bathing' and returns the three newest results. Phrases match exact words in order.

• https://elasticsearch.pdphilip.com/eloquent/search-queries/#search-phrase

3. Boosting Terms fields:

User::viaIndex()->searchTerm('David',['first_name^3', 'last_name^2', 'bio'])->get();

Searches for the term 'David', boosts the first_name field by 3, last_name by 2, and checks the bio field. Results are ordered by score.

• https://elasticsearch.pdphilip.com/full-text-search#boosting-terms
• https://elasticsearch.pdphilip.com/full-text-search#minimum-score

4. Geolocation Filtering:

User::viaIndex()->where('status', 'active')
    ->filterGeoPoint('home.location', '5km', [0, 0])
    ->orderByGeo('home.location',[0, 0])
    ->get();

Finds all active users within a 5km radius from the coordinates [0, 0], ordering them from closest to farthest. Not kidding.

• https://elasticsearch.pdphilip.com/es-specific#geo-point
• https://elasticsearch.pdphilip.com/ordering-and-pagination#order-by-geo-distance

5. Regex Search:

User::viaIndex()->whereRegex('favourite_color', 'bl(ue)?(ack)?')->get();

Finds all users whose favourite colour is blue or black.

• https://elasticsearch.pdphilip.com/full-text-search#regular-expressions

6. Pagination:

User::viaIndex()->whereRegex('favorite_color', 'bl(ue)?(ack)?')->paginate(10);

Paginate search results.

• https://elasticsearch.pdphilip.com/ordering-and-pagination

7. Nested Object Search:

User::viaIndex()->whereNestedObject('user_logs', function (Builder $query) {
    $query->where('user_logs.country', 'Norway')
        ->where('user_logs.created_at', '>=',Carbon::now()->modify('-1 week'));
})->get();

Searches nested user_logs for users who logged in from Norway within the last week. Whoa.

• https://elasticsearch.pdphilip.com/nested-queries

8. Fuzzy Search:

User::viaIndex()->searchFuzzy('quikc')
    ->orSearchFuzzy('brwn')
    ->orSearchFuzzy('foks')
    ->get();

No spell, no problem. Search Fuzzy.

• https://elasticsearch.pdphilip.com/full-text-search

9. Highlighting Search Results:

User::viaIndex()->searchTerm('espresso')
    ->withHighlights()->get();

Searches for 'espresso' across all fields and highlights where it was found.

• https://elasticsearch.pdphilip.com/full-text-search#highlighting

10. Phrase prefix search:

User::viaIndex()->searchPhrasePrefix('loves espr')
    ->withHighlights()->get();

Searches for the phrase prefix 'loves espr' across all fields and highlights where it was found.

• https://elasticsearch.pdphilip.com/full-text-search#highlighting

Note on Index-Model vs Base-Model Results

• Since the viaIndex() taps into the IndexModel, the results will be instances of IndexedUser, not the base User model.
• This can be useful for display purposes, such as highlighting embedded fields.
• However, in most cases you'll need to return and work with the Base-Model

To search and return results as Base-Models:

1. use asBase()

• Simply chain ->asBase() at the end of your query:

User::viaIndex()->searchTerm('david')->orderByDesc('created_at')->limit(3)->get()->asBase();
User::viaIndex()->whereRegex('favorite_color', 'bl(ue)?(ack)?')->get()->asBase();
User::viaIndex()->whereRegex('favorite_color', 'bl(ue)?(ack)?')->first()->asBase();

2. use getBase() instead of get()->asBase()

User::viaIndex()->searchTerm('david')->orderByDesc('created_at')->limit(3)->getBase();
User::viaIndex()->whereRegex('favorite_color', 'bl(ue)?(ack)?')->getBase();

To search and paginate results as Base-Models use: paginateBase()

• Complete the query string with ->paginateBase()

// Returns a pagination instance of Users ✔️:
User::viaIndex()->whereRegex('favorite_color', 'bl(ue)?(ack)?')->paginateBase(10);

// Returns a pagination instance of IndexedUsers:
User::viaIndex()->whereRegex('favorite_color', 'bl(ue)?(ack)?')->paginate(10);

// Will not paginate ❌ (but will at least return a collection of 10 Users):
User::viaIndex()->whereRegex('favorite_color', 'bl(ue)?(ack)?')->paginate(10)->asBase();

Step 3: Create a field Map

Docs → Index-model field mapping

You can define the fieldMap() method in your Index-Model to control how the index is built during synchronisation.

use PDPhilip\ElasticLens\Builder\IndexBuilder;
use PDPhilip\ElasticLens\Builder\IndexField;

class IndexedUser extends IndexModel
{
    protected $baseModel = User::class;
    
    public function fieldMap(): IndexBuilder
    {
        return IndexBuilder::map(User::class, function (IndexField $field) {
            $field->text('first_name');
            $field->text('last_name');
            $field->text('email');
            $field->bool('is_active');
            $field->type('state', UserState::class); //Maps enum
            $field->text('created_at');
            $field->text('updated_at');
        });
    }

Notes:

• The IndexedUser records will contain only the fields defined in the fieldMap(). The value of $user->id will correspond to $indexedUser->id.
• Fields can also be derived from attributes in the Base-Model. For example, $field->bool('is_active') could be derived from a custom attribute in the Base-Model:

    public function getIsActiveAttribute(): bool
    {
        return $this->updated_at >= Carbon::now()->modify('-30 days');
    }

• When mapping enums, ensure that you also cast them in the Index-Model.
• If a value is not found during the build process, it will be stored as null.

Step 4: Update fieldMap() to include relationships as embedded fields

Docs → Relationships as embedded fields

You can further customise indexing by embedding relationships as nested objects within your Index-Model. The builder allows you to define fields and embed relationships, enabling more complex data structures in your Elasticsearch index.

Examples:

1. If a User has many Profiles

use PDPhilip\ElasticLens\Builder\IndexBuilder;
use PDPhilip\ElasticLens\Builder\IndexField;

class IndexedUser extends IndexModel
{
    protected $baseModel = User::class;
    
    public function fieldMap(): IndexBuilder
    {
        return IndexBuilder::map(User::class, function (IndexField $field) {
            $field->text('first_name');
            $field->text('last_name');
            $field->text('email');
            $field->bool('is_active');
            $field->type('type', UserType::class);
            $field->type('state', UserState::class);
            $field->text('created_at');
            $field->text('updated_at');
            $field->embedsMany('profiles', Profile::class)->embedMap(function (IndexField $field) {
                $field->text('profile_name');
                $field->text('about');
                $field->array('profile_tags');
            });
        });
    }

2. If a Profile has one ProfileStatus

use PDPhilip\ElasticLens\Builder\IndexBuilder;
use PDPhilip\ElasticLens\Builder\IndexField;

class IndexedUser extends IndexModel
{
    protected $baseModel = User::class;
    
    public function fieldMap(): IndexBuilder
    {
        return IndexBuilder::map(User::class, function (IndexField $field) {
            $field->text('first_name');
            $field->text('last_name');
            $field->text('email');
            $field->bool('is_active');
            $field->type('type', UserType::class);
            $field->type('state', UserState::class);
            $field->text('created_at');
            $field->text('updated_at');
            $field->embedsMany('profiles', Profile::class)->embedMap(function (IndexField $field) {
                $field->text('profile_name');
                $field->text('about');
                $field->array('profile_tags');
                $field->embedsOne('status', ProfileStatus::class)->embedMap(function (IndexField $field) {
                    $field->text('id');
                    $field->text('status');
                });
            });
        });
    }

3. If a User belongs to an Account

use PDPhilip\ElasticLens\Builder\IndexBuilder;
use PDPhilip\ElasticLens\Builder\IndexField;

class IndexedUser extends IndexModel
{
    protected $baseModel = User::class;
    
    public function fieldMap(): IndexBuilder
    {
        return IndexBuilder::map(User::class, function (IndexField $field) {
            $field->text('first_name');
            $field->text('last_name');
            $field->text('email');
            $field->bool('is_active');
            $field->type('type', UserType::class);
            $field->type('state', UserState::class);
            $field->text('created_at');
            $field->text('updated_at');
            $field->embedsMany('profiles', Profile::class)->embedMap(function (IndexField $field) {
                $field->text('profile_name');
                $field->text('about');
                $field->array('profile_tags');
                $field->embedsOne('status', ProfileStatus::class)->embedMap(function (IndexField $field) {
                    $field->text('id');
                    $field->text('status');
                });
            });
            $field->embedsBelongTo('account', Account::class)->embedMap(function (IndexField $field) {
                $field->text('name');
                $field->text('url');
            });
        });
    }

4. If a User belongs to a Country and you don't need to observe the Country model:

use PDPhilip\ElasticLens\Builder\IndexBuilder;
use PDPhilip\ElasticLens\Builder\IndexField;

class IndexedUser extends IndexModel
{
    protected $baseModel = User::class;
    
    public function fieldMap(): IndexBuilder
    {
        return IndexBuilder::map(User::class, function (IndexField $field) {
            $field->text('first_name');
            $field->text('last_name');
            $field->text('email');
            $field->bool('is_active');
            $field->type('type', UserType::class);
            $field->type('state', UserState::class);
            $field->text('created_at');
            $field->text('updated_at');
            $field->embedsMany('profiles', Profile::class)->embedMap(function (IndexField $field) {
                $field->text('profile_name');
                $field->text('about');
                $field->array('profile_tags');
                $field->embedsOne('status', ProfileStatus::class)->embedMap(function (IndexField $field) {
                    $field->text('id');
                    $field->text('status');
                });
            });
            $field->embedsBelongTo('account', Account::class)->embedMap(function (IndexField $field) {
                $field->text('name');
                $field->text('url');
            });
            $field->embedsBelongTo('country', Country::class)->embedMap(function (IndexField $field) {
                $field->text('country_code');
                $field->text('name');
                $field->text('currency');
            })->dontObserve();  // Don't observe changes in the country model
        });
    }

5. If a User has Many UserLogs and you only want to embed the last 10:

use PDPhilip\ElasticLens\Builder\IndexBuilder;
use PDPhilip\ElasticLens\Builder\IndexField;

class IndexedUser extends IndexModel
{
    protected $baseModel = User::class;
    
    public function fieldMap(): IndexBuilder
    {
        return IndexBuilder::map(User::class, function (IndexField $field) {
            $field->text('first_name');
            $field->text('last_name');
            $field->text('email');
            $field->bool('is_active');
            $field->type('type', UserType::class);
            $field->type('state', UserState::class);
            $field->text('created_at');
            $field->text('updated_at');
            $field->embedsMany('profiles', Profile::class)->embedMap(function (IndexField $field) {
                $field->text('profile_name');
                $field->text('about');
                $field->array('profile_tags');
                $field->embedsOne('status', ProfileStatus::class)->embedMap(function (IndexField $field) {
                    $field->text('id');
                    $field->text('status');
                });
            });
            $field->embedsBelongTo('account', Account::class)->embedMap(function (IndexField $field) {
                $field->text('name');
                $field->text('url');
            });
            $field->embedsBelongTo('country', Country::class)->embedMap(function (IndexField $field) {
                $field->text('country_code');
                $field->text('name');
                $field->text('currency');
            })->dontObserve();  // Don't observe changes in the country model
            $field->embedsMany('logs', UserLog::class, null, null, function ($query) {
                $query->orderBy('created_at', 'desc')->limit(10); // Limit the logs to the 10 most recent
            })->embedMap(function (IndexField $field) {
                $field->text('title');
                $field->text('ip');
                $field->array('log_data');
            });
        });
    }

IndexField $field Methods:

• text($field)
• integer($field)
• array($field)
• bool($field)
• type($field, $type) - Set own type (like Enums)
• embedsMany($field, $relatedModelClass, $whereRelatedField, $equalsLocalField, $query)
• embedsBelongTo($field, $relatedModelClass, $whereRelatedField, $equalsLocalField, $query)
• embedsOne($field, $relatedModelClass, $whereRelatedField, $equalsLocalField, $query)

Note: For embeds the $whereRelatedField, $equalsLocalField, $query parameters are optional.

• $whereRelatedField is the foreignKey, and $equalsLocalField is the localKey; if they are not provided, they will be inferred from the relationship.
• $query is a closure that allows you to customise the query for the related model.

Embedded Relationship Builder Methods:

• embedMap(function (IndexField $field) {}) - Define the mapping for the embedded relationship
• dontObserve() - Don't observe changes in the $relatedModelClass

Step 5: Define your Index-Model's migrationMap()

Docs → Index-model migrations

Elasticsearch automatically indexes new fields it encounters, but it might not always index them in the way you need. To ensure the index is structured correctly, you can define a migrationMap() in your Index-Model.

Since the Index-Model utilises the Laravel-Elasticsearch package, you can use IndexBlueprint to customise your migrationMap()

use PDPhilip\Elasticsearch\Schema\Blueprint;

class IndexedUser extends IndexModel
{
    //......
    public function migrationMap(): callable
    {
        return function (Blueprint $index) {
            $index->text('name');
            $index->keyword('first_name');
            $index->text('first_name');
            $index->keyword('last_name');
            $index->text('last_name');
            $index->keyword('email');
            $index->text('email');
            $index->text('avatar')->indexField(false);
            $index->keyword('type');
            $index->text('type');
            $index->keyword('state');
            $index->text('state');
            //...etc
        };
    }

Notes:

• Documentation: For more details on migrations, refer to the: https://elasticsearch.pdphilip.com/migrations
• Running the Migration: To execute the migration and rebuild all your indexed, use the following command:

php artisan lens:migrate User

This command will delete the existing index, run the migration, and rebuild all records.

Step 6: Fine-tune the Observers

Docs → Base Model Observers

By default, the Base Model is observed for changes (saves) and deletions. When the Base Model is deleted, the corresponding Index Model will also be deleted, even in cases of soft deletion.

Handling Embedded Models

The related models are also observed when you define a fieldMap() with embedded fields. For example:

• A save or delete action on ProfileStatus will trigger a chain reaction, fetching the related Profile and then User, which in turn initiates a rebuild of the IndexedUser.

However, to ensure these observers are loaded, you need to reference the User model explicitly:

//This alone will not trigger a rebuild
$profileStatus->status = 'Unavailable';
$profileStatus->save();

//This will since the observers are loaded in the User model
new User::class
$profileStatus->status = 'Unavailable';
$profileStatus->save();

Customising Observers

If you want ElasticLens to observe ProfileStatus without requiring a reference to User, follow these steps:

1. Add the HasWatcher Trait to ProfileStatus:

use PDPhilip\ElasticLens\HasWatcher;

class ProfileStatus extends Eloquent
{
    use HasWatcher;

2. Define the Watcher in the elasticlens.php Config File:

'watchers' => [
    \App\Models\ProfileStatus::class => [
        \App\Models\Indexes\IndexedUser::class,
    ],
],

Disabling Base-Model Observation

If you want to disable the automatic observation of the Base-Model, include the following in your Index-Model:

class IndexedUser extends IndexModel
{
    protected $baseModel = User::class;
    
    protected $observeBase = false;

---

Step 7: Monitor and administer all your indexes with Artisan commands

Docs → Artisan CLI Tools

Use the following Artisan commands to manage and monitor your Elasticsearch indexes:

1. Check Overall Status:

php artisan lens:status 

Displays the overall status of all your indexes and the ElasticLens configuration.

2. Check Index Health:

php artisan lens:health User

Provides a comprehensive state of a specific index, in this case, for the `User` model.

3. Migrate and Build/Rebuild an Index:

php artisan lens:migrate User

Deletes the existing User index, runs the migration, and rebuilds all records.

4. Create a New Index-Model for a Base-Model:

php artisan lens:make Profile

Generates a new index for the Profile model.

5. Bulk (Re)Build Indexes for a Base-Model:

php artisan lens:build Profile

Rebuilds all the IndexedProfile records for the Profile model.

---

Step 8: Optionally access the built-in IndexableBuild model to track index build states

Docs → Accessing IndexableBuild model

ElasticLens includes a built-in IndexableBuild model that allows you to monitor and track the state of your index builds. This model records the status of each index build, providing you with insights into the indexing process.

Fields

Model Fields:

• string $model: The Base-Model being indexed.
• string $model_id: The ID of the Base-Model.
• string $index_model: The corresponding Index-Model.
• string $last_source: The last source of the build state.
• IndexableStateType $state: The current state of the index build.
• array $state_data: Additional data related to the build state.
• array $logs: Logs of the indexing process.
• Carbon $created_at: Timestamp of when the build state was created.
• Carbon $updated_at: Timestamp of the last update to the build state.

Attributes:

• @property-read string $state_name: The name of the current state.
• @property-read string $state_color: The colour associated with the current state.

Built-in methods include:

IndexableBuild::returnState($model, $modelId, $indexModel);
IndexableBuild::countModelErrors($indexModel);
IndexableBuild::countModelRecords($indexModel);

Note: While you can query the IndexableBuild model directly, avoid writing or deleting records within it manually, as this can interfere with the health checks and overall integrity of the indexing process. The model should be used for reading purposes only to ensure accurate monitoring and reporting.

---

Step 9: Optionally Access the Built-in IndexableMigrationLog Model for Index Migration Status

Docs → Access IndexableMigrationLog model

ElasticLens includes a built-in IndexableMigrationLog model for monitoring and tracking the state of index migrations. This model logs each migration related to an Index-Model.

Fields

• string $index_model: The migrated Index-Model.
• IndexableMigrationLogState $state: State of the migration
• array $map: Migration map passed to Elasticsearch.
• int $version_major: Major version of the indexing process.
• int $version_minor: Minor version of the indexing process.
• Carbon $created_at: Timestamp of when the migration was created.

Attributes:

• @property-read string $version: Parsed version, ex v2.03
• @property-read string $state_name: Current state name.
• @property-read string $state_color: Colour representing the current state.

Built-in methods include:

IndexableMigrationLog::getLatestVersion($indexModel);
IndexableMigrationLog::getLatestMigration($indexModel);

Note: While you can query the IndexableMigrationLog model directly, avoid writing or deleting records within it manually, as this can interfere with versioning of the migrations. The model should be used for reading purposes only, to ensure accuracy.

---

Credits

• David Philip

License

The MIT License (MIT). Please see License File for more information.