michaeljennings/laralastica

A laravel package that allows you to search eloquent results using elasticsearch.

Laralastica

A laravel 5 package that adds the ability to search eloquent models using elasticsearch results, it also handles indexing and removing documents when you save or delete models., _(*1)

• Installation
  • Configuration
• Usage
• Building Your Index
• Searching
  • Searching Soft Deleted Records
  • Searching Without the Searchable Trait
  • Limit Results
  • Offsetting Results
  • Sorting Results
• Queries
• Filters
• Paginate Results
• The Result Collection

Upgrading from 3.0 to 3.1+

When hitting the search method on a model the query builder will return an instance of Michaeljennings\Laralastica\Eloquent\ResultCollection instead of Illuminate\Database\Eloquent\Collection., _(*2)

// This will return an instance of Michaeljennings\Laralastica\Eloquent\ResultCollection
Model::search(function(Builder $builder) {
  $builder->matchAll();
})->get();

This is useful as you get access to the totalHits, maxScore, and totalTime methods., _(*3)

However if you want to use the default collection you may override the newCollection method on your model and return the collection instance you need., _(*4)

/**
 * Create a new database notification collection instance.
 *
 * @param array $models
 * @return ResultCollection
 */
public function newCollection(array $models = [])
{
    return new Illuminate\Database\Eloquent\Collection($models);
}

Installation

Check the table below to see which version you will need., _(*5)

To install through composer either run composer require michaeljennings/laralastica or add the package to you composer.json., _(*6)

"michaeljennings/laralastica": "^3.1"

For Laravel 5.5 and upwards, the service provider and facade will be loaded automatically., _(*7)

For older versions of Laravel, you will need to add the laralastica service provider into your providers array in config/app.php., _(*8)

'providers' => [

  'Michaeljennings\Laralastica\LaralasticaServiceProvider'

];

The package also comes with a facade, to use it add it to your aliases array in config/app.php., _(*9)

'aliases' => [

  'Laralastica' => 'Michaeljennings\Laralastica\Facades\Laralastica',

];

Configuration

Finally publish the package config using php artisan vendor:publish. Once the config has published you can edit the `config/laralastica.php' file to set your elasticsearch connection., _(*10)

The package comes with 2 drivers: elastica, and null. By default the package will use the elastica driver. The null driver is mainly testing purposes where you don't want to have an elasticsearch instance running., _(*11)

'driver' => 'elastica',

As of laralastica 3.0 we now use multiple indexes, rather than multiple types in one index. To see why check this post about the removal of types., _(*12)

If you are using multiple environments (production, staging, testing etc.) you can define a index prefix in the config. This will the be added to each index when searcing, adding documents etc., _(*13)

'index_prefix' => 'testing_',

Finally you need to configure your elasticsearch connection. Out of the box the package comes ready to support multiple connections., _(*14)

However you can pass through any of the parameters the elastica client can receive, check the elastica documentation for more information., _(*15)

To set the connection you wish to use either enter the host and port you want to connect to, or the url to connect with., _(*16)

'drivers' => [
  'elastica' => [
    'servers' => [
      [
        'host' => 'localhost',
        'port' => 9200
      ],
      [
        'url' => 'https://user:pass@your-search.com/'
      ]
    ],
  ]
]

Usage

To get started using the package simply add the Searchable trait to the models you want to index and search., _(*17)

use Illuminate\Database\Eloquent\Model;
use Michaeljennings\Laralastica\Searchable;

class Foo extends Model
{
    use Searchable;
}

Once you have added the trait it will use model events to watch when a model is saved, deleted or restored and will add or delete the elasticsearch document as appropriate., _(*18)

Set Elasticsearch Index

To set the elasticsearch index for the model use the getIndex method to return the name of the index. By default this will return the table name the model is using. The index must be lowercase., _(*19)

public function getIndex()
{
    return 'foo';
}

Set Elasticsearch Key To Index By

To set the value to index the elasticsearch documents by use the 'getSearchKey' method to return the key. By default this will return the primary key of the model., _(*20)

public function getSearchKey()
{
    return $this->key;
}

Set the Attributes to Index

To set which attributes should be indexed for the model use the getIndexableAttributes method. The attributes must be returned as an array of key value pairs. By default all of the models attributes are indexed., _(*21)

public function getIndexableAttributes()
{
    return [
        'foo' => $this->bar,
    ];
}

Type Cast Attributes

In elasticsearch each index has a mapping type which will determine how records are indexed, this means that you have to supply each object in the same format. To this we can use the casts property that is supplied by laravel., _(*22)

protected $casts = [
    'price' => 'float',
    'active' => 'bool',
    'quantity' => 'int',
    'name' => 'string'
];

Occasionally you may find yourself wanting to cast values slightly differently for your elasticsearch records. To that you can define the laralasticaCasts property and this will allow you to override the casts property., _(*23)

protected $casts = [
    'price' => 'float',
];

protected $laralasticaCasts = [
    'price' => 'string',
];

Building Your Index

If you already have data you in your database and you want to index it you can use the laralastica:index artisan command., _(*24)

Defining Models To Index

To get started you'll need to set the models you want to index in the indexable section of the laralastica.php config file., _(*25)

By default the package is setup to index the standard App\User class., _(*26)

'indexable' => [
    'users' => \App\User::class,
]

To add a new model we need to set a custom key to reference this model by, this will allow us to index just that model if we want to., _(*27)

Then the value needs to be the fully qualified path of the model class., _(*28)

For example if we wanted to index a products model we could do:, _(*29)

'indexable' => [
    'users' => \App\User::class,
    'products' => \App\Product::class,
]

Occasionally you may want to index relational data, if you have a large database this can take a long time to lazy load the relations. To get around this you can specify the relations to bring when indexing., _(*30)

'indexable' => [
    'users' => \App\User::class,
    'products' => [
        'model' => \App\Product::class,
        'with' => [
            'category' => function($query) {
                $query->with('subcategories');
            }
        ]
    ]
]

Indexing

If you want to index all of the models you have setup then you can run:, _(*31)

php artisan laralastica:index

To run a specific index run:, _(*32)

php artisan laralastica:index [your-index]

// For our example above it would be 
php artisan laralastica:index products 

If you are indexing a large amount of data you may want to push it to the queue, you can do so by providing the queue option, _(*33)

php artisan laralastica:index --queue

Searching

To run a search use the search method. This uses a closure to search the elasticsearch type and then gets the results and adds a where in query from the results., _(*34)

The first parameter for the search method is a Closure which gets passed an instance of the laralastica query builder., _(*35)

The second parameter is the column for the where in query, this defaults to 'id'., _(*36)

The third parameter is a boolean indicating if the query should be ordered by the order of the elasticsearch results., _(*37)

Foo::search(function(Builder $query) {

    $query->matchAll();

}, 'foo', true)->get();

You can also set whether the query must, should or must not match the value you are searching for., _(*38)

Foo::search(function(Builder $query) {

    $query->match('foo', 'bar')->must();
    $query->terms('bar', ['baz'])->should();
    $query->wildcard('baz', 'qux*', 1.0)->mustNot();

})->get();

You may also chain any Laravel query builder methods before or after searching., _(*39)

Foo::where('foo', 'bar')->search(function(Builder $query) {

    $query->match('foo', 'bar');

})->orderBy('baz')->get();

Searching Soft Deleted Records

By default laralastica will delete the elasticsearch record when a model is deleted., _(*40)

Occasionally you may want to search against your soft deleted records, to do that you implement the SearchSoftDeletes trait instead of the Searchable trait in your model., _(*41)

use Illuminate\Database\Eloquent\Model;
use Michaeljennings\Laralastica\SearchSoftDeletes;

class Foo extends Model
{
    use SearchSoftDeletes;
}

This adds adds two new methods - searchWithTrashed and searchOnlyTrashed., _(*42)

Both methods take the same parameters as the search method, but searchWithTrashed will search both soft deleted and non-soft deleted results, and searchOnlyTrashed will only get soft deleted results., _(*43)

To only search for non-soft deleted results just use the search method as usual., _(*44)

Searching Without the Searchable Trait

It is also possible to use Laralastica without using the searchable trait. To do so you can either dependency inject the class via its contract, use the provided Facade, or use the laralastica helper method., _(*45)

class Foo
{
    public function __construct(Michaeljennings\Laralastica\Contracts\Laralastica $laralastica)
    {
        $this->laralastica = $laralastica;
    }

    public function foo()
    {
        $laralastica = Laralastica::search();
        $laralastica = laralastica();
    }
}

To run a new query use the search method. This takes two parameters:, _(*46)

• The index/indices you are searching in
• The query to be run

$laralastica->search('foo', function($query) {
    $query->matchAll();
});

To search across multiple elasticsearch indices simply pass an array of indices as the first parameter., _(*47)

$laralastica->search(['foo', 'bar], function($query) {
    $query->matchAll();
});

To get a paginated list of results hit the paginate method and the amount to paginate by., _(*48)

$laralastica->paginate('foo', function($query) {
    $query->matchAll();
}, 15);

Limit Results

By default the results will be limited to the size set in the laralastica.php config file. However you can override it by hitting the size method., _(*49)

$laralastica->search('foo', function($query) {
    $query->size(50);
});

Offsetting Results

It is also possible to provide an offset by hitting the from method., _(*50)

$laralastica->search('foo', function($query) {
    $query->from(10);
});

Sorting Results

By default we sort the results by their score in descending order. You can override this by hitting the sort method., _(*51)

$laralastica->search('foo', function($query) {
    // Sort by id in ascending order
    $query->sort('id');
    // Sort by id in descending order
    $query->sort('id', 'desc');
    // Sort by multiple fields
    $query->sort([
        '_score',
        'id' => 'desc'
    ]);
});

Queries

The elasticsearch queries are powered by the great elastica package., _(*52)

There are some preset queries on the query builder, but it is also possible to create an instance of an elastica query and pass that through., _(*53)

Available Queries

A list of the available queries can be found below., _(*54)

Each of the queries can optionally be passed a callback as the final parameter which will allow you to access the raw elastica query., _(*55)

Bool Query

$laralastica->search('foo', function($query) {

    $query->bool(function($query) {
        $query->match('foo', 'bar');
    });

});

Common Query

$laralastica->search('foo', function($query) {

    $query->common('baz', 'qux', 1.0);
    $query->common('baz', 'qux', 1.0, function($commonQuery) {
        $commonQuery->setMinimumShouldMatch(5);
    });

});

Exists Query

$laralastica->search('foo', function($query) {

    $query->exists('baz');

});

Fuzzy Query

$laralastica->search('foo', function($query) {

    $query->fuzzy('baz', 'qux');
    $query->fuzzy('baz', 'qux', function($fuzzyQuery) {
        $fuzzyQuery->setFieldOption('fuzziness', 2);
    });

});

Match Query

$laralastica->search('foo', function($query) {

    $query->match('baz', 'qux');
    $query->match('baz', 'qux', function($matchQuery) {
        $matchQuery->setFieldBoost('foo');
    });

});

Match All Query

$laralastica->search('foo', function($query) {

    $query->matchAll();

});

Query String Query

$laralastica->search('foo', function($query) {

    $query->queryString('testing');
    $query->queryString('testing', function($queryStringQuery) {
        $queryStringQuery->setDefaultField('foo');
    });

});

Range Query

$laralastica->search('foo', function($query) {

    $query->queryString('foo', ['gte' => 1, 'lte' => 20]);
    $query->queryString('foo', ['gte' => 1, 'lte' => 20], function($rangeQuery) {
        $rangeQuery->setParam('foo', ['gte' => 1, 'lte' => 20, 'boost' => 1]);
    });

});

Regular Expression Query

$laralastica->search('foo', function($query) {

    $query->regexp('foo', 'testing');

});

Term Query

$laralastica->search('foo', function($query) {

    $query->term(['foo' => 'bar']);
    $query->term(['foo' => 'bar'], function($termQuery) {
        $termQuery->setTerm('baz', 'qux', 2.0);
    });

});

Terms Query

$laralastica->search('foo', function($query) {

    $query->terms('foo', ['bar', 'baz']);
    $query->terms('foo', ['bar', 'baz'], function($query) {
        $query->setMinimumMatch(5);
    });

});

Wildcard Query

$laralastica->search('foo', function($query) {

    $query->wildcard('foo', 'bar');

});

Filters

Occasionally you will want to run a query to exclude/include records, but you don't want the query to effect the score., _(*56)

You can do this using filters., _(*57)

To add a filter hit the filter methods and pass it a callback. The callback will be passed an instance of the laralastica builder as the first parameter., _(*58)

For example if only wanted to search against records that had a due date we could do the following., _(*59)

$laralastica->search('foo', function($query) {
    $query->matchAll()
          ->filter(function($query) {
            $query->exists('due_date');
          });
});

Paginate Results

To get a paginated list of results use the paginate method and pass the amount to paginate the results by., _(*60)

$laralastica->paginate('foo', function($query) {

    $query->matchAll();

}, 15);

Raw Elastica Queries

To run a raw elastica query create the query instance and then pass it to the query method., _(*61)

$laralastica->search('foo', function($query) {

    $match = new \Elastica\Query\Match();

    $query->query($match);

});

The Result Collection

The search method will return an instance of the result collection. This extends the default laravel collection but also adds a couple of laralastica specific methods., _(*62)

Total Hits

Gets the total amount of hits matched by the query., _(*63)

$results = $laralastica->search('foo', function($query) { $query->matchAll() });

$results->totalHits();

Maximum Score

Gets the maximum score matched by the search., _(*64)

$results = $laralastica->search('foo', function($query) { $query->matchAll() });

$results->maxScore();

Time Taken

Gets the time taken to execute the elasticsearch query., _(*65)

$results = $laralastica->search('foo', function($query) { $query->matchAll() });

$results->totalTime();