dumpr 1.3 → 1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 333617934d6bd6652bd3a67d8f5afdea20ab75d7
-  data.tar.gz: e738de1c4d150aba044599ac8842a33629df99c8
+SHA256:
+  metadata.gz: fc389dfe47cee75a1693efcc96b2320f859107abf58456a9cb13730bcd9ff252
+  data.tar.gz: e50b33f103457183f669acac00197fbc6f1751572384d85c6659afda25b45835
 SHA512:
-  metadata.gz: bb48d7a57b4424ebea2cedbf0b0d16995253e5c7d89df6bc555284a39befc58db0cc6ccdae4a9e8b2b7d77183e6a7ded49890448009aca281ef29ef28206d98e
-  data.tar.gz: fd08f9a6c8c81fc9d381cee212c3c73d0c04522ed77368ba057f6739d6c85704fce434819918dd1c959daaa8a847a07777d35ae6e0c5fbffcd4accbfa38044cd
+  metadata.gz: eeba1bbc43df3747fff76e87f692ea805705acc36b92c96c0d92e41f6cbad8930b32d733aa31b55ceb78298a7ce3adba7d61011aed0b908f9a5177217bcafe85
+  data.tar.gz: a49a759ab2fe9361d2cc32a2c1efe6eec8bf6f639aaf36c7a462eccd6c53fcc000c956b07f511deaaf8a2970852bb45fccfa194501fe9904ace9c3b8de63b1d3

data/History.md

@@ -0,0 +1,27 @@
+# HISTORY
+
+This is the changelog version history for the [dumpr](https://rubygems.org/gems/dumpr) gem.
+
+## dumpr 1.4
+
+* Changed `--password` to no longer be required.
+* Improved `--help` documentation.
+
+## dumpr 1.3
+
+* Added support for postgresql with `-t postgres`
+
+## dumpr 1.2
+
+* Changed repo name from dumper to dumpr for uniqueness sake.
+* Added command `dumpr-import`.
+* Deprecated `dumpr -i` option, replaced by `dumpr-import`.
+
+## dumpr 1.1
+
+* Improved usage
+
+
+## dumpr 1.0
+
+* Initial release.

data/README.md

@@ -5,9 +5,15 @@ Features:
 * generates gzipped sql dump files for a specific database or specific tables.
 * automates transfer of dump files to remote hosts
 * automates import
+* support for MySQL and Postgres.
 
 Executables installed:
 * dumpr
+* dumpr-import
+
+The current version is [dumpr 1.4](https://rubygems.org/gems/dumpr).
+
+Recent changes are documented in [History](https://github.com/jamesdickson6/dumpr/blob/master/History.md).
 
 ### Dependencies
 * [Ruby ≥ 2.2.1](http://www.ruby-lang.org/en/downloads/)
@@ -48,23 +54,26 @@ You can write your own scripts that use a *Dumpr::Driver*
 
 ### Exporting
 
-Generate yourdb.sql.gz and transfer it to server2
+Generate yourdb.sql.gz and transfer it to another server.
+
 ```ruby
- Dumpr::Driver::Mysql.export( 
-    :user => 'backupuser', :pass => 'dbpass',
-    :db => 'yourdb', 
-    :destination => 'server2:/data/dumps/yourdb.sql'
+ Dumpr::Driver::Mysql.dump( 
+    :user => 'backupuser', 
+    :password => '12345',
+    :db => 'test_database', 
+    :destination => 'server2:/data/dumps/test_database.sql'
  )
 ```
 
 ### Importing
 
-Then, over on dbserver2, import your dump file
+Then, over on **dbserver2**, import your dump file.
 ```ruby
  Dumpr::Driver::Mysql.import( 
-    :user => 'importuser', :pass => 'pass',
-    :db => 'yourdb', 
-    :file => '/data/dumps/yourdb.sql'
+    :user => 'importuser', 
+    :password => '12345',
+    :db => 'test_database', 
+    :file => '/data/dumps/test_database.sql'
 )
 ```
 
@@ -72,23 +81,9 @@ Then, over on dbserver2, import your dump file
 
 See *Dumpr::Driver*
   
-  
-## CHANGELOG
-
-### Version 1.3
-* Split binary, new command `dumpr-import` to replace `dumpr --import`
-* Postgres support (beta)
-
-### Version 1.2
-* Changed gem and binary command from `dumper` to `dumpr`
-
-### Version 1.1
-* Tweaks
-
-### 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, maybe?

data/dumpr.gemspec

@@ -7,10 +7,10 @@ Gem::Specification.new do |s|
   s.version     = Dumpr::Version.to_s
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["James Dickson"]
-  s.email       = ["jdickson@bcap.com"]
+  s.email       = ["james.dickson@hpe.com"]
   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.description = "Dumpr provides an easy way to dump and import databases. Support for MySQL and Postgres databases."
   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

@@ -18,15 +18,27 @@ module Dumpr
       op = OptionParser.new do |opts|
 
         opts.banner = <<-ENDSTR
-Usage: #{PROG_NAME} [options]
+#{PROG_NAME} #{Dumpr::Version}
 
-Example:
+usage: #{PROG_NAME} [options] [file]
 
-  #{PROG_NAME} --user root --password yourpass --db yourdb --file yourdb.sql --destination server2:/data/backups
+       #{PROG_NAME} --user test --db test_example test_example_dump.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.
+Create a database dump file, exporting database(s) to a file.
+The default database type is MySQL. Supports MySQL and Postgres.
 
-Options:
+arguments:
+
+    [file] File is the filename of the database dump being created.
+           It may be relative, 'mydumpfile.sql' to write to your working directory.
+           It may be absolute, 'server:/path/to/dumpfile.sql'.
+           If server: is specified, ssh/scp is used to transfer data to the remote server.
+           You will want to setup .ssh/config to avoid being prompted for passwords.
+           The .gz file extension is assumed.
+           By default it will first look for a compressed version at [file].gz.
+           The --no-gzip option can be used to skip compression.
+
+options:
 
 ENDSTR
 
@@ -34,20 +46,20 @@ ENDSTR
           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|
+        opts.on("--db DATABASE", "--database DATABASE", "Dump a single database") 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|
+        opts.on("--databases x,y,z", Array, "Dump multiple databases") do |val|
           options[:databases] = val
         end
 
-        opts.on("--tables z,y,z", Array, "dump certain tables, to be used on conjuction with a single --database") do |val|
+        opts.on("--all-databases", "Dump ALL databases") do |val|
+          options[:all_databases] = val
+        end
+
+        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
 
@@ -67,23 +79,25 @@ ENDSTR
           options[:port] = val
         end
 
-        opts.on("--file FILENAME", "Filename of dump to create/import") do |val|
+        opts.on("-f FILENAME", "--file FILENAME", "Filename of dump to create, may passed in place of the [file] argument.") do |val|
           options[:dumpfile] = val
         end
 
-        opts.on("--dumpfile FILENAME", "Alias for --file") do |val|
-          options[:dumpfile] = val
-        end
+        # could get rid of all these and just rely on full filepath being passed.
 
-        opts.on("--destination DESTINATION", "Destination for dumpfile. This can be a remote host:path.") do |val|
-          options[:destination] = val
-        end
+        # opts.on("--dumpfile FILENAME", "Alias for --file") do |val|
+        #   options[:dumpfile] = val
+        # end
 
-        opts.on("--dumpdir DIRECTORY", "Default directory for dumpfiles. Default is working directory") do |val|
-          options[:dumpdir] = val
-        end
+        # opts.on("--destination DESTINATION", "Destination for dumpfile. This can be a remote host:path.") do |val|
+        #   options[:destination] = val
+        # end
 
-        opts.on("--dump-options=[DUMPOPTIONS]", "Extra options to be included in dump command") do |val|
+        # opts.on("--dumpdir DIRECTORY", "Default directory for dumpfiles. Default is working directory") do |val|
+        #   options[:dumpdir] = val
+        # end
+
+        opts.on("--dump-options=[OPTIONS]", "Extra options to be included in dump command") do |val|
           options[:dump_options] = val
         end
 
@@ -105,6 +119,7 @@ ENDSTR
 
         opts.on("-h", "--help", "Show this message") do
          puts opts
+         print "\n"
          exit
         end
 
@@ -117,9 +132,22 @@ ENDSTR
 
       begin
         op.parse!(args)
-      rescue OptionParser::MissingArgument => e
-        puts "invalid arguments.  try #{PROG_NAME} --help"
-        exit 1
+        if args.count == 0 && options[:dumpfile].nil?
+          raise OptionParser::InvalidOption.new("[file] or --file is required.")
+        elsif args.count == 1
+          options[:dumpfile] = args[0]
+        else
+          raise OptionParser::NeedlessArgument.new("wrong number of arguments, expected 0-1 and got (#{args.count}) #{args.join(', ')}")
+        end
+      rescue => e
+        case (e)
+        when OptionParser::InvalidOption, OptionParser::AmbiguousOption, OptionParser::MissingArgument, OptionParser::InvalidArgument, OptionParser::NeedlessArgument
+          STDERR.puts "#{e.message}"
+          STDERR.puts  "Try -h for help with this command."
+          exit 1
+        else
+          raise e
+        end
       end
 
 
@@ -133,7 +161,7 @@ ENDSTR
         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"
+        puts "#{e.message}\nIt looks like this dump exists already. You should move it, or use --force to overwrite it"
         exit 1
       rescue Dumpr::BusyDumping => e
         puts "#{e.message}\n See --help"
@@ -159,15 +187,31 @@ ENDSTR
       op = OptionParser.new do |opts|
 
         opts.banner = <<-ENDSTR
-Usage: #{PROG_NAME} [options]
+#{PROG_NAME} #{Dumpr::Version}
+
+usage: 
+    #{PROG_NAME} [options] [file]
 
-Example:
+    #{PROG_NAME} --user test --db test_example ./test_example_dump.sql
 
-  #{PROG_NAME} -i --user root --password yourpass --db yourdb --file /data/backups/yourdb.sql
+Import a database dump file, restoring data to the specified hosts and database(s).
+The default database type is MySQL. Supports MySQL and Postgres.
+WARNING: This command will overwrite your database information.
+         Be sure you specify the correct host and database name(s)
+         and the [file] that contains the data you want in it.
 
-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.
+arguments:
 
-Options:
+    [file] File is the path of the database dump file being imported.
+           File may be relative, 'mydumpfile.sql.gz' to read from your working directory.
+           File may be absolute, 'server:/path/to/dumpfile.sql'.
+           If server: is specified, ssh/scp is used to transfer data from the remote server.
+           You will want to setup ssh configuration to avoid password prompts.
+           The .gz file extension is assumed.
+           By default it will first look for a compressed version at [file].gz.
+           The --no-gzip option can be used to skip compression.
+
+options:
 
 ENDSTR
 
@@ -175,23 +219,24 @@ ENDSTR
           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|
+        opts.on("--db DATABASE", "--database DATABASE", "Import to a single database") 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|
+        # TODO: add support to Driver for --databases and --tables
+        #      import probably does not need this right now
+        opts.on("--databases x,y,z", Array, "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
+        opts.on("--all-databases", "Import ALL databases") do |val|
+          options[:all_databases] = val
         end
 
+        # opts.on("--tables x,y,z", Array, "Import only 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
@@ -208,23 +253,25 @@ ENDSTR
           options[:port] = val
         end
 
-        opts.on("--file FILENAME", "Filename of dump to create/import") do |val|
+        opts.on("-f FILENAME", "--file FILENAME", "Filename of dump to create, may passed in place of the [file] argument.") do |val|
           options[:dumpfile] = val
         end
 
-        opts.on("--dumpfile FILENAME", "Alias for --file") do |val|
-          options[:dumpfile] = val
-        end
+        # could get rid of all these and just rely on full filepath being passed.
 
-        opts.on("--destination DESTINATION", "Destination for dumpfile. This can be a remote host:path.") do |val|
-          options[:destination] = val
-        end
+        # opts.on("--dumpfile FILENAME", "Alias for --file") do |val|
+        #   options[:dumpfile] = val
+        # end
 
-        opts.on("--dumpdir DIRECTORY", "Default directory for dumpfiles. Default is working directory") do |val|
-          options[:dumpdir] = val
-        end
+        # opts.on("--destination DESTINATION", "Destination for dump files. This can be a remote host:path.") do |val|
+        #   options[:destination] = val
+        # end
+
+        # opts.on("--dumpdir DIRECTORY", "Default directory for dump files. 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|
+        opts.on("--import-options=[OPTIONS]", "Extra options to be included in import command") do |val|
           options[:import_options] = val.to_s
         end
 
@@ -232,20 +279,21 @@ ENDSTR
           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("--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|
+        opts.on("--force", "Overwrite dump file if it exists already.") do |val|
           options[:force] = val
         end
 
         opts.on("-h", "--help", "Show this message") do
          puts opts
+         print "\n"
          exit
         end
 
@@ -258,9 +306,22 @@ ENDSTR
 
       begin
         op.parse!(args)
-      rescue OptionParser::MissingArgument => e
-        puts "invalid arguments.  try #{PROG_NAME} --help"
-        exit 1
+        if args.count == 0 && options[:dumpfile].nil?
+          raise OptionParser::InvalidOption.new("[file] or --file is required.")
+        elsif args.count == 1
+          options[:dumpfile] = args[0]
+        else
+          raise OptionParser::NeedlessArgument.new("wrong number of arguments, expected 0-1 and got (#{args.count}) #{args.join(', ')}")
+        end
+      rescue => e
+        case (e)
+        when OptionParser::InvalidOption, OptionParser::AmbiguousOption, OptionParser::MissingArgument, OptionParser::InvalidArgument, OptionParser::NeedlessArgument
+          STDERR.puts "#{e.message}"
+          STDERR.puts  "Try -h for help with this command."
+          exit 1
+        else
+          raise e
+        end
       end
 
 
@@ -274,7 +335,7 @@ ENDSTR
         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"
+        puts "#{e.message}\nIt looks like this dump exists already. You should move it, or use --force to overwrite it"
         exit 1
       rescue Dumpr::BusyDumping => e
         puts "#{e.message}\n See --help"

data/lib/dumpr/driver/mysql.rb

@@ -43,7 +43,16 @@ module Dumpr
       end
 
       def import_cmd
-        "mysql -u #{user} --password=#{password} -h #{host} -P #{port} #{database} < #{dumpfile}"
+        #"mysql -u #{user} --password=#{password} -h #{host} -P #{port} #{database} < #{dumpfile}"
+        cmd = ["mysql"]
+        cmd << "-u '#{user}'" unless user.to_s.empty?
+        cmd << "--password '#{password}'" unless password.to_s.empty?
+        cmd << "-h '#{host}'" unless host.to_s.empty?
+        cmd << "-P '#{port}'" unless port.to_s.empty?
+        cmd << "#{database}" unless database.empty?
+        cmd << "#{import_options}" unless import_options.to_s.empty?
+        cmd << " < #{dumpfile}"
+        cmd.join(" ")
       end
 
     end

data/lib/dumpr/driver.rb

@@ -66,7 +66,8 @@ module Dumpr
         @gzip = opts[:gzip].nil? ? true : opts[:gzip]
         @gzip_options = opts[:gzip_options] || "-9"
         @dumpdir = opts[:dumpdir] || Dir.pwd #"./"
-        @dumpfile = (opts[:file] || opts[:dumpfile] || opts[:filename]) or raise BadConfig.new "dumpfile is required"
+        @dumpfile = (opts[:file] || opts[:dumpfile] || opts[:filename]) or raise BadConfig.new "[file] is required"
+        @dumpfile = @dumpfile.to_s.dup # this is frozen?
         @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
@@ -130,12 +131,12 @@ module Dumpr
         Util.with_lockfile("localhost", dumpfn, @opts[:force]) do
 
           logger.debug "preparing dump..."
-          if !File.exists?(File.dirname(dumpfn))
+          if !File.exist?(File.dirname(dumpfn))
             run "mkdir -p #{File.dirname(dumpfn)}"
           end
 
           # avoid overwriting dump files..
-          if File.exists?(dumpfn)
+          if File.exist?(dumpfn)
             if @opts[:force]
               logger.warn "#{dumpfn} exists, moving it to #{dumpfn}.1"
               #run "rm -f #{dumpfn}.1;"
@@ -182,8 +183,8 @@ module Dumpr
       end
 
       def decompress
-        if File.exists?(@dumpfile + ".gz")
-          if File.exists?(@dumpfile) && !@opts[:force]
+        if File.exist?(@dumpfile + ".gz")
+          if File.exist?(@dumpfile) && !@opts[:force]
             logger.warn "skipping decompress because #{@dumpfile} already exists."
           else
             logger.debug "decompressing..."
@@ -201,7 +202,7 @@ module Dumpr
         Util.with_lockfile("localhost", @dumpfile, @opts[:force]) do
           decompress if @gzip
 
-          if !File.exists?(@dumpfile)
+          if !File.exist?(@dumpfile)
             raise "Cannot import #{@dumpfile} because it does not exist!"
           else
             dumpsize = Util.human_file_size("localhost", @dumpfile)

data/lib/dumpr/util.rb

@@ -5,7 +5,7 @@ module Dumpr
 
     def self.file_exists?(h, fn)
       if h == "localhost"
-        File.exists?(fn)
+        File.exist?(fn)
       else
         `ssh #{h} test -f '#{fn}' &> /dev/null`
         $?.success?
@@ -14,7 +14,7 @@ module Dumpr
 
     def self.dir_exists?(h, fn)
       if h == "localhost"
-        File.exists?(fn)
+        File.exist?(fn)
       else
         `ssh #{h} test -d '#{fn}' &> /dev/null`
         $?.success?

data/lib/dumpr/version.rb

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

metadata

@@ -1,19 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: dumpr
 version: !ruby/object:Gem::Version
-  version: '1.3'
+  version: '1.5'
 platform: ruby
 authors:
 - James Dickson
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-10 00:00:00.000000000 Z
+date: 2025-07-31 00:00:00.000000000 Z
 dependencies: []
-description: Dumpr provides an easy way to dump and import databases. Supported databases
-  include MySQL and Postgres.
+description: Dumpr provides an easy way to dump and import databases. Support for
+  MySQL and Postgres databases.
 email:
-- jdickson@bcap.com
+- james.dickson@hpe.com
 executables:
 - csv2sqlinsert
 - dumpr
@@ -24,6 +24,7 @@ extra_rdoc_files:
 files:
 - ".gitignore"
 - Gemfile
+- History.md
 - LICENSE
 - README.md
 - Rakefile
@@ -43,7 +44,7 @@ homepage: http://github.com/jamesdickson6/dumpr
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -58,9 +59,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.6
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: Dump and import databases.
 test_files: []