Download the PHP package edwinhoksberg/elasticsearch-query-builder without Composer
On this page you can find all versions of the php package edwinhoksberg/elasticsearch-query-builder. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download edwinhoksberg/elasticsearch-query-builder
More information about edwinhoksberg/elasticsearch-query-builder
Files in edwinhoksberg/elasticsearch-query-builder
Package elasticsearch-query-builder
Short Description Build and execute an Elasticsearch search query using a fluent PHP API
License MIT
Homepage https://github.com/edwinhoksberg/elasticsearch-query-builder
Informations about the package elasticsearch-query-builder
Build and execute ElasticSearch queries using a fluent PHP API
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!
Installation
You can install the package via composer:
Basic usage
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 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.
Adding queries
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.
Adding sorts
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.
Retrieve specific fields
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.
Pagination
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:
Testing
Credits
- Edwin Hoksberg
- Alex Vanderbist
- Ruben Van Assche
- All Contributors
License
The MIT License (MIT). Please see License File for more information.