PHPackages                             nexucis/es-index-helper - 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. [Utility & Helpers](/categories/utility)
4. /
5. nexucis/es-index-helper

ActiveLibrary[Utility & Helpers](/categories/utility)

nexucis/es-index-helper
=======================

Elasticsearch Index Helper for php, which allows you to manage your indices without any downtime

7.1.0(5y ago)1519.5k4[1 PRs](https://github.com/Nexucis/es-php-index-helper/pulls)MITPHPPHP ^7.1 | ^8.0CI failing

Since Nov 11Pushed 4y ago2 watchersCompare

[ Source](https://github.com/Nexucis/es-php-index-helper)[ Packagist](https://packagist.org/packages/nexucis/es-index-helper)[ RSS](/packages/nexucis-es-index-helper/feed)WikiDiscussions master Synced 4w ago

READMEChangelog (9)Dependencies (5)Versions (13)Used By (0)

Elasticsearch Index Helper for php
==================================

[](#elasticsearch-index-helper-for-php)

[![CircleCI](https://camo.githubusercontent.com/79814ec9cc444a1d20ab06d7808954af393b7b38f210e20b5e9638145fa16514/68747470733a2f2f636972636c6563692e636f6d2f67682f4e6578756369732f65732d7068702d696e6465782d68656c7065722e7376673f7374796c653d736869656c64)](https://circleci.com/gh/Nexucis/es-php-index-helper) [![codecov](https://camo.githubusercontent.com/6a5d651aedb4dcd15205bdb75c8a1dc6f70faea6899d10eec4b49fd413f1b043/68747470733a2f2f636f6465636f762e696f2f67682f4e6578756369732f65732d7068702d696e6465782d68656c7065722f6272616e63682f6d61737465722f67726170682f62616467652e737667)](https://codecov.io/gh/Nexucis/es-php-index-helper) [![Latest Stable Version](https://camo.githubusercontent.com/ae034807e3580716da2e1766543558717cc9a483d839eba6d5ae158c588984a9/68747470733a2f2f706f7365722e707567782e6f72672f6e6578756369732f65732d696e6465782d68656c7065722f762f737461626c65)](https://packagist.org/packages/nexucis/es-index-helper) [![Total Downloads](https://camo.githubusercontent.com/6f9ebab546afc0d9720ed77e5728c1b0010af6b66320c6ea7e227734a76f28af/68747470733a2f2f706f7365722e707567782e6f72672f6e6578756369732f65732d696e6465782d68656c7065722f646f776e6c6f616473)](https://packagist.org/packages/nexucis/es-index-helper)

1. [Overview](#overview)
2. [Installation](#installation)
3. [Quickstart](#quickstart)
4. [Contributions](#contributions)
5. [Development](#development)
6. [License](#license)

Overview
--------

[](#overview)

This project provides an index Helper in order to help you to manage your ES Indices with no downtime. This helper implements the philosophy described in the [official documentation](https://www.elastic.co/guide/en/elasticsearch/guide/master/index-aliases.html) which can be summarized in a few words : *use alias instead of index directly*

### Versioning

[](#versioning)

This project uses the following version rules:

```
X.Y.Z

```

Where :

- X is the major version of ElasticSearch supported by this project
- Y is the major version of this helper. Be careful with this rule, you can have some breaking changes between two **Y** number.
- Z is the minor version of this Index Helper. It will be increased when there are some bug fixes.

### Supported Version

[](#supported-version)

Elasticsearch VersionSupport Branch>= 7.0master>= 6.0, < 7.0support/6.0>= 5.0, < 6.0support/5.0>= 2.0, < 5.0support/2.0Installation
------------

[](#installation)

The recommended method to install this library is through [Composer](https://getcomposer.org/).

- In your `composer.json` file put the following dependency :

```
{
  "require": {
    "nexucis/es-index-helper": "X.Y.*"
  }
}
```

where X.Y is the version which fit your need.

- After that you need to install this new dependency :

```
php composer.phar install
```

> Or you can just use the composer command to modify your `composer.json` and update your dependencies :
>
> ```
> php composer.phar require nexucis/es-index-helper
> ```

- To initialize the Index Helper, you need first to instantiate the elasticsearch client :

```