An easy way to use the official PHP ElasticSearch client in your Laravel applications.

4.1.1 2019-09-14 03:02 UTC


An easy way to use the official Elastic Search client in your Laravel or Lumen applications.

Build Status Total Downloads Latest Stable Version Latest Stable Version Scrutinizer Code Quality

Installation and Configuration

Install the current version of the alexsaab/laravel-elasticsearch package via composer:

composer require alexsaab/laravel-elasticsearch

If you are using ElasticSearch version 5, then install version 2 of this package:

composer require alexsaab/laravel-elasticsearch:^2


The package's service provider will automatically register its service provider.

Publish the configuration file:

php artisan vendor:publish --provider="Alexsaab\LaravelElasticsearch\ServiceProvider"
Alternative configuration method via .env file

After you publish the configuration file as suggested above, you may configure ElasticSearch by adding the following to your application's .env file (with appropriate values):

Connecting to AWS Elasticsearch Service

If you are connecting to ElasticSearch instances on Amazon AWS, then you'll also need to composer require aws/aws-sdk-php:^3.80 and add the following to your .env file:



If you work with Lumen, please register the service provider and configuration in bootstrap/app.php:


Manually copy the configuration file to your application.


The Elasticsearch facade is just an entry point into the ES client, so previously you might have used:

$data = [
    'body' => [
        'testField' => 'abc'
    'index' => 'my_index',
    'type' => 'my_type',
    'id' => 'my_id',

$client = ClientBuilder::create()->build();
$return = $client->index($data);

You can now replace those last two lines with simply:

$return = Elasticsearch::index($data);

That will run the command on the default connection. You can run a command on any connection (see the defaultConnection setting and connections array in the configuration file).

$return = Elasticsearch::connection('connectionName')->index($data);

Lumen users who wish to use Facades can do so by editing the bootstrap/app.php file to include the following:

$app->withFacades(true, [
    Alexsaab\LaravelElasticsearch\Facade::class => 'Elasticsearch',

Lumen users who aren't using facades will need to use dependency injection or the application container in order to get the ES service object:

// using injection:
public function handle(\Alexsaab\LaravelElasticsearch\Manager $elasticsearch)

// using application container:
$elasticSearch = $this->app('elasticsearch');

Of course, dependency injection and the application container work for Laravel applications as well.

Advanced Usage

Because the package is a wrapper around the official Elastic client, you can do pretty much anything with this package. Not only can you perform standard CRUD operations, but you can monitor the health of your Elastic cluster programmatically, back it up, or make changes to it. Some of these operations are done through "namespaced" commands, which this package happily supports.

To grab statistics for an index:

$stats = Elasticsearch::indices()->stats(['index' => 'my_index']);
$stats = Elasticsearch::nodes()->stats();
$stats = Elasticsearch::cluster()->stats();

To create and restore snapshots (read the Elastic docs about creating repository paths and plugins first):

$response = Elasticsearch::snapshots()->create($params);
$response = Elasticsearch::snapshots()->restore($params);

To delete whole indices (be careful!):

$response = Elasticsearch::indices()->delete(['index' => 'my_index']);

Please remember that this package is a thin wrapper around a large number of very sophisticated and well-documented Elastic features. Information about those features and the methods and parameters used to call them can be found in the Elastic documentation. Help with using them is available via the Elastic forums and on sites like Stack Overflow.

Bugs, Suggestions, Contributions and Support

Thanks to everyone who has contributed to this project!

Special thanks to JetBrains for their Open Source License Program ... and the excellent PHPStorm IDE, of course!


Please use Github for reporting bugs, and making comments or suggestions.

See for how to contribute changes.

Copyright and License

laravel-elasticsearch was written by Colin Viebrock and is released under the MIT License.

Copyright (c) 2015 Colin Viebrock