mysql_db_tool 0.2.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c70b37689d0fb784905734790283707a98f4956c635fd29a3f17ae19fc18a2c
-  data.tar.gz: 71982b0e54f79191e98d34436f9c78f410cbd59db904f00b00cb86c5eacf4fa2
+  metadata.gz: fdecb06617c9937d6c99c95a6f3dc167dff3398a05d7cdfd1c7d27e072204222
+  data.tar.gz: cb1bbc19b30dd0f1208f470254c4737eff569f641d4df76c94a3f0e5340b71d6
 SHA512:
-  metadata.gz: eb654e6a3b37d3da2c100db8274d600e167afdb6cdba6100d3a57cf8f22f04ff91706050785d8f310eda2a5aa8902ae6a32a9e58e0dd5285a93a81f7e64754a5
-  data.tar.gz: dcea7f1a62444d8e074b7bee219328a4e3a616e719e56ac2baf880d3688c332381c1dc6df793337848023d2186bb1c54268af46b44c4483d61730653ec5ade89
+  metadata.gz: a4b72b0ae34adf46c5dd689e3192d85b25d3d11607d96c2eb4bab7e192d518c30f049593ddadba81e2cede2fa028c3d8f8cefc2ce0379154b4ba7fb60f7e489e
+  data.tar.gz: 4b941a0eb4851b49405dc6bfbbcbfc78c46f13b659903654e37212dac7eda213e52b2815fc7e4839fd40af66d24faa4eba133935c0fceef1dfc26814a0c4e4cc

data/README.md

@@ -53,7 +53,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.
 
@@ -77,6 +77,10 @@ gen_create_db_user {user} {password} {db} {host}
 
 ## Installing Ruby
 
+You can use OS default ruby if it is already installed.
+
+Below is additional steps to install or develop with the latest version of Ruby.
+
 Install using `rbenv` on Mac OS X
 
 ```bash
@@ -87,6 +91,3 @@ rbenv global 3.3.0
 ruby -v
 ```
 
-## TODO
-
-* [ ] Add option to get db configuration information from spring cloud config

data/bin/mysql_backup

@@ -9,7 +9,8 @@ options = {
   env: "local",
   id: "0",
   run: false,
-  gzip: true
+  gzip: true,
+  gzip_suffix: ".gz"
 }
 
 # Parse command line arguments
@@ -19,11 +20,16 @@ OptionParser.new do |opts|
   MySQLDBTool.env_opt(options, opts)
   MySQLDBTool.id_opt(options, opts)
   MySQLDBTool.run_opt(options, opts)
+  MySQLDBTool.database_opt(options, opts)
 
   opts.on("-g", "--[no-]gzip", "Enable or disable gzip (default: enabled)") do |gzip|
     options[:gzip] = gzip
   end
 
+  opts.on("-s", "--gzip-suffix SUFFIX", "Set the gzip suffix (default: .gz), some platform requires '.Z'") do |gzip_suffix|
+    options[:gzip_suffix] = gzip_suffix
+  end
+
   opts.on("-h", "--help", "Show this help message") do
     puts opts
     exit

data/bin/mysql_restore

@@ -19,8 +19,9 @@ OptionParser.new do |opts|
   MySQLDBTool.env_opt(options, opts)
   MySQLDBTool.id_opt(options, opts)
   MySQLDBTool.run_opt(options, opts)
+  MySQLDBTool.database_opt(options, opts)
 
-  opts.on("-d", "--[no-]drop-all-tables", "Drop all tables before restoring (default: disabled)") do |drop_all_tables|
+  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
 

data/lib/mysql_db_tool/backup.rb

@@ -8,10 +8,12 @@ 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
 
     def perform
@@ -19,50 +21,51 @@ module MySQLDBTool
       verify_tools_exist
 
       id=@options[:id] || "0"
-      isGzip=@options[:gzip]
-      limitDays=@options[:limit_days] || 3
+      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=#{@db_info[: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#{isGzip ? '.gz' : ''}")
+        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#{isGzip ? '.gz' : ''}"))
+            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 #{options} #{defaultOptions} #{backupTables.join(' ')}", isGzip, "#{backupFile}-all-other-tables.sql#{isGzip ? '.gz' : ''}"))
+        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)
-      "#{command} #{isGzip ? '| gzip ' : ''} > #{file}"
+    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,7 @@
 
 
-def run(isRun, command)
-  if not isRun
+def run(is_run, command)
+  if not is_run
     puts "[dryRun] #{command}"
   else
     puts "Running: [#{command}]"
@@ -9,11 +9,11 @@ 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)
+def mysql_default_options(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} "
 end
 
@@ -22,7 +22,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,12 @@ 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
 
     def perform
@@ -23,47 +25,44 @@ module MySQLDBTool
       end
 
       id=@options[:id] || "0"
-      isRun=@options[:run]
-      isDropAllTables=@options[:drop_all_tables]
-
-      puts "ARGV=#{ARGV}, env=#{env}, id=#{id}, run=#{isRun} isDropAllTables=#{isDropAllTables}"
+      is_drop_all_tables=@options[:drop_all_tables]
 
-      backupDir=backupDirName(id)
+      backup_dir=backup_dir_name(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
@@ -71,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?
-      if file.end_with? ".sql.gz"
-        command = "zcat #{file} #{replacing} | mysql #{defaultOptions}"
-      elsif file.end_with? ".sql"
-        command = "cat #{file} #{replacing} | mysql #{defaultOptions}"
+      replacing = " | ruby -pe '$_=$_#{replace_db_names_command}'" unless replace_db_names_command.empty?
+      if file.end_with? ".sql"
+        command = "cat #{file} #{replacing} | mysql #{default_options}"
+      elsif gzip_file?(file)
+        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)
@@ -96,6 +95,14 @@ module MySQLDBTool
       index < array.length ? array[index] : array.last
     end
 
+    def gzip_file?(file_path)
+      magic_number = "\x1F\x8B".force_encoding('ASCII-8BIT')
+
+      File.open(file_path, "rb") do |file|
+        file.read(2) == magic_number
+      end
+    end
+
   end
 end
 

data/lib/mysql_db_tool/version.rb

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

data/lib/mysql_db_tool.rb

@@ -32,6 +32,12 @@ module MySQLDBTool
     end
   end
 
+  def self.database_opt(options, opts)
+    opts.on("-d", "--database DATABASE", "Override option for dbInfo.database configuration") do |database|
+      options[:database] = database.split(',')
+    end
+  end
+
   # You might want to add methods to easily access your main functionalities
   def self.backup(options = {})
     commands = Backup.new(options).perform

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mysql_db_tool
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Soonoh Jung
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-14 00:00:00.000000000 Z
+date: 2025-02-17 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