yeet_dba 0.2.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92a86fe5de9138137a8afdd48be9cb53bbc39a637d30da59d3ad5325bdc9b915
-  data.tar.gz: 3b091561a3fcf620dbc9efd842191d05fb621ef4ff81abbe50c17d32e8b5268f
+  metadata.gz: a4ebeaa010c0aac25fec89ae37bfa612bba92ac059f409d555a41c62a591e9ac
+  data.tar.gz: 2a1936a44bb7ec4f776420be9517c08604fc6ca5f0f7f4855adf8458cd6cda61
 SHA512:
-  metadata.gz: a10647d80a806e4a05da43ed8636762cbc9ce1ff9eef08e0d7510f1e5aed6b5372d00087a44f091658f11f085fd877804a1eb878427f2d26af9d162042ca7a49
-  data.tar.gz: d98a6c41b3b925b468d3c2c92c7c1fbc416d42d597c943e8842ca2fd4b9ad5304b0ce9cec5419faa055d29d0a79a307db5d2c2e97d18e3db891cd6209f8c6003
+  metadata.gz: aca3b09485598e836fcd99c4a8dde0986dfa2a602b69c15fe2f45e06472e050868be0200760eec6c77779a4f0891912b8626f65890028d041ac406960266a9c8
+  data.tar.gz: 06e42dba1df5abdc3aa4e2f5a0c0e8fc998838d820378cb6df994c6a247448740c09fac9e31b153a234e1b2139ad01a67d632d2f9e9c33de4fb701e5b357adf7

data/CHANGELOG.md

@@ -1,9 +1,13 @@
-# 0.2.1
+# 1.0.1 (unreleased, master)
 
-## Major changes
+## Minor changes
+
+# 1.0.0
 
 ## Minor changes
 
+Improved test coverage
+
 # 0.1.2
 
 ## Major changes

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    yeet_dba (0.1.2)
+    yeet_dba (0.2.1)
       actionpack (>= 3.0, < 6.0)
       activerecord (>= 3.0, < 6.0)
       railties (>= 3.0, < 6.0)

data/README.md

@@ -1,3 +1,4 @@
+
 ![Foreign Key by Ary Prasetyo from the Noun Project](./yeet_dba.png)
 
 # yeet_dba - find missing foreign key constraints
@@ -34,29 +35,9 @@ And then execute:
 
     $ bundle
 
-## Usage
-
-### Foriegn keys migration
-
-This probably should run against the production database so you can know if there are dangling records. If there are records with a value, but not the corresponding table does not have an id, then the migration will fail.
+## Start here
 
-```
-$ RAILS_ENV=production rails g yeet_dba:foreign_key_migration
-```
-
-This will create a new migration with for every foreign_key that can safely be added without running into orphaned data errors. We also warn you if active_record models that are missing association declarations (`has_many`, `belongs_to`, etc.)`
-
-`WARNING - cannot find an association for alternative_housings . supplier_id | suppliers`
-
-We also warn if we have tables that don't have existing models attached to them. This can be safe to ignore because join tables on many to many relations don't need models, but ideally, everything should have an AR model backing it.
-
-`WARNING - cannot find a model for alternative_housings . supplier_id | suppliers`
-
-Finnally, if there is a table that we think should have a foreign key constraint, but there are dangling values we warn you against that too.
-
-`WARNING - orphaned rows alternative_housings . supplier_id | suppliers`
-
-### Invalid rows
+### 1. Find invalid rows
 
 If a row has an id, but there doesn't exist an id the expected associated table, then the row has bad data and should either be fixed by nulling the orphaned row or assigning it to an existing row.
 
@@ -82,35 +63,43 @@ SELECT "notifications".* FROM "notifications" left join active_storage_attachmen
 
 ```
 
-### Fix invalid rows
+### 2. Fix invalid rows
 
-If a row has an id, but there doesn't exist an id the expected associated table, then the row has bad data and should either be fixed by nulling the orphaned row or assigning it to an existing row.
+You can either manually repair your data via rails console or direct SQL queries, or you can run a rake task to resolve failures.
 
-This rake task will scan every column for orphaned rows.
+If your rails association requires a value (e.g. `belongs_to :user, required: true`), then we try to delete the row.
+
+If your rails association says a value is optional, then we try to nullify the value if the schema alls that column to be null.
+
+If your schema does not allow you to nullify a column, we print a warning.
 
 ```
-$ RAILS_ENV=production rake yeet_dba:fix_invalid_columns
+$ RAILS_ENV=production rake yeet_dba:nullify_or_destroy_invalid_rows
 ```
 
-Sample output:
+### 3a. Add foreign keys via migration
+
+Now that the database is in a valid state, we can add the foreign keys in a migration.
 
 ```
----RESULTS---
+$ RAILS_ENV=production rails g yeet_dba:foreign_key_migration
+```
 
-🚨Houston, we have a problem 🚨. We found 1 invalid column.
+This will create a new migration with for every foreign_key that can safely be added without running into orphaned data errors. We also warn you if active_record models that are missing association declarations (`has_many`, `belongs_to`, etc.)
 
--> notifications.primary_image_id
-Invalid rows:   83
-Foreign table:  active_storage_attachments
+`WARNING - cannot find an association for alternative_housings . supplier_id | suppliers`
 
-This query should return no results:
-SELECT "notifications".* FROM "notifications" left join active_storage_attachments as association_table on association_table.id = notifications.primary_image_id WHERE "notifications"."primary_image_id" IS NOT NULL AND (association_table.id is null)
+We also warn if we have tables that don't have existing models attached to them. This can be safe to ignore because join tables on many to many relations don't need models, but ideally, everything should have an AR model backing it.
 
-```
+`WARNING - cannot find a model for alternative_housings . supplier_id | suppliers`
 
-### Add missing foriegn keys as a rake task
+Finally, if there is a table that we think should have a foreign key constraint, but there are dangling values we warn you against that too.
 
-You might want to add foreign keys outside of your regular deployment flow in case there are failures and deployment would be blocked by bad data. This would be especially obnoxious for MySql users since you can't rollback migrations.
+`WARNING - orphaned rows alternative_housings . supplier_id | suppliers`
+
+### 3b. Add missing foreign keys as a rake task
+
+You might want to add foreign keys outside of your regular deployment flow in case there are failures and deployment would be blocked by bad data. This would be especially obnoxious for MySql users since you can't rollback migrations on failure.
 
 ```
 $ RAILS_ENV=production rake yeet_dba:add_foreign_keys
@@ -135,9 +124,7 @@ This rake task is idempotent (safe to run as many times as you need).
 - [x] add rake task identify all dangling records
 - [x] add rake task to automatically nullify or destroy dangling records
 - [x] run adding foreign keys as rake task instead of generating a migration
-- [ ] support "soft delete" gems
-- [ ] Use rails associations to find columns that should be "not null" to [improve performance](https://stackoverflow.com/questions/1017239/how-do-null-values-affect-performance-in-a-database-search)
-
+- [x] Use rails associations to find columns that should be "not null" to [improve performance](https://stackoverflow.com/questions/1017239/how-do-null-values-affect-performance-in-a-database-search)
 
 ## Development
 
@@ -167,3 +154,4 @@ Foreign Key by Ary Prasetyo from the Noun Project
 ## Author
 
 Kevin Coleman, [https://kcoleman.me/](https://kcoleman.me)
+

data/lib/yeet_dba/version.rb

@@ -1,3 +1,3 @@
 module YeetDba
-  VERSION = '0.2.1'.freeze
+  VERSION = '1.0.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yeet_dba
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Kevin Coleman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-06 00:00:00.000000000 Z
+date: 2019-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler