es_dump_restore 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8c543de6aac0bbd4e8380b4fdf8b9f995c2ff33c
-  data.tar.gz: eb25e1154138dba1bb53c71080190c9a3d57a7c2
+  metadata.gz: 26b95784a5cbe09598686a716498b43feb08e905
+  data.tar.gz: fc3451f6a37dda8116891bb9daa09291faaaf485
 SHA512:
-  metadata.gz: 5af4422476d43ff85ea997463162703f4c4d214cd617517ea4ca9950c9ef24c06367b7fa8eeeadc0acc683f0ee1ab352d250c969ae8eef3263a5b9ce9e94533c
-  data.tar.gz: 6707141cbeae98732da6dd62d786f6c2ba2c09879f29a5b9c027559f73dca4ac588d50b7c68af71060f541a4ae7e62683633f92ddfa61a29fcf625cd340f458d
+  metadata.gz: dd7c79f8d006bd3ab5ac8818ab5a86b8a9d81bd9e2819b17d7d42a45cd8347d96d15b6e2bcb3d5ff880db9431c87d25e9223d9e654b1dadee55029bfd7f18db4
+  data.tar.gz: db90aeae9f731d02009f9cd857708cd6eac25ac135db5558adcf47cdea4bb3e73d37b89a39b44a463f7fa3fc113519854470719c3f36606e1385615284595361

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# Version 1.1.0 - May 12, 2015
+
+* Allow specifying additional index settings to the `restore` and `restore_alias` commands (thanks again Richard Boulton!)
+
 # Version 1.0.0 - April 11, 2015
 
 * Add a `restore_alias` command, which performs a restore and switches an alias to point at the result (thanks Richard Boulton!)

data/README.md

@@ -23,7 +23,30 @@ To dump an ElasticSearch index by type to a file:
 
 To restore an index to an ElasticSearch server:
 
-    es_dump_restore restore ELASTIC_SEARCH_SERVER_URL DESTINATON_INDEX FILENAME_ZIP
+    es_dump_restore restore ELASTIC_SEARCH_SERVER_URL DESTINATION_INDEX FILENAME_ZIP [SETTING_OVERRIDES]
+
+To restore an index and set an alias to point to it:
+
+    es_dump_restore restore_alias ELASTIC_SEARCH_SERVER_URL DESTINATION_ALIAS DESTINATION_INDEX FILENAME_ZIP [SETTING_OVERRIDES]
+
+This loads the dump into an index named `DESTINATION_INDEX`, and once the load
+is complete sets the alias `DESTINATION_ALIAS` to point to it.  If
+`DESTINATION_ALIAS` already exists, it will be atomically changed to point to
+the new location.  This allows a dump file to be loaded on a running server
+without disrupting searches going on on that server (as long as those searches
+are accessing the index via the alias).
+
+If `SETTING_OVERRIDES` is set for a restore command, it must be a valid
+serialised JSON object.  This will be merged with the settings in the dump
+file, allowing selected settings to be altered, but keeping any unspecified
+settings as they were in the dump file.  For example:
+
+    es_dump_restore restore_alias http://localhost:9200 test test-1276512 test_dump.zip '{"settings":{"index":{"number_of_replicas":"0","number_of_shards":"1"}}'
+
+would read the dump file `test_dump.zip`, load it into an index called
+`test-1276512`, then set the alias `test` to point to this index.  The index
+would be set to have no replicas, and only 1 shard, but have all other settings
+from the dump file.
 
 ## Contributing
 

data/lib/es_dump_restore/app.rb

@@ -61,11 +61,11 @@ module EsDumpRestore
     end
 
     desc "restore URL INDEX_NAME FILENAME", "Restores a dumpfile into the given ElasticSearch index"
-    def restore(url, index_name, filename)
+    def restore(url, index_name, filename, overrides=nil)
       client = EsClient.new(url, index_name, nil)
 
       Dumpfile.read(filename) do |dumpfile|
-        client.create_index(dumpfile.index)
+        client.create_index(dumpfile.index, overrides)
 
         bar = ProgressBar.new(dumpfile.num_objects) unless options[:noprogressbar]
         dumpfile.scan_objects(1000) do |batch, size|
@@ -76,12 +76,12 @@ module EsDumpRestore
     end
 
     desc "restore_alias URL ALIAS_NAME INDEX_NAME FILENAME", "Restores a dumpfile into the given ElasticSearch index, and then sets the alias to point at that index, removing any existing indexes pointed at by the alias"
-    def restore_alias(url, alias_name, index_name, filename)
+    def restore_alias(url, alias_name, index_name, filename, overrides=nil)
       client = EsClient.new(url, index_name, nil)
       client.check_alias alias_name
 
       Dumpfile.read(filename) do |dumpfile|
-        client.create_index(dumpfile.index)
+        client.create_index(dumpfile.index, overrides)
 
         bar = ProgressBar.new(dumpfile.num_objects) unless options[:noprogressbar]
         dumpfile.scan_objects(1000) do |batch, size|

data/lib/es_dump_restore/es_client.rb

@@ -73,7 +73,11 @@ module EsDumpRestore
       end
     end
 
-    def create_index(metadata)
+    def create_index(metadata, overrides)
+      if overrides
+        overrides = MultiJson.load(overrides)
+        metadata = deep_merge(metadata, overrides)
+      end
       request(:post, "#{@path_prefix}", :body => MultiJson.dump(metadata))
     end
 
@@ -135,5 +139,16 @@ module EsDumpRestore
         raise e
       end
     end
+
+    def deep_merge(hash1, hash2)
+      merger = proc { |key, v1, v2|
+        if Hash === v1 && Hash === v2
+          v1.merge(v2, &merger)
+        else
+          v2
+        end
+      }
+      hash1.merge(hash2, &merger)
+    end
   end
 end

data/lib/es_dump_restore/version.rb

@@ -1,3 +1,3 @@
 module EsDumpRestore
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: es_dump_restore
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Nat Budin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-11 00:00:00.000000000 Z
+date: 2015-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -135,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Dump ElasticSearch indexes to files and restore them back