Download the PHP package spatie/elasticsearch-query-builder without Composer
On this page you can find all versions of the php package spatie/elasticsearch-query-builder. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download spatie/elasticsearch-query-builder
More information about spatie/elasticsearch-query-builder
Files in spatie/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/spatie/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!
Support us
We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.
We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.
Installation
You can install the package via composer:
Note If you're using
elasticsearch/elasticsearch
v7 you need to use v1 of this package.
Basic usage
The only class you really need to interact with is the Spatie\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.
The following query types are available:
ExistsQuery
https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-exists-query.html
MatchQuery
https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-query.html
MatchPhraseQuery
https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-query-phrase.html
MultiMatchQuery
https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-match-query.html
NestedQuery
https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-nested-query.html
RangeQuery
https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-range-query.html
TermQuery
https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-term-query.html
TermsQuery
https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-terms-query.html
WildcardQuery
https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-wildcard-query.html
BoolQuery
https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-bool-query.html
Chaining multiple queries
Multiple addQuery()
calls can be chained on one Builder
. Under the hood they'll be added to a BoolQuery
with occurrence type must
. By passing a second argument to the addQuery()
method you can select a different occurrence type:
More information on the boolean query and its occurrence types can be found in the ElasticSearch docs.
Adding aggregations
The $builder->addAggregation()
method can be used to add any of the available Aggregation
s to the builder. The available aggregation types can be found below or in the src/Aggregations
directory of this repo. Every Aggregation
has a static create()
method to pass its most important parameters and sometimes some extra methods.
The following query types are available:
CardinalityAggregation
FilterAggregation
https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-filter-aggregation.html
MaxAggregation
https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-max-aggregation.html
MinAggregation
https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-min-aggregation.html
SumAggregation
https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-sum-aggregation.html
NestedAggregation
https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-nested-aggregation.html
ReverseNestedAggregation
https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-reverse-nested-aggregation.html
TermsAggregation
https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-terms-aggregation.html
TopHitsAggregation
https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-top-hits-aggregation.html
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.
Nested sort
https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-search-results.html#_nested_sorting_examples
Nested sort with filter
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.
Highlighting
The highlight()
method can be used to add a highlight section to your query along the rules in the ElasticSearch docs.
Post filter
The addPostFilterQuery()
method can be used to add a post_filter BoolQuery to your query along the rules 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
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
- Alex Vanderbist
- Ruben Van Assche
- All Contributors
License
The MIT License (MIT). Please see License File for more information.