Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gskema/elasticsearch-query-dsl-php
Feature complete, object oriented, composable, extendable ElasticSearch query DSL builder for PHP
https://github.com/gskema/elasticsearch-query-dsl-php
dsl elasticsearch php query
Last synced: 2 months ago
JSON representation
Feature complete, object oriented, composable, extendable ElasticSearch query DSL builder for PHP
- Host: GitHub
- URL: https://github.com/gskema/elasticsearch-query-dsl-php
- Owner: gskema
- License: mit
- Created: 2018-02-16T21:09:16.000Z (almost 7 years ago)
- Default Branch: 6.x
- Last Pushed: 2024-01-29T12:04:02.000Z (12 months ago)
- Last Synced: 2024-11-02T11:42:27.241Z (3 months ago)
- Topics: dsl, elasticsearch, php, query
- Language: PHP
- Homepage:
- Size: 383 KB
- Stars: 6
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Elasticsearch Query DSL
[![Latest Version on Packagist][ico-version]][link-packagist]
[![Software License][ico-license]](LICENSE.md)
[![Build Status][ico-build]][link-build]
[![Coverage Status][ico-coverage]][link-build]
[![Total Downloads][ico-downloads]][link-downloads]
Feature complete, object oriented, composable, extendable Elasticsearch query DSL builder for PHP.
## Features
- Dependency free
- Can be used with any PHP Elasticsearch client
- Fully interfaced, ready for custom classes and
- Explicit class and property naming, fully matches produced JSON and Elasticsearch docs
- All configuration options are listed inside classes, links to documentation
- Classes can be easily composed, extended
- Usage of setters/getters so that everything can be inlined and chained.
- Fully working `::__clone()` methods
- Extendable code: no usage of `private`, `final` or `readonly`
- Basic objects created on `__construct`, no unnecessary body build logic until `jsonSerialize()` is called
## Versions
Most of the classes should be compatible with any Elasticsearch versions.
If something is not compatible or not supported, `Raw*` or custom classes can be used.
| Package version | Elasticsearch version |
|-----------------|-----------------------|
| >=6.0.0 <7.0.0 | >=6.0.0 <7.0.0 |
| >=5.0.0 <6.0.0 | >=5.0.0 <6.0.0 |
Because major version number follows Elasticsearch major version number, second number is reserved for breaking changes.
## Install
``` bash
composer require gskema/elasticsearch-query-dsl-php 6.* # match your Elasticsearch version
```
## Usage
``` php
$searchRequest = new SearchRequest();
$searchRequest->setOption('min_score', 3.5);
$searchRequest->setSize(10);
$searchRequest->setQuery(
(new BoolMatcher())->addMustNot(new TermMatcher('field1', 'value1'))
);
$searchRequest->addStatGroup('stat_group_1');
$searchRequest->setAgg(
'agg1',
(new FilterAggregation(new MatchAllMatcher()))
->setAgg('agg2', TermsAggregation::fromField('field2', 'value2'))
);
(new ElasticsearchClient())->search($searchRequest->jsonSerialize());
```
All classes match naming in official Elasticsearch documentation.
Each class has a list of possible configuration options listed above
class using attributes:
```php
#[Options([
'flags' => 'ALL|ANYSTRING|COMPLEMENT|EMPTY|INTERSECTION|INTERVAL|NONE',
'max_determinized_states' => 2000,
...
])]
class RegexpMatcher implements MultiTermMatcherInterface {}
```
Similarly, `SearchRequest` class also has possible URL parameters listed:
```php
#[Parameters([
'timeout' => '2s',
'terminate_after' => 1,
'max_concurrent_shard_requests' => 2,
...
])]
class SearchRequest implements SearchRequestInterface {}
```
## Matcher?
Request object that is received by Elasticsearch `/_search/` has many properties and sub-properties
like `query`, `filter`, `post_filter`, etc.
To avoid convoluted expressions like
```php
(new SearchRequest())->setQuery(
(new BoolQuery()->addFilter(new TermQuery('x')
)->setPostFilter(new BoolQuery(...)))
```
keyword `matcher` was explicitly chosen.
## Change log
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Testing
``` bash
./vendor/bin/phpunit
```
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
[ico-version]: https://img.shields.io/packagist/v/gskema/elasticsearch-query-dsl-php.svg?style=flat-square
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
[ico-build]: https://img.shields.io/github/actions/workflow/status/gskema/elasticsearch-query-dsl-php/ci.yml?branch=6.x
[ico-coverage]: https://raw.githubusercontent.com/gskema/elasticsearch-query-dsl-php/image-data/coverage.svg
[ico-downloads]: https://img.shields.io/packagist/dt/gskema/elasticsearch-query-dsl-php.svg?style=flat-square
[link-packagist]: https://packagist.org/packages/gskema/elasticsearch-query-dsl-php
[link-build]: https://github.com/gskema/elasticsearch-query-dsl-php/actions
[link-downloads]: https://packagist.org/packages/gskema/elasticsearch-query-dsl-php