filipgolonka/elasticsearch-reindex-bundle

Elasticsearch reindex bundle

Tuesday, June 6, 2017
by filipgolonka
Repository
1 Watchers
0 Stars
89 Installations

PHP
0 Dependents
0 Suggesters
0 Forks
0 Open issues
4 Versions
10 % Grown

The README.md

Elasticsearch reindex bundle

Allows to reindex data in zero-downtime mode., _(*1)

, _(*2)

How is it working?

See https://www.elastic.co/blog/changing-mapping-with-zero-downtime, _(*3)

Long story short: * create new index * fill in with data * point an alias to new index * remove old index, _(*4)

Your application has to use alias name, not index name directly., _(*5)

Requirements

elasticsearch/elasticsearch >=2.0, <5.0
symfony/config
PHP >7.0

Installation

composer require filipgolonka/elasticsearch-reindex-bundle
add following lines to app/AppKernel.php

$bundles = [
    // ...
    new FilipGolonka\ElasticsearchReindexBundle\FilipGolonkaElasticsearchReindexBundle(),
    // ...
];

add config options to app/config/config.yml

filip_golonka_elasticsearch_reindex:
    alias_name: 'alias_name'
    elasticsearch_client: 'elasticsearch.client'
    index_name_template: 'my-index-%s'
    index_type: my-type
    mapping: '%elasticsearch_mapping%'
    reindex_command_name: 'app.command.elastic_search.importer.all_to'
    settings: '%elasticsearch_settings%'

where: alias_name - alias used by your application elasticsearch_client - DI container id, which points to \Elasticsearch\Client object index_name_template - template used for creating new index. It has to be sprintf pattern with one placement (in the other words - contains one and only one %s) index_type - document types used in your application mapping - Elasticsearch mapping for newly created index reindex_command_name - DI container id, which points to \Symfony\Component\Console\Command\Command object. This command has to accept one and only one argument: index_name. settings - Elasticsearch settings for newly created index, _(*6)

Elasticsearch mapping and settings example

parameters:
    elasticsearch_mapping:
        dynamic: "environment == 'dev' ? 'strict' : false"
        properties:
            id:
                type: string
            date:
                type: date
            gallery:
                type: object
                properties:
                    image:
                        type: string

    elasticsearch_settings:
        number_of_shards: 1,
        number_of_replicas: 0,
        analysis:
            analyzer:
                analyzer_keyword:
                    tokenizer: 'keyword'
                    filter: 'lowercase'

Development

Add your functionality, but before submitting Pull Request - make sure, that you didn't break the quality of code., _(*7)

First - run code static analyses tools:, _(*8)

bin/phing quality

Second - run tests:, _(*9)

bin/phing tests

Before submitting Pull Request, make sure that your code is covered with PhpSpec and Behat tests., _(*10)

How to run Behat locally?

Behat tests if the bundle logic works properly with connection to Elasticsearch, so Elasticsearch url is needed to run tests. How to do it?, _(*11)

export ELASTICSEARCH_URL=http://localhost:9200 && bin/behat

The Versions

06/06 2017

dev-master

9999999-dev https://github.com/filipgolonka/elasticsearch-reindex-bundle

Elasticsearch reindex bundle

Sources Download

BSD-3-Clause

The Requires

The Development Requires

by Filip Golonka

06/06 2017

0.3.0

0.3.0.0 https://github.com/filipgolonka/elasticsearch-reindex-bundle

Elasticsearch reindex bundle

Sources Download

BSD-3-Clause

The Requires

The Development Requires

by Filip Golonka

05/06 2017

0.2.0

0.2.0.0 https://github.com/filipgolonka/elasticsearch-reindex-bundle

Elasticsearch reindex bundle

Sources Download

BSD-3-Clause

The Requires

The Development Requires

by Filip Golonka

05/06 2017

0.1.0

0.1.0.0

Elasticsearch reindex bundle

Sources Download

library elasticsearch-reindex-bundle