PHP download

Download the PHP package shader2k/search-indexer without Composer

On this page you can find all versions of the php package shader2k/search-indexer. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

Table of contents
Download shader2k/search-indexer
More information about shader2k/search-indexer
Files in shader2k/search-indexer

Vendor shader2k
Package search-indexer
Short Description zero downtime reindex
License MIT

Keywords elasticsearch laravel reindex

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:

If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.

Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
To use Composer is sometimes complicated. Especially for beginners.
Composer needs much resources. Sometimes they are not available on a simple webspace.
If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.

Please rate this library. Is it a good library?

Example code of shader2k/search-indexer

Informations about the package search-indexer

Elasticsearch zero downtime reindexing

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

Установка

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

Настройка

Скопировать config файл в <projectRoot>/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() удаление сущности из индекса

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

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

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

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

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

Расширения можно найти по ссылкам: Драйвера для поисковых машин, Провайдеры данных

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

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

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

All versions of search-indexer with dependencies

PHP Build Version

Package Version

Version 1.0 Release 04. Jan 2021
create-project require 0 people chose require and
0 people chose create-project.

Download

Download latest version of search-indexer from vendor shader2k

Requires php Version ^7.1 || ^8.0
vlucas/phpdotenv Version ^3.6
hassankhan/config Version ^2.1
ext-json Version *

Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package shader2k/search-indexer contains the following files

Loading the files please wait ...