tjn/elastic

Elastic Driver for Laravel Scout

1.0.0 2018-07-27 01:52 UTC

Requires

• php: >=5.6.4
• elasticsearch/elasticsearch: ^5.0
• laravel/scout: ^3.0|^4.0

Requires (Dev)

• fzaninotto/faker: ~1.4
• mockery/mockery: 0.9.*
• phpunit/phpunit: ~5.0

Suggests

• elasticsearch/elasticsearch: Required to use the Elasticsearch engine (^5.0).

MIT

• elasticsearch
• laravel
• elastic
• scout

README

This package makes is the Elasticsearch driver for Laravel Scout.

Contents

• Installation
• Usage
• Credits
• License

Installation

You can install the package via composer:

composer require lanzhanqiao/laravel-scout-elastic

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

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

If you need help with this please refer to the Elasticsearch documentation

After you've published the Laravel Scout package configuration:

// 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特性

2. es的index在model中通过方法esIndex动态设置，如果没有则取scout配置文件中的默认index

Now you can use Laravel Scout as described in the official documentation

Credits

• Erick Tamayo
• All Contributors

License

The MIT License (MIT).