crasmedia/laravel-scout-elastic

Elastic Driver for Laravel Scout

Laravel Scout Elasticsearch Driver

, _(*1)

This package makes is the Elasticsearch driver for Laravel Scout., _(*2)

Contents

• Installation
• Usage
• Credits
• License

Installation

You can install the package via composer:, _(*3)

``` bash composer require Crasmedia/laravel-scout-elastic, <sub>(*4)</sub>

You must add the Scout service provider and the package service provider in your app.php config:

```php
// config/app.php
'providers' => [
    ...
    Laravel\Scout\ScoutServiceProvider::class,
    ...
    ScoutEngines\Elasticsearch\ElasticsearchProvider::class,
],

Setting up Elasticsearch configuration

You must have a Elasticsearch server up and running with the index you want to use created, <sub>(*5)</sub>

If you need help with this please refer to the Elasticsearch documentation, <sub>(*6)</sub>

After you've published the Laravel Scout package configuration:, <sub>(*7)</sub>

// config/scout.php
// Set your driver to elasticsearch
    'driver' => env('SCOUT_DRIVER', 'elasticsearch'),

...
    'elasticsearch' => [
        'index' => env('ELASTICSEARCH_INDEX', 'laravel'),
        'hosts' => [
            env('ELASTICSEARCH_HOST', 'http://localhost'),
        ],
    ],
...

Usage

Now you can use Laravel Scout as described in the official documentation, <sub>(*8)</sub>

Custom modifications

You can create/delete your own indexes and put custom mappings on it, <sub>(*9)</sub>

$index = config('scout.elasticsearch.index');

// Check if index exists
if($model->searchableUsing()->exists($index))
{
    // Delete index if exists
    $model->searchableUsing()->deleteIndex($index);
}

// Create new index
$model->searchableUsing()->createIndex($index);

// Put custom mapping
$mappings = $model->mapping();
$model->searchableUsing()->putMapping($index, $model->getTable(), $mappings);

For using the custom mapping just add a mapping function to your model, <sub>(*10)</sub>

public function mapping()
{
    $mapping = [
        'title' => [
            'type' => 'keyword'
        ]
    ];

    return $mapping;
}

Boost

If you wanna boost some fields, just add a boosts variable to your model, <sub>(*11)</sub>

protected $boosts = [
    'title' => 2
];

More information on elastic site, <sub>(*12)</sub>

Sort

Just use the eloquent order by function, <sub>(*13)</sub>

Model::search('')->orderBy('title', 'asc')->get()

Credits

• Erick Tamayo
• Rutger Daling
• All Contributors

License

The MIT License (MIT)., <sub>(*14)</sub>