PHPackages vae/php-elasticsearch-orm - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Database & ORM](/categories/database) 4. / 5. vae/php-elasticsearch-orm ActiveLibrary[Database & ORM](/categories/database) vae/php-elasticsearch-orm ========================= Adapt the orm query method of elasticsearch for >=php7.4 v2.0.1(8mo ago)35.6k2MITPHPPHP >=7.4 Since Jun 27Pushed 8mo ago1 watchersCompare [ Source](https://github.com/vae-s/php-elasticsearch-orm)[ Packagist](https://packagist.org/packages/vae/php-elasticsearch-orm)[ RSS](/packages/vae-php-elasticsearch-orm/feed)WikiDiscussions master Synced 1mo ago READMEChangelog (9)Dependencies (5)Versions (17)Used By (0) PHP ELASTICSEARCH ORM ===================== [](#php-elasticsearch-orm) 从 v1.x 升级到 v2.0 指南 ------------------ [](#从-v1x-升级到-v20-指南) 变更 -- [](#变更) 1. **依赖变更**： - 移除了 `illuminate/support` 依赖 - 新增 `tightenco/collect` 依赖 迁移步骤 ---- [](#迁移步骤) ### 1. 修改 composer.json [](#1-修改-composerjson) ``` { "require": { "vae/php-elasticsearch-orm": "^2.0" } } ``` Install ------- [](#install) ``` composer require vae/php-elasticsearch-orm ``` Support Elasticsearch Version ----------------------------- [](#support-elasticsearch-version) > more than 7.0 Use --- [](#use) ### PHP [](#php) ``` //require elasticsearch config $config = require "elasticsearch.php"; //instance $builder = Factory::builder($config); ``` ### Laravel framework [](#laravel-framework) Add the service provider config in `config/app.php` ``` 'providers' => [ Vae\PhpElasticsearchOrm\Laravel\ElasticsearchOrm\OrmProvider::class, ] ``` Use in Code ``` $builder = app(\Vae\PhpElasticsearchOrm\Builder::class); ``` ### Hyperf framework [](#hyperf-framework) Use in Code OrmElasticsearchClientFactory ``` use \Vae\PhpElasticsearchOrm\Builder; use \Vae\PhpElasticsearchOrm\Query; use \Vae\PhpElasticsearchOrm\Grammar; class OrmElasticsearchClientFactory{ public static function builder() { // 如果在协程环境下创建，则会自动使用协程版的 Handler，非协程环境下无改变 $hyperfBuilder = ApplicationContext::getContainer()->get(ClientBuilderFactory::class)->create(); $client = $hyperfBuilder->setHosts(['http://127.0.0.1:9200'])->build(); return new Builder(new Query(new Grammar(), $client)); } } ``` Quickstart ---------- [](#quickstart) ### Create [](#create) ``` $builder->index('index')->create(['key' => 'value']); //return collection $builder->index('index')->createCollection(['key' => 'value']); ``` ### Batch Create [](#batch-create) ``` $builder->index('index')->batchCreate( [ 'key1' => 'v1', 'key2' => 'v2', ], [ 'key3' => 'v3', 'key4' => 'v4', ] ); ``` ### Update [](#update) ``` $builder->index('index')->update(['key' => 'value']); $builder->index('index')->update(['key' => ['key2' => 'value']]); ``` ### Batch Update Or Update [](#batch-update-or-update) ``` $builder->index('index')->batchUpdateOrCreate( [ 'id' => '1', 'key1' => 'v1', 'key2' => 'v2', ], [ 'id' => 2, 'key3' => 'v3', 'key4' => 'v4', ] ); ``` ### deleteById [](#deletebyid) ``` $builder->index('index')->deleteById($id) : bool ``` ### delete [](#delete) ``` $builder->index('index')->delete() ``` ### Select [](#select) ``` //select one $builder->index('index')->first(); //select all $builder->index('index')->get(); //select with paginate $builder->index('index')->paginate($page, $size) : Collection //select by id $builder->byId($id) : stdClass //select by id if failed throw error $builder->byIdOrFail($id) : stdClass //select chunk $builder->chunk(callback $callback, $limit = 2000, $scroll = '10m') ``` ### Count [](#count) ``` $builder->count() : int ``` ### Condition [](#condition) whereTerm ``` $builder->whereTerm('key', 'value'); ``` whereLike（wildcard） ``` //value without add wildcard '*' $builder->whereLike('key', 'value'); ``` match ``` $builder->whereMatch('key', 'value'); ``` range ``` $builder->whereBetween('key', ['value1', 'value2']); ``` where in ``` $builder->whereIn('key', ['value1', 'value2', ...]); ``` nestedQuery ``` $builder->where(function(Builder $query){ $query->whereTerm('key', 'value'); }); ``` search nested data ``` $nestedColumn = "nested_column"; $builder->whereNested($nestedColumn, function ($query) { $query->where('key1', 'value1') $query->where('key2', 'value2') }); ``` ``` $nestedKey = "nested_key"; $key = "key"; $builder->where("{$nestedKey}@{$key}", '=', 'value'); ``` ### Where Support Operator [](#where-support-operator) > \['=' => 'eq','>' => 'gt','>=' => 'gte','<' => 'lt','<=' => 'lte','!=' => 'ne',\] ``` $builder->where('key', '=', 'value'); ``` ### More [](#more) see file `Vae\PhpElasticsearchOrm\Builder` ### Health Score 40 — FairBetter than 88% of packages Maintenance59 Moderate activity, may be stable Popularity25 Limited adoption so far Community9 Small or concentrated contributor base Maturity56 Maturing project, gaining track record Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~144 days Recently: every ~205 days Total 9 Last Release 263d ago Major Versions v1.0.6 → v2.0.02025-05-27 ### Community Maintainers ![](https://www.gravatar.com/avatar/b924e9474ce64cf0e6dfab0b088ed09b8717a7acf8df2bb78d7edb93992375da?d=identicon)[vae-s](/maintainers/vae-s) --- Top Contributors [![vae-s](https://avatars.githubusercontent.com/u/53052986?v=4)](https://github.com/vae-s "vae-s (6 commits)") ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/vae-php-elasticsearch-orm/health.svg) ``` [![Health](https://phpackages.com/badges/vae-php-elasticsearch-orm/health.svg)](https://phpackages.com/packages/vae-php-elasticsearch-orm) ``` ### Alternatives [bavix/laravel-wallet It's easy to work with a virtual wallet. 1.3k1.1M11](/packages/bavix-laravel-wallet)[dyrynda/laravel-model-uuid This package allows you to easily work with UUIDs in your Laravel models. 4802.8M8](/packages/dyrynda-laravel-model-uuid)[google/cloud-bigquery BigQuery Client for PHP 8917.2M41](/packages/google-cloud-bigquery)[pdphilip/elasticsearch An Elasticsearch implementation of Laravel's Eloquent ORM 145360.2k4](/packages/pdphilip-elasticsearch)[formal/orm 324.0k1](/packages/formal-orm) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)