Scout Elasticsearch Driver

🍺 If you like my package, it'd be nice of you to buy me a beer.

The project has a chat room on Gitter!

---

This package offers advanced functionality for searching and filtering data in Elasticsearch. Check out its features!

Contents

• Features
• Requirements
• Installation
• Configuration
• Index configurator
• Searchable model
• Usage
• Console commands
• Search rules
• Available filters
• Zero downtime migration
• Debug

Features

• An easy way to configure and create an Elasticsearch index.
• A fully configurable mapping for each model.
• A possibility to add a new field to an existing mapping automatically or using the artisan command.
• Lots of different ways to implement your search algorithm: using search rules or a raw search.
• Various filter types to make a search query more specific.
• Zero downtime migration from an old index to a new index.
• Bulk indexing, see the configuration section.

Requirements

The package has been tested in the following configuration:

• PHP version >= 7.1.3
• Laravel Framework version >= 5.6
• Elasticsearch version >= 6

Installation

Use composer to install the package:

composer require babenkoivan/scout-elasticsearch-driver

Configuration

To configure the package you need to publish settings first:

php artisan vendor:publish --provider="Laravel\Scout\ScoutServiceProvider"
php artisan vendor:publish --provider="ScoutElastic\ScoutElasticServiceProvider"

Then, set the driver setting to elastic in the config/scout.php file and configure the driver itself in the config/scout_elastic.php file. The available options are:

Option	Description
client	A setting hash to build Elasticsearch client. More information you can find here. By default the host is set to localhost:9200.
update_mapping	The option that specifies whether to update a mapping automatically or not. By default it is set to true.
indexer	Set to single for the single document indexing and to bulk for the bulk document indexing. By default is set to single.
document_refresh	This option controls when updated documents appear in the search results. Can be set to 'true', 'false', 'wait_for' or null. More details about this option you can find here. By default set to null.
track_scores	By default the track_scores is set to true.

Note, that if you use the bulk document indexing you'll probably want to change the chunk size, you can do that in the config/scout.php file.

Index configurator

An index configurator class is used to set up settings for an Elasticsearch index. To create a new index configurator use the following artisan command:

php artisan make:index-configurator MyIndexConfigurator

It'll create the file MyIndexConfigurator.php in the app folder of your project. You can specify index name and settings like in the following example:

<?php

namespace App;

use ScoutElastic\IndexConfigurator;

class MyIndexConfigurator extends IndexConfigurator
{
    // It's not obligatory to determine name. By default it'll be a snaked class name without `IndexConfigurator` part.
    protected $name = 'my_index';  
    
    // You can specify any settings you want, for example, analyzers. 
    protected $settings = [
        'analysis' => [
            'analyzer' => [
                'es_std' => [
                    'type' => 'standard',
                    'stopwords' => '_spanish_'
                ]
            ]    
        ]
    ];
}

More about index settings you can find in the index management section of Elasticsearch documentation.

To create an index just run the artisan command:

php artisan elastic:create-index App\\MyIndexConfigurator

Searchable model

To create a model with the ability to perform search requests in an Elasticsearch index use the command:

php artisan make:searchable-model MyModel --index-configurator=MyIndexConfigurator

After executing the command you'll find the file MyModel.php in you app folder:

<?php

namespace App;

use ScoutElastic\Searchable;
use Illuminate\Database\Eloquent\Model;

class MyModel extends Model
{
    use Searchable;

    protected $indexConfigurator = MyIndexConfigurator::class;

    protected $searchRules = [
        //
    ];

    // Here you can specify a mapping for a model fields.
    protected $mapping = [
        'properties' => [
            'text' => [
                'type' => 'text',
                'fields' => [
                    'raw' => [
                        'type' => 'text',
                        'index' => 'not_analyzed',
                    ]
                ]
            ],
        ]
    ];
}

Each searchable model represents an Elasticsearch type. By default a type name is the same as a table name, but you can set any type name you want through the searchableAs method. You can also specify fields which will be indexed by the driver through the toSearchableArray method. More information about these options you will find in the scout official documentation.

The last important option you can set in the MyModel class is the $searchRules property. It allows you to set different search algorithms for a model. We'll take a closer look at it in the search rules section.

After setting up a mapping in your model you can update an Elasticsearch type mapping:

php artisan elastic:update-mapping App\\MyModel

Usage

Once you've created an index configurator, an Elasticsearch index itself and a searchable model, you are ready to go. Now you can index and search data according to the documentation.

Basic search usage example:

// set query string
App\MyModel::search('phone')
    // specify columns to select
    ->select(['title', 'price'])
    // filter 
    ->where('color', 'red')
    // sort
    ->orderBy('price', 'asc')
    // collapse by field
    ->collapse('brand')
    // set offset
    ->from(0)
    // set limit
    ->take(10)
    // get results
    ->get();

If you only need the number of matches for a query, use the count method:

App\MyModel::search('phone') 
    ->count();

If you need to load relations, use the with method:

App\MyModel::search('phone') 
    ->with('makers')
    ->get();

If you need to load multiple relations you can use the with method:

App\MyModel::search('phone') 
    ->with(['makers', 'company'])
    ->paginate();

In addition to standard functionality the package offers you the possibility to filter data in Elasticsearch without specifying a query string:

App\MyModel::search('*')
    ->where('id', 1)
    ->get();

Also you can override model search rules:

App\MyModel::search('Brazil')
    ->rule(App\MySearchRule::class)
    ->get();

And use variety of where conditions:

App\MyModel::search('*')
    ->whereRegexp('name.raw', 'A.+')
    ->where('age', '>=', 30)
    ->whereExists('unemployed')
    ->get();

If you want to send a custom sort, you can use the orderByScript method:

App\MyModel::search('*')->orderByScript([
    'script' => [
        'lang' => 'groovy',
        'inline' => "
            def rank = 1;
            if (doc['price'].value) {
                rank += doc['total_view'].value*1+doc['total_like'].value*4+doc['total_download'].value*64;
            } else {
                rank += doc['total_view'].value*1+doc['total_like'].value*8+doc['total_download'].value*16;
            }
            return rank;
        "
    ],
    'type' => 'number',
    'order' => 'desc'
])->paginate();

At last, if you want to send a custom request, you can use the searchRaw method:

App\MyModel::searchRaw([
    'query' => [
        'bool' => [
            'must' => [
                'match' => [
                    '_all' => 'Brazil'
                ]
            ]
        ]
    ]
]);

In addition to standard functionality the package offers you the possibility to aggregate data in Elasticsearch without specifying a query string:

App\MyModel::search('*')
    ->aggregate();

In addition to standard functionality the package offers you the possibility to suggest data in Elasticsearch with specifying a query string:

App\MyModel::search('phone')
    ->suggest();

In addition to standard functionality the package offers you the possibility to highlight data in Elasticsearch with specifying a query string:

App\MyModel::search('phone')
    ->highlight();

This query will return raw response.

Console commands

Available artisan commands are listed below:

Command	Arguments	Description
make:index-configurator	name - The name of the class	Creates a new Elasticsearch index configurator.
make:searchable-model	name - The name of the class	Creates a new searchable model.
make:search-rule	name - The name of the class	Creates a new search rule.
make:aggregate-rule	name - The name of the class	Creates a new aggregate rule.
make:suggest-rule	name - The name of the class	Creates a new suggest rule.
make:highlight-rule	name - The name of the class	Creates a new highlight rule.
elastic:create-index	index-configurator - The index configurator class	Creates an Elasticsearch index.
elastic:update-index	index-configurator - The index configurator class	Updates settings and mappings of an Elasticsearch index.
elastic:drop-index	index-configurator - The index configurator class	Drops an Elasticsearch index.
elastic:update-mapping	model - The model class	Updates a model mapping.
elastic:migrate	model - The model class, target-index - The index name to migrate	Migrates model to another index.

For detailed description and all available options run php artisan help [command] in the command line.

Search rules

A search rule is a class that describes how a search query will be executed. To create a search rule use the command:

php artisan make:search-rule MySearchRule

In the file app/MySearchRule.php you will find a class definition:

<?php

namespace App;

use ScoutElastic\SearchRule;

class MySearchRule extends SearchRule
{
    // This method returns an array, describes how to highlight the results.
    // If null is returned, no highlighting will be used. 
    public function buildHighlightPayload()
    {
        return [
            'fields' => [
                'name' => [
                    'type' => 'plain'
                ]
            ]
        ];
    }
    
    // This method returns an array, that represents bool query.
    public function buildQueryPayload()
    {
        return [
            'must' => [
                'match' => [
                    'name' => $this->builder->query
                ]
            ]
        ];
    }
}

You can read more about bool queries here and about highlighting here.

The default search rule returns the following payload:

return [
   'must' => [
       'query_string' => [
           'query' => $this->builder->query
       ]
   ]
];

This means that by default when you call search method on a model it tries to find the query string in any field.

To determine default search rules for a model just add a property:

<?php

namespace App;

use ScoutElastic\Searchable;
use Illuminate\Database\Eloquent\Model;

class MyModel extends Model
{
    use Searchable;
    
    // You can set several rules for one model. In this case, the first not empty result will be returned.
    protected $searchRules = [
        MySearchRule::class
    ];
}

You can also set a search rule in a query builder:

// You can set either a SearchRule class
App\MyModel::search('Brazil')
    ->rule(App\MySearchRule::class)
    ->get();
    
// or a callable
App\MyModel::search('Brazil')
    ->rule(function($builder) {
        return [
            'must' => [
                'match' => [
                    'Country' => $builder->query
                ]
            ]
        ];
    })
    ->get();

Aggregate rules

A aggregate rule is a class that describes how a aggregate query will be executed. To create a aggregate rule use the command:

php artisan make:aggregate-rule MyAggregateRule

In the file app/MyAggregateRule.php you will find a class definition:

<?php

namespace App;

use ScoutElastic\AggregateRule;

class MyAggregateRule extends AggregateRule
{
    // This method returns an array that represents a content of bool query.
    public function buildAggregatePayload()
    {
        return [
            'icon_count' => [
                'terms' => [
                    'field' => 'icon_id',
                    'size' => 15
                ]
            ],
            'style_count' => [
                'terms' => [
                    'field' => 'style_id',
                    'size' => 7
                ]
            ],
            'category_count' => [
                'terms' => [
                    'field' => 'category_id',
                    'size' => 39
                ]
            ]
        ];
    }
}

You can read more about aggregation queries here.

To determine default aggregate rules for a model just add a property:

<?php

namespace App;

use ScoutElastic\Searchable;
use Illuminate\Database\Eloquent\Model;

class MyModel extends Model
{
    use Searchable;
    
    // You can set several rules for one model. In this case, the first not empty result will be returned.
    protected $aggregateRules = [
        MyAggregateRule::class
    ];
}

Suggest rules

A suggest rule is a class that describes how a suggest query will be executed. To create a suggest rule use the command:

php artisan make:suggest-rule MySuggestRule

In the file app/MySuggestRule.php you will find a class definition:

<?php

namespace App;

use ScoutElastic\SuggestRule;

class MySuggestRule extends SuggestRule
{
    // This method returns an array that represents a content of bool query.
    public function buildSuggestPayload()
    {
        $query = $this->builder->query;

        if (empty($query)) {
            return null;
        }

        return [
            'text' => $query,
            'autocomplete' => [
                'prefix' => $query,
                'completion' => [
                    'field' => 'name.suggest_autocomplete',
                    'size' => 7
                ],
            ],
            'phrase-suggest' => [
                'phrase' => [
                    'field' => 'name.suggest_phrase.trigram',
                    'gram_size' => 3,
                    'direct_generator' => [
                        [
                            'field' => 'name.suggest_phrase.trigram',
                            'suggest_mode' => 'always'
                        ],
                        [
                            'field' => 'name.suggest_phrase.reverse',
                            'suggest_mode' => 'always',
                            'pre_filter' => 'reverse',
                            'post_filter' => 'reverse'
                        ],
                    ],
                    'highlight' => [
                        'pre_tag' => '<em>',
                        'post_tag' => '</em>'
                    ]
                ]
            ]
        ];
    }
}

You can read more about suggestion queries here.

To determine default suggest rules for a model just add a property:

<?php

namespace App;

use ScoutElastic\Searchable;
use Illuminate\Database\Eloquent\Model;

class MyModel extends Model
{
    use Searchable;
    
    // You can set several rules for one model. In this case, the first not empty result will be returned.
    protected $suggestRules = [
        MySuggestRule::class
    ];
}

Hightlight rules

A hightlight rule is a class that describes how a hightlight query will be executed. To create a hightlight rule use the command:

php artisan make:hightlight-rule MyHightlightRule

In the file app/MyHightlightRule.php you will find a class definition:

<?php

namespace App;

use ScoutElastic\HightlightRule;

class MyHightlightRule extends HightlightRule
{
    // This method returns an array that represents a content of bool query.
    public function buildHightlightPayload()
    {
        return [
            'fields' => [
                'name' => [
                    'force_source' => true
                ]
            ]
        ];
    }
}

You can read more about hightlighter queries here.

To determine default hightlight rules for a model just add a property:

<?php

namespace App;

use ScoutElastic\Searchable;
use Illuminate\Database\Eloquent\Model;

class MyModel extends Model
{
    use Searchable;
    
    // You can set several rules for one model. In this case, the first not empty result will be returned.
    protected $hightlightRules = [
        MyHightlightRule::class
    ];
}

To retrieve highlight, use model `highlight` attribute:

```php
// Let's say we highlight field `name` of `MyModel`.
$model = App\MyModel::search('Brazil')
    ->rule(App\MySearchRule::class)
    ->first();

// Now you can get raw highlighted value:
$model->highlight->name;

// or string value:
 $model->highlight->nameAsString;

Available filters

You can use different types of filters:

Method	Example	Description
where($field, $value)	where('id', 1)	Checks equality to a simple value.
where($field, $operator, $value)	where('id', '>=', 1)	Filters records according to a given rule. Available operators are: =, <, >, <=, >=, <>.
whereIn($field, $value)	where('id', [1, 2, 3])	Checks if a value is in a set of values.
whereNotIn($field, $value)	whereNotIn('id', [1, 2, 3])	Checks if a value isn't in a set of values.
whereBetween($field, $value)	whereBetween('price', [100, 200])	Checks if a value is in a range.
whereNotBetween($field, $value)	whereNotBetween('price', [100, 200])	Checks if a value isn't in a range.
whereExists($field)	whereExists('unemployed')	Checks if a value is defined.
whereNotExists($field)	whereNotExists('unemployed')	Checks if a value isn't defined.
whereRegexp($field, $value, $flags = 'ALL')	whereRegexp('name.raw', 'A.+')	Filters records according to a given regular expression. Here you can find more about syntax.
whereGeoDistance($field, $value, $distance)	whereGeoDistance('location', [-70, 40], '1000m')	Filters records according to given point and distance from it. Here you can find more about syntax.
whereGeoBoundingBox($field, array $value)	whereGeoBoundingBox('location', ['top_left' => [-74.1, 40.73], 'bottom_right' => [-71.12, 40.01]])	Filters records within given boundings. Here you can find more about syntax.
whereGeoPolygon($field, array $points)	whereGeoPolygon('location', [[-70, 40],[-80, 30],[-90, 20]])	Filters records within given polygon. Here you can find more about syntax.
whereGeoShape($field, array $shape)	whereGeoShape('shape', ['type' => 'circle', 'radius' => '1km', 'coordinates' => [4, 52]])	Filters records within given shape. Here you can find more about syntax.

In most cases it's better to use raw fields to filter records, i.e. not analyzed fields.

Zero downtime migration

As you might know, you can't change the type of already created field in Elasticsearch. The only choice in such case is to create a new index with necessary mapping and import your models into the new index.
A migration can take quite a long time, so to avoid downtime during the process the driver reads from the old index and writes to the new one. As soon as migration is over it starts reading from the new index and removes the old index. This is how the artisan elastic:migrate command works.

Before you run the command, make sure that your index configurator uses the ScoutElastic\Migratable trait. If it's not, add the trait and run the artisan elastic:update-index command using your index configurator class name as an argument:

php artisan elastic:update-index App\\MyIndexConfigurator

When you are ready, make changes in the model mapping and run the elastic:migrate command using the model class as the first argument and desired index name as the second argument:

php artisan elastic:migrate App\\MyModel my_index_v2

Note, that if you need just to add new fields in your mapping, use the elastic:update-mapping command.

Debug

There are two methods that can help you to analyze results of a search query:

• explain

  App\MyModel::search('Brazil')
      ->explain();

• profile

  App\MyModel::search('Brazil')
      ->profile();

Both methods return raw data from ES.

Besides, you can get a query payload that will be sent to ES, by calling the buildPayload method.

App\MyModel::search('Brazil')
    ->buildPayload();

Note, that this method returns a collection of payloads, because of possibility of using multiple search rules in one query.