Download the PHP package zumba/elasticsearch-index-rotate without Composer
On this page you can find all versions of the php package zumba/elasticsearch-index-rotate. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download zumba/elasticsearch-index-rotate
More information about zumba/elasticsearch-index-rotate
Files in zumba/elasticsearch-index-rotate
Package elasticsearch-index-rotate
Short Description Safely rotate indexes with no downtime to end users.
License MIT
Informations about the package elasticsearch-index-rotate
Elasticsearch Index Rotator
A library to enable you to safely rotate indexes with no downtime to end users.
Why would I use this?
In many situations, Elasticsearch is used as an ephemeral datastore used to take structured or relational data and make it fast to search on that data. Often this is achieved via scheduled jobs that read data from a permanent datastore (such as MySQL or Postgres) and translate it into an Elasticsearch index.
In many cases, rebuilding an index requires a clean slate so that the entire index is rebuilt. How do you do this without interrupting end users searching on that index? The answer is a rotating index.
Here the user's search is fully disrupted when the index is first removed, and only partially available while the index is being rebuilt. While the index is being rebuilt, users get incomplete data.
Here the user's search is never disrupted because we construct a new index and after it is built/settled, we change the what index to search by the client.
Installation
Elasticsearch Index Rotator supports multiple versions of ElasticSearch server and uses the official elasticsearch library for execute the commands. On your application, make sure you include this package as well and specify the version supported by your Elasticsearch server. See the library documentation for the versions.
Usage
Example Search
Example Build
All together
Using Strategies
You can now customize the strategy of getting/setting the primary index. By default, the ConfigurationStrategy
is employed,
however we have also included an AliasStrategy
. The main difference is when setPrimaryIndex
is called, instead of creating an entry
in the configuration index, it adds an alias (specified by alias_name
option) on the specified index and deletes all other aliases
for the old primary indices (specified by index_pattern
).
Using the AliasStrategy
Since the alias (pizza_shops
) is mapped to the primary index (pizza_shops_1234102874
), you can use the alias directly in your client application rather than having to call getPrimaryIndex()
on the IndexRotator
. That being said, calling getPrimaryIndex
won't return the alias, but rather the index that it is aliasing. The secondary entries in the configuration index are still used and reference the actual index names, since the alias can be updated at any time and there wouldn't be a reference to remove the old one.