PHPackages                             funphp/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. funphp/elasticsearch

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

funphp/elasticsearch
====================

An Elasticsearch query package

1.1.7(2y ago)0571MITPHPPHP >=7.4

Since Jul 14Pushed 2y agoCompare

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

READMEChangelog (8)Dependencies (2)Versions (12)Used By (0)

Elasticsearch
=============

[](#elasticsearch)

一个基于[elasticsearch/elasticsearch](https://github.com/elastic/elasticsearch-php)简易的Elasticsearch工具包, 对`Document`的查询操作进行了简单的封装.

安装
--

[](#安装)

```
composer require funphp/elasticsearch
```

### 使用

[](#使用)

#### 引入相关搜索类

[](#引入相关搜索类)

在你需要搜索的类中添加 `\Funphp\Elasticsearch\Searchable` trait, 就可以使用相关的搜索操作了.

通过 `searchableIndex()`方法, 就可以指定`index`了.

```
namespace Start;

use Funphp\Elasticsearch\Searchable;

Class User{
    use Searchable;

    public function searchableIndex(): string
    {
        return 'index-user';
    }
}
```

查询文档
----

[](#查询文档)

### 根据指定`id`查询

[](#根据指定id查询)

```
self::searchable()
    ->searchableId('test-id')
    ->search();
```

### term

[](#term)

```
self::searchable()
    ->query(function (Query $query) {
        $query->term('status', 1);
    })
    ->search();
```

### match

[](#match)

```
self::searchable()
    ->query(function (Query $query) {
        $query->match('name', '乌拉');
    })
    ->search();
```

### ids

[](#ids)

```
self::searchable()
    ->query(function (Query $query) {
        $query->ids([1, 2]);
    })
    ->search();
```

### range

[](#range)

```
self::searchable()
    ->query(function (Query $query) {
        $query->range('age', function (Range $range) {
            $range->gte(20);
        });
    })
    ->search();
```

### bool

[](#bool)

#### must

[](#must)

```
self::searchable()
    ->query(function (Query $query) {
        $query->bool(function (BoolQuery $boolQuery) {
            $boolQuery->must(function (Query $query) {
                $query->range('login_at', function (Range $range) {
                    $range->gte('2021-10-01 00:00:00');
                });
            })->must(function (Query $query) {
                $query->range('age', function (Range $range) {
                    $range->lt(18)->gte(12);
                });
            });
        });
    })
    ->sort(fn(Sort $sort) => $sort->sortBy('age'))
    ->search();
```

#### must\_not

[](#must_not)

```
self::searchable()
    ->query(function (Query $query) {
        $query->bool(function (BoolQuery $boolQuery) {
            $boolQuery->mustNot(function (Query $query) {
                $query->exists('comments');
            });
        });
    })
    ->from(10)
    ->size(10)
    ->source(['id', 'title', 'content'])
    ->search();
```

- `filter` `should`用法与`must`相同

### `source`

[](#source)

```
你可以使用`source` 来指定查询的列

对于分页查询,你可以使用`from`和`size`方法来实现.

```

### aggs

[](#aggs)

```
self::searchable()
    ->query(function (Query $query) {
        $query->term('status', $status);
    })->aggs(function (Aggregation $aggregation) {
        $aggregation->valueCount('count', 'id')
            ->max('max', 'value')
            ->sum('sum', 'value');
    })->search();
```

###  Health Score

25

—

LowBetter than 37% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity9

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity54

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

Recently: every ~80 days

Total

11

Last Release

770d ago

PHP version history (2 changes)1.0PHP >7.2

1.1PHP >=7.4

### Community

Maintainers

![](https://www.gravatar.com/avatar/54332e93439991dbeb515b605697b3e0b34be7937d5e7a2cac91d9dc628f0de0?d=identicon)[kiratst](/maintainers/kiratst)

---

Top Contributors

[![aevioni](https://avatars.githubusercontent.com/u/9879953?v=4)](https://github.com/aevioni "aevioni (21 commits)")

### Embed Badge

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

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

###  Alternatives

[mailerlite/laravel-elasticsearch

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

934529.3k2](/packages/mailerlite-laravel-elasticsearch)[jeroen-g/explorer

Next-gen Elasticsearch driver for Laravel Scout.

397612.3k](/packages/jeroen-g-explorer)

PHPackages © 2026

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