redis-copy 0.0.1 → 0.0.2

data/README.md

@@ -1,24 +1,59 @@
 # Redis::Copy
 
-TODO: Write a gem description
+This utility provides a way to move the contents of one redis DB to another
+redis DB. It is inspired by the [redis-copy.rb script][original] included in
+the redis source, but supports the following additional features:
+
+ - all known data types (original supported `set`, `list`, and `string`,
+   dropping the others without warning)
+ - if available on both dbs, will use `DUMP`/`RESTORE` commands (redis v2.6+)
+ - support for more than just db0
+
+[original]: https://github.com/antirez/redis/commits/unstable/utils/redis-copy.rb
 
 ## Installation
 
-Add this line to your application's Gemfile:
+    $ gem install redis-copy
 
-    gem 'redis-copy'
+## Usage
 
-And then execute:
+The current options can be grabbed using the `--help` flag.
 
-    $ bundle
+```
+$ redis-copy --help
+redis-copy v0.0.2
+Usage: redis-copy [options] <source> <destination>
+    <source> and <destination> must be redis connection uris
+    like [redis://]<hostname>[:<port>][/<db>]
 
-Or install it yourself as:
+Specific options:
+        --strategy STRATEGY          Select strategy (auto, new, classic) (default auto)
+                                       auto:    uses new if available, otherwise fallback
+                                       new:     use redis DUMP and RESTORE commands (faster)
+                                       classic: migrates via multiple type-specific commands
+        --[no-]dry-run               Output configuration and exit
+    -d, --[no-]debug                 Write debug output
+    -t, --[no-]trace                 Enable backtrace on failure
+    -f, --[no-]fail-fast             Abort on first failure
+    -y, --yes                        Automatically accept any prompts
+        --[no-]allow-nonempty        Allow non-empty destination
 
-    $ gem install redis-copy
+```
 
-## Usage
+## Example:
 
-TODO: Write usage instructions here
+```
+$ redis-copy --fail-fast --yes old.redis.host/9 new.redis.host:6380/3
+Source:      redis://old.redis.host:6379/9
+Destination: redis://new.redis.host:6380/3 (empty)
+Key Emitter: Default
+Strategy:    New
+PROGRESS {:success=>1000, :attempt=>1000}
+PROGRESS {:success=>2000, :attempt=>2000}
+PROGRESS {:success=>3000, :attempt=>3000}
+PROGRESS {:success=>4000, :attempt=>4000}
+DONE: {:success=>4246, :attempt=>4246}
+```
 
 ## Contributing
 

data/lib/redis-copy.rb

@@ -15,7 +15,6 @@ module RedisCopy
     # @param destination [String]
     # @options options [Hash<Symbol,Object>]
     def copy(source, destination, options = {})
-      puts options.inspect
       ui = UI.load(options)
 
       source = redis_from(source)
@@ -35,7 +34,7 @@ module RedisCopy
         Strategy:    #{strategem}
       EODESC
 
-      ui.abort('Destination not empty!') unless dest_empty
+      ui.abort('Destination not empty!') unless dest_empty or options[:allow_nonempty]
 
       key_emitter.keys.each_with_object(Hash.new {0}) do |key, stats|
         success = strategem.copy(key)
@@ -46,7 +45,7 @@ module RedisCopy
           ui.notify("FAIL: #{key.dump}")
           ui.abort if options[:fail_fast]
         end
-        ui.notify(stats.inspect) if (stats[:attempt] % 1000).zero?
+        ui.notify("PROGRESS: #{stats.inspect}") if (stats[:attempt] % 1000).zero?
       end.tap do |stats|
         ui.notify("DONE: #{stats.inspect}")
       end

data/lib/redis-copy/cli.rb

@@ -7,11 +7,12 @@ module RedisCopy
   class CLI
     REDIS_URI = (/\A(?:redis:\/\/)?([a-z0-9\-.]+)(:[0-9]{1,5})?(\/(?:(?:1[0-5])|[0-9]))?\z/i).freeze
     DEFAULTS = {
-      ui:           :command_line,
-      key_emitter:  :default,
-      strategy:     :auto,
-      fail_fast:    false,
-      yes:          false,
+      ui:             :command_line,
+      key_emitter:    :default,
+      strategy:       :auto,
+      fail_fast:      false,
+      yes:            false,
+      allow_nonempty: false,
     }.freeze unless defined?(DEFAULTS)
 
     def initialize(argv = ARGV)
@@ -19,8 +20,9 @@ module RedisCopy
       options = {}
 
       OptionParser.new do |opts|
-        opts.banner = "Usage: #{opts.program_name} [options] <source> <destination>"
         opts.version = RedisCopy::VERSION
+        opts.banner = "#{opts.program_name} v#{opts.version}\n" +
+                      "Usage: #{opts.program_name} [options] <source> <destination>"
 
         indent_desc = proc do |desc|
           desc.split("\n").join("\n#{opts.summary_indent}#{' '*opts.summary_width} ")
@@ -62,6 +64,10 @@ module RedisCopy
           options[:yes] = true
         end
 
+        opts.on('--[no-]allow-nonempty', 'Allow non-empty destination') do |allow_nonempty|
+          options[:allow_nonempty] = allow_nonempty
+        end
+
         opts.parse!(argv)
         unless argv.size == 2
           opts.abort "Source and Destination must be specified\n\n" +

data/lib/redis-copy/key-emitter.rb

@@ -36,6 +36,25 @@ module RedisCopy
     class Default
       include KeyEmitter
 
+      def initialize(redis, ui, options = {})
+        ui.abort unless ui.confirm? <<-EOWARNING.strip_heredoc
+          WARNING: #{self} key emitter uses redis.keys('*') to
+          get its list of keys.
+
+          The redis keys command [reference](http://redis.io/commands/keys)
+          says this:
+
+          > Warning: consider KEYS as a command that should only be used
+          > in production environments with extreme care. It may ruin
+          > performance when it is executed against large databases.
+          > This command is intended for debugging and special operations,
+          > such as changing your keyspace layout. Don't use KEYS in your
+          > regular application code. If you're looking for a way to find
+          > keys in a subset of your keyspace, consider using sets.
+        EOWARNING
+        super
+      end
+
       def keys
         @ui.debug "REDIS: #{@redis.client.id} KEYS *"
         @redis.keys('*').to_enum

data/lib/redis-copy/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 module RedisCopy
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/redis-copy.gemspec

@@ -16,6 +16,10 @@ Gem::Specification.new do |spec|
   spec.authors       = authors_and_emails.map(&:first)
   spec.email         = authors_and_emails.map(&:last)
   spec.summary       = 'Copy the contents of one redis db to another'
+  spec.description   = 'A command-line utility built for copying the ' +
+                       'contents of one redis db to another over a ' +
+                       'network. Supports all data types, persists ttls, ' +
+                       'and attempts to be as efficient as possible.'
   spec.homepage      = 'https://github.com/yaauie/redis-copy'
   spec.license       = 'MIT'
 

data/spec/redis-copy/key-emitter_spec.rb

@@ -3,7 +3,7 @@ require 'redis-copy'
 
 describe RedisCopy::KeyEmitter::Default do
   let(:redis) { double }
-  let(:ui) { double }
+  let(:ui) { double.as_null_object }
   let(:instance) { RedisCopy::KeyEmitter::Default.new(redis, ui)}
   let(:connection_uri) { 'redis://12.34.56.78:9000/15' }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redis-copy
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -91,7 +91,9 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description: A command-line utility built for copying the contents of one redis db
+  to another over a network. Supports all data types, persists ttls, and attempts
+  to be as efficient as possible.
 email:
 - ryan@yaauie.com
 executables: