laravel-elasticsearch

by shift31

Elasticsearch for Laravel

199 Stars 43 Forks Last release: over 3 years ago (v4.5.1) MIT License 80 Commits 27 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

Laravel Elasticsearch Service Provider (4.5.0)

Latest Stable Version Total Downloads Build Status Coverage Status License

This is a Laravel (4.2) Service Provider for the official Elasticsearch low-level client.

Version Matrix

Since there are breaking changes in Elasticsearch versions, your version of Elasticsearch must match the version of this library, which matches the version of the Elasticsearch low-level client.

|Shift31/laravel-elasticsearch| Elasticsearch | Laravel | | :---: | :---: | :---: | | 0.4| <= 0.90.* | 4.2 | | 1.0, 2.0| >= 1.0 | 4.x, 5.x | |4.0| <= 0.90.* | 4.2| |4.1| >= 1.0 <= 2.0 | 4.2| |4.2| >= 2.0 <= 5.0| 4.2| |4.5| >= 5.0| 4.2| |5.0| <= 0.90.* | 5.x| |5.1| >= 1.0 <= 2.0 | 5.x| |5.2| >= 2.0 <= 5.0| 5.x| |5.5| >= 5.0| 5.x|

Attention: Until we launch new versions please keep using old stable versions (which are created as a branch) and don't use dev-master branch!

Usage

  1. Run

    composer require shift31/laravel-elasticsearch:~4.5.0
  2. Publish config file

Laravel artisan command

$ php artisan config:publish shift31/laravel-elasticsearch 
You can always read config parameters with:
php
\Config::get('shift31::elasticsearch');
Note: The keys of this array should be named according the parameters supported by Elasticsearch\ClientBuilder.
  1. In the

    'providers'
    array in app/config/app.php, add
    'Shift31\LaravelElasticsearch\ElasticsearchServiceProvider'
    .
  2. Use the

    Es
    facade to access any method from the
    Elasticsearch\Client
    class, for example:
    php
    $searchParams['index'] = 'your_index';
    $searchParams['size'] = 50;
    $searchParams['body']['query']['query_string']['query'] = 'foofield:barstring';
    $result = Es::search($searchParams);
    

Default Configuration

If you return an empty array in the config file, Service provider merges default config with custom config variables. For custom config file question please see this elastic search configuration page.

Default config file which is publishing by artisan command.

Contributing

Please see CONTRIBUTING.md.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.