{"id":14981102,"url":"https://github.com/erichard/elasticsearch-query-builder","last_synced_at":"2025-04-09T14:12:34.744Z","repository":{"id":38310687,"uuid":"120622726","full_name":"erichard/elasticsearch-query-builder","owner":"erichard","description":"Build query for an ElasticSearch client using a fluent interface","archived":false,"fork":false,"pushed_at":"2024-06-24T09:22:47.000Z","size":168,"stargazers_count":39,"open_issues_count":4,"forks_count":21,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-04-02T08:38:44.946Z","etag":null,"topics":["elasticsearch","php","querybuilder"],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/erichard.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-02-07T14:04:31.000Z","updated_at":"2024-06-14T11:20:46.000Z","dependencies_parsed_at":"2024-06-19T11:23:27.060Z","dependency_job_id":"3d9c5c4a-e50f-4a3b-9c12-383ac70f3e62","html_url":"https://github.com/erichard/elasticsearch-query-builder","commit_stats":{"total_commits":98,"total_committers":17,"mean_commits":5.764705882352941,"dds":0.7346938775510203,"last_synced_commit":"773e4cfa1edddbd12405429f462e3ff717fd90f3"},"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/erichard%2Felasticsearch-query-builder","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/erichard%2Felasticsearch-query-builder/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/erichard%2Felasticsearch-query-builder/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/erichard%2Felasticsearch-query-builder/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/erichard","download_url":"https://codeload.github.com/erichard/elasticsearch-query-builder/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248054195,"owners_count":21039952,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["elasticsearch","php","querybuilder"],"created_at":"2024-09-24T14:02:55.257Z","updated_at":"2025-04-09T14:12:34.712Z","avatar_url":"https://github.com/erichard.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"ElasticSearch Query Builder\n===========================\n\n![img](https://img.shields.io/badge/phpstan-8-green)\n![php](https://img.shields.io/badge/php-8.0-brightgreen)\n\n\nThis is a PHP library which helps you build query for an ElasticSearch client by using a fluent interface.\n\nWARNING: This branch contains the next 3.x release. Check the [corresponding issue](https://github.com/erichard/elasticsearch-query-builder/issues/7) for the roadmap.\n\nInstallation\n------------\n\n```bash\ncomposer require erichard/elasticsearch-query-builder \"^3.0@beta\"\n```\n\nUsage\n-----\n\n```php\n\nuse Erichard\\ElasticQueryBuilder\\QueryBuilder;\nuse Erichard\\ElasticQueryBuilder\\Aggregation\\Aggregation;\nuse Erichard\\ElasticQueryBuilder\\Filter\\Filter;\n\n$qb = new QueryBuilder();\n\n$qb\n    -\u003esetIndex('app')\n    -\u003esetSize(10)\n;\n\n// Add an aggregation\n$qb-\u003eaddAggregation(Aggregation::terms('agg_name', 'my_field'));\n$qb-\u003eaddAggregation(Aggregation::terms('agg_name_same_as_field'));\n\n// Set query\n$qb-\u003esetQuery(Query::terms('field', 'value'));\n\n// I am using a client from elasticsearch/elasticsearch here\n$results = $client-\u003esearch($qb-\u003ebuild());\n```\n\nwith PHP 8.1 you can use named arguments like this:\n\n```php\n$query = new BoolQuery(must: [\n    new RangeQuery(\n        field: 'price',\n        gte: 100\n    ),\n    new RangeQuery(\n        field: 'stock',\n        gte: 10\n    ),\n]);\n```\n\nor with the factory\n\n```php\n$query = Query::bool(must: [\n    Query::range(\n        field: 'price',\n        gte: 100\n    ),\n    Query::range(\n        field: 'stock',\n        gte: 10\n    ),\n]);\n```\n\nContribution\n------------\n\n- Use PHPCS fixer and PHPStan\n  - `composer lint`\n- Update tests (PHPUnit)\n  - `composer test`\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ferichard%2Felasticsearch-query-builder","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ferichard%2Felasticsearch-query-builder","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ferichard%2Felasticsearch-query-builder/lists"}