alhoqbani/laravel-scout-elasticsearch

0.0.2 2017-10-18 15:02 UTC

README

Latest Version on Packagist Software License Build Status Coverage Status Quality Score Total Downloads

Add elasticsearch engine to Laravel Scout

Under development. Not ready for production.

Install

Via Composer

$ composer require alhoqbani/laravel-scout-elasticsearch

Usage

Quick Start

Publish scout config file and change the driver to elastic

    'driver' => env('SCOUT_DRIVER', 'elastic'),

Publish the config file for this library:

php artisan vendor:publish --provider "Alhoqbani\Elastic\ScoutElasticServiceProvider"

update the configuration for elasticsearch hosts.

Add Laravel\Scout\Searchable trait to your model

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;
use Laravel\Scout\Searchable;

class Post extends Model
{
    use Searchable;
    //
}
  • Run php artisan scout:import "App\Post" to import all records to elasticsearch
  • Search $posts = App\Post::search('Star Trek')->get();

Change log

Please see CHANGELOG for more information on what has changed recently.

Testing

$ composer test

Contributing

Please see CONTRIBUTING and CODE_OF_CONDUCT for details.

Security

If you discover any security related issues, please email h.alhoqbani@gmail.com instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.