This package is a lightweight query builder for ElasticSearch. It was specifically built for our elasticsearch-search-string-parser so it covers most use-cases but might lack certain features. We're always open for PRs if you need anything specific!
use EdwinHoksberg\ElasticsearchQueryBuilder\Aggregations\MaxAggregation;
use EdwinHoksberg\ElasticsearchQueryBuilder\Builder;
use EdwinHoksberg\ElasticsearchQueryBuilder\Queries\MatchQuery;
$client = Elastic\Elasticsearch\ClientBuilder::create()->build();
$companies = (new Builder($client))
->index('companies')
->addQuery(MatchQuery::create('name', 'spatie', fuzziness: 3))
->addAggregation(MaxAggregation::create('score'))
->search();
You can install the package via composer:
composer require edwinhoksberg/elasticsearch-query-builder
The only class you really need to interact with is the EdwinHoksberg\ElasticsearchQueryBuilder\Builder
class. It requires an \Elastic\Elasticsearch\Client
passed in the constructor. Take a look at the ElasticSearch SDK docs to learn more about connecting to your ElasticSearch cluster.
The Builder
class contains some methods to add queries, aggregations, sorts, fields and some extras for pagination. You can read more about these methods below. Once you've fully built-up the query you can use $builder->search()
to execute the query or $builder->getPayload()
to get the raw payload for ElasticSearch.
use EdwinHoksberg\ElasticsearchQueryBuilder\Queries\RangeQuery;
use EdwinHoksberg\ElasticsearchQueryBuilder\Builder;
$client = Elastic\Elasticsearch\ClientBuilder::create()->build();
$builder = new Builder($client);
$builder->addQuery(RangeQuery::create('age')->gte(18));
$results = $builder->search(); // raw response from ElasticSearch
The $builder->addQuery()
method can be used to add any of the available Query
types to the builder. The available query types can be found below or in the src/Queries
directory of this repo. Every Query
has a static create()
method to pass its most important parameters.
The Builder
(and some aggregations) has a addSort()
method that takes a Sort
instance to sort the results. You can read more about how sorting works in the ElasticSearch docs.
use EdwinHoksberg\ElasticsearchQueryBuilder\Sorts\Sort;
$builder
->addSort(Sort::create('age', Sort::DESC))
->addSort(
Sort::create('score', Sort::ASC)
->unmappedType('long')
->missing(0)
);
The fields()
method can be used to request specific fields from the resulting documents without returning the entire _source
entry. You can read more about the specifics of the fields parameter in the ElasticSearch docs.
$builder->fields('user.id', 'http.*.status');
Finally the Builder
also features a size()
and from()
method for the corresponding ElasticSearch search parameters. These can be used to build a paginated search. Take a look the following example to get a rough idea:
use EdwinHoksberg\ElasticsearchQueryBuilder\Builder;
$pageSize = 100;
$pageNumber = $_GET['page'] ?? 1;
$pageResults = (new Builder(Elastic\Elasticsearch\ClientBuilder::create()))
->size($pageSize)
->from(($pageNumber - 1) * $pageSize)
->search();
composer test
The MIT License (MIT). Please see License File for more information.