databender 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4f0224e71e9970b7d51d20dc020ceb5ddb449f37
-  data.tar.gz: 5fe6a3f2af057f4d523b8bbc3bf9c0672a943833
+  metadata.gz: 4ad9e917c73266362f09b6e5c415f328b13fc8b1
+  data.tar.gz: 189bb02bc2cc8cf69a178efb2ae5b6153149d9bd
 SHA512:
-  metadata.gz: 5a88848c0ee536aacbc32914c7fa84a95c70475ac10c3d0c679fdf47b3a7be4f66279bca268397377fe4e31a54a91702ab7ad4597d317cc2a3649b15f81b7937
-  data.tar.gz: 90f1af10b4950336312cb406e3b7c5e1f60de5fd2906bcb6c71d76d8c34b063c7aad6016a464a96b114896aa9fc2abe54fbb82c65d0cd1b82826ed2707ab67ca
+  metadata.gz: 38c12d2545e3df7308901e065ecf59cb9d05922a1285950bb60b186f0b9ddc337319c017085a5960c3530ef357310ae5356a653ad2890e4e511c285aaae99f45
+  data.tar.gz: c7974b08526e052e6426fba283d17ef9a7292993b1859099410024a0a909e88b5d2865b531dee7acbc2e4e6887cffeafcf7b5151bea6f1ef0d108e8f56799e8b

data/{LICENSE → LICENSE.md}

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 RC
+Copyright (c) 2017 RC
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,31 +1,84 @@
 # Databender
 
-Database Subset Generator
+Ruby script to generate a database subset driven by configuration based rule-engine
 
-## Installation
+#### Demo
 
-Add this line to your application's Gemfile:
+![alt tag](https://github.com/rcdexta/databender/raw/master/assets/demo.gif)
 
-```ruby
-gem 'databender'
+#### Why
+
+If you have to quickly boot up a micro-service or any application in your local machine and you are stuck because the service has dependent seed data that needs to be present in the database before starting up, you have couple options:
+
+* automate data generation using tools like [bobcat](https://github.com/ThoughtWorksStudios/bobcat)
+* use the fixtures that power your testing suite to generate the seed data
+* generate a subset of the data from one of the working environments (staging, uat)
+
+Databender aims to offer an easy and seamless solution to solve the last option.
+
+#### Features
+
+* configuration driven rule engine
+* can add filters at table level or globally at column level
+* can resolve sequence of tables to import based on referential integrity (foreign key dependencies)
+
+#### Installation
+
+Install the gem to install the command-line cli
+
+```bash
+$ gem install databender
+```
+
+and the type 
+
+```shell
+$ databender --help
 ```
 
-And then execute:
+to know the list of available commands.
 
-    $ bundle
+#### Usage
 
-Or install it yourself as:
+First initialise the configuration for the database you would like to take a subset of
 
-    $ gem install databender
+```powershell
+$ databender init --db-name=employees
+```
+
+> Note: I have taken the MySQL public dataset available here: https://github.com/datacharmer/test_db as the sample dataset to illustrate the gem
+
+This should create a `config` folder and a `database.yml` file. Specify the connection params to the source database in `database.yml` file. Inspect `filters/employees.yml`  to specify the rules for generating the subset. The comments in the file should serve as good documentation to specify the table and column filters. Find a sample filter configuration below.
+
+```yaml
+tables:
+  # Tables with rows lesser than min_row_count will be fully imported with no filters applied
+  min_row_count: 20
+
+  # For tables with no filters, the maximum number of rows to import
+  max_row_count: 1000
+
+  # specify table specific filters here
+  filters:
+    employees: hire_date >= '1994-01-01'
+    departments: dept_name in ('d004', 'd005')
+
+columns:
+  # specify column filters applicable to all tables that contain that column
+  filters:
+    birth_date: birth_date >= '1950-01-01'
+
+```
+
+Now you can run the generator using
+
+```shell
+$ databender generate --db-name=employees
+```
 
-## Usage
+This should generate another database called `employees_subset` with the subset data and also create a dump of the file gzipped.
 
-TODO: Write usage instructions here
 
-## Contributing
+#### License
 
-1. Fork it ( https://github.com/[my-github-username]/databender/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+MIT

data/databender.gemspec

@@ -3,30 +3,31 @@ lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'databender/version'
 
-Gem::Specification.new do |spec|
-  spec.name          = 'databender'
-  spec.version       = Databender::VERSION
-  spec.authors       = ['RC']
-  spec.email         = ['rc.chandru@gmail.com']
-  spec.summary       = %q{Database subset generator}
-  spec.description   = %q{Database subset generator}
-  spec.homepage      = ''
-  spec.license       = 'MIT'
+Gem::Specification.new do |s|
+  s.name          = 'databender'
+  s.version       = Databender::VERSION
+  s.authors       = ['RC']
+  s.email         = ['rc.chandru@gmail.com']
+  s.summary       = %q{Database subset generator}
+  s.description   = %q{Database subset generator}
+  s.homepage      = ''
+  s.license       = 'MIT'
+  s.homepage      = 'https://github.com/rcdexta/databender'
 
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = ['databender']
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ['lib']
+  s.files         = `git ls-files -z`.split("\x0")
+  s.executables   = ['databender']
+  s.test_files    = s.files.grep(%r{^(test|s|features)/})
+  s.require_paths = ['lib']
 
-  spec.add_dependency 'thor', '~> 0.20.0'
-  spec.add_dependency 'activerecord', '=5.1.4'
-  spec.add_dependency 'mysql2', '=0.4.9'
-  spec.add_dependency 'mustache', '~> 1.0', '>= 1.0.5'
-  spec.add_dependency 'configatron', '~> 4.5', '>= 4.5.1'
-  spec.add_dependency 'terminal-table', '~> 1.8', '>= 1.8.0'
+  s.add_dependency 'thor', '~> 0.20.0'
+  s.add_dependency 'activerecord', '=5.1.4'
+  s.add_dependency 'mysql2', '=0.4.9'
+  s.add_dependency 'mustache', '~> 1.0', '>= 1.0.5'
+  s.add_dependency 'configatron', '~> 4.5', '>= 4.5.1'
+  s.add_dependency 'terminal-table', '~> 1.8', '>= 1.8.0'
 
-  spec.add_development_dependency 'bundler', '~> 1.7'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'pry', '~> 0'
+  s.add_development_dependency 'bundler', '~> 1.7'
+  s.add_development_dependency 'rake', '~> 10.0'
+  s.add_development_dependency 'pry', '~> 0'
 
 end

data/lib/databender/cli/main.rb

@@ -29,9 +29,9 @@ module Databender
       desc 'generate', 'Generate subset given a database'
       def generate
         say "Creating subset for #{options[:db_name]}", :green
-        Databender::Runner.process! options[:db_name]
-        puts ''
+        source, report_queries = Databender::Runner.process! options[:db_name]
         run 'sh subset.sh', verbose: false
+        Databender::Runner.print_report source, report_queries
       end
 
     end

data/lib/databender/connection.rb

@@ -20,7 +20,7 @@ module Databender
       execute(%[
                   SELECT table_name
                   FROM information_schema.tables
-                  WHERE table_schema = '#{db_name}';
+                  WHERE table_schema = '#{db_name}' and table_type = 'BASE TABLE';
               ])
     end
 

data/lib/databender/runner.rb

@@ -14,13 +14,25 @@ module Databender
   class Runner
     extend Databender::SQLHelper
 
-
-
     def self.generate_script(params)
       template = File.read("#{GEM_ROOT}/subset.sh.mustache")
       File.write('subset.sh', Mustache.render(template, params))
     end
 
+    def self.print_report(source, report_queries)
+      report = []
+      report_queries.each do |rq|
+        all_count = source.execute_count(rq[:all_count_sql]).first.first
+        subset_count = source.execute_count(rq[:filter_count_sql]).count
+        report << [rq[:table], all_count, subset_count, rq[:filter]]
+      end
+      headings = ['Table Name', 'Total Rows', 'Fetched Rows', 'Filter(s)']
+      tty = Terminal::Table.new headings: headings, rows: report
+      puts ''
+      puts 'Generating report...'
+      puts tty
+    end
+
     def self.apply_column_filters(table, source, source_db, target_db)
       columns = source.columns_for(source_db, table.name)
       overlapping_filters = Databender::Config.column_filters.keys & columns
@@ -36,8 +48,6 @@ module Databender
         exit(1)
       end
 
-      report = []
-
       Databender::Config.load!(db_name)
       target_db = Databender::Config.target_db
       source_db = Databender::Config.source.database
@@ -53,11 +63,12 @@ module Databender
 
       ordered_tables = Databender::TableOrder.order_by_foreign_key_dependency(source, source_db, all_tables)
 
+      report_queries = []
+
       entries = ordered_tables.collect do |table|
         column_filters = apply_column_filters table, source, source_db, target_db
-        sql = count_all_query source_db, table.name
-        all_count = source.execute_count(sql).first.first
-        sql, count_query, filter = if Databender::Config.table_filters.keys.include?(table.name)
+        all_count_sql = count_all_query source_db, table.name
+        sql, filter_count_sql, filter = if Databender::Config.table_filters.keys.include?(table.name)
                              conditions = merge_filters(Databender::Config.table_filters[table.name], column_filters)
                              [insert_into_select(source_db, table.name, conditions),
                               count_filtered_query(source_db, table.name, conditions), conditions]
@@ -67,21 +78,15 @@ module Databender
                              else
                                parents = Databender::TableOrder.parent_tables_for(table.name)
                                condition = parents.present? ? where_clause_by_reference(target_db, parents) : nil
-                               [insert_into_select(source_db, table.name, condition), count_filtered_query(source_db, table.name, condition), nil]
+                               [insert_into_select(source_db, table.name, condition), count_filtered_query(source_db, table.name, condition), condition]
                              end
                                    end
-        subset_count = source.execute_count(count_query).count
-        report << [table.name, all_count, subset_count, filter && filter]
+        report_queries << {table: table.name, all_count_sql: all_count_sql, filter_count_sql: filter_count_sql, filter: filter}
         {sql: sql, table: table.name}
       end
 
-      headings = ['Table Name', 'Total Rows', 'Fetched Rows', 'Filter(s)']
-      tty = Terminal::Table.new headings: headings, rows: report
-      puts tty
-
-
       self.generate_script source: Databender::Config.source, target_db: target_db, entries: entries, database: db_name
-
+      [source, report_queries]
     end
   end
 end

data/lib/databender/templates/database.yml

@@ -1,8 +1,8 @@
-<%= options[:database] %>:
+<%= options[:db_name] %>:
     adapter: mysql2
     host: 127.0.0.1
     encoding: utf8
-    database: <%= options[:database] %>
+    database: <%= options[:db_name] %>
     username: root
     password:
     port: 3306

data/lib/databender/version.rb

@@ -1,3 +1,3 @@
 module Databender
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/lib/subset.sh.mustache

@@ -36,5 +36,5 @@ mkdir -p dumps
 
 MYSQL_PWD='{{source.password}}' mysqldump -u{{source.username}} -h{{source.host}} -P{{source.port}} {{target_db}} | gzip > dumps/{{database}}.sql.gz
 
-echo "\033[92mThe dump of db_subset is available at dumps/{{database}}.sql.gz. Use gunzip to extract followed by mysql command to load. The subset database is intact in the db server too!"
+echo "\033[92mThe dump of db_subset is available at dumps/{{database}}.sql.gz. Use gunzip to extract followed by mysql command to load. The subset database is intact in the db server too!\033[0m"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: databender
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - RC
@@ -166,10 +166,10 @@ files:
 - ".ruby-gemset"
 - ".ruby-version"
 - Gemfile
-- LICENSE
-- LICENSE.txt
+- LICENSE.md
 - README.md
 - Rakefile
+- assets/demo.gif
 - bin/databender
 - databender.gemspec
 - dumps/magic_list_service_test.sql.gz
@@ -186,7 +186,7 @@ files:
 - lib/databender/templates/filter.yml
 - lib/databender/version.rb
 - lib/subset.sh.mustache
-homepage: ''
+homepage: https://github.com/rcdexta/databender
 licenses:
 - MIT
 metadata: {}

data/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (c) 2015 RC
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.