PHPackages                             shader2k/search-indexer - 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. shader2k/search-indexer

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

shader2k/search-indexer
=======================

zero downtime reindex

1.0(5y ago)383MITPHPPHP ^7.1 || ^8.0CI failing

Since Apr 5Pushed 5y ago1 watchersCompare

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

READMEChangelog (6)Dependencies (4)Versions (9)Used By (0)

[![PHPUnit](https://github.com/shader2k/search-indexer/workflows/PHPUnit/badge.svg?branch=master)](https://github.com/shader2k/search-indexer/workflows/PHPUnit/badge.svg?branch=master)

Elasticsearch zero downtime reindexing
======================================

[](#elasticsearch-zero-downtime-reindexing)

Переиндексация модели с нулевым временем простоя

Установка
---------

[](#установка)

Установка через Composer

```
composer require shader2k/search-indexer

```

Настройка
---------

[](#настройка)

Скопировать config файл в `/config/indexerconfig.php`

Параметры конфигурации:

- `searchDriverFactories` и `dataProviderFactories` - доступные в системе драйвера и провайдеры (можно расширять имеющиеся, указав алиасы и классы фабрик)
- `searchDriverNameDefault` и `dataProviderNameDefault` - алиасы драйвера и провайдера по умолчанию
- `dataProviderChunkSize` размер частей для получения данных из модели
- `elasticsearchHost` хост поискового движка (ElasticSearch)

При необходимости можно разместить .env файл в корень проекта (.env.example)

Использование
-------------

[](#использование)

Индексируемая модель должна **обязательно** имплементировать интерфейс `\Indexable\IndexableContract`

Реализуемые методы:

- `getIndexableFields()` должен вернуть массив имен полей, которые небоходимо добавить в индекс
- `getIdentifierField()` должен вернуть имя поля, используемое в качестве ID
- `getSearchDriverName()` если метод вернет null, будет использован драйвер по умолчанию. Если указать имя драйвера, для индексирования будет использован этот драйвер
- `getProviderName()` имя провайдера. Используется аналогично методу `getSearchDriverName()`
- `getIndexName()` имя индекса (должно быть уникально), например `return __CLASS__;`
- `getIdentifierValue()` значение ID, например `return (string) $this->id;`

В пакете присутствует трейт `Traits\IndexableTrait`, который можно использовать в моделях для использования драйвера и провайдера по умолчанию.

### Использование сервиса в проекте

[](#использование-сервиса-в-проекте)

Инициализировать сервис желательно как синглтон

- `indexingModel()` переиндексация всей модели. В данном случае будет создан новый индекс, в него проиндексируется модель, затем, атомарной операцией, старый индекс будет подменен новым.
- `indexingEntity()` добавить одну сущность в индекс
- `removeEntity()` удаление сущности из индекса

```
$searchIndexer = new SearchIndexerService(new ProviderManager(), new DriverManager());
//переиндексация всей модели
$searchIndexer->indexingModel(User::class);
//переиндексация одной сущности
$index = $searchIndexer->indexingEntity($entity);
//удаление одной сущности
$index = $searchIndexer->removeEntity($entity);
```

### Добавление сервиса в проект на Laravel

[](#добавление-сервиса-в-проект-на-laravel)

В методе `boot()` AppServiceProvider.php нужно объявить сервис как синглтон

```
$this->app->singleton('SearchIndexerService', function ($app) {
    return new SearchIndexerService(new ProviderManager(), new DriverManager());
});
```

Использование сервиса:

```
$indexerService = App::make('SearchIndexerService');
//переиндексация всей модели
$indexerService->indexingModel(User::class);
//переиндексация одной сущности
$index = $indexerService->indexingEntity($entity);
//удаление одной сущности
$index = $indexerService->removeEntity($entity);
```

Расширение пакета
=================

[](#расширение-пакета)

Возможно расширение пакета за счет дополнительных драйверов для поисковых движков (например Sphinx, Elasticsearch) и провайдеров данных (например Eloquent, Doctrine)

Расширения можно найти по ссылкам: [Драйвера для поисковых машин](https://github.com/shader2k/search-indexer-drivers), [Провайдеры данных](https://github.com/shader2k/search-indexer-providers)

Добавление драйвера:
Необходимо реализовать интерфейс фабрики для драйвера `DriverFactoryContract` и интерфейс драйвера `DriverContract`. Добавить новый драйвер в config:

```
'searchDriverFactories' => [
    'anyAlias' => '\YourRepository\DriverFactoryClass'
]
```

При реализации метода `prepareIndex` драйвера, необходимо обеспечить бесперебойную работу старого индекса, в случае переиндексации всей модели (на что указывает параметр `$reindex` со значением `true`). После переиндексации - атомарной операцией подменить старый индекс на новый.

Аналогично можно расширить провайдеры, реализуя `ProviderFactoryContract` для фабрики и `ProviderContract` для провайдера. Добавить новый провайдер в config:

```
'dataProviderFactories' => [
    'anyAlias' => '\YourRepository\ProviderFactoryClass'
]
```

###  Health Score

30

—

LowBetter than 64% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity12

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity66

Established project with proven stability

 Bus Factor1

Top contributor holds 73.1% 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 ~53 days

Recently: every ~60 days

Total

6

Last Release

1953d ago

Major Versions

0.0.5 → 1.02021-01-04

PHP version history (2 changes)0.0.1PHP ^7.1

1.0PHP ^7.1 || ^8.0

### Community

Maintainers

![](https://www.gravatar.com/avatar/f9c77a93cef261807def8715c0ca7692e9800fb7ece5fd2fc9d4f6c4b0e69ab3?d=identicon)[artem-prozorov](/maintainers/artem-prozorov)

![](https://www.gravatar.com/avatar/2824c4b0847f9449da75f5a982e88877c1fa884d10cdb837a807fb91fc6ff22f?d=identicon)[shader2k](/maintainers/shader2k)

---

Top Contributors

[![shader2k](https://avatars.githubusercontent.com/u/21981491?v=4)](https://github.com/shader2k "shader2k (38 commits)")[![artprozorov](https://avatars.githubusercontent.com/u/188947463?v=4)](https://github.com/artprozorov "artprozorov (14 commits)")

---

Tags

laravelelasticsearchreindex

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/shader2k-search-indexer/health.svg)

```
[![Health](https://phpackages.com/badges/shader2k-search-indexer/health.svg)](https://phpackages.com/packages/shader2k-search-indexer)
```

###  Alternatives

[baijunyao/laravel-scout-elasticsearch

Elasticsearch Driver for Laravel Scout

8023.7k1](/packages/baijunyao-laravel-scout-elasticsearch)

PHPackages © 2026

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