Skip to content

Latest commit

 

History

History
117 lines (79 loc) · 3.4 KB

README.markdown

File metadata and controls

117 lines (79 loc) · 3.4 KB
Raw

Build Status

es-reindex - simple ruby gem for copying ElasticSearch index

Simple ruby gem to copy and reindex ElasticSearch index, copying index settings and mapping(s).

Progress and time estimation is displayed during the scrolling process.

Requirements

  • Ruby 1.9.3 or newer

Installation

[sudo] gem install es-reindex

Usage (command line)

Refer to script's help:

$ es-reindex -h

Script to copy particular ES index including its (re)creation w/options set
and mapping copied.

Usage:

  es-reindex [options] [source_url/]<index> [destination_url/]<index>

    - -r  - remove the index in the new location first
    - -f  - specify frame size to be obtained with one fetch during scrolling
    - -u  - update existing documents (default: only create non-existing)
    - -nm - don't copy mappings and settings
    - optional source/destination urls default to http://127.0.0.1:9200

Usage (in project)

You can also use it as a PORO:

To Copy

# Options:
# remove: same as -r
# frame: same as -f
# update: same as -u cli option

options = {
  remove: true,
  update: true
}

ESReindex.copy! 'http://my_server/index', 'http://my_server/index_copy', options

To Reindex

If you want to reindex the destination from the source without copying the mappings/settings from the source, you can do it as such:

ESReindex.reindex! 'http://my_server/index', 'http://my_server/index_copy',
  mappings: -> { set_of_mappings },
  settings: -> { set_of_settings}

If using the .reindex! method, you MUST pass valid mappings/settings in via the options.

Callbacks

There also a set of callbacks you can use:

ESReindex.copy! 'http://my_server/index', 'http://my_server/index_copy',
  before_create: ->    { do_something },      # Runs before the (re)creation of the destination index
  after_create:  ->    { do_something_else }, # Runs after the (re)creation of the destinatino index
  before_each:   ->doc { use_the doc },       # Runs before each document is copied
  after_each:    ->doc { foo_bar doc },       # Runs after each document is copied
  after_copy:    ->    { finish_thing }       # Runs after everything is copied over

Callbacks (guards)

You can also use the :if or :unless callbacks to prevent the copy/reindexing from occuring if conditions are (un)met. The source client and destination client are passed in:

ESReindex.copy! 'http://my_server/index', 'http://my_server/index_copy',
  if:     ->(sclient,dclient) { Time.now.hour > 20 },                 # Only copy the indexes if it's after 8pm
  unless: ->(sclient,dclient) { Time.now.strftime("%A") == "Friday" } # Never copy on Fridays

For a more practical example, see the reindex integration specs.

Changelog

The full changelog is available here.

Credits

Original script:

  • @geronime
  • @pgaertig

Developed by Mojo Lingo.

License

es-reindex the gem is copyright (c)2014 Mojo Lingo, and released under the terms of the MIT license. See the LICENSE file for the gory details.

es-reindex is copyright (c)2012 Jiri Nemecek, and released under the terms of the MIT license. See the LICENSE file for the gory details.