mysqlknife 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 637c07907f66dc0ccc6d540823276a176f2d5d45
-  data.tar.gz: d24487597eda4c6b1d218230fdd0b97acf9f6100
+  metadata.gz: 5bf6062612d1868ec0ace249f6411307680db9b5
+  data.tar.gz: 82cd3ccbc43e2dd9faebb746a4c05afd466187e5
 SHA512:
-  metadata.gz: 922805c201c6072786be0af0ac1ff0c92c8575b204a23fa5c5e413a7c2c154bcf29fda6a7bd6aeaaed45cb6d25935e51e00a000cd66a7e53526c706c473d0c67
-  data.tar.gz: f7c8bcbd18d3eae2bce59fd14541821878281113c5002f6ce35a2cfce9ffbd9e5dbce7de50c34c62445440727bc6b1a1b529561c616b2381b6d19deee5967bd8
+  metadata.gz: cffcc0fa53b48aa686b8cf0f73a59e2eedd16dff643aba68f23c48a2c15a4c1ba3d20d56156e38d1c6d5f2d79e32ef0f64956e2f5e1f9d66d416481500c89843
+  data.tar.gz: aaf2eda2aca81c62e18795b312c7e4b73d7e9d3ae64f2bffad99804da79b322061b6616ab4180e01cdaf10374b8c7eba700b51e6f7ea623b7e760ede4e18dca9

data/README.md

@@ -1,6 +1,9 @@
 # Mysqlknife
 
-The missing utility for MySQL DBA:
+MySQL Knife is a Ruby Gem and command line tools, written for UNIX-like
+operating systems. That allows many tasks in MySQL Administration is easily for
+normal installation or in Amazon RDS. You can:
+
 - Checksum tables.
 - Skip error is slave.
 - Swap Databases
@@ -21,13 +24,18 @@ $ gem install mysqlknife
 Compare two tables with checksum:
 
 ```Shell
-$ mysqlknife checksum --from h=127.0.0.1,P=3306,u=root,p=admin,d=demo_from --to h=127.0.0.1,P=3306,u=root,p=admin,d=demo_to --table foo
+$ mysqlknife checksum --from h=127.0.0.1,P=3306,u=root,p=admin,d=demo_from \
+                      --to h=127.0.0.1,P=3306,u=root,p=admin,d=demo_to \
+                      --table foo
 ```
 
 ### Skip error in slave.
 
 ```Shell
-$ mysqlknife skip --host 127.0.0.1 --user root --password admin --behind -120
+$ mysqlknife skip --host 127.0.0.1 \
+                  --user root \
+                  --password admin \
+                  --behind -120
 ```
 
 ### Swap Databases
@@ -39,7 +47,10 @@ following command and save the STDOUT output to a file and then execute DML
 statements.
 
 ```Shell
-$ mysqlknife swap --host 127.0.0.1 --user root --password admin --databases from,to > swap.sql
+$ mysqlknife swap --host 127.0.0.1 \
+                  --user root \
+                  --password admin \
+                  --databases from,to > swap.sql
 $ mysql -h 127.0.0.1 -u root -padmin < swap.sql
 ```
 
@@ -51,11 +62,20 @@ output who kill.
 Please, follow next instructions to kill process:
 
 ```Shell
-$ mysqlknife kill --host 127.0.0.1 --user root --pass admin --where "time >= 200" --list
+$ mysqlknife kill --host 127.0.0.1 \
+                  --user root \
+                  --pass admin \
+                  --where "time >= 200"
 ```
 
+And kill the listed process:
+
 ```Shell
-$ mysqlknife kill --host 127.0.0.1 --user root --pass admin --where "time >= 200"
+$ mysqlknife kill --host 127.0.0.1 \
+                  --user root \
+                  --pass admin \
+                  --where "time >= 200" \
+                  --kill
 ```
 
 ## Warning

data/bin/mysqlknife

@@ -1,131 +1,6 @@
 #!/usr/bin/env ruby
 # encoding: utf-8
 
-$LOAD_PATH << './lib'
+require File.expand_path("../../lib/mysqlknife", __FILE__)
 
-require 'commander'
-require 'commander/import'
-require 'terminal-table'
-require 'mysqlknife'
-
-program :name, 'MySQL knife tools'
-program :version, Mysqlknife::VERSION
-program :description, 'MySQL knife tools'
-program :help, 'Author', 'Nicola Strappazzon <nicola51980@gmail.com>'
-
-global_option('-H', '--host      STRING')
-global_option('-u', '--user      STRING')
-global_option('-p', '--password [STRING]')
-global_option('-P', '--port     [STRING]')
-
-command :checksum do |c|
-  c.description = 'Checksum table.'
-  c.syntax      = %w(mysqlknife checksum
-                     --from h=127.0.0.1,P=3306,u=root,p=admin,d=demo_from
-                     --to h=127.0.0.1,P=3306,u=root,p=admin,d=demo_to
-                     --table foo).join(' ')
-  c.option '--from STRING', String, 'DNS to connect to source database.'
-  c.option '--to STRING', String, 'DNS to connect to destination database.'
-  c.option '--table STRING', String, 'Table name to compare.'
-
-  c.action do |args, options|
-    if options.from.nil?  ||
-       options.to.nil?    ||
-       options.table.nil?
-      puts c.syntax
-    else
-      unless Mysqlknife::Checksum.new(options.__hash__).equal?
-        puts "-- Table '#{options.table}' is not equal data."
-        exit 1
-      end
-    end
-  end
-end
-
-command :swap do |c|
-  c.description = 'Swap two databases.'
-  c.syntax      = %w(mysqlknife swap
-                     --host 127.0.0.1
-                     --user root
-                     --password admin
-                     --databases from,to).join(' ')
-  c.option '--databases STRING', String, 'Databases to swap.'
-
-  c.action do |args, options|
-    if options.host.nil?     ||
-       options.user.nil?     ||
-       options.databases.nil?  ||
-       options.databases.split(',').count != 2
-      puts c.syntax
-    else
-      swap = Mysqlknife::Swap.new(options.__hash__).all
-
-      if swap
-        swap.each do |sql|
-          puts sql
-        end
-      end
-    end
-  end
-end
-
-command :kill do |c|
-  c.description = 'Kill all process.'
-  c.syntax      = %w(mysqlknife kill
-                     --host 127.0.0.1
-                     --user root
-                     --password admin
-                     --where "time >= 28800").join(' ')
-  c.option '--where STRING', String, 'Conditions to filter.'
-  c.option '--list', 'List match process to kill.'
-
-  c.action do |args, options|
-    if options.host.nil?  ||
-       options.user.nil?  ||
-       options.where.nil?
-      puts c.syntax
-    else
-      kill = Mysqlknife::Kill.new(options.__hash__)
-
-      if kill.check_privileges
-        if options.list.nil?
-          kill.clear unless kill.list.first.nil?
-        else
-          unless kill.list.first.nil?
-            table = Terminal::Table.new do |t|
-              t.add_row(kill.list.first.keys)
-              t.add_separator
-
-              kill.list.each do |row|
-                t.add_row(row.values)
-              end
-            end
-            puts table
-          end
-        end
-      else
-        puts 'User does not have process privileges.'
-      end
-    end
-  end
-end
-
-command :skip do |c|
-  c.description = 'Skipping the current replication error in Amazon RDS.'
-  c.syntax      = %w(mysqlknife skip
-                     --host 127.0.0.1
-                     --user root
-                     --password admin
-                     --behind -120).join(' ')
-  c.option '--behind Integer', Integer, 'Set Seconds Behind Master, default is 120.'
-  c.action do |args, options|
-    if options.host.nil?   ||
-       options.user.nil?   ||
-       options.behind.nil?
-      puts c.syntax
-    else
-      rep = Mysqlknife::Replica.new(options.__hash__)
-      rep.skip
-    end
-  end
-end
+Mysqlknife::CLI.start(ARGV)

data/lib/mysqlknife.rb

@@ -1,14 +1,17 @@
 # encoding: utf-8
 
-require 'mysqlknife/config'
-require 'mysqlknife/connection'
-require 'mysqlknife/checksum'
-require 'mysqlknife/replica'
-require 'mysqlknife/kill'
-require 'mysqlknife/sql'
-require 'mysqlknife/swap'
-require 'mysqlknife/version'
+require 'mysql2'
+require 'terminal-table'
+require 'thor'
+require 'yaml'
 
 module Mysqlknife
-  # Your code goes here...
+  LIBRARY_PATH = File.join(File.dirname(__FILE__), 'mysqlknife')
+
+  # Autoload libraries:
+  Dir["#{LIBRARY_PATH}/*.rb"].select do |file|
+    if File.file? file
+      require File.join(LIBRARY_PATH, File.basename(file, '.rb'))
+    end
+  end
 end

data/lib/mysqlknife/checksum.rb

@@ -3,16 +3,16 @@
 module Mysqlknife
   class Checksum
     def initialize(options = {})
-      dns_from  = Config.new.dns(options[:from])
-      dns_to    = Config.new.dns(options[:to])
+      dsn_from  = Config.new.dsn(options[:from])
+      dsn_to    = Config.new.dsn(options[:to])
 
-      @sum_from = sum(dns_from, options[:table])
-      @sum_to   = sum(dns_to, options[:table])
+      @sum_from = sum(dsn_from, options[:table])
+      @sum_to   = sum(dsn_to, options[:table])
     end
 
-    def sum(dns, table)
-      conn    = Connection.new(dns)
-      sql     = Sql.new(dns[:database], table)
+    def sum(dsn, table)
+      conn    = Connection.new(dsn)
+      sql     = Sql.new(dsn[:database], table)
       columns = conn.execute(sql.columns)
       sql     = sql.checksum(columns)
       columns = conn.execute(sql)

data/lib/mysqlknife/cli.rb

@@ -0,0 +1,144 @@
+module Mysqlknife
+  class CLI < Thor
+    def initialize(*args)
+      super
+    end
+
+    desc 'checksum', 'Checksum table.'
+    long_desc <<-LONGDESC
+      DSN:
+
+      These DSN (Data Source Name) options are used to create a DSN. Each option
+      is given like option=value. The options are case-sensitive, so P and p are
+      not the same option. There cannot be whitespace before or after the = and
+      if the value contains whitespace it must be quoted. DSN options are
+      comma-separated. This idea is get from percona-toolkit.
+
+      h=<host>,P=<port>,u=<user>,p=<password>,d=<database>
+
+      Example: h=127.0.0.1,P=3306,u=root,p=admin,d=demo_from
+
+      Syntax:
+
+      mysqlknife checksum
+        --from h=127.0.0.1,P=3306,u=root,p=admin,d=demo_from
+        --to h=127.0.0.1,P=3306,u=root,p=admin,d=demo_to
+        --table foo
+      LONGDESC
+    option :from,
+           desc: 'DSN to connect to source database.',
+           required: true,
+           type: :string
+    option :to,
+           desc: 'DSN to connect to destination database.',
+           required: true,
+           type: :string
+    option :table,
+           desc: 'Name of table to compare.',
+           required: true,
+           type: :string
+    def checksum
+      unless Mysqlknife::Checksum.new(options).equal?
+        puts "-- Table '#{options[:table]}' is not equal data."
+        exit 1
+      end
+    end
+
+    desc 'kill', 'Kill process in MySQL or RDS'
+    long_desc <<-LONGDESC
+      Syntax:
+
+        mysqlknife kill --host 127.0.0.1 --user root --password admin
+        --where "time >= 28800"
+      LONGDESC
+    option :host,
+           type: :string
+    option :user,
+           type: :string
+    option :password,
+           type: :string
+    option :port,
+           type: :numeric
+    option :where,
+           default: 'time >= 28800',
+           desc: 'Conditions to filter.',
+           required: true,
+           type: :string
+    option :kill,
+           desc: 'Execute kill statements.',
+           type: :boolean
+    def kill
+      kill = Mysqlknife::Kill.new(options)
+
+      if kill.check_privileges
+        if options[:kill]
+          kill.clear
+        else
+          puts kill.show
+        end
+      else
+        puts 'User does not have process privileges.'
+      end
+    end
+
+    desc 'skip', 'Skipping the current replication error in Amazon RDS.'
+    long_desc <<-LONGDESC
+      Syntax:
+
+        mysqlknife skip --host 127.0.0.1 --user root --password admin --behind
+        -120
+      LONGDESC
+    option :host,
+           type: :string
+    option :user,
+           type: :string
+    option :password,
+           type: :string
+    option :port,
+           type: :numeric
+    option :behind,
+           default: 120,
+           desc: 'Set Seconds Behind Master',
+           required: true,
+           type: :numeric
+    def skip
+      rep = Mysqlknife::Replica.new(options)
+      rep.skip
+    end
+
+    desc 'swap', 'Invert two databases.'
+    long_desc <<-LONGDESC
+      Move all tables and views from DB(A) to DB(B), and DB(B) to DB(A).
+      Use rename of SQL Statements for this action.
+
+      Syntax:
+
+        mysqlknife swap --host 127.0.0.1 --user root --password admin
+        --databases from,to
+      LONGDESC
+    option :host,
+           type: :string
+    option :user,
+           type: :string
+    option :password,
+           type: :string
+    option :port,
+           type: :numeric
+    option :databases,
+           desc: 'Name of databases to swap.',
+           required: true,
+           type: :string
+    def swap
+      if options[:databases].split(',').count == 2
+        swap = Mysqlknife::Swap.new(options).all
+
+        if swap
+          swap.each do |sql|
+            puts sql
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/mysqlknife/config.rb

@@ -1,7 +1,5 @@
 # encoding: utf-8
 
-require 'yaml'
-
 module Mysqlknife
   class Config
     @configs = nil
@@ -26,9 +24,11 @@ module Mysqlknife
       end
     end
 
-    def defaults(options)
-      options.delete_if { |k, v| v.nil? }
+    def symbolize_keys(options)
+      options.inject({}){|hash,(k,v)| hash[k.to_sym] = v; hash}
+    end
 
+    def defaults(options)
       { host: 'localhost',
         port: '3306',
         user: 'root',
@@ -36,7 +36,7 @@ module Mysqlknife
       .merge(options)
     end
 
-    def dns(options)
+    def dsn(options)
       options.split(',')
              .map { |c| c.split('=', 2) }
              .reduce({}) do |m, (key, value)|

data/lib/mysqlknife/connection.rb

@@ -1,13 +1,11 @@
 # encoding: utf-8
 
-require 'rubygems'
-require 'mysqlknife/config'
-require 'mysql2'
-
 module Mysqlknife
   class Connection
     def initialize(options = {}, database = nil)
-      options   = Config.new.defaults(options)
+      config    = Config.new
+      options   = config.symbolize_keys(options)
+      options   = config.defaults(options)
 
       @host     = options[:host]
       @port     = options[:port]

data/lib/mysqlknife/kill.rb

@@ -8,33 +8,64 @@ module Mysqlknife
       @where = options[:where]
     end
 
-    def check_privileges
-      sql_user   = @sql.current_user
-      sql_grants = @sql.current_user_grants
-      if @conn.execute(sql_user).first['CURRENT_USER'] =~ /^root\@/
-        return true
-      else
-        return true if @conn.execute(sql_grants).first.values.to_s =~ /PROCESS/
+    def clear
+      list.each do |process|
+        log(process)
+        kill(process['id'])
       end
     end
 
+    def check_user
+      sql    = @sql.current_user
+      result = @conn.execute(sql).first['CURRENT_USER'] =~ /^root\@/
+
+      return true if result
+    end
+
+    def check_grants
+      sql    = @sql.current_user_grants
+      result = @conn.execute(sql).first.values.to_s =~ /PROCESS/
+
+      return true if result
+    end
+
+    def check_privileges
+      check_user || check_grants
+    end
+
     def list
       @conn.execute(@sql.processlist(@where))
     end
 
-    def clear
-      exist_procedure = @conn.execute(@sql.show_procedure('rds_kill'))
-
-      @conn.execute(@sql.processlist(@where)).each do |process|
-        puts %W(#{Time.now.getutc}
-                : MySQL Kill Process -
-                #{process.map { |k, v| "#{k}: #{v}" }.join(', ')}
-                ).join(' ')
-        if exist_procedure.first.nil?
-          @conn.execute(@sql.mysql_kill(process['id']))
-        else
-          @conn.execute(@sql.rds_kill(process['id']))
+    def show
+      unless list.first.nil?
+        table = Terminal::Table.new do |t|
+          t.add_row(list.first.keys)
+          t.add_separator
+          list.each do |row|
+            t.add_row(row.values)
+          end
         end
+        table
+      end
+    end
+
+    def log(process)
+      puts %W(#{Time.now.getutc}
+              : MySQL Kill Process -
+              #{process.map { |k, v| "#{k}: #{v}" }.join(', ')}
+              ).join(' ')
+    end
+
+    def rds?
+      ! @conn.execute(@sql.show_procedure('rds_kill')).first
+    end
+
+    def kill(id)
+      if rds?
+        @conn.execute(@sql.mysql_kill(id))
+      else
+        @conn.execute(@sql.rds_kill(id))
       end
     end
   end

data/lib/mysqlknife/replica.rb

@@ -18,20 +18,23 @@ module Mysqlknife
 
     def skip
       procedure_name  = @sql.show_procedure('rds_skip_repl_error')
-      exist_procedure = @conn.execute(procedure_name)
+      exist_procedure = @conn.execute(procedure_name).first
       slave_status    = @conn.execute(@sql.slave_status).first
 
-      # Resolv Negative Lag:
+      return nil if slave_status.nil?
+      return nil unless slave_status.include? 'Seconds_Behind_Master'
+
       if check_status_negative(slave_status['Seconds_Behind_Master'])
         puts %W(#{Time.now.getutc} : MySQL Skip error replica -
                 #{slave_status.map { |k, v| "#{k}: #{v}" }.join(', ')}
                 ).join(' ')
-        if exist_procedure.first.nil?
+        if exist_procedure.nil?
           @conn.execute(@sql.mysql_skip_repl_error)
           while @conn.next_result
             message = @conn.store_result
             puts %W(#{Time.now.getutc} : MySQL Skip error replica -
                     Message: #{message}).join(' ')
+            sleep(1)
           end
         else
           message = @conn.execute(@sql.rds_skip_repl_error).first['Message']

data/lib/mysqlknife/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 module Mysqlknife
-  VERSION = '1.3.1'
+  VERSION = '1.4.0'
 end

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: mysqlknife
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Nicola Strappazzon C.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-16 00:00:00.000000000 Z
+date: 2015-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: commander
+  name: mysql2
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.1.6
+        version: 0.3.18
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.1.6
+        version: 0.3.18
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.19.1
 - !ruby/object:Gem::Dependency
   name: terminal-table
   requirement: !ruby/object:Gem::Requirement
@@ -42,25 +56,33 @@ dependencies:
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.5.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.5.5
-description: MySQL Knife tools
+description: MySQL Knife is a Ruby Gem and command line tools, written for UNIX-like
+  operating systems. That allows many tasks in MySQL Administration is easily for
+  normal installation or in Amazon RDS. You can check two tables by checksum in two
+  servers (Master/Slave for example), Kill process with query, skipping the current
+  replication error, and invert (swap) two databases.
 email: nicola51980@gmail.com
 executables:
 - mysqlknife
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE.txt
+- README.md
 - bin/mysqlknife
+- lib/mysqlknife.rb
 - lib/mysqlknife/checksum.rb
+- lib/mysqlknife/cli.rb
 - lib/mysqlknife/config.rb
 - lib/mysqlknife/connection.rb
 - lib/mysqlknife/kill.rb
@@ -68,9 +90,6 @@ files:
 - lib/mysqlknife/sql.rb
 - lib/mysqlknife/swap.rb
 - lib/mysqlknife/version.rb
-- lib/mysqlknife.rb
-- LICENSE.txt
-- README.md
 homepage: https://github.com/nicola51980/mysqlknife
 licenses:
 - MIT
@@ -81,18 +100,19 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: The missing utility for MySQL.
+summary: MySQL and RDS tools for checksum, kill process, swap and resume replication
+  error.
 test_files: []