mysql_db_tool 0.3.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 246f356370dec4811df1950c8972b0110618d4551bc3776c746efd597413f5b4
-  data.tar.gz: 58e81526ba38e1f9201396d808d5aeb6499bb7f91d479a5e4df8f4110d07652f
+  metadata.gz: 7b51856f5b5dc1e95daf56bfb215edef9a3a4ced392cad7fdcb99f83f5956e09
+  data.tar.gz: 60eae7d024f7d9fa6457b929f47c3ce5e890a6de6bb9ca7e300033250a7c1145
 SHA512:
-  metadata.gz: 014563a869d15aef0140f1d04580896cb12616efeb5e95435e1c84dc401e2ae538657c853ff63d8376464f2091f14a859ac031e2715799d98875a12e3b067e0b
-  data.tar.gz: 689bc7c215256672151f4b8041303d74570449cdfababbf48025155da23940e242a8697bd877987fb7a7008cc6a7a106cf6bc108ec74c7d452ad4f353759bd43
+  metadata.gz: 88b5e23657d090a1c3327da8a9e1ad189192e37451df741ab4da451daf881c5cdeaa2635431b0ef4046cb1c6093a80619065ba9b04ca14735d21a06b14226502
+  data.tar.gz: 95a1efb08ead4a9e772fa4a32058395b5b51772101f7f544e84f23d7fc93c4e7cb4b66c8a52da7706f56f3f62eb0ca5375962edf440d5fb2caf9522f966aca8a

data/README.md

@@ -39,6 +39,8 @@ Create a config-<env>.json file under the current directory according to the dat
 gem install mysql_db_tool
 ```
 
+[Example script](docs/examples.md)
+
 ## Data backup
 
 ```shell
@@ -53,7 +55,7 @@ you can get help by running `mysql_backup -h`
 * gzip? - default (true), whether to compress with gzip or not
 
 * DUMP_OPTIONS - you can set common mysqldump command options by this Environment variable,
-  if not set, it will use default options for mysqldump. (--single-transaction --skip-lock-tables)
+  if not set, it will use default options for mysqldump. (--single-transaction --skip-lock-tables --no-tablespaces)
 
 After execution, a directory named "backup-{backup id}" will be created under the current directory.
 

data/lib/mysql_db_tool/backup.rb

@@ -8,11 +8,11 @@ module MySQLDBTool
 
     def initialize(options = {})
       @options = options
-      tableConfig = MySQLDBTool::Config::ConfigLoader.load(options[:env])
-      @data_tables = tableConfig[:data_tables]
-      @ignore_tables = tableConfig[:ignore_tables]
-      @db_info = tableConfig[:db_info]
-      
+      config = MySQLDBTool::Config::ConfigLoader.load(options[:env])
+      @data_tables = config[:data_tables]
+      @ignore_tables = config[:ignore_tables]
+      @db_info = config[:db_info]
+
       @db_info[:database] = @options[:database] if @options[:database]
     end
 
@@ -21,51 +21,51 @@ module MySQLDBTool
       verify_tools_exist
 
       id=@options[:id] || "0"
-      isGzip=@options[:gzip]
-      limitDays=@options[:limit_days] || 3
-      gzipSuffix = @options[:gzip_suffix] || '.gz'
+      use_gzip=@options[:gzip]
+      limit_days=@options[:limit_days] || 3
+      gzip_suffix = @options[:gzip_suffix] || '.gz'
 
       Array(@db_info[:database]).flat_map.each_with_index do |database, index |
 
-        defaultOptions="--column-statistics=0 #{mysqlDefaultOptions(@db_info, database)}"
-        backupDir=backupDirName(id, "#{index}_#{database}")
+        default_options="--column-statistics=0 #{mysql_default_options(@db_info, database)}"
+        backup_dir=backup_dir_name(id, "#{index}_#{database}")
 
         commands = []
-        if File.exist? backupDir
-          puts "[skip - directory exists] #{backupDir}"
+        if File.exist? backup_dir
+          puts "[skip - directory exists] #{backup_dir}"
           return commands
         end
-        commands.push "mkdir -p #{backupDir}"
+        commands.push "mkdir -p #{backup_dir}"
 
-        backupFile="#{backupDir}/#{DateTime.now.strftime("%Y-%m-%d")}_#{id}"
-        whereDate=(Date.today - limitDays).strftime("%Y-%m-%d 00:00:00")
-        options=ENV['DUMP_OPTIONS'] || "--single-transaction --skip-lock-tables"
+        backup_file="#{backup_dir}/#{DateTime.now.strftime("%Y-%m-%d")}_#{id}"
+        where_date=(Date.today - limit_days).strftime("%Y-%m-%d 00:00:00")
+        options=ENV['DUMP_OPTIONS'] || "--single-transaction --skip-lock-tables --no-tablespaces"
 
-        puts "backupFile=#{backupFile}"
+        puts "backupFile=#{backup_file}"
 
-        ignoreTablesOption = @ignore_tables.map { |e| "--ignore-table=#{e.include?('.') ? e : "#{database}.#{e}"}" }.join(' ')
+        ignore_tables_option = @ignore_tables.map { |e| "--ignore-table=#{e.include?('.') ? e : "#{database}.#{e}"}" }.join(' ')
 
-        commands.push gzipCommand("mysqldump --no-data #{ignoreTablesOption} #{defaultOptions}", isGzip, "#{backupFile}-schema.sql", gzipSuffix)
+        commands.push gzip_command("mysqldump --no-data #{ignore_tables_option} #{options} #{default_options}", use_gzip, "#{backup_file}-schema.sql", gzip_suffix)
 
-        backupTables = []
+        backup_tables = []
 
         @data_tables.each {|table|
-          where = table[:where].empty? ? "" : "--where=\"#{table[:where]} >= '#{whereDate}'\""
+          where = table[:where].empty? ? "" : "--where=\"#{table[:where]} >= '#{where_date}'\""
           if where.empty?
-            backupTables.push(table[:name])
+            backup_tables.push(table[:name])
             next
           else
-            commands.push(gzipCommand("mysqldump --no-create-info #{options} #{where} #{defaultOptions} #{table[:name]}", isGzip, "#{backupFile}-#{table[:name]}.sql", gzipSuffix))
+            commands.push(gzip_command("mysqldump --no-create-info #{options} #{where} #{default_options} #{table[:name]}", use_gzip, "#{backup_file}-#{table[:name]}.sql", gzip_suffix))
           end
         }
 
-        commands.push(gzipCommand("mysqldump --no-create-info #{ignoreTablesOption} #{options} #{defaultOptions} #{backupTables.join(' ')}", isGzip, "#{backupFile}-all-other-tables.sql", gzipSuffix))
+        commands.push(gzip_command("mysqldump --no-create-info #{ignore_tables_option} #{options} #{default_options} #{backup_tables.join(' ')}", use_gzip, "#{backup_file}-all-other-tables.sql", gzip_suffix))
         commands
       end
     end
 
-    def gzipCommand(command, isGzip, file, gzipSuffix = '.gz')
-      "#{command} #{isGzip ? '| gzip ' : ''} > #{file}#{isGzip ? gzipSuffix : ''}"
+    def gzip_command(command, use_gzip, file, gzip_suffix = '.gz')
+      "#{command} #{use_gzip ? '| gzip ' : ''} > #{file}#{use_gzip ? gzip_suffix : ''}"
     end
 
   end

data/lib/mysql_db_tool/db_backup_base.rb

@@ -1,7 +1,5 @@
-
-
-def run(isRun, command)
-  if not isRun
+def run(is_run, command)
+  if not is_run
     puts "[dryRun] #{command}"
   else
     puts "Running: [#{command}]"
@@ -9,12 +7,17 @@ def run(isRun, command)
   end
 end
 
-def backupDirName(id, dbName = "")
-  "backup-#{id}#{dbName.empty? ? '' : "/#{dbName}"}"
+def backup_dir_name(id, db_name = "")
+  "backup-#{id}#{db_name.empty? ? '' : "/#{db_name}"}"
 end
 
-def mysqlDefaultOptions(db_info, database)
-  " --ssl-mode=disabled -h #{db_info[:host]} -u #{db_info[:user]} #{db_info[:password].to_s.empty? ? '' : " -p'#{db_info[:password]}'"} #{db_info[:port].to_s.empty? ? '' : " -P'#{db_info[:port]}'"} #{database} "
+def mysql_default_options(db_info, database)
+  dump_options = ENV['DUMP_OPTIONS'] || ''
+  ssl_mode_disabled = '--ssl-mode=disabled'
+  # Remove default --ssl-mode=disabled if any --ssl-mode is present in DUMP_OPTIONS
+  ssl_mode = dump_options.include?('--ssl-mode')
+  ssl_mode_disabled = '' if ssl_mode
+  " #{ssl_mode_disabled} -h #{db_info[:host]} -u #{db_info[:user]} #{db_info[:password].to_s.empty? ? '' : " -p'#{db_info[:password]}'"} #{db_info[:port].to_s.empty? ? '' : " -P'#{db_info[:port]}'"} #{database} "
 end
 
 def verify_tools_exist
@@ -22,7 +25,7 @@ def verify_tools_exist
   missing_tools = []
 
   tools.each do |tool|
-    if not system("which #{tool} > /dev/null 2>&1")
+    unless system("which #{tool} > /dev/null 2>&1")
       missing_tools << tool
       puts "'#{tool}' is not available"
     end

data/lib/mysql_db_tool/restore.rb

@@ -6,10 +6,10 @@ module MySQLDBTool
 
     def initialize(options = {})
       @options = options
-      tableConfig = MySQLDBTool::Config::ConfigLoader.load(options[:env])
-      @data_tables = tableConfig[:data_tables]
-      @ignore_tables = tableConfig[:ignore_tables]
-      @db_info = tableConfig[:db_info]
+      config = MySQLDBTool::Config::ConfigLoader.load(options[:env])
+      @data_tables = config[:data_tables]
+      @ignore_tables = config[:ignore_tables]
+      @db_info = config[:db_info]
 
       @db_info[:database] = @options[:database] if @options[:database]
     end
@@ -25,47 +25,44 @@ module MySQLDBTool
       end
 
       id=@options[:id] || "0"
-      isRun=@options[:run]
-      isDropAllTables=@options[:drop_all_tables]
+      is_drop_all_tables=@options[:drop_all_tables]
 
-      puts "ARGV=#{ARGV}, env=#{env}, id=#{id}, run=#{isRun} isDropAllTables=#{isDropAllTables}"
+      backup_dir=backup_dir_name(id)
 
-      backupDir=backupDirName(id)
-
-      puts "backupDir=#{backupDir}"
+      puts "backupDir=#{backup_dir}"
       databases = Array(@db_info[:database])
 
-      databaseMap = {}
-      sameDb = true
+      database_map = {}
+      same_db = true
 
-      Dir.entries(backupDir).reject {|f| File.directory? f}.sort.each do |f|
+      Dir.entries(backup_dir).reject {|f| File.directory? f}.sort.each do |f|
 
         index, origin_database = split_integer_and_string(f)
         database = get_element_or_last(databases, index)
-        sameDb = sameDb && (database == origin_database)
-        databaseMap["`#{origin_database}`\\."] = "`#{database}`."
+        same_db = same_db && (database == origin_database)
+        database_map["`#{origin_database}`\\."] = "`#{database}`."
       end
 
-      gsubstring = sameDb ? "" : databaseMap.map { |k,v| ".gsub(/#{k}/, \"#{v}\")" }.join("")
+      replace_db_names_command = same_db ? "" : database_map.map { |k,v| ".gsub(/#{k}/, \"#{v}\")" }.join("")
 
-      Dir.entries(backupDir).reject {|f| File.directory? f}.sort.flat_map do |f|
+      Dir.entries(backup_dir).reject {|f| File.directory? f}.sort.flat_map do |f|
 
         commands = []
 
         index, origin_database = split_integer_and_string(f)
         database = get_element_or_last(databases, index)
 
-        defaultOptions=mysqlDefaultOptions(@db_info, database)
-        backupDir=backupDirName(id, f)
+        default_options=mysql_default_options(@db_info, database)
+        backup_dir=backup_dir_name(id, f)
 
-        commands.push("cat #{MySQLDBTool.find_resource('sql/drop_all_tables.sql')} | mysql #{defaultOptions}") if isDropAllTables
-        commands.push("cat #{MySQLDBTool.find_resource('sql/drop_all_views.sql')} | mysql #{defaultOptions}") if isDropAllTables
+        commands.push("cat #{MySQLDBTool.find_resource('sql/drop_all_tables.sql')} | mysql #{default_options}") if is_drop_all_tables
+        commands.push("cat #{MySQLDBTool.find_resource('sql/drop_all_views.sql')} | mysql #{default_options}") if is_drop_all_tables
 
-        Dir.entries(backupDir).reject {|f| File.directory? f} .select {|f| f.include?("-schema.sql")} .each {|f|
-          restore_each(commands, backupDir+"/"+f, defaultOptions, gsubstring)
+        Dir.entries(backup_dir).reject {|f| File.directory? f}.select {|f| f.include?("-schema.sql")}.each {|f|
+          restore_each(commands, backup_dir+"/"+f, default_options, replace_db_names_command)
         }
-        Dir.entries(backupDir).reject {|f| File.directory? f} .reject {|f| f.include?("-schema.sql")} .each {|f|
-          restore_each(commands, backupDir+"/"+f, defaultOptions, gsubstring)
+        Dir.entries(backup_dir).reject {|f| File.directory? f}.reject {|f| f.include?("-schema.sql")}.each {|f|
+          restore_each(commands, backup_dir+"/"+f, default_options, replace_db_names_command)
         }
         commands
       end
@@ -73,18 +70,18 @@ module MySQLDBTool
 
     private
 
-    def restore_each(commands, file, defaultOptions, gsubstring)
+    def restore_each(commands, file, default_options, replace_db_names_command)
       command = ""
-      replacing = " | ruby -pe '$_=$_#{gsubstring}'" unless gsubstring.empty?
+      replacing = " | ruby -pe '$_=$_#{replace_db_names_command}'" unless replace_db_names_command.empty?
       if file.end_with? ".sql"
-        command = "cat #{file} #{replacing} | mysql #{defaultOptions}"
+        command = "cat #{file} #{replacing} | mysql #{default_options}"
       elsif gzip_file?(file)
-        command = "zcat #{file} #{replacing} | mysql #{defaultOptions}"
+        command = "zcat #{file} #{replacing} | mysql #{default_options}"
       else
         puts "not supported file #{file}"
       end
 
-      commands.push(command) if not command.empty?
+      commands.push(command) unless command.empty?
     end
 
     def split_integer_and_string(input)

data/lib/mysql_db_tool/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mysql_db_tool
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Soonoh Jung
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-17 00:00:00.000000000 Z
+date: 2025-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -95,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.17
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: MySQL DB Tool