rbarman 0.0.2 → 0.0.3

data/README.md

@@ -21,7 +21,7 @@ Or install it yourself as:
 
 ## Usage
 
-Just a few examples..
+Just a few examples. Please read the [documentation](https://rubygems.org/gems/rbarman) for more details.
 
 ### Get all your backups!
 
@@ -104,7 +104,7 @@ p b.id
 
 ### Delete a backup
 
-This tells pgbarman to delete the specified backup
+This instructs barman to delete the specified backup
 
 <pre>
 backup = RBarman::Backup.by_id('server', '20130225T192654', { :with_wal_files => false })
@@ -115,10 +115,14 @@ p backup.deleted
 => true
 </pre>
 
-### Not yet implemented
+### Recover a backup
 
-* restore backups
+Recovers newest/latest backup to the specified path on the remote host
 
+<pre>
+RBarman::Backups.all('testdb').latest.recover('/var/lib/postgresql/9.2/main', 
+    { :remote_ssh_cmd => 'ssh postgres@10.20.20.2' })
+</pre>
 
 ## Contributing
 
@@ -133,5 +137,5 @@ p backup.deleted
 
 Written by [Holger Amann](http://github.com/hamann), sponsored by [Sauspiel GmbH](https://www.sauspiel.de)
 
-Release under the MIT License: http://www.opensource.org/licenses/mit-license.php
+Release under the [MIT License](http://www.opensource.org/licenses/mit-license.php)
 

data/lib/rbarman/backup.rb

@@ -192,6 +192,23 @@ module RBarman
       @deleted = true
     end
 
+    # Instructs the underlying (barman) command to recover this backup
+    # @param [String] path the path to which the backup should be restored
+    # @param [Hash] opts options passed as arguments to barman recover cmd
+    # @option opts [String] :remote_ssh_cmd the ssh command to be used for remote recovery
+    # @option opts [String, Time] :target_time the timestamp as recovery target
+    # @option opts [String] :target_xid the transaction ID as recovery target
+    # @option opts [Boolean] :exclusive whether to stop immediately before or after the recovery target
+    # @return [void]
+    # @note when :remote_ssh_cmd is passed in options, 'path' is the path on the remote host, otherwise local
+    # @since 0.0.3
+    # @example
+    #   backup.recover('/var/lib/postgresql/9.2/main', { :remote_ssh_cmd => 'ssh postgres@10.20.20.2' })
+    def recover(path, opts = {})
+      cmd = CliCommand.new
+      cmd.recover(@server, @id, path, opts)
+    end
+
     # Instructs the underlying (barman) command to create a new backup.
     # @param [String] server server name for which a backup should be created
     # @return [Backup] a new backup object with wal files

data/lib/rbarman/cli_command.rb

@@ -56,7 +56,6 @@ module RBarman
 
     # Instructs barman to get information about backups
     # @param [String] server server name
-    # @param [String] backup_id when given, only information about this backup id will be retrieved
     # @param [Hash] opts options for creating {Backups}
     # @option opts [Boolean] :with_wal_files whether to include {WalFiles} in each {Backup}
     # @option opts [String] :backup_id retrieve just one {Backup} specified by this backup id
@@ -65,7 +64,7 @@ module RBarman
       list = run_barman_command("list-backup #{server}")
       list = list.grep(/#{opts[:backup_id]}/) if !opts[:backup_id].nil?
 
-      backups = parse_backup_list(list)
+      backups = Backups.new(parse_backup_list(list))
       backups.each do |backup|
         parse_backup_info_file(backup)
         if opts[:with_wal_files]
@@ -303,6 +302,42 @@ module RBarman
       run_barman_command("backup #{server}")
     end
 
+    # Instructs barman to recover a backup
+    # @param [String] server the server which includes the backup
+    # @param [String] backup_id the id of the backup
+    # @param [String] path the path to which the backup should be restored
+    # @param [Hash] opts options passed as arguments to barman recover cmd
+    # @option opts [String] :remote_ssh_cmd the ssh command to be used for remote recovery
+    # @option opts [String, Time] :target_time the timestamp as recovery target
+    # @option opts [String] :target_xid the transaction ID as recovery target
+    # @option opts [Boolean] :exclusive whether to stop immediately before or after the recovery target
+    # @note when :remote_ssh_cmd is passed in options, 'path' is the path on the remote host, otherwise local
+    # @return [void]
+    # @since 0.0.3
+    # @example
+    #   clicommand.recover('test2', '20130218T080002', '/var/lib/postgresql/9.2/main', { :remote_ssh_cmd => 'ssh postgres@10.20.20.2' })
+    def recover(server, backup_id, path, opts={})
+      args = create_recovery_cmd_args(opts)
+      run_barman_command("recover #{args} #{server} #{backup_id} #{path}")
+    end
+
+    # Creates an argument string for barman recovery command based on opts Hash
+    # @param [Hash] opts options for creating the arguments
+    # @option opts [String] :remote_ssh_cmd the ssh command to be used for remote recovery
+    # @option opts [String, Time] :target_time the timestamp as recovery target
+    # @option opts [String] :target_xid the transaction ID as recovery target
+    # @option opts [Boolean] :exclusive whether to stop immediately before or immediately after the recovery target
+    # @return [String] the arguments
+    # @since 0.0.3
+    def create_recovery_cmd_args(opts={})
+      args = Array.new
+      args << "--remote-ssh-command='#{opts[:remote_ssh_cmd]}'" if opts[:remote_ssh_cmd]
+      args << "--target-time '#{opts[:target_time].to_s}'" if opts[:target_time]
+      args << "--target-xid #{opts[:target_xid]}" if opts[:target_xid]
+      args << "--exclusive" if opts[:exclusive]
+      return args.join(" ")
+    end
+
     private
     def run_barman_command(args)
       sh = Mixlib::ShellOut.new("#{@binary} #{args}")

data/lib/rbarman/version.rb

@@ -1,3 +1,3 @@
 module RBarman
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rbarman
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-12 00:00:00.000000000 Z
+date: 2013-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler