PHPackages                             georgebohnisch/laravel-elasticsearch-query-builder - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Search & Filtering](/categories/search)
4. /
5. georgebohnisch/laravel-elasticsearch-query-builder

ActiveLibrary[Search & Filtering](/categories/search)

georgebohnisch/laravel-elasticsearch-query-builder
==================================================

:Query Elasticsearch by using Eloquent

1.0.3(6y ago)0112GPL-3.0-onlyPHP

Since Nov 9Pushed 5y agoCompare

[ Source](https://github.com/georgebohnisch/Laravel-Elasticsearch-Query-Builder)[ Packagist](https://packagist.org/packages/georgebohnisch/laravel-elasticsearch-query-builder)[ Docs](https://github.com/shisun/laravel-elasticsearch-query-builder)[ RSS](/packages/georgebohnisch-laravel-elasticsearch-query-builder/feed)WikiDiscussions master Synced 2d ago

READMEChangelogDependencies (6)Versions (5)Used By (0)

Laravel Elasticsearch Query Builder
===================================

[](#laravel-elasticsearch-query-builder)

> Query Elasticsearch by using Eloquent

This Laravel package is developed to simplify the process of querying Elasticsearch. Eloquent is a powerful tool to access and manipulate data in RDB. However, it is not designed to query no-sql DB like Elasticsearch. This package is made to fill the gap between the most popular ORM in Laravel and Elasticsearch.

The package only relies on the official [PHP Elasticsearch package(v6)](https://github.com/elastic/elasticsearch-php).

PHP version
-----------

[](#php-version)

The package is developed and tested under PHP `v7.1`. It should be also compatible with `v7.*`. Please email me if you find any compatibility issue.

Elasticsearch version
---------------------

[](#elasticsearch-version)

The package is developed and tested under Elasticsearch `v6.*`. It should be also compatible with `v5.*`. Please email me if you find any compatibility issue. It is confirmed that the package does not support versions before `v5.*`.

Installation
------------

[](#installation)

- Add the following to your `composer.json` file:

    ```
    "shisun/laravel-elasticsearch-query-builder": "dev-master"
    ```
- Run `composer update` in terminal
- Add the package to your `app.php` file in the config folder:

    ```
    'providers' => [
        ...
        Shisun\LaravelElasticsearchQueryBuilder\LaravelElasticsearchQueryBuilderServiceProvider::class,
    ]
    ```
- If your Elasticsearch is not accessible at `localhost:9200` then you have to publish the config file by running:

    ```
    $ php artisan vendor:publish --provider="Shisun\LaravelElasticsearchQueryBuilder\LaravelElasticsearchQueryBuilderServiceProvider"
    ```
- (Optional) Change the `ES_HOSTS` in config/laravel-elasticsearch-query-builder.php to the address of your Elasticsearch
- Use with Eloquent Model

    - Add `EsTrait` to your model ```
        use Shisun\LaravelElasticsearchQueryBuilder\EsTrait;

        class User extends Model
        {
            use EsTrait;
        }
        ```
    - Enable validation(Optional) ```
        use Shisun\LaravelElasticsearchQueryBuilder\EsTrait;
        class User extends Model
        {
           use EsTrait;
           public $mappingProperties;
           public function __construct($attributes = []) {
               parent::__construct($attributes);

               $this->mappingProperties = [
                   'id' => [
                       'type' => 'integer',
                   ],
                   'name' => [
                       'type' => 'text',
                           'index' => true,
                   ],
                   'email' => [
                       'type' => 'keyword'
                   ],
                   'address' => [
                       'type' => 'text'
                   ],
                   'float_example' => [
                       'type' => 'float'
                   ],
                   'multi_fields_example' => [
                       'type' => 'text',
                       'fields' => [
                           'raw' => [
                               'type' => 'keyword'
                           ]
                       ]
                   ],
                   'created_at' => [
                       'type' => 'date',
                       'format' => 'yyyy-MM-dd HH:mm:ss',
                   ],
                   'some_relations' => [
                       'type' => 'nested',
                       'properties' => [
                           ....
                       ]
                   ]
               ];
           }
        }
        ```
    - Set model-level Index and Type name. Add follow two functions to your model.(Optional) ```
        public function getIndexName() {
            return 'users';
        }
        // type name will be set to index name if this function is not defined.
        public function getTypeName() {
            return 'users';
        }
        ```
- Use without Eloquent

    ```
    use Shisun\LaravelElasticsearchQueryBuilder\LaravelElasticsearchQueryBuilder as Builder;
    $query = (new Builder())->setOptions([
        'index_name' => 'users',
        'type_name'  => 'users'
    ])->where('name', 'Leo')->get()->toArray();
    // or if you only want to generate the query without getting results
    $query = (new Builder())->where('name', 'Leo')->getBody()
    ```

Usage
-----

[](#usage)

### Table of Contents

[](#table-of-contents)

- [Init & Configs](#init-&-configs)
    - [\_\_construct](#__construct)
    - [setOptions](#setoptions)
    - getters
        - getIndexName
        - getTypeName
        - getValidation
        - getMappingProperties
    - setters
        - setIndexName
        - setTypeName
        - setValidation
        - setMappingProperties
- [Query Clauses](#query-clauses)
    - [where](#where)
    - [orWhere](#orwhere)
    - [whereMatch](#wherematch)
    - [whereDoesntMatch](#wheredoesntmatch)
    - [orWhereMatch](#)
    - [whereHas](#wherehas)
    - [whereHasNull](#wherehasnull)
    - [orWhereHas](#orwherehas)
    - [whereIn](#wherein)
    - [orWhereIn](#orwherein)
    - [whereNotIn](#wherenotin)
    - [orWhereNotIn](#orwherenotin)
    - [whereBetween](#wherebetween)
    - [orWhereBetween](#orwherebetween)
- [Order](#order)
    - [orderBy](#orderby)
- [Pagination](#pagination)
    - [page](#page)
    - [limit](#limit)
    - [offset](#offset)
- [Aggregation](#aggregations)
    - [aggregate](#aggregate)
    - [aggregateAll](#aggregateall)
    - [aggregateOn](#aggregateon)
    - [groupBy](#groupby)
    - [min](#min)
    - [max](#max)
    - [avg](#avg)
    - [sum](#sum)
- [Other Filters](#other-filters)
    - [minScore](#minscore)
    - [with](#with)
    - [withOut](#without)
- [Execute Query](#execute-query)
    - [get](#get)
    - [scroll](#scroll)
    - [count](#count)
    - [first](#first)
    - [find](#find)
    - [delete](#delete)
- [Results Manipulation](#results-manipulation)
    - [toArray](#toarray)
    - [toEloquent](#toeloquent)
    - [rawResults](#rawresults)
    - [aggregations](#aggregations)
    - [getAggregationBuckets](#getaggregationbuckets)
    - [paginate](#paginate)
- [Direct Query Output](#orwherebetween)
    - [getQuery](#orwherebetween)
    - [getBody](#orwherebetween)
    - [getAggs](#orwherebetween)

### Init & Configs

[](#init--configs)

#### \_\_construct

[](#__construct)

- You do not need to use this function if you use Eloquent
- Parameters

    NameRequiredTypeDefaultDescriptionmodel`Eloquent`,`null``null`
- Output

    `self`
- Examples

    1. basic example ```
        use Shisun\LaravelElasticsearchQueryBuilder\LaravelElasticsearchQueryBuilder as Builder;
        $builder = new Builder();
        ```

#### setOptions

[](#setoptions)

- You do not need to use this function if you use Eloquent
- Parameters

    NameRequiredTypeDefaultDescriptionoptionsY`array`
- Output

    `self`
- Examples

    1. Basic ```
        use Shisun\LaravelElasticsearchQueryBuilder\LaravelElasticsearchQueryBuilder as Builder;
        $builder = (new Builder())->setOptions([
            'index_name' => 'users',
            'type_name'  => 'users',
            'validation' => false,
            'mapping_properties' => [check the example in the installation section]
        ]);
        ```

### Query Clauses

[](#query-clauses)

#### where

[](#where)

- Parameters

    NameRequiredTypeDefaultDescriptioncolumnY`callable`,`string`operator`string``null``=`,`>`,`where('id', 1)->first()
        ```
    2. `*` is the wildcard operator ```
        // Find the user whose name starts with 'Leo'
        User::es()->where('name', '*', 'Leo*')->first()
        ```
    3. `column` can be a function ```
        User::es()->where(function($q) {
            $q->orWhere(...)->orWhere(...);
        })->get()->toArray()
        ```

#### whereNull

[](#wherenull)

- Parameters

    NameRequiredTypeDefaultDescriptioncolumnY`string`Column or relation
- Output

    `self`
- Examples

    1. Find all users with no name ```
        User::es()->whereNull('name')->get()
        ```
    2. Find all users who don't have address ```
        User::es()->whereNull('Addresses')->get()
        ```

#### whereNotNull

[](#wherenotnull)

- Parameters

    NameRequiredTypeDefaultDescriptioncolumnY`string`Column or relation
- Output

    `self`
- Examples

    1. Find all users with a name ```
        User::es()->whereNotNull('name')->get()
        ```
    2. Find all users who have at least one address ```
        User::es()->whereNotNull('Addresses')->get()
        ```

#### orWhere

[](#orwhere)

- Parameters

    NameRequiredTypeDefaultDescriptioncolumnY`callable`,`string`operator`string``null``=`,`>`,`orWhere('id', 1)->first()
        ```
    2. `column` can be a function ```
        User::es()->orWhere(function($q) {
            $q->where(...)->where(...);
        })->limit(1)->get()->toArray()
        ```

#### whereMatch

[](#wherematch)

- It is used to make fuzzy text search. This function should only be applied on text fields.
- Parameters

    NameRequiredTypeDefaultDescriptioncolumnY`string`value`mixed``null`options`array`\[\]`match`query options. Check elasticsearch Docs for references
- Output

    `self`
- Examples

    1. without `options````
        User::es()->whereMatch('email', 'shisun@')->first()
        ```
    2. with `options````
        User::es()->whereMatch('email', 'shisun@', [
               'query' => 'this will be overrided by $value',
               'operator' => 'and',
               'zero_terms_query' => 'all'
             ])->first()
        ```

#### whereDoesntMatch

[](#wheredoesntmatch)

- Parameters

    NameRequiredTypeDefaultDescriptioncolumnY`string`value`mixed``null`options`array`\[\]`match`query options. Check elasticsearch Docs for references
- Output

    `self`
- Examples

    1. without `options````
        User::es()->whereDoesntMatch('email', 'shisun@')->first()
        ```
    2. with `options````
        User::es()->whereDoesntMatch('email', 'shisun@', [
               'query' => 'this will be overrided by $value',
               'operator' => 'and',
               'zero_terms_query' => 'all'
             ])->first()
        ```

#### orWhereMatch

[](#orwherematch)

- Parameters

    NameRequiredTypeDefaultDescriptioncolumnY`string`value`mixed``null`options`array`\[\]`match`query options. Check elasticsearch Docs for references
- Output

    `self`
- Examples

    1. without `options````
        User::es()->orWhereMatch('email', 'shisun@')->first()
        ```
    2. with `options````
        User::es()->orWhereMatch('email', 'shisun@', [
               'query' => 'this will be overrided by $value',
               'operator' => 'and',
               'zero_terms_query' => 'all'
             ])->first()
        ```

#### whereHas

[](#wherehas)

- Parameters

    NameRequiredTypeDefaultDescriptionrelationY`string`, `callable`Must be capitalizedclosure`callable`, `null``null``from` and `to` cannot be both `null`or`boolean``null`for internal use. See orWhereHasboost`boolean`,`integer``false`Used to adjust the weight of the condition
- Output

    `self`
- Examples

    1. basic example ```
        // find all users with active someRelations
        User::es()->whereHas('someRelations', function($q) {
            $q->where('status', 'active');
        })->first();
        ```
    2. first parameter can be a function ```
        // find all users with either active someRelations or red someOtherRelations
        // Note: the parent 'whereHas' is interchangable with 'where' clause
        User::es()->whereHas(function($q) {
            $q->orWhereHas('someRelations', function($k) {
                 $k->where('status', 'active');
            })->orWhereHas('someOtherRelations', function($k) {
                 $k->where('color', 'red');
            });
        })->first();
        ```

#### orWhereHas

[](#orwherehas)

- Parameters

    NameRequiredTypeDefaultDescriptionrelationY`string`, `callable`Must be capitalizedclosure`callable`, `null``null``from` and `to` cannot be both `null`boost`boolean`,`integer``false`Used to adjust the weight of the condition
- Output

    `self`
- Examples

    1. basic example ```
        // find all users with either active someRelations or red someOtherRelations
        // Note: the parent 'whereHas' is interchangable with 'where' clause
        User::es()->whereHas(function($q) {
            $q->orWhereHas('someRelations', function($k) {
                 $k->where('status', 'active');
            })->orWhereHas('someOtherRelations', function($k) {
                 $k->where('color', 'red');
            });
        })->first();
        ```

#### whereHasNull

[](#wherehasnull)

- Parameters

    NameRequiredTypeDefaultDescriptionrelationY`string`Must be capitalizedclosure`null`, `callable``null`
- Output

    `self`
- Examples

    1. basic example ```
        // find all users with no someRelation
        User::es()->whereHasNull('someRelations')->first();
        ```
    2. with sub query ```
        // find all users with no someRelation with id = 1
        User::es()->whereHasNull('someRelations', function($q) {
            $q->where('id', 1);
        })->first();
        ```

#### orWhereHasNull

[](#orwherehasnull)

- Parameters

    NameRequiredTypeDefaultDescriptionrelationY`string`Must be capitalizedclosure`null`, `callable``null`
- Output

    `self`
- Examples

    1. basic example ```
        // find all users either with no someRelation or named as 'Leo'
        User::es()->where(function($q) {
            $q->orWhereHasNull('someRelations')->orWhere('name', 'Leo');
        })->first();
        ```

#### whereIn

[](#wherein)

- Parameters

    NameRequiredTypeDefaultDescriptioncolumnY`string`valuesY`array`
- Output

    `self`
- Examples

    1. basic example ```
        // find all users with pending or active status
        User::es()->whereIn('status', ['active', 'pending'])->get();
        ```

#### orWhereIn

[](#orwherein)

- Parameters

    NameRequiredTypeDefaultDescriptioncolumnY`string`valuesY`array`
- Output

    `self`
- Examples

    1. basic example ```
        // find all users with either pending/active status or with name Leo
        User::es()->where(function($q) {
            $q->orWhereIn('status', ['active', 'pending'])->orWhere('name', 'Leo');
        })->get();
        ```

#### whereNotIn

[](#wherenotin)

- Parameters

    NameRequiredTypeDefaultDescriptioncolumnY`string`valuesY`array`
- Output

    `self`
- Examples

    1. basic example ```
        // find all users that are not in pending or active status
        User::es()->whereNotIn('status', ['active', 'pending'])->get();
        ```

#### orWhereNotIn

[](#orwherenotin)

- Parameters

    NameRequiredTypeDefaultDescriptioncolumnY`string`valuesY`array`
- Output

    `self`
- Examples

    1. basic example ```
        // find all users with either not in pending/active status or with name Leo
        User::es()->where(function($q) {
            $q->orWhereNotIn('status', ['active', 'pending'])->orWhere('name', 'Leo');
        })->get();
        ```

#### whereBetween

[](#wherebetween)

- Parameters

    NameRequiredTypeDefaultDescriptioncolumnY`string`from`numeric``null``from` and `to` cannot be both `null`to`numeric``null`
- Output

    `self`
- Examples

    1. basic example ```
        User::es()->whereBetween('id', 1, 5)->first()
        ```

#### orWhereBetween

[](#orwherebetween)

- Parameters

    NameRequiredTypeDefaultDescriptioncolumnY`string`from`numeric``null``from` and `to` cannot be both `null`to`numeric``null`
- Output

    `self`
- Examples

    1. basic example ```
        User::es()->orWhereBetween('id', 1, 5)->first()
        ```

### Order

[](#order)

#### orderBy

[](#orderby)

- Parameters

    NameRequiredTypeDefaultDescriptioncolumnY`string`order`numeric``asc`either `asc` or `desc`script`array`,`boolean``false`
- Output

    `self`
- Examples

    1. basic example ```
        User::es()->orderBy('id', 'desc')->get()
        ```
    2. script ```
        // If the category of the item is Laptop then use discount_price for ordering. Otherwise, use listing_price.
        Item::es()->orderBy('id', 'desc',
                    ['lang' => 'painless', 'source' => "if(doc['category'].value == 'Laptops') {return doc['discount_price'].value;} else {return doc['listing_price'].value;}"])
              ->get()
        ```

### Pagination

[](#pagination)

#### page

[](#page)

- Parameters

    NameRequiredTypeDefaultDescriptionpageY`integer`per\_pageY`integer`
- Output

    `self`
- Examples

    1. basic example ```
        // get the first page. 25 users per page.
        User::es()->page(1, 25)->get()
        ```

#### limit

[](#limit)

- Parameters

    NameRequiredTypeDefaultDescriptionlimitY`integer`
- Output

    `self`
- Examples

    1. basic example ```
        // get 25 users.
        User::es()->limit(25)->get()
        ```

#### offset

[](#offset)

- Parameters

    NameRequiredTypeDefaultDescriptionlimitY`integer`
- Output

    `self`
- Examples

    1. basic example ```
        // skip first 25 users.
        User::es()->offset(25)->get()
        ```

### Aggregations

[](#aggregations)

#### aggregate

[](#aggregate)

- Parameters

    NameRequiredTypeDefaultDescriptionnameY`string`aggY`callable`
- Output

    `self`
- Examples

    1. basic example ```
        Item::es()->aggregate('group_items_by_categories', function($q) {
            $q->groupBy('category_id');
        })->get()->aggregations();
        ```
    2. with filters ```
        // get all active and pending items. But only aggregate on the filtered items that are also red.
        // Note: aggregate clause is only applied on the filtered items.
        Item::es()->whereIn('status', ['active', 'pending'])->aggregate('categories', function($q) {
            $q->where('color', 'red')->aggregate('group_by', function($k) {
                $k->groupBy('category_id');
            });
        })->get()->aggregations();
        // this returns
        // [
        //     'categories' => [
        //         'doc_count' => 50,
        //         'group_by'  => [
        //             'doc_count_error_upper_bound' => 0,
        //             'sum_other_doc_count'         => 8,
        //             'buckets' => [
        //                 [
        //                     'key' => 1,
        //                     'doc_count' => 15
        //                 ],
        //                 ...
        //             ]
        //         ]
        //     ]
        //  ]
        // the 'key' in buckets is one of the category_id
        ```

#### aggregateAll

[](#aggregateall)

- Parameters

    NameRequiredTypeDefaultDescriptionnameY`string`aggY`callable`
- Output

    `self`
- Examples

    1. with filters ```
        // get all active and pending items. And aggregate on all red items.
        // Note: aggregateAll clause is applied on all items regardless other queries.
        Item::es()->whereIn('status', ['active', 'pending'])->aggregateAll('categories', function($q) {
            $q->where('color', 'red')->aggregate('group_by', function($k) {
                $k->groupBy('category_id');
            });
        })->get()->aggregations();
        // this returns
        // [
        //     'categories' => [
        //         'doc_count' => 50,
        //         'group_by'  => [
        //             'doc_count_error_upper_bound' => 0,
        //             'sum_other_doc_count'         => 8,
        //             'buckets' => [
        //                 [
        //                     'key' => 1,
        //                     'doc_count' => 15
        //                 ],
        //                 ...
        //             ]
        //         ]
        //     ]
        //  ]
        // the 'key' in buckets is one of the category_id
        ```

#### aggregateOn

[](#aggregateon)

- Parameters

    NameRequiredTypeDefaultDescriptionrelationY`string`Must be capitalizedaggY`callable`custom\_name`string``null`
- Output

    `self`
- Examples

    1. basic example ```
        Item::es()->aggregateOn('someRelations', function($q) {
            $q->min('id');
        })->get()->aggregations();
        // this returns
        // [
        //     'some_relations' => [
        //         'doc_count' => 50,
        //         'min_id'  => [
        //             'value' => 1
        //         ]
        //     ]
        //  ]
        // 'some_relations' will be replaced if custom_name is provided
        ```

#### groupBy

[](#groupby)

- Parameters

    NameRequiredTypeDefaultDescriptioncolumnY`string`size`integer``10`The limit of number of groups. Default to 10 groups
- Output

    `self`
- Check aggregate clause for examples

#### min

[](#min)

- Parameters

    NameRequiredTypeDefaultDescriptioncolumnY`string`custom\_name`string``null`
- Output

    `self`
- Examples

    1. basic example ```
        Item::es()->min('id')->get()->aggregations();
        // or
        Item::es()->aggregate('test', function($q) {
            $q->min('id');
        })->get()->aggregations();
        // They both return. Note: the 'test' in the second example is ignored.
        // [
        //     'min_id' => [
        //         'value' => 1
        //     ]
        //  ]
        // 'min_id' will be replaced if custom_name is provided. The format of the name is 'min_' + column
        ```

#### max

[](#max)

- Parameters

    NameRequiredTypeDefaultDescriptioncolumnY`string`custom\_name`string``null`missing\_value`numeric``null`This value will be used to replace null values
- Output

    `self`
- Examples

    1. basic example ```
        Item::es()->max('id')->get()->aggregations();
        // or
        Item::es()->aggregate('test', function($q) {
            $q->max('id');
        })->get()->aggregations();
        // They both return. Note: the 'test' in the second example is ignored.
        // [
        //     'max_id' => [
        //         'value' => 1
        //     ]
        //  ]
        // 'min_id' will be replaced if custom_name is provided. The format of the name is 'max_' + column
        ```

#### avg

[](#avg)

- Parameters

    NameRequiredTypeDefaultDescriptioncolumnY`string`custom\_name`string``null`missing\_value`numeric``null`This value will be used to replace null values
- Output

    `self`
- Examples

    1. basic example ```
        Item::es()->avg('id')->get()->aggregations();
        // or
        Item::es()->aggregate('test', function($q) {
            $q->avg('id');
        })->get()->aggregations();
        // They both return. Note: the 'test' in the second example is ignored.
        // [
        //     'avg_id' => [
        //         'value' => 1
        //     ]
        //  ]
        // 'min_id' will be replaced if custom_name is provided. The format of the name is 'avg_' + column
        ```

#### sum

[](#sum)

- Parameters

    NameRequiredTypeDefaultDescriptioncolumn`string``Empty`custom\_name`string``null`missing\_value`numeric``null`This value will be used to replace null valuesscript`array``null`Check official Doc as reference
- Output

    `self`
- Examples

    1. basic example ```
        Item::es()->sum('id')->get()->aggregations();
        // or
        Item::es()->aggregate('test', function($q) {
            $q->sum('id');
        })->get()->aggregations();
        // They both return. Note: the 'test' in the second example is ignored.
        // [
        //     'sum_id' => [
        //         'value' => 1
        //     ]
        //  ]
        // 'min_id' will be replaced if custom_name is provided. The format of the name is 'sum_' + column
        ```

### Other Filters

[](#other-filters)

#### minScore

[](#minscore)

- Parameters

    NameRequiredTypeDefaultDescriptionscoreY`numeric`Only get items with \_score greater than this value
- Output

    `self`
- Examples

    1. basic example ```
        User::es()->whereMatch('name', 'Leo', ['operator' => 'and'])->minScore(5)->get()
        ```

#### with

[](#with)

- Parameters

    NameRequiredTypeDefaultDescriptionrelationsY`list`include these relations in results. All relations are included by default.
- Output

    `self`
- Examples

    1. basic example ```
        User::es()->with('Addresses', 'Company')->get()
        ```

#### withOut

[](#without)

- Parameters

    NameRequiredTypeDefaultDescriptionrelationsY`list`Exclude these relations in results. All relations are included by default.
- Output

    `self`
- Examples

    1. basic example ```
        User::es()->withOut('Addresses', 'Company')->get()
        ```

### Execute Query

[](#execute-query)

#### get

[](#get)

#### scroll

[](#scroll)

- Parameters

    NameRequiredTypeDefaultDescriptionscroll\_alive`string``5m`This specifies the life span of the scroll session.scroll\_size`integer``500`This specifies the number of records retrieved from Elasticsearch per batch.json`boolean``false`If encode the results from each batch in JSON format. Fetching data and put the data in PHP array can consume a lot of memory. This option can greatly reduce the memory usage.
- Output

    `array`
- Examples

    1. basic example ```
        User::es()->scroll()
        ```

#### count

[](#count)

- Output

    `integer`
- Examples

    1. basic example ```
        User::es()->count()
        ```

#### first

[](#first)

- Parameters

    NameRequiredTypeDefaultDescriptioneloquent`boolean``false`get result in array or Eloquent. Returns array if not provided.
- Output

    `array`|`Eloquent`
- Examples

    1. basic example ```
        User::es()->first()
        ```

#### find

[](#find)

- Parameters

    NameRequiredTypeDefaultDescriptionkeyY`mixed`
- Output

    `array`
- Examples

    1. basic example ```
        // get the user with id = 5
        // Note: the key_name can be set by setKeyName or setOptions. The key_name is 'id' by default
        User::es()->find(5)
        ```

#### delete

[](#delete)

- Delete a record from elasticsearch. Returns false if the record does not exist.
- Parameters

    NameRequiredTypeDefaultDescriptionkeyY`mixed`
- Output

    `array`
- Examples

    1. basic example ```
        // delete the user with id = 5
        // Note: the key_name can be set by setKeyName or setOptions. The key_name is 'id' by default
        User::es()->delete(5)
        ```

### Results Manipulation

[](#results-manipulation)

#### toArray

[](#toarray)

- Output

    `array`

#### toEloquent

[](#toeloquent)

Warning: This function does not work if you don't use the package with Eloquent.

- Output

    `Eloquent`

#### rawResults

[](#rawresults)

Get raw results from Elasticsearch

- Output

    `array`

#### aggregations

[](#aggregations-1)

Get aggregation results

- Output

    `array`

#### getAggregationBuckets

[](#getaggregationbuckets)

This is a helper function to get buckets from the aggregation specified by agg\_name

- Parameters

    NameRequiredTypeDefaultDescriptionagg\_nameY`mixed`agg`mixed``null`
- Output

    `array`
- Examples

    1. basic example ```
        // if the aggregations are
        // this returns
        // [
        //     'categories' => [
        //         'doc_count' => 50,
        //         'group_by'  => [
        //             'doc_count_error_upper_bound' => 0,
        //             'sum_other_doc_count'         => 8,
        //             'buckets' => [
        //                 [
        //                     'key' => 1,
        //                     'doc_count' => 15
        //                 ],
        //                 ...
        //             ]
        //         ]
        //     ]
        //  ]
        // Then you can use getAggregationBuckets('categories') to get the buckets array
        ```

#### paginate

[](#paginate)

Returns pagination information

- Parameters

    NameRequiredTypeDefaultDescriptionper\_page`mixed`The value can be ignored if per\_page is set by limit() or page(). Otherwise, it's required.
- Output

    `array`
- Example

    1. basic

    ```
    [
      "pages" => [
        1,
        2,
        3,
        4,
        5,
      ],
      "rows" => 165,
      "active" => 1,
      "totalpages" => 7.0,
      "prev" => false,
      "next" => true,
      "per_page" => 25
    ]
    ```

### Direct Query Output

[](#direct-query-output)

#### getQuery

[](#getquery)

Returns the query part of the body

#### getBody

[](#getbody)

Returns the body

#### getAggs

[](#getaggs)

Returns the aggregation part of the body

Release History
---------------

[](#release-history)

Meta
----

[](#meta)

Shisun(Leo) Xia -

Distributed under the GNU V3 license. See `LICENSE` for more information.

###  Health Score

29

—

LowBetter than 60% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity10

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity64

Established project with proven stability

 Bus Factor1

Top contributor holds 68.8% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~99 days

Total

4

Last Release

2444d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/f4b01b8bd7329e9a3260803ac96e80ed18b916cfad9a16e904a700cf1cb51d0f?d=identicon)[georgebohnisch](/maintainers/georgebohnisch)

---

Top Contributors

[![ShisunXia](https://avatars.githubusercontent.com/u/6559117?v=4)](https://github.com/ShisunXia "ShisunXia (11 commits)")[![georgebohnisch](https://avatars.githubusercontent.com/u/494749?v=4)](https://github.com/georgebohnisch "georgebohnisch (4 commits)")[![stevebauman](https://avatars.githubusercontent.com/u/6421846?v=4)](https://github.com/stevebauman "stevebauman (1 commits)")

---

Tags

laravelelasticsearchLaravelElasticsearchQueryBuilder

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/georgebohnisch-laravel-elasticsearch-query-builder/health.svg)

```
[![Health](https://phpackages.com/badges/georgebohnisch-laravel-elasticsearch-query-builder/health.svg)](https://phpackages.com/packages/georgebohnisch-laravel-elasticsearch-query-builder)
```

###  Alternatives

[mailerlite/laravel-elasticsearch

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

934529.3k2](/packages/mailerlite-laravel-elasticsearch)[jeroen-g/explorer

Next-gen Elasticsearch driver for Laravel Scout.

397612.3k](/packages/jeroen-g-explorer)[baijunyao/laravel-scout-elasticsearch

Elasticsearch Driver for Laravel Scout

8023.7k1](/packages/baijunyao-laravel-scout-elasticsearch)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)