redis-dump 0.1.2 → 0.1.3

data/CHANGES.txt

@@ -1,5 +1,10 @@
 REDIS-DUMP, CHANGES
 
+#### 0.1.3 (2010-11-16) ###############################
+
+* ADDED: Support for dumping a specific subset of keys
+* CHANGE: Now dependent on uri-redis 0.4+
+
 #### 0.1.2 (2010-11-15) ###############################
 
 * ADDED: redis-report

data/Rakefile

@@ -11,7 +11,7 @@ end
  
 config = YAML.load_file("VERSION.yml")
 task :default => ["build"]
-CLEAN.include [ 'pkg', 'doc' ]
+CLEAN.include [ 'pkg', 'doc', '*gemspec' ]
 name = "redis-dump"
 
 begin
@@ -27,6 +27,7 @@ begin
     gem.authors = ["Delano Mandelbaum"]
     gem.add_dependency("yajl-ruby",    ">= 0.1")
     gem.add_dependency("redis",        ">= 2.0")
+    gem.add_dependency("uri-redis",    ">= 0.4.0")
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError

data/VERSION.yml

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

data/lib/redis/dump.rb

@@ -3,6 +3,7 @@ unless defined?(RD_HOME)
 end
 
 require 'redis'
+require 'uri/redis'
 require 'yajl'
 
 class Redis
@@ -43,20 +44,39 @@ class Redis
       self.class.ld 'CONNECT: ' << this_uri
       Redis.connect :url => this_uri
     end
-    def each_key &blk
-      @redis_connections.keys.sort.each do |redis_uri|
-        self.class.ld ['---', "DB: #{redis_connections[redis_uri].client.db}", '---'].join($/)
-        keys = redis_connections[redis_uri].keys
+    
+    # Calls blk for each key. If keys is nil, this will iterate over
+    # every key in every open redis connection.
+    # * keys (Array, optional). If keys is provided it must contain URI::Redis objects.
+    def each_key(keys=nil, &blk)
+      if keys.nil?
+        @redis_connections.keys.sort.each do |redis_uri|
+          self.class.ld ['---', "DB: #{redis_connections[redis_uri].client.db}", '---'].join($/)
+          keys = redis_connections[redis_uri].keys
+          keys.each do |key|
+            blk.call redis_connections[redis_uri], key
+          end
+        end
+      else
         keys.each do |key|
-          blk.call redis_connections[redis_uri], key
+          unless URI::Redis === key
+            raise Redis::Dump::Problem, "#{key} must be a URI::Redis object"
+          end
+          redis_uri = key.serverid
+          if redis_connections[redis_uri].nil?
+            raise Redis::Dump::Problem, "Not connected to #{redis_uri}"
+          end
+          blk.call redis_connections[redis_uri], key.key
         end
       end
     end
-    def dump(&each_record)
+    
+    # See each_key
+    def dump(keys=nil, &each_record)
       values = []
-      each_key do |this_redis,key|
+      each_key(keys) do |this_redis,key|
         info = Redis::Dump.dump this_redis, key
-        #self.class.ld " #{key} (#{info[:type]}): #{info[:size].to_bytes}"
+        self.class.ld " #{key} (#{info['type']}): #{info['size'].to_bytes}"
         encoded = self.class.encoder.encode info
         each_record.nil? ? (values << encoded) : each_record.call(encoded)
       end
@@ -66,7 +86,7 @@ class Redis
       values = []
       each_key do |this_redis,key|
         info = Redis::Dump.report this_redis, key
-        #self.class.ld " #{key} (#{info[:type]}): #{info[:size].to_bytes}"
+        self.class.ld " #{key} (#{info['type']}): #{info['size'].to_bytes}"
         each_record.nil? ? (values << info) : each_record.call(info)
       end
       values

data/try/10_redis_dump_try.rb

@@ -1,5 +1,8 @@
 require 'redis/dump'
 
+# The test instance of redis must be running:
+# $ redis-server try/redis-server.conf
+
 @uri_base = "redis://127.0.0.1:6371"
 
 Redis::Dump.debug = false

data/try/20_dump_specific_keys_try.rb

@@ -0,0 +1,43 @@
+require 'redis/dump'
+
+# The test instance of redis must be running:
+# $ redis-server try/redis-server.conf
+
+@uri_base = "redis://127.0.0.1:6371"
+
+Redis::Dump.debug = false
+Redis::Dump.safe = true
+
+## Connect to DB
+@rdump = Redis::Dump.new 0..1, @uri_base
+@rdump.redis_connections.size
+#=> 2
+
+## Populate
+3.times { |idx| @rdump.redis(0).set "gloria:#{idx}", "gloria_value[#{idx}]" }  # yp.ca
+4.times { |idx| @rdump.redis(0).set "pamela:#{idx}", "pamela_value[#{idx}]" }  # soap web service
+2.times { |idx| @rdump.redis(1).set "nikola:#{idx}", "nikola_value[#{idx}]" }  # m.yp.ca log analyzer
+[@rdump.redis(0).keys.size, @rdump.redis(1).keys.size]
+#=> [7, 2]
+
+## Generate a list of keys
+@keys = @rdump.redis(0).keys('*gloria*').collect { |key| URI.parse "#{@uri_base}/0/#{key}" }
+@keys.push *@rdump.redis(1).keys('*nikola*').collect { |key| URI.parse "#{@uri_base}/1/#{key}" }
+@keys.size
+#=> 5
+
+## Dump these specific keys
+@rdump.dump(@keys).sort
+#=> ['{"db":0,"key":"gloria:0","ttl":-1,"type":"string","value":"gloria_value[0]","size":15}','{"db":0,"key":"gloria:1","ttl":-1,"type":"string","value":"gloria_value[1]","size":15}','{"db":0,"key":"gloria:2","ttl":-1,"type":"string","value":"gloria_value[2]","size":15}','{"db":1,"key":"nikola:0","ttl":-1,"type":"string","value":"nikola_value[0]","size":15}', '{"db":1,"key":"nikola:1","ttl":-1,"type":"string","value":"nikola_value[1]","size":15}']
+
+
+## Dump none existent keys
+unknown_keys = [URI.parse("#{@uri_base}/0/unknownkey1"), URI.parse("#{@uri_base}/1/unknownkey2")]
+@rdump.dump(unknown_keys).sort
+#=> ['{"db":0,"key":"unknownkey1","ttl":-1,"type":"none","value":"","size":0}', '{"db":1,"key":"unknownkey2","ttl":-1,"type":"none","value":"","size":0}']
+
+
+Redis::Dump.safe = true
+db0 = Redis::Dump.new 0..1, @uri_base
+db0.redis(0).flushdb
+db0.redis(1).flushdb

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: redis-dump
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 29
   prerelease: false
   segments: 
   - 0
   - 1
-  - 2
-  version: 0.1.2
+  - 3
+  version: 0.1.3
 platform: ruby
 authors: 
 - Delano Mandelbaum
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-15 00:00:00 -05:00
+date: 2010-11-16 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -48,6 +48,22 @@ dependencies:
         version: "2.0"
   type: :runtime
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: uri-redis
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 0
+        - 4
+        - 0
+        version: 0.4.0
+  type: :runtime
+  version_requirements: *id003
 description: Backup and restore your Redis data to and from JSON.
 email: delano@solutious.com
 executables: 
@@ -70,6 +86,7 @@ files:
 - bin/redis-report
 - lib/redis/dump.rb
 - try/10_redis_dump_try.rb
+- try/20_dump_specific_keys_try.rb
 - try/db0.json
 - try/redis-server.conf
 has_rdoc: true