db_backup 1.0.0

data/bin/db_backup.rb

@@ -0,0 +1,133 @@
+#!/usr/bin/env ruby -w
+
+# ********************************************************************************
+#
+#  File: db_backup.rb
+#  Version: 1.0.0
+#  Author: Lee Choon Siong (lee@choonsiong.com)
+# 
+# Backup one or more MySQL database(s).
+#
+# ********************************************************************************
+
+$LOAD_PATH.push File.expand_path("../../lib", __FILE__)
+
+# --------------------------------------------------------------------------------------------------------------------------------------------- modules
+require 'optparse'
+require 'English'
+require 'open3'
+require 'yaml'
+require 'dbbackup_version'
+
+# --------------------------------------------------------------------------------------------------------------------------------------------- global options
+options = {
+  gzip: true,
+  force: false,
+  end_of_iteration: false,
+  user: nil,
+  password: nil,
+}
+
+#CONFIG_FILE = File.join(ENV['HOME'],'.db_backup.rc.yaml')
+CONFIG_FILE = File.join('./etc/db_backup.yaml') # --------------------------------------------------------------------------------------------- configuration file
+
+if File.exists? CONFIG_FILE
+  config_options = YAML.load_file(CONFIG_FILE)
+  options.merge!(config_options)
+else
+  File.open(CONFIG_FILE, 'w') { |file| YAML::dump(options, file) }
+  STDERR.puts "Initialized configuration file in #{CONFIG_FILE}"
+end
+
+# --------------------------------------------------------------------------------------------------------------------------------------------- OptionParser start
+option_parser = OptionParser.new do |opts|
+  executable_name = File.basename($PROGRAM_NAME)
+  opts.banner = "Backup one or more MySQL databases
+  
+  Usage: #{executable_name} [options] database_name
+  
+  Version: #{Dbbackup::VERSION}
+  
+  Run man man/db_backup.1 for man page
+  "
+  
+  # end of iteration switch
+  opts.on("-i", "--end-of-iteration", "Indicate that this backup is an \"iteration\" backup") do
+    options[:end_of_iteration] = true
+  end
+  
+  # username flag
+  opts.on("-u USER", "--username", "Database username, in first.last format", /^[^.]+\.[^.]+$/) do |user|
+    options[:user] = user
+  end
+
+  # password flag
+  opts.on("-p PASSWORD", "--password", "Database password") do |password|
+    options[:password] = password
+  end
+
+  # no-gzip switch
+  opts.on("--no-gzip", "Do not compress the backup file") do
+    options[:gzip] = false
+  end
+
+  # force overwrite switch
+  opts.on("--[no-]force", "Overwrite existing files") do |force|
+    options[:force] = force
+  end
+end
+# --------------------------------------------------------------------------------------------------------------------------------------------- OptionParser end
+
+exit_status = 0
+
+begin
+  option_parser.parse!
+  if ARGV.empty?
+    STDERR.puts "Error: you must supply a database name"
+    puts
+    puts option_parser.help
+    exit_status |= 0b0010 # exit 2
+  end
+rescue OptionParser::InvalidArgument => ex
+  STDERR.puts ex.message
+  STDERR.puts option_parser
+  exit_status |= 0b0001 # exit 1
+end
+
+exit exit_status unless exit_status == 0 # ---------------------------------------------------------------------------------------------------- Try exit
+
+# --------------------------------------------------------------------------------------------------------------------------------------------- Main
+auth = ""
+auth += "-u#{options[:user]} " if options[:user]
+auth += "-p#{options[:password]} " if options[:password]
+
+database_name = ARGV[0]
+output_file = "#{database_name}" + "_" + Time.now.strftime('%Y%m%d') + "_" + "#{$PROCESS_ID}" + ".sql"
+
+command = "/usr/local/mysql/bin/mysqldump " + "#{auth}#{database_name} > ./out/#{output_file}" # ---------------------------------------------- MySQL command
+
+if File.exists? output_file
+  if options[:force]
+    STDERR.puts "Warning: Overwriting #{output_file}"
+  else
+    STDERR.puts "Error: #{output_file} exists, use --force to overwrite"
+    exit 1 # ---------------------------------------------------------------------------------------------------------------------------------- Try exit
+  end
+end
+
+# Not sure whether this should put here or other place...
+Signal.trap("SIGINT") do
+  FileUtils.rm output_file
+end
+
+unless ENV['NO_RUN']
+  puts "Running '#{command}'"
+  stdout_str, stderr_str, status = Open3.capture3(command)
+  
+  unless status.success?
+    STDERR.puts "Error: There was a problem running '#{command}'"
+    STDERR.puts stderr_str.gsub(/^mysqldump: /, '')
+    exit 1 # ------------------------------------------------------------------------------------------------------------------------------------ Try exit
+  end
+end
+# --------------------------------------------------------------------------------------------------------------------------------------------- Program end

data/etc/db_backup.yaml

@@ -0,0 +1,5 @@
+---
+:gzip: false
+:force: true
+:user:
+:password:

data/lib/dbbackup_version.rb

@@ -0,0 +1,3 @@
+module Dbbackup
+  VERSION = '1.0.0'
+end

data/man/db_backup.1

@@ -0,0 +1,85 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "DB_BACKUP\.RB" "1" "April 2012" "" ""
+.
+.SH "NAME"
+\fBdb_backup\.rb\fR \- backup one or more MySQL databases
+.
+.SH "SYNOPSIS"
+\fBdb_backup\.rb\fR \fIdatabase_name\fR
+.
+.br
+\fBdb_backup\.rb\fR \fB\-u username\fR \fB\-p password\fR \fIdatabase_name\fR
+.
+.br
+\fBdb_backup\.rb\fR \fB\-i\fR|\fB\-\-end\-of\-iteration\fR \fIdatabase_name\fR
+.
+.SH "DESCRIPTION"
+\fBdb_backup\.rb\fR is a simple command\-line tool for backing up a MySQL database\. It does so safely and quietly, using a sensible name for the backup files, so it\'s perfect for use with cron as a daily backup\.
+.
+.P
+By default, \fBdb_backup\.rb\fR makes a daily backup and names the resulting backup file with the date\. \fBdb_backup\.rb\fR also understands our development process, so if you specify the \fB\-\-end\-of\-iteration\fR flag, the backup will be named differently than for a daily backup\. This will allow you to easily keep one backup per iteration, easily identifying it, and differentiate it from daily backups\.
+.
+.P
+By default, \fBdb_backup\.rb\fR will use your database credentials in \fB~/\.my\.cnf\fR, however, you can override either the username or password (or both) via the \fB\-u\fR and \fB\-p\fR flags, respectively\.
+.
+.P
+Finally, \fBdb_backup\.rb\fR will add a sanity check on your username, to make sure it fits with our corporate standard format of \fBfirst\.last\fR\.
+.
+.SH "FILES"
+\fB~/\.my\.cnf\fR is used for authentication if \fB\-u\fR or \fB\-p\fR is omitted\.
+.
+.SH "OPTIONS"
+.
+.TP
+\fB\-i\fR, \fB\-\-end\-of\-iteration\fR
+Indicate that this backup is an "end of iteration" backup\.
+.
+.TP
+\fB\-u USER\fR
+Database username, in first\.last format \fB~/my\.cnf\fR is not correct
+.
+.TP
+\fB\-p PASSWORD\fR
+Database password
+.
+.SH "EXAMPLES"
+Backup the database "big_client"
+.
+.IP "" 4
+.
+.nf
+
+$ db_backup\.rb big_client
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Backup the database "small_client", for which different credentials are required:
+.
+.IP "" 4
+.
+.nf
+
+$ db_backup\.rb \-u dave\.thomas \-p d4v3 small_client
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Make an iteration backup of the "big_client" database:
+.
+.IP "" 4
+.
+.nf
+
+$ db_backup\.rb \-i big_client
+.
+.fi
+.
+.IP "" 0
+

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: db_backup
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Lee Choon Siong
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: optparse
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: open3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yaml
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: English
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Dbbackup allows you to backup MySQL database on the command line
+email:
+- lee at choonsiong.com
+executables:
+- db_backup.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/db_backup.rb
+- etc/db_backup.yaml
+- lib/dbbackup_version.rb
+- man/db_backup.1
+homepage: http://lee.choonsiong.com
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: db_backup
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+summary: A lightweighted database backup application
+test_files: []