PHPackages                             jfxy/elasticsearch - 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. [Search & Filtering](/categories/search)
4. /
5. jfxy/elasticsearch

ActiveLibrary[Search & Filtering](/categories/search)

jfxy/elasticsearch
==================

v7.1.0(4y ago)635MITPHPPHP ^7.1

Since May 19Pushed 1y ago1 watchersCompare

[ Source](https://github.com/jfxyl/elasticsearch)[ Packagist](https://packagist.org/packages/jfxy/elasticsearch)[ RSS](/packages/jfxy-elasticsearch/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependencies (1)Versions (6)Used By (0)

elasticsearch
=============

[](#elasticsearch)

安装
--

[](#安装)

```
composer require jfxy/elasticsearch

```

注意
--

[](#注意)

elasticsearchphppackage>= 7.0>= 7.17.\*>= 6.0>= 7.16.\*使用
--

[](#使用)

#### laravel

[](#laravel)

- 对于Laravel版本低于5.5的应用，需要在config/app.php文件中设置服务提供者和别名
- Laravel版本为5.5或以上，Laravel会进行「包自动发现」

```
'providers' => [
    .
    .
    .
    Jfxy\Elasticsearch\ElasticsearchServiceProvider::class,
],

'aliases' => [
    .
    .
    .
    'Es' => Jfxy\Elasticsearch\ElasticsearchFacade::class
]

```

- 发布配置文件

```
php artisan vendor:publish --provider="Jfxy\Elasticsearch\ElasticsearchServiceProvider"

```

- 调用方式

> 1、在laravel中可以使用门面Es来进行调用

```
    Es::setIndex('products')->where('type','normal')->get();
```

> 2、可以通过传入配置文件进行调用

```
    $config = [
        'hosts' => ['http://127.0.0.1:9200'],
        'connection_retry_times' => 5,
        'connection_pool' => \Elasticsearch\ConnectionPool\StaticNoPingConnectionPool::class,
        'selector' => \Elasticsearch\ConnectionPool\Selectors\RoundRobinSelector::class,
        'serializer' => \Elasticsearch\Serializers\SmartSerializer::class,
    ];
    Builder::init($config)->setIndex('products')->get();
```

> 3、可以使用子类继承\\Jfxy\\Elasticsearch\\Builder，通过重写clientBuilder方法和设置index来简化调用，同时可以在子类中对复杂的操作进行封装

```
    class Es extends \Jfxy\Elasticsearch\Builder
    {

        public $index = 'index1';

        protected function clientBuilder()
        {
            $config = [
                'hosts' => ['http://127.0.0.1:9200'],
                'connection_retry_times' => 5,
                'connection_pool' => \Elasticsearch\ConnectionPool\StaticNoPingConnectionPool::class,
                'selector' => \Elasticsearch\ConnectionPool\Selectors\RoundRobinSelector::class,
                'serializer' => \Elasticsearch\Serializers\SmartSerializer::class,
            ];

            $client = \Elasticsearch\ClientBuilder::create();

            $client->setHosts($config['hosts'])
                ->setRetries($config['connection_retry_times'])
                ->setConnectionPool($config['connection_pool'])
                ->setSelector($config['selector'])
                ->setSerializer($config['serializer'])
                ->build();

            return $client->build();
        }
    }

    Es::init()->get();
```

方法
==

[](#方法)

### 索引操作

[](#索引操作)

#### setIndex

[](#setindex)

- 设置当前操作或查询的索引

```
    public function setIndex($index)

    ->setIndex('index1')
    ->setIndex('index1,index2')
    ->setIndex(['index1','index2'])
```

### 文档操作

[](#文档操作)

#### index 索引文档

[](#index-索引文档)

- 不指定id或指定的id不存在时为创建操作
- 指定id且id存在时为更新操作

```
    public function index(array $data, string $id = null)
```

#### create 创建文档

[](#create-创建文档)

- id必须指定，如果id已存在则创建失败

```
    public function create(array $data, string $id)

    ->create(['id' => 1,'name' => 'jfxy'],1)
```

#### update 更新文档

[](#update-更新文档)

```
    public function update(array $data, string $id)

    ->update(['id' => 1,'name' => 'jfxyl'],1)
```

#### delete 删除文档

[](#delete-删除文档)

- 删除的文档不存在时会抛出 Elasticsearch\\Common\\Exceptions\\Missing404Exception 异常

```
    public function delete(string $id)

```

### 查询操作

[](#查询操作)

#### select

[](#select)

```
    public function select($columns) :self

    ->select('id','name')
    ->select(['id','name'])
```

#### where

[](#where)

- 比较运算符支持 **=,>,>=,<,<=,!=,<>**
- where、orWhere、whereNot、orWhereNot均支持闭包调用，而orWhere、whereNot、orWhereNot则是对闭包内的整体条件进行 or 和 not 的操作，闭包用法类似mysql中对闭包内的条件前后加上（）
- 在封装业务代码存在or关系时，应使用闭包包裹内部条件

```
    public function where($column, $operator = null, $value = null, $match = 'term', $boolean = 'and',$not = false) :self
    public function orWhere($column, $operator = null, $value = null) :self
    public function whereNot($column, $value = null) :self
    public function orWhereNot($column, $value = null) :self

    ->where('id',1)
    ->where('id','=',1)
    ->where('id',[1,2])                         // 等同于  ->whereIn('id',[1,2])
    ->where('news_postdate','',0);
    })
    ->orWhere(function($query){
        return $query->where('id',1)->orWhere('status','>',0);
    })

    // 数组用法，下面两种写法类似，数组用法下的time条件顺序跟直接传入where方法顺序一致即可
    ->where(['id' => 1,'status' => [0,1],['time','>=','2020-09-01']])
    ->where(function($query){
        $query->where('id',1)->where('status',[0,1])->where('time','>=','2020-09-01');
    })

    // whereNot实现 a != 1 and b != 2
    ->whereNot('a',1)->whereNot('b',2)

    // whereNot实现 a != 1 or b != 2，即not(a=1 and b=2)
    ->whereNot(['a'=>1,'b'=>2])
    ->whereNot(function($query){
        $query->where('a',1)->where('b',2);
    })
```

#### filter

[](#filter)

- 用法同where一致，不过条件会写在filter下

```
    public function filter($field, $operator = null, $value = null, $boolean = 'and',$not = false) :self
    public function orFilter($field, $operator = null, $value = null) :self
    public function filterNot($field, $value = null) :self
    public function orFilterNot($field, $value = null) :self
```

#### in

[](#in)

```
    public function whereIn($column, array $value, $boolean = 'and', $not = false) :self
    public function whereNotIn($column, array $value, $boolean = 'and') :self
    public function orWhereIn($column, array $value) :self
    public function orWhereNotIn($column, array $value) :self

    ->whereIn('id',[1,2])
```

#### between

[](#between)

- 默认为闭区间，比较运算符支持 **>,>=,<,<=**

```
    public function whereBetween($column, array $value, $boolean = 'and', $not = false) :self
    public function whereNotBetween($column, array $value, $boolean = 'and') :self
    public function orWhereBetween($column, array $value) :self
    public function orWhereNotBetween($column, array $value) :self

    ->whereBetween('id',[1,10])                     // 1  10])              // 1 whereBetween('id',['>=' => 1,'','100']],['inner_hits'=>['highlight' => ['fields'=>['skus.title'=>new \stdClass()]]]]);
```

#### postWhere 后置过滤器

[](#postwhere-后置过滤器)

- postWhere方法添加的条件会作用于post\_filter查询，条件作用于聚合之后
- postWhere方法参数同where方法相同，复杂的检索可以传入数组或闭包

```
    public function postWhere($field, $operator = null, $value = null, $boolean = 'and',$not = false) :self

    ->postWhere('platform','wx')
    ->postWhere(['platform' => ['wx','web'],['news_posttime','>','2020-09-01 00:00:00']])
    ->postWhere(function(Es $query){
        $query->where('platform','wx')->whereNotMatch('news_title','安徽合肥')->orWhereIn('news_postdate',['2020-09-01','2020-09-02']);
    })
```

#### when

[](#when)

- $value为true时会执行$callback，否则当$default存在时会执行$default

```
    public function when($value,$callback,$default = null) :self

    ->when(1 > 2,function($query){
        return $query->whereBetween('news_postdate',['2020-05-01','2020-05-05']);
    },function($query){
        return $query->whereBetween('news_postdate',['2020-05-09','2020-05-10']);
    })
```

#### collapse 折叠

[](#collapse-折叠)

- 使用collapse方法并不会使返回的总数发生变化，计算折叠后的总数需要配合cardinality聚合使用
- collapse方法和paginator方法一起使用时，paginator方法内部会对折叠的字段做cardinality聚合，不需要考虑collapse的总数问题

```
    public function collapse(string $field,array $appendParams = []) :self

    ->collapse('news_sim_hash')
    ->collapse('news_sim_hash')->aggs('alias','cardinality',['field'=>'news_sim_hash'])
    ->collapse('news_sim_hash')->cardinality('news_sim_hash')
    ->collapse('news_sim_hash')->paginator()
```

#### minScore

[](#minscore)

```
    public function minScore($value): self
```

#### from

[](#from)

```
    public function from(int $value) :self
```

#### size

[](#size)

```
    public function size(int $value) :self
```

#### orderBy 排序

[](#orderby-排序)

```
    public function orderBy(string $field, $sort = 'asc') :self

    ->orderBy('news_posttime','asc')->orderBy('news_like_count','desc')
```

#### highlight 高亮

[](#highlight-高亮)

- 高亮配置及高亮字段
- 建议先在Es子类中设置highlightConfig通用属性

```
    // 根据自己的需要在子类中配置
    public $highlightConfig = [
        "require_field_match" => false,     // 是否只高亮查询的字段
        "number_of_fragments" => 0,         // 高亮字段会被分段，返回分段的个数，设置0不分段
        "pre_tags" => "",
        "post_tags" => "",
    ];
```

- 使用highlightConfig方法会覆盖highlightConfig通用属性中的同键名配置
- highlight方法指定高亮字段并且设置指定字段的高亮属性

```
    public function highlight(string $field,array $params = [])
    public function highlightConfig(array $config = [])

    ->highlightConfig(['require_field_match'=>false,'number_of_fragments' => 0,'pre_tags'=>'','post_tags'=>''])
    ->highlight('news_title')->highlight('news_digest',['number_of_fragments' => 0])
```

#### aggs 聚合

[](#aggs---聚合)

- $alias参数是该聚合的别名
- $type参数是聚合的类型，terms、histogram、date\_histogram、date\_range、range、cardinality、avg、sum、min、max、extended\_stats、top\_hits、filter...
- $params参数是不同聚合类型下的条件键值对数组
- ...$subGroups参数是嵌套聚合，通过传递闭包参数调用，可同时传递多个闭包

```
    public function aggs(string $alias,string $type = 'terms',$params = [], ... $subGroups) :self

    ->aggs('alias','terms',['field'=>'platform','size'=>15,'order' => ['_count'=>'asc']])
    ->aggs('alias','date_histogram',['field'=>'news_posttime','interval' => 'day','format' => 'yyyy-MM-dd','min_doc_count' => 0])
    ->aggs('alias','histogram',['field'=>'news_like_count','interval'=>10])
    ->aggs('alias','extended_stats',['field'=>'news_like_count'])
    ->aggs('alias','cardinality',['field'=>'news_sim_hash'])
    ->aggs('alias','avg',['field'=>'news_like_count'])
    ->aggs('alias','sum',['field'=>'news_like_count'])
    ->aggs('alias','min',['field'=>'news_like_count'])
    ->aggs('alias','max',['field'=>'news_like_count'])
    ->aggs('alias','date_range',[
        'field' => 'news_posttime',
        'format'=> 'yyyy-MM-dd',
        'ranges'=>[
            ['from'=>'2020-09-01','to'=>'2020-09-02'],
            ['from'=>"2020-09-02",'to'=>'2020-09-03']
        ]
    ])
    ->aggs('alias','range',[
        'field' => 'media_CI',
        'ranges'=>[
            ['key'=>'0-500','to'=>'500'],
            ['key'=>'500-1000','from'=>'500','to'=>'1000'],
            ['key'=>'1000-∞','from'=>'1000'],
        ]
    ])
    ->aggs('alias','top_hits',['size'=>1])
    ->aggs('alias','filter',['term' => ['platform' => 'web']])
```

- groupBy方法是aggs的terms类型聚合的封装

```
    public function groupBy(string $field, array $appendParams = [], ... $subGroups) :self

    ->groupBy('platform',['size'=>20,'order'=>['_count'=>'asc']])

    // $appendParams 常用的一些设置，不同的聚合类型参数不同
    $appendParams = [
        'size' => 10,                   // 默认
        'order' => ['_count'=>'desc']   // 默认，文档数量倒序
        'order' => ['_count'=>'asc']    // 文档数量顺序
        'order' => ['_key'=>'desc']     // 分组key倒序
        'order' => ['_key'=>'asc']      // 分组key顺序
        ...
    ]
```

- dateGroupBy方法是aggs的date\_histogram类型聚合的封装

```
    public function dateGroupBy(string $field,string $interval = 'day',string $format = "yyyy-MM-dd",array $appendParams = [], ... $subGroups) :self

    ->dateGroupBy('news_posttime','day','yyyy-MM-dd')
```

- cardinality方法是aggs的cardinality类型聚合的封装

```
    public function cardinality(string $field,array $appendParams = []) :self

    ->cardinality('news_sim_hash')
```

- avg方法是aggs的avg类型聚合的封装

```
    public function avg(string $field,array $appendParams = []) :self

    ->avg('media_CI')
```

- sum方法是aggs的sum类型聚合的封装

```
    public function sum(string $field,array $appendParams = []) :self

    ->sum('media_CI')
```

- min方法是aggs的min类型聚合的封装

```
    public function min(string $field,array $appendParams = []) :self

    ->min('media_CI')
```

- max方法是aggs的max类型聚合的封装

```
    public function max(string $field,array $appendParams = []) :self

    ->max('media_CI')
```

- stats方法是aggs的stats类型聚合的封装

```
    public function stats(string $field,array $appendParams = []) :self

    ->stats('media_CI')
```

- extendedStats方法是aggs的extended\_stats类型聚合的封装

```
    public function extendedStats(string $field,array $appendParams = []) :self

    ->extendedStats('media_CI')
```

- topHits方法是top\_hits类型聚合的封装

```
    public function topHits(string $alias,$params) :self

    ->topHits('alias',[
        'from' => 2,
        'size' => 1,
        'sort' => ['news_posttime' => ['order' => 'asc']],
        '_source' => ['news_title','news_posttime','news_url','news_digest'],
        'highlight' => [
            'require_field_match'=>true,
            'pre_tags'=>'',
            'post_tags'=>'',
            'fields' => [
                'news_title' => new \stdClass(),
                'news_digest' => ['number_of_fragments' => 0]]
            ]
    ]);

    ->topHits('alias',function(Es $query){
        $query->size(1)->from(2)
            ->orderBy('news_posttime','asc')
            ->select(['news_title','news_posttime','news_url','news_digest'])
            ->highlight('news_title')
            ->highlight('news_digest',['number_of_fragments' => 0]);
    })
```

- aggsFilter方法是filter类型聚合的封装，可在聚合内部进行条件过滤，$wheres参数仅支持数组和闭包，可参考where方法

```
    public function aggsFilter($alias,$wheres,... $subGroups) :self

    ->aggsFilter('alias1',function(Es $query){
        $query->where('platform','web');
    },function(Es $query){
        $query->groupBy('platform_name',['size'=>30]);
    })
    ->aggsFilter('alias2',['platform'=>'web','news_title'=>'合肥',['news_postdate','>=','2020-09-01']],function(Es $query){
        $query->groupBy('platform_name',['size'=>30]);
    })
```

#### raw

[](#raw)

- 原生dsl语句查询,不支持添加其他条件

```
    public function raw($dsl) :self

    ->raw(['query'=>['match_all' => new \stdClass()]])->get()
    ->raw(json_encode(['query'=>['match_all' => new \stdClass()]]))->get()
```

#### dsl

[](#dsl)

- 返回待查询的dsl语句，$type = 'json'，返回json字符串

```
    public function dsl($type = 'array')
```

#### response

[](#response)

- 原样输出查询结果

```
    public function response()
```

#### get

[](#get)

- 返回经过一定处理的结果

```
    public function get()

    // $directReturn = false时，返回以下数据
    [
        'total'     => 文档总数,
        'list'      => 文档列表,
        'aggs'      => 聚合结果（存在聚合时返回）,
        'scroll_id' => scroll_id（游标查询时返回）
    ]
```

#### paginator 分页

[](#paginator-分页)

- paginator方法和collapse方法一起使用时，paginator方法内部会对折叠的字段做cardinality聚合，不需要考虑collapse的总数问题

```
    public function paginator(int $page = 1, int $size = 10)

    ->collapse('news_sim_hash')->paginator()

    [
        'total'             => 文档总数（存在collapse时，是计算折叠后的总数）,
        'original_total'    => 文档总数（不受collapse影响）,
        'per_page'          => 每页条数,
        'current_page'      => 当前页码,
        'last_page'         => 最大页码,
        'list'              => 文档列表,
        'aggs'              => 聚合结果（存在聚合时返回）
    ]
```

#### first

[](#first)

- 返回第一条记录

```
    public function first()
```

#### count 计数

[](#count-计数)

```
    public function count()
```

#### scroll 游标

[](#scroll-游标)

```
    $data = Es::init()->scroll()->size(1000)->where('platform','app')->get();
    $es = Es::init();
    while(true){
        $data = $es->scrollId($data['scroll_id'])->get();
        // do something
        ...
    }
```

封装示例
----

[](#封装示例)

```
    // 本例实现的是多个关键词组短语匹配，词组之间是or关系，词组内为and关系
    $keywordGroups = [
        ['中国','上海'],
        ['安徽','合肥'],
    ];
    public function keywords($keywordGroups,$type = 'full'){
        $this->where(function(self $query)use($keywordGroups,$type){
            foreach($keywordGroups as $keywordGroup){
                $query->orWhere(function(self $query1)use($keywordGroup,$type){
                    foreach($keywordGroup as $keyword){
                        if('full' == $type){
                            $query1->whereMultiMatch(['news_title','news_content'],$keyword,'phrase',["operator" => "OR"]);
                        }elseif('title' == $type){
                            $query1->whereMatch('news_title',$keyword,'match_phrase');
                        }elseif('content' == $type){
                            $query1->whereMatch('news_content',$keyword,'match_phrase');
                        }
                    }
                });
            }
        });
        return $this;
    }

    // 本例实现的是排除关键词组内的关键词
    $keywords = ['美国','日本'];
    public function keywordsExclude($keywords){
        $this->where(function(self $query)use($keywords){
            foreach($keywords as $keyword){
                $query->whereNotMultiMatch(['news_title','news_content'],$keyword,'phrase',["operator" => "OR"]);
            }
        });
        return $this;
    }
```

调用示例
----

[](#调用示例)

```
    Es::init()->select('id','name')->where('id',3)->dsl();
    Es::init()->select('id','name')->where('id',3)->groupBy('platform_name')->get();
    Es::init()->select('id','name')->where('id',3)->paginator(2,15);
    Es::init()->select('id','name')->where('id',3)->first();
    Es::init()->select('id','name')->where('id',3)->response();
    Es::init()->select('id','name')->where('id',3)->count();

    Es::init()->select('news_title','news_url','news_uuid','platform')
    ->where('platform',['wx','web','app'])
    ->whereBetween('news_postdate',['2020-09-01','2020-09-10'])
    ->keywords([['中国','上海'],['安徽','合肥']],'full')
    ->keywordsExclude(['美国','日本'])
    ->highlight('news_title')
    ->groupBy('platform',['size'=>20,'order'=>['_count'=>'asc']],function(Es $query){
        $query->groupBy('platform_name',['size'=>30]);
    },function(Es $query){
        $query->groupBy('platform_domian_pri',['size'=>30],function(Es $query){
            $query->topHits('alias',['size'=>1]);
        });
    })
    ->dateGroupBy('news_posttime')
    ->aggs('news_like_count','histogram',['interval'=>100])
    ->cardinality('news_sim_hash')
    ->avg('media_CI')
    ->sum('media_CI')
    ->max('media_CI')
    ->min('media_CI')
    ->extendedStats('media_CI')
    ->get();
```

###  Health Score

26

—

LowBetter than 43% of packages

Maintenance27

Infrequent updates — may be unmaintained

Popularity12

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity50

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 ~44 days

Total

3

Last Release

1727d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/8ef05ab5a7f8940c713a65acce7aa849f5156ca3bc9ed5dfee4dd092b78d775f?d=identicon)[yjj](/maintainers/yjj)

---

Top Contributors

[![jfxyl](https://avatars.githubusercontent.com/u/29575609?v=4)](https://github.com/jfxyl "jfxyl (17 commits)")

### Embed Badge

![Health badge](/badges/jfxy-elasticsearch/health.svg)

```
[![Health](https://phpackages.com/badges/jfxy-elasticsearch/health.svg)](https://phpackages.com/packages/jfxy-elasticsearch)
```

###  Alternatives

[ruflin/elastica

Elasticsearch Client

2.3k50.4M201](/packages/ruflin-elastica)[mailerlite/laravel-elasticsearch

An easy way to use the official PHP ElasticSearch client in your Laravel applications.

934529.3k2](/packages/mailerlite-laravel-elasticsearch)[ongr/elasticsearch-dsl

Elasticsearch DSL library

46411.9M46](/packages/ongr-elasticsearch-dsl)[matchish/laravel-scout-elasticsearch

Search among multiple models with ElasticSearch and Laravel Scout

7431.6M2](/packages/matchish-laravel-scout-elasticsearch)[jeroen-g/explorer

Next-gen Elasticsearch driver for Laravel Scout.

397612.3k](/packages/jeroen-g-explorer)[ongr/elasticsearch-bundle

Elasticsearch bundle for Symfony.

3151.1M15](/packages/ongr-elasticsearch-bundle)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)