dumpr 1.2 → 1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 1c4e092e069d3b3a1a9ddb44c6e4fae4b405c49510fce4e89ef1577bed0a6016
-  data.tar.gz: ea58fb39085ea624683a026f3fce5ddabe4cdbf2f1a3c8c5d69621067cc3bb01
+SHA1:
+  metadata.gz: 333617934d6bd6652bd3a67d8f5afdea20ab75d7
+  data.tar.gz: e738de1c4d150aba044599ac8842a33629df99c8
 SHA512:
-  metadata.gz: 53283e55f775af19059ee12c578e05012a5c141409e9484b562884bd80eb1b8ddfb34677753a3e6d37194367c12e3e904c9f712b2d57b5e93a602701a3a9cba5
-  data.tar.gz: 31d4147d81e4cede85aa7d70fef0707a00491415262487cfc9d9df5403ba56eb1cec02d92340ed458cbcfa4fc47c0627aa32dd9a68a2a13519ea9193c9fcbf92
+  metadata.gz: bb48d7a57b4424ebea2cedbf0b0d16995253e5c7d89df6bc555284a39befc58db0cc6ccdae4a9e8b2b7d77183e6a7ded49890448009aca281ef29ef28206d98e
+  data.tar.gz: fd08f9a6c8c81fc9d381cee212c3c73d0c04522ed77368ba057f6739d6c85704fce434819918dd1c959daaa8a847a07777d35ae6e0c5fbffcd4accbfa38044cd

data/README.md

@@ -10,7 +10,7 @@ Executables installed:
 * dumpr
 
 ### Dependencies
-* [Ruby ≥ 1.8.7](http://www.ruby-lang.org/en/downloads/)
+* [Ruby ≥ 2.2.1](http://www.ruby-lang.org/en/downloads/)
 
 **SSH access is assumed to be automated with .ssh/config entries**
 
@@ -39,7 +39,7 @@ Generate yourdb.sql.gz and transfer it to server2
 
 Then, over on dbserver2, import your dump file
 ```sh
-  dumpr -i --user user --password pw --file /data/dumps/yourdb.sql
+  dumpr-import --user user --password pw --file /data/dumps/yourdb.sql
 ```
 
 ## Ruby API
@@ -75,12 +75,21 @@ See *Dumpr::Driver*
   
 ## CHANGELOG
 
-* Version 1.0
+### Version 1.3
+* Split binary, new command `dumpr-import` to replace `dumpr --import`
+* Postgres support (beta)
 
-## TODO
+### Version 1.2
+* Changed gem and binary command from `dumper` to `dumpr`
+
+### Version 1.1
+* Tweaks
 
-* Dumpr::Driver::Postgres
-* automate importing after an export (socket communication exporter/importer, or just some dumb lockfile checking / polling)
+### Version 1.0
+* Initial release
+
+## TODO
+* automate importing after an export (socket communication exporter/importer, or just lockfile checking / polling)
 * security: stop logging passwords
-* daemonize 
+* daemonize, maybe?
 * SSH parameters

data/bin/dumpr

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
 require 'rubygems'
 require 'dumpr/cli'
-Dumpr::CLI.execute(ARGV)
+Dumpr::CLI.dump(ARGV)

data/bin/dumpr-import

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'dumpr/cli'
+Dumpr::CLI.import(ARGV)

data/dumpr.gemspec

@@ -8,9 +8,9 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["James Dickson"]
   s.email       = ["jdickson@bcap.com"]
-  s.homepage    = "http://github.com/sixjameses/dumpr"
-  s.summary     = "Dump and load databases."
-  s.description = "Dumpr provides an easy way to dump and import databases."
+  s.homepage    = "http://github.com/jamesdickson6/dumpr"
+  s.summary     = "Dump and import databases."
+  s.description = "Dumpr provides an easy way to dump and import databases. Supported databases include MySQL and Postgres."
   s.files       = `git ls-files -z`.split("\x0")
   s.executables = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
   s.test_files  = s.files.grep(%r{^(test|spec|features)/})

data/lib/dumpr/cli.rb

@@ -7,7 +7,7 @@ module Dumpr
     PROG_NAME = File.basename($0)
 
 
-    def self.execute(args)
+    def self.dump(args)
       # default options
       options = {}
       options[:dumpdir] = Dir.pwd
@@ -20,28 +20,20 @@ module Dumpr
         opts.banner = <<-ENDSTR
 Usage: #{PROG_NAME} [options]
 
-Exporting:
+Example:
 
   #{PROG_NAME} --user root --password yourpass --db yourdb --file yourdb.sql --destination server2:/data/backups
 
-Importing:
-
-  #{PROG_NAME} -i --user root --password yourpass --db yourdb --file /data/backups/yourdb.sql
-
-Don't forget to set up your .ssh/config so you won't be prompted for ssh passwords for file transfers
+If using remote server destinations, don't forget to set up your .ssh/config so you won't be prompted for ssh passwords for file transfers.
 
 Options:
 
 ENDSTR
 
-        opts.on("-t", "--type [TYPE]", "Database type.  (mysql is the default) ") do |val|
+        opts.on("-t", "--type TYPE", "Database type: mysql or postgres. Default is mysql.") do |val|
           options[:driver] = val
         end
 
-        opts.on("-i", "--import", "Import dump file.  Default behavior is to dump and export to --destination") do |val|
-          options[:import] = val
-        end
-
         opts.on("--all-databases", "dump/import ALL databases") do |val|
           options[:all_databases] = val
         end
@@ -51,11 +43,11 @@ ENDSTR
         end
 
         # TODO: Add support to Driver for this
-        opts.on("--databases [x,y,z]", Array, "dump/import multiple databases") do |val|
+        opts.on("--databases x,y,z", Array, "dump/import multiple databases") do |val|
           options[:databases] = val
         end
 
-        opts.on("--tables [t1,t2,t3]", Array, "dump certain tables, to be used on conjuction with a single --database") do |val|
+        opts.on("--tables z,y,z", Array, "dump certain tables, to be used on conjuction with a single --database") do |val|
           options[:tables] = val
         end
 
@@ -87,7 +79,7 @@ ENDSTR
           options[:destination] = val
         end
 
-        opts.on("--dumpdir", "Default directory for dumpfiles. Default is working directory") do |val|
+        opts.on("--dumpdir DIRECTORY", "Default directory for dumpfiles. Default is working directory") do |val|
           options[:dumpdir] = val
         end
 
@@ -103,7 +95,7 @@ ENDSTR
           options[:gzip_options] = val
         end
 
-        opts.on("--log-file [LOGFILE]", "Log file.  Default is stdout.") do |val|
+        opts.on("--log-file LOGFILE", "Log file.  Default is stdout.") do |val|
           options[:log_file] = val
         end
 
@@ -133,11 +125,148 @@ ENDSTR
 
       # do it
       begin
-        if options[:import]
-          Dumpr.import(options[:driver], options)
-        else
-          Dumpr.export(options[:driver], options)
+        Dumpr.export(options[:driver], options)
+      rescue Dumpr::MissingDriver => e
+        puts "#{e.message}."
+        exit 1
+      rescue Dumpr::BadConfig => e
+        puts "bad arguments: #{e.message}.\n See --help"
+        exit 1
+      rescue Dumpr::DumpFileExists => e
+        puts "#{e.message}\nIt looks like this dump exists already. You should move it, or use --force to trash it"
+        exit 1
+      rescue Dumpr::BusyDumping => e
+        puts "#{e.message}\n See --help"
+        exit 1
+      rescue Dumpr::CommandFailure => e
+        puts e.message
+        exit 1
+      end
+
+      exit 0
+
+    end
+
+
+    def self.import(args)
+      # default options
+      options = {}
+      options[:dumpdir] = Dir.pwd
+      options[:driver] = :mysql
+      options[:gzip] = true
+
+
+      op = OptionParser.new do |opts|
+
+        opts.banner = <<-ENDSTR
+Usage: #{PROG_NAME} [options]
+
+Example:
+
+  #{PROG_NAME} -i --user root --password yourpass --db yourdb --file /data/backups/yourdb.sql
+
+If using remote server destinations, don't forget to set up your .ssh/config so you won't be prompted for ssh passwords for file transfers.
+
+Options:
+
+ENDSTR
+
+        opts.on("-t", "--type TYPE", "Database type: mysql or postgres. Default is mysql.") do |val|
+          options[:driver] = val
+        end
+
+        opts.on("--all-databases", "dump/import ALL databases") do |val|
+          options[:all_databases] = val
+        end
+
+        opts.on("--db DATABASE", "--database DATABASE", "Database to dump/import") do |val|
+          options[:database] = val
+        end
+
+        # TODO: Add support to Driver for this
+        opts.on("--databases x,y,z", Array, "dump/import multiple databases") do |val|
+          options[:databases] = val
+        end
+
+        opts.on("--tables x,y,z", Array, "dump certain tables, to be used on conjuction with a single --database") do |val|
+          options[:tables] = val
+        end
+
+        opts.on("-u USER", "--user USER", "Database user") do |val|
+          options[:user] = val
         end
+
+        opts.on("-p PASS", "--password PASS", "--password=pass", "Database password") do |val|
+          options[:password] = val
+        end
+
+        opts.on("-h HOST", "--host HOST", "Database host") do |val|
+          options[:host] = val
+        end
+
+        opts.on("-P PORT", "--port PORT", "Database port") do |val|
+          options[:port] = val
+        end
+
+        opts.on("--file FILENAME", "Filename of dump to create/import") do |val|
+          options[:dumpfile] = val
+        end
+
+        opts.on("--dumpfile FILENAME", "Alias for --file") do |val|
+          options[:dumpfile] = val
+        end
+
+        opts.on("--destination DESTINATION", "Destination for dumpfile. This can be a remote host:path.") do |val|
+          options[:destination] = val
+        end
+
+        opts.on("--dumpdir DIRECTORY", "Default directory for dumpfiles. Default is working directory") do |val|
+          options[:dumpdir] = val
+        end
+
+        opts.on("--import-options=[DUMPOPTIONS]", "Extra options to be included in dump command") do |val|
+          options[:import_options] = val.to_s
+        end
+
+        opts.on("--no-gzip", "Don't use gzip") do |val|
+          options[:gzip] = false
+        end
+
+        opts.on("--gzip-options=[GZIPOPTIONS]", "gzip compression options.  Default is -9 (slowest /max compression)") do |val|
+          options[:gzip_options] = val
+        end
+
+        opts.on("--log-file LOGFILE", "Log file.  Default is stdout.") do |val|
+          options[:log_file] = val
+        end
+
+        opts.on("--force", "Overwrite dumpfile if it exists already.") do |val|
+          options[:force] = val
+        end
+
+        opts.on("-h", "--help", "Show this message") do
+         puts opts
+         exit
+        end
+
+        opts.on("-v", "--version", "Show version") do
+          puts Dumpr::Version
+          exit
+        end
+
+      end
+
+      begin
+        op.parse!(args)
+      rescue OptionParser::MissingArgument => e
+        puts "invalid arguments.  try #{PROG_NAME} --help"
+        exit 1
+      end
+
+
+      # do it
+      begin
+        Dumpr.import(options[:driver], options)
       rescue Dumpr::MissingDriver => e
         puts "#{e.message}."
         exit 1

data/lib/dumpr/driver.rb

@@ -43,8 +43,8 @@ module Dumpr
         # db connection settings
         @host = opts[:host] || "localhost"
         @port = opts[:port]
-        @user = opts[:user] or raise BadConfig.new ":user => <db user> is required"
-        @password = (opts[:password]  || opts[:pass]) or raise BadConfig.new ":pass => <db password> is required"
+        @user = opts[:user] or raise BadConfig.new "user is required"
+        @password = (opts[:password]  || opts[:pass]) # or raise BadConfig.new "password is required"
 
         # dump all_databases or specific database(s)
         @all_databases = nil
@@ -59,14 +59,14 @@ module Dumpr
         elsif opts[:all_databases]
           @all_databases = true
         else
-          raise BadConfig.new ":database => <db schema name> is required"
+          #raise BadConfig.new "database is required"
         end
 
         # dump settings
         @gzip = opts[:gzip].nil? ? true : opts[:gzip]
         @gzip_options = opts[:gzip_options] || "-9"
-        @dumpdir = opts[:dumpdir] || "./"
-        @dumpfile = (opts[:file] || opts[:dumpfile] || opts[:filename]) or raise BadConfig.new ":dumpfile => <file.sql> is required"
+        @dumpdir = opts[:dumpdir] || Dir.pwd #"./"
+        @dumpfile = (opts[:file] || opts[:dumpfile] || opts[:filename]) or raise BadConfig.new "dumpfile is required"
         @dumpfile = @dumpfile[0].chr == "/" ? @dumpfile : File.join(@dumpdir, @dumpfile)
         @dumpfile.chomp!(".gz")
         # (optional) :destination is where dumps are exported to, and can be a remote host:path

data/lib/dumpr/driver/mysql.rb

@@ -19,6 +19,19 @@ module Dumpr
         system("which mysql") == true
       end
 
+      def configure(opts)
+        super(opts)
+        if @all_databases
+          # supported
+        elsif @databases
+          # supported
+        elsif @database
+          # supported
+        else
+          raise BadConfig.new "#{self.class} requires option --database or --databases or --all-databases"
+        end
+      end
+
       def dump_cmd
         if @all_databases
           "mysqldump -u #{user} --password=#{password} -h #{host} -P #{port} --all-databases #{dump_options}"

data/lib/dumpr/driver/postgres.rb

@@ -0,0 +1,58 @@
+require 'dumpr/driver'
+module Dumpr
+  module Driver
+    class Postgres < Base
+
+      def port
+        @port || 5432
+      end
+
+      def dump_options
+        @dump_options || "-Fc" #"-Fc -v"
+      end
+
+      def dump_installed?
+        system("which pg_dump") == true
+      end
+
+      def import_installed?
+        system("which pg_restore") == true
+      end
+
+      def configure(opts)
+        super(opts)
+        if @all_databases
+          raise BadConfig.new "#{self.class} does not support --all-databases"
+        elsif @databases
+          raise BadConfig.new "#{self.class} does not support multiple --databases"
+        elsif @database
+          # supported
+        else
+          raise BadConfig.new "#{self.class} requires option --database"
+        end
+        if @tables
+          raise BadConfig.new "#{self.class} does not support --tables"
+        end
+      end
+
+      def dump_cmd
+        if @all_databases
+          "pg_dump -h #{host} -p #{port} -U #{user} --password #{password} #{dump_options}"
+        elsif @databases
+          # not supported
+        else
+          "pg_dump -h #{host} -p #{port} -U #{user} --password #{password} #{dump_options} #{database}"
+        end
+      end
+
+      def import_cmd
+        if @database
+          "pg_restore -h #{host} -p #{port} -U #{user} --password #{password} --verbose --clean --no-owner --no-acl -d #{database} #{dumpfile}"
+        else
+          "pg_restore -h #{host} -p #{port} -U #{user} --password #{password} --verbose --clean --no-owner --no-acl #{database} #{dumpfile}"
+        end
+      end
+
+    end
+  end
+end

data/lib/dumpr/version.rb

@@ -1,3 +1,3 @@
 module Dumpr
-  Version = "1.2".freeze
+  Version = "1.3".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dumpr
 version: !ruby/object:Gem::Version
-  version: '1.2'
+  version: '1.3'
 platform: ruby
 authors:
 - James Dickson
@@ -10,12 +10,14 @@ bindir: bin
 cert_chain: []
 date: 2020-04-10 00:00:00.000000000 Z
 dependencies: []
-description: Dumpr provides an easy way to dump and import databases.
+description: Dumpr provides an easy way to dump and import databases. Supported databases
+  include MySQL and Postgres.
 email:
 - jdickson@bcap.com
 executables:
 - csv2sqlinsert
 - dumpr
+- dumpr-import
 extensions: []
 extra_rdoc_files:
 - README.md
@@ -27,15 +29,17 @@ files:
 - Rakefile
 - bin/csv2sqlinsert
 - bin/dumpr
+- bin/dumpr-import
 - dumpr.gemspec
 - lib/dumpr.rb
 - lib/dumpr/chunkpipe.rb
 - lib/dumpr/cli.rb
 - lib/dumpr/driver.rb
 - lib/dumpr/driver/mysql.rb
+- lib/dumpr/driver/postgres.rb
 - lib/dumpr/util.rb
 - lib/dumpr/version.rb
-homepage: http://github.com/sixjameses/dumpr
+homepage: http://github.com/jamesdickson6/dumpr
 licenses:
 - MIT
 metadata: {}
@@ -55,8 +59,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
-summary: Dump and load databases.
+summary: Dump and import databases.
 test_files: []