anthonyvipond/deduper-laravel

This package is abandoned and no longer maintained. No replacement package was suggested.

Deduplicate and remap your database tables

dev-master 2014-12-29 08:08 UTC

Requires

• anthonyvipond/simple-pdo: dev-master
• illuminate/database: ~4.2
• symfony/console: ~2.0
• symfony/process: 2.5.*

MIT

• Anthony Vipond

• database
• mysql
• Remap
• dedupe
• deduplicate

README

Purpose

• Removes duplicate records from your database and remaps foreign keys in other tables

• You can easily define the uniqueness of a row using one or more columns

• It works well on large tables (10M+ rows) as well.

• Designed to run directly on production tables

Installation

The recommended way is through composer.

Edit composer.json and add:

{
    "require": {
        "anthonyvipond/deduper": "dev-master"
    }
}

And install dependencies:

    composer install

Copy config/database.php.sample to config/database.php and fill it out

You should now be able to use the program from the command line (where dlr file is stored)

php dlr

Purpose

###Deduplicating Tables####

Suppose you have the following people table:

id	name
2	Mary
3	Joseph
5	Mary
6	mary
7	Joseph

php dlr dedupe tableName columnName

i.e.

php dlr dedupe people name

Your original table will not be touched, and you will get this table people_uniques

id	name
2	Mary
3	Joseph

You will also get this table people_removes

id	name	new_id
5	Mary	null
6	Joseph	null
7	Joseph	null

But what if you have a table where the uniqueness of defined over three columns? No problem.

id	firstname	lastname	birthday
2	Mary	Smith	1991-01-01
3	Joseph	Parker	1984-02-02
5	Mary	Kate	1981-08-08
6	mary	kate	2001-03-03
7	Joseph	Parker	1984-02-02

Seperate the columns with a : in the second argument:

php dlr dedupe people firstname:lastname:birthday

You will get a new table people_uniques

id	firstname	lastname	birthday
2	Mary	Smith	1991-01-01
3	Joseph	Parker	1984-02-02
5	Mary	Kate	1981-08-08
6	mary	kate	2001-03-03

And another table people_removes

id	firstname	lastname	birthday	new_id
7	Joseph	Parker	1984-02-02	null

You can continue to deduplicate on different columns.

Your uniques table will get smaller, and your removes table will get bigger.

Take another look at the last stage our tables were in.

Let's keep deduplicating further on new rules...

php dlr dedupe tableName firstname:lastname

Now people_uniques is like this:

id	firstname	lastname	birthday
2	Mary	Smith	1991-01-01
3	Joseph	Parker	1984-02-02
5	Mary	Kate	1981-08-08

And people_removes is like this:

id	firstname	lastname	birthday	new_id
7	Joseph	Parker	1984-02-02	null
6	mary	kate	2001-03-03	null

###Linking####

The next stage is add the new ids to the removes table

php dlr link uniquesTable removesTable col1:col2:col3

ie

php dlr link people_uniques people_removes firstname:lastname:birthday

When doing linking, you should pass in the same columns as you did when deduping

If you ran the dedupe command several times with different combinations, you want to link from the least specific to the most.

ie

php dlr link people_uniques people_removes lastname:placeOfBirth

php dlr link people_uniques people_removes firstname:lastname:birthday

This way the more specific and higher quality groupings overwrite the lower quality ones

If you ran the dedupe command multiple times on different rules, you may end up with a small percentage of records that weren't linked after running the link command

You can pass the --fillerMode option to fill the rest with of the new_id with ids

Check how many new_id have not been remapped after each run:

SELECT count(1) FROM table_removes WHERE new_id IS NULL;

ie

php dlr link people_uniques people_removes firstname:lastname --fillerMode=true

###Remapping####

After you run dedupe you will have table_uniques and table_removes, as well as your original table.

The removes table needs to be present for remapping to work.

It won't be written to but needs to be read from.

Suppose you have this teams table:

id	team
2	Knicks
3	Knicks
4	Lakers
5	Knicks

And a champions table that needs remapping

id	team_id
2	3
3	2
4	5
5	2

And the teams_uniques table (remember, you deduped already)

id	team
2	Knicks
4	Lakers

And you also have this teams_removes table which is used for remapping:

id	team	new_id
3	Knicks	2
5	Knicks	2

You can now remap the foreign keys on other tables pointing to teams.id

php dlr remap remapTable removesTable foreignKey

i.e.

php dlr remap champions teams_removes team_id

The champions table now looks like this:

id	team_id
2	2
3	2
4	2
5	2

You should backup your remap table prior to running the remap command.

If your remapping doesn't finish the first time, just run it again. It won't hurt anything.

###Swapping in the new table###

Going back to the people table example...

Finish remapping foreign keys for all tables that point to people.id

Now for the final coup-de-grace!

RENAME TABLE table TO table_bak;
RENAME TABLE table_uniques TO table;
DROP TABLE table_bak -- optional

Congrats! You've deduped and remapped your table.

Contribution Guidelines

• Post an issue!
• Fork and pull.

Notes

• For the time being, your original table with duplicates must have an id column
• Only works on MySQL, but I'm open to adding more support