redis-dump 0.1.0 → 0.1.1

data/CHANGES.txt

@@ -1,5 +1,11 @@
 REDIS-DUMP, CHANGES
 
+#### 0.1.1 (2010-11-15) ###############################
+
+* ADDED: redis-load and redis-dump executables
+* ADDED: Redis::Dump.host, Redis::Dump.port
+
+
 #### 0.1.0 (2010-11-15) ###############################
 
 Initial public release.

data/README.rdoc

@@ -2,14 +2,48 @@
 
 <i>Backup and restore your Redis data to and from JSON.</i>
 
-<b>NOTE: This is alpha software. DO NOT RELY ON IT!!</b>
+<b>NOTE: This is alpha software. DO NOT RELY ON IT FOR PRECIOUS THINGS!!</b>
+
+
+== Usage
+
+There are two executables: <tt>redis-dump</tt> and <tt>redis-load</tt>. 
+
+    $ redis-dump 
+    $ redis-dump -u 127.0.0.1:6371 > db_full.json
+    $ redis-dump -u 127.0.0.1:6371 -d 15 > db_db15.json
+    
+    $ < db_full.json redis-load 
+    $ < db_db15.json redis-load -d 15
+    
+== Output format
+
+All redis datatypes are output to a simple JSON object. All objects have the following 5 fields:
+
+* db (Integer)
+* key (String)
+* ttl (Integer): The amount of time in seconds that the key will live . If no expire is set, it's -1. 
+* type (String), one of: string, list, set, zset, hash, none. 
+* value (String): A JSON-encoded string. For keys of type list, set, zset, and hash, the data is given a specific structure (see below). 
+
+Here are examples of each datatype:
+
+    {"db":0,"key":"hashkey","ttl":-1,"type":"hash","value":{"field_a":"value_a","field_b":"value_b","field_c":"value_c"},"size":42}
+    {"db":0,"key":"listkey","ttl":-1,"type":"list","value":["value_0","value_1","value_2","value_0","value_1","value_2"],"size":42}
+    {"db":0,"key":"setkey","ttl":-1,"type":"set","value":["value_2","value_0","value_1","value_3"],"size":28}
+        {"db":0,"key":"zsetkey","ttl":-1,"type":"zset","value":[["value_0","100"],["value_1","100"],["value_2","200"],["value_3","300"],["value_4","400"]],"size":50}
+    {"db":0,"key":"stringkey","ttl":79,"type":"string","value":"stringvalue","size":11}
+
+=== Important note about TTLs
+
+One of the purposes of redis-dump is the ability to restore the database to a known state. When you restore a redis database from a redis-dump file, <em>expires are reset to their values at the time the dump was created</em>. This is different from restoring from Redis' native .rdb or .aof files (expires are stored relative to the actual time they were set). 
 
 
 == Installation
 
 One of:
 
-    $ gem install redis0dump
+    $ gem install redis-dump
     
     
 == More Info

data/VERSION.yml

@@ -1,5 +1,5 @@
 --- 
 :MAJOR: 0
 :MINOR: 1
-:PATCH: 0
+:PATCH: 1
 :BUILD: '001'

data/bin/redis-dump

@@ -0,0 +1,76 @@
+#!/usr/bin/ruby
+
+# = Redis-Dump
+# 
+#
+# Usage:
+# 
+#     $ redis-dump -h
+#     $ redis-dump > dumpfile_full.json
+#     $ redis-dump -d 15 > dumpfile_db15.json
+#
+#--
+
+RD_HOME = File.expand_path File.join(File.dirname(__FILE__), '..')
+lib_dir = File.join(RD_HOME, 'lib')
+$:.unshift lib_dir  
+
+require 'redis/dump'
+require 'drydock'
+
+# Command-line interface for bin/redis-dump
+class Redis::Dump::CLI
+  extend Drydock
+  
+  default :dump
+  trawler :dump
+  
+  global :u, :uri, String, "Redis URI (e.g. redis://hostname[:port])"
+  global :d, :database, Integer, "Redis database (e.g. -d 15)"
+  global :V, :version, "Display version" do 
+    puts "Version: #{Redis::Dump::VERSION.to_s}"
+    exit 0
+  end
+  global :D, :debug do
+    Redis::Dump.debug = true
+  end
+  global :nosafe do
+    Redis::Dump.safe = false
+  end
+  
+  before do |obj|
+    obj.global.uri ||= 'redis://%s:%s' % [Redis::Dump.host, Redis::Dump.port]
+    obj.global.uri = 'redis://' << obj.global.uri unless obj.global.uri.match(/^redis:\/\//)
+    obj.global.database &&= obj.global.database.to_i
+    obj.global.database ||= (0..15)
+    Redis::Dump.ld " redis_uri: #{obj.global.uri} (#{obj.global.database})"
+  end
+  
+  usage "redis-dump > dumpfile_full.json"
+  usage "redis-dump -d 15 > dumpfile_db15.json"
+  command :dump do |obj|
+    rd = Redis::Dump.new obj.global.database, obj.global.uri
+    rd.dump do |record|
+      puts record
+    end
+  end
+  
+end
+
+  
+begin
+  Drydock.run!(ARGV, STDIN) if Drydock.run? && !Drydock.has_run?
+rescue Drydock::ArgError, Drydock::OptError => ex
+  STDERR.puts ex.message
+  STDERR.puts ex.usage
+rescue Drydock::InvalidArgument => ex
+  STDERR.puts ex.message
+rescue Drydock::UnknownCommand => ex
+  STDERR.puts "Unknown command: %s" % ex.name
+rescue Interrupt
+  puts $/, "Exiting... "
+  exit 1
+rescue => ex
+  STDERR.puts "ERROR (#{ex.class.to_s}): #{ex.message}"
+  STDERR.puts ex.backtrace if Redis::Dump.debug
+end

data/bin/redis-load

@@ -0,0 +1,74 @@
+#!/usr/bin/ruby
+
+# = Redis-Dump
+# 
+#
+# Usage:
+# 
+#     $ redis-load -h
+#     $ <dumpfile_full.json redis-load
+#     $ <dumpfile_db15.json redis-load -d 15
+#
+#--
+
+RD_HOME = File.expand_path File.join(File.dirname(__FILE__), '..')
+lib_dir = File.join(RD_HOME, 'lib')
+$:.unshift lib_dir  
+
+require 'redis/dump'
+require 'drydock'
+
+# Command-line interface for bin/redis-dump
+class Redis::Dump::CLI
+  extend Drydock
+  
+  default :load
+  trawler :load
+  
+  global :u, :uri, String, "Redis URI (e.g. redis://hostname[:port])"
+  global :d, :database, Integer, "Redis database (e.g. -d 15)"
+  global :V, :version, "Display version" do 
+    puts "Version: #{Redis::Dump::VERSION.to_s}"
+    exit 0
+  end
+  global :D, :debug do
+    Redis::Dump.debug = true
+  end
+  global :nosafe do
+    Redis::Dump.safe = false
+  end
+
+  before do |obj|
+    obj.global.uri ||= 'redis://%s:%s' % [Redis::Dump.host, Redis::Dump.port]
+    obj.global.uri = 'redis://' << obj.global.uri unless obj.global.uri.match(/^redis:\/\//)
+    obj.global.database &&= obj.global.database.to_i
+    obj.global.database ||= (0..15)
+    Redis::Dump.ld " redis_uri: #{obj.global.uri} (#{obj.global.database})"
+  end
+  
+  usage "<dumpfile_full.json redis-load"
+  usage "<dumpfile_db15.json redis-load -d 15"
+  command :load do |obj|
+    rd = Redis::Dump.new obj.global.database, obj.global.uri
+    rd.load STDIN
+  end
+  
+end
+
+  
+begin
+  Drydock.run!(ARGV, STDIN) if Drydock.run? && !Drydock.has_run?
+rescue Drydock::ArgError, Drydock::OptError => ex
+  STDERR.puts ex.message
+  STDERR.puts ex.usage
+rescue Drydock::InvalidArgument => ex
+  STDERR.puts ex.message
+rescue Drydock::UnknownCommand => ex
+  STDERR.puts "Unknown command: %s" % ex.name
+rescue Interrupt
+  puts $/, "Exiting... "
+  exit 1
+rescue => ex
+  STDERR.puts "ERROR (#{ex.class.to_s}): #{ex.message}"
+  STDERR.puts ex.backtrace if Redis::Dump.debug
+end

data/lib/redis/dump.rb

@@ -1,3 +1,7 @@
+unless defined?(RD_HOME)
+  RD_HOME = File.expand_path(File.join(File.dirname(__FILE__), '..', '..') )
+end
+
 require 'redis'
 require 'yajl'
 
@@ -6,19 +10,21 @@ class Redis
     unless defined?(Redis::Dump::VALID_TYPES)
       VALID_TYPES = ['string', 'set', 'list', 'zset', 'hash', 'none'].freeze
     end
+    @host = '127.0.0.1'
+    @port = 6379
     @debug = false
     @encoder = Yajl::Encoder.new
     @parser = Yajl::Parser.new
     @safe = true
     class << self
-      attr_accessor :debug, :encoder, :parser, :safe
+      attr_accessor :debug, :encoder, :parser, :safe, :host, :port
       def ld(msg)
         STDERR.puts "#{'%.4f' % Time.now.utc.to_f}: #{msg}" if @debug
       end
     end
     attr_accessor :dbs, :uri
     attr_reader :redis_connections
-    def initialize(dbs=nil,uri="redis://127.0.0.1:6379")
+    def initialize(dbs=nil,uri="redis://#{Redis::Dump.host}:#{Redis::Dump.port}")
       @redis_connections = {}
       @uri = uri
       unless dbs.nil?
@@ -157,6 +163,33 @@ class Redis
       def stringify_none  (this_redis, key, v=nil)  (v || '')                                            end
     end
     extend Redis::Dump::ClassMethods
+    
+    module VERSION
+      def self.stamp
+        @info[:STAMP].to_i
+      end
+      def self.owner
+        @info[:OWNER]
+      end
+      def self.to_s
+        [@info[:MAJOR], @info[:MINOR], @info[:PATCH], @info[:BUILD]].join('.')
+      end
+      def self.path
+        File.join(RD_HOME, 'VERSION.yml')
+      end
+      def self.load_config
+        require 'yaml'
+        @info ||= YAML.load_file(path)
+      end
+      load_config
+    end
+
+    class Problem < RuntimeError
+      def initialize(*args)
+        @args = args.flatten.compact
+      end
+      def message() @args && @args.first end
+    end
   end
 end
 

data/try/10_redis_dump_try.rb

@@ -1,4 +1,4 @@
-require 'lib/redis/dump'
+require 'redis/dump'
 
 @uri_base = "redis://127.0.0.1:6371"
 

data/try/db0.json

@@ -0,0 +1,5 @@
+{"db":0,"key":"hashkey","ttl":-1,"type":"hash","value":{"field_a":"value_a","field_b":"value_b","field_c":"value_c"},"size":42}
+{"db":0,"key":"listkey","ttl":-1,"type":"list","value":["value_0","value_1","value_2","value_0","value_1","value_2"],"size":42}
+{"db":0,"key":"setkey","ttl":-1,"type":"set","value":["value_2","value_0","value_1","value_3"],"size":28}
+{"db":0,"key":"zsetkey","ttl":-1,"type":"zset","value":[["value_0","100"],["value_1","100"],["value_2","200"],["value_3","300"],["value_4","400"]],"size":50}
+{"db":0,"key":"stringkey","ttl":79,"type":"string","value":"stringvalue","size":11}

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: redis-dump
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Delano Mandelbaum
@@ -50,8 +50,9 @@ dependencies:
   version_requirements: *id002
 description: Backup and restore your Redis data to and from JSON.
 email: delano@solutious.com
-executables: []
-
+executables: 
+- redis-dump
+- redis-load
 extensions: []
 
 extra_rdoc_files: 
@@ -63,8 +64,11 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION.yml
+- bin/redis-dump
+- bin/redis-load
 - lib/redis/dump.rb
 - try/10_redis_dump_try.rb
+- try/db0.json
 - try/redis-server.conf
 has_rdoc: true
 homepage: http://github.com/delano/redis-dump