mysql_db_tool 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7ba1c8784d5842dc7f1212c89ccaf8cd3fbd31793be8c3dd1c168bf75366ff7
-  data.tar.gz: e2eb44bd513921e7957f293076386ce63f614ee02bafbd242ee8f71bb8599145
+  metadata.gz: 2f58a8a6254b856cac959a89c42c2b261f8f2888bb8eb7042b64155c25d67461
+  data.tar.gz: 9e955ad5bb771f353290099daf3b813793bc557c2f72615e39b5a97c8919703e
 SHA512:
-  metadata.gz: fbe7207993d444b6cbf7c408f2860702bd0c63af6f09776865905598ab1c54aa7b4217e64921c5a742f6a1f7db1a19d4381d33aa8488eae2a31aa3fae0e03552
-  data.tar.gz: f90055728240fa5754b159b81e2798964956d299376c56eac7d31edad5e280483b739e6d3c73e47da5b11193c10f927625c503fe3bbff2437faded8d363a4f2b
+  metadata.gz: 89ae0acb67eecfc7fc4a7a598ed484edd63adece7f4777f92bf23f36843e522d8f3a69aa942cfe499708324d4ff23b7399982ffb4187b61e9f0185689a064d4c
+  data.tar.gz: 461425b16cf7f41ba6a92d10541adc3cedb42e948bf3e12a5dc247c107930011e2dd5b4d04a74f67e82a83587d7e7ffe1c3ee89b1f2f4cd5fb1dbe2ecfcf3825

data/README.md

@@ -33,12 +33,20 @@ Create a config-<env>.json file under the current directory according to the dat
     * { "name": "table_name", "where": "column_name" }
 * ignoreTables - allows you to set which tables should be excluded from backups as unused tables.
 
+## Install
+
+```shell
+gem install mysql_db_tool
+```
+
 ## Data backup
 
 ```shell
-./bin/backup {env} {backup id} {run?} {gzip?}
+mysql_backup -e {env} -i {backup id} -r {run?} --gzip
 ```
 
+you can get help by running `mysql_backup -h`
+
 * env - default (local), key to find the configuration file. e.g.) config-local.json
 * backup id - default (0), ID to use when restoring as a string
 * run? - Default (false), you can check in advance which command will be executed, if true, it will be executed
@@ -52,9 +60,11 @@ After execution, a directory named "backup-{backup id}" will be created under th
 ## restore backup data
 
 ```shell
-./bin/restore <env> {backup id} {run?} {drop all tables?}
+mysql_restore -e {env} -i {backup id} -r {run?} --drop-all-tables
 ```
 
+you can get help by running `mysql_restore -h`
+
 * drop all tables? - Default (false), to keep existing tables, or true, which may cause integration check error if not set to true
 
 ## Generate creating db and user sql
@@ -62,7 +72,7 @@ After execution, a directory named "backup-{backup id}" will be created under th
 You can generate a sql script to create a db and user.
 
 ```shell
-./bin/gen_create_db_user {user} {password} {db} {host}
+gen_create_db_user {user} {password} {db} {host}
 ```
 
 ## Installing Ruby
@@ -80,4 +90,3 @@ ruby -v
 ## TODO
 
 * [ ] Add option to get db configuration information from spring cloud config
-* [ ] Change linux standard command line argument input format to --backup-id=1 when inputting arguments

data/bin/mysql_backup

@@ -2,23 +2,43 @@
 
 require "bundler/setup"
 require "mysql_db_tool"
+require "optparse"
+
+# Define the options
+options = {
+  env: "local",
+  id: "0",
+  run: false,
+  gzip: true
+}
 
 # Parse command line arguments
-options = {}
-options[:env] = ARGV[0] || "local"
-options[:id] = ARGV[1] || "0"
-options[:run] = ARGV[2] == "true"
-options[:gzip] = ARGV.count > 3 ? ARGV[3] == "true" : true
+OptionParser.new do |opts|
+  opts.banner = "Usage: mysql_backup [options]\n\n#{MySQLDBTool::ENV_VAR_DESCRIPTION}\n"
+
+  MySQLDBTool.env_opt(options, opts)
+  MySQLDBTool.id_opt(options, opts)
+  MySQLDBTool.run_opt(options, opts)
+
+  opts.on("-g", "--[no-]gzip", "Enable or disable gzip (default: enabled)") do |gzip|
+    options[:gzip] = gzip
+  end
+
+  opts.on("-h", "--help", "Show this help message") do
+    puts opts
+    exit
+  end
+end.parse!
 
 # Print the options for verification
 puts "options=#{options}"
 
 # Perform the backup
-# begin
+begin
   MySQLDBTool.backup(options)
-# rescue => e
-#   puts "Error during backup: #{e.message}"
-#   exit 1
-# end
+rescue => e
+  puts "Error during backup: #{e.message}"
+  exit 1
+end
 
-puts "Backup completed successfully."
+puts "Backup completed successfully."

data/bin/mysql_restore

@@ -2,26 +2,43 @@
 
 require "bundler/setup"
 require "mysql_db_tool"
+require "optparse"
+
+# Define the options with default values
+options = {
+  env: "local",
+  id: "0",
+  run: false,
+  drop_all_tables: false
+}
 
 # Parse command line arguments
-options = {}
-options[:env] = ARGV[0] || "local"
-options[:id] = ARGV[1] || "0"
-options[:run] = ARGV[2] == "true"
-options[:drop_all_tables] = ARGV.count > 3 ? ARGV[3] == "true" : true
+OptionParser.new do |opts|
+  opts.banner = "Usage: mysql_restore [options]"
+
+  MySQLDBTool.env_opt(options, opts)
+  MySQLDBTool.id_opt(options, opts)
+  MySQLDBTool.run_opt(options, opts)
+
+  opts.on("-d", "--[no-]drop-all-tables", "Drop all tables before restoring (default: disabled)") do |drop_all_tables|
+    options[:drop_all_tables] = drop_all_tables
+  end
+
+  opts.on("-h", "--help", "Show this help message") do
+    puts opts
+    exit
+  end
+end.parse!
 
 # Print the options for verification
-puts "Env: #{options[:env]}"
-puts "Backup ID: #{options[:id]}"
-puts "Run: #{options[:run]}"
-puts "DropAllTables: #{options[:drop_all_tables]}"
+puts "options=#{options}"
 
-# Perform the backup
-# begin
+# Perform the restore
+begin
   MySQLDBTool.restore(options)
-# rescue => e
-#   puts "Error during backup: #{e.message}"
-#   exit 1
-# end
+rescue => e
+  puts "Error during restore: #{e.message}"
+  exit 1
+end
 
-puts "Restore completed successfully."
+puts "Restore completed successfully."

data/lib/mysql_db_tool/backup.rb

@@ -42,7 +42,7 @@ module MySQLDBTool
 
         ignoreTablesOption = @ignore_tables.map { |e| "--ignore-table=#{@db_info[:database]}.#{e}"  }.join(' ')
 
-        commands.push gzipCommand("mysqldump --no-data #{ignoreTablesOption} #{defaultOptions}", isGzip, "#{backupFile}-schema.sql")
+        commands.push gzipCommand("mysqldump --no-data #{ignoreTablesOption} #{defaultOptions}", isGzip, "#{backupFile}-schema.sql#{isGzip ? '.gz' : ''}")
 
         backupTables = []
 
@@ -52,11 +52,11 @@ module MySQLDBTool
             backupTables.push(table[:name])
             next
           else
-            commands.push(gzipCommand("mysqldump --no-create-info #{options} #{where} #{defaultOptions} #{table[:name]}", isGzip, "#{backupFile}-#{table[:name]}.sql"))
+            commands.push(gzipCommand("mysqldump --no-create-info #{options} #{where} #{defaultOptions} #{table[:name]}", isGzip, "#{backupFile}-#{table[:name]}.sql#{isGzip ? '.gz' : ''}"))
           end
         }
 
-        commands.push(gzipCommand("mysqldump --no-create-info #{options} #{defaultOptions} #{backupTables.join(' ')}", isGzip, "#{backupFile}-all-other-tables.sql"))
+        commands.push(gzipCommand("mysqldump --no-create-info #{options} #{defaultOptions} #{backupTables.join(' ')}", isGzip, "#{backupFile}-all-other-tables.sql#{isGzip ? '.gz' : ''}"))
         commands
       end
     end

data/lib/mysql_db_tool/version.rb

@@ -1,5 +1,5 @@
 # lib/mysql_db_tool/version.rb
 
 module MySQLDBTool
-  VERSION = "0.1.0"
+  VERSION = "0.2.1"
 end

data/lib/mysql_db_tool.rb

@@ -7,17 +7,40 @@ require_relative 'mysql_db_tool/db_backup_base'
 module MySQLDBTool
   class Error < StandardError; end
 
+  # Environment variable description
+  ENV_VAR_DESCRIPTION = <<~DESC
+    Environment Variables:
+      DUMP_OPTIONS - Additional options to pass to the MySQL dump command during the backup process.
+                     This can include any options supported by mysqldump, such as --skip-lock-tables.
+  DESC
+
+  def self.env_opt(options, opts)
+    opts.on("-e", "--env ENVIRONMENT", "Environment (default: local) - key to find the configuration file. e.g.) config-local.json") do |env|
+      options[:env] = env
+    end
+  end
+
+  def self.id_opt(options, opts)
+    opts.on("-i", "--backup-id BACKUP_ID", "BACKUP_ID (default: 0)") do |id|
+      options[:id] = id
+    end
+  end
+
+  def self.run_opt(options, opts)
+    opts.on("-r", "--run", "Run the backup (default: false) or Just show the commands") do
+      options[:run] = true
+    end
+  end
+
   # You might want to add methods to easily access your main functionalities
   def self.backup(options = {})
-    isRun = options[:run]
     commands = Backup.new(options).perform
-    commands.each { |command| run(isRun, command) }
+    commands.each { |command| run(options[:run], command) }
   end
 
   def self.restore(options = {})
-    isRun = options[:run]
     commands = Restore.new(options).perform
-    commands.each { |command| run(isRun, command) }
+    commands.each { |command| run(options[:run], command) }
   end
 
   def self.find_resource(relative_path)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mysql_db_tool
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Soonoh Jung
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-13 00:00:00.000000000 Z
+date: 2024-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -88,7 +88,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="