tjn/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 lanzhanqiao/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

1. 如果你想使用highlight,在你的model中引入ScoutEngines\Elasticsearch\EsHighlight特性, <sub>(*8)</sub>

2. es的index在model中通过方法esIndex动态设置，如果没有则取scout配置文件中的默认index, <sub>(*9)</sub>

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

Credits

• Erick Tamayo
• All Contributors

License

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