edujugon/tablediff

Comparing DB tables data for Laravel

TableDiff

Comparing DB tables data for Laravel., _(*1)

Installation

type in console:, _(*2)

composer require edujugon/tablediff

Register TableDiff service by adding it to the providers array., _(*3)

'providers' => array(
        ...
        Edujugon\TableDiff\Providers\TableDiffServiceProvider::class
    )

Let's add the Alias facade, add it to the aliases array., _(*4)

'aliases' => array(
        ...
        'TableDiff' => Edujugon\TableDiff\Facades\TableDiff::class,
    )

Usage samples

Instance the main TableDiff class:, _(*5)

$diff = new \Edujugon\TableDiff\TableDiff();

Add tables to be compared, _(*6)

$diff->tables('base_table', 'merge_table');

Set the pivots, _(*7)

$diff->pivots('base_table_pivot', 'merge_table_pivot');

If the columns have the same name you could do it like follows:, _(*8)

$diff->pivot('pivot_name');

Now, we can run the comparison and get the report, _(*9)

$report = $diff->run()->withReport();

Of course, all those methods can be chained, _(*10)

$report = $diff->tables('base_table','merge_table')
            ->pivot('pivot_name')
            ->run()
            ->withReport();

Notice if you don't use column method, it will look for all columns with same name in both tables., _(*11)

Merging

The simplest way yo do a merge is like follows, _(*12)

$diff->tables('base_table','merge_table')
    ->pivot('id')
    ->column('column_to_update')
    ->merge();

The above code snippet will update the column_to_update column values from base_table with the column_to_update column values of merge_table in matched ids., _(*13)

Notice that merge method will update the matched records and also add those records that are new for base table., _(*14)

Just merging matched records, _(*15)

diff->tables('base_table','merge_table')
    ->pivot('id')
    ->column('column_to_update')
    ->mergeMatched();

Now, let's insert the new records., _(*16)

diff->tables('base_table','merge_table')
    ->pivot('id')
    ->column('column_to_update')
    ->mergeUnMatched();

merge, mergeMatched and mergeUnMatched methods accept callbacks before doing the merge and just after each update., _(*17)

Before callback is perfect for casting data like. It takes the data which will be added., _(*18)

$ddiff->tables('base_table','merge_table')
            ->pivot('id')
            ->column('column_to_update')
            ->merge(null,function(&$data){
                // HERE your code
                $data->column_to_update = (float) $data->column_to_update;
            });

The first callback is call each time the db is updated. It takes the collection to be updated and the data with the new values, _(*19)

$diff->tables('base_table','merge_table')
    ->pivot('id')
    ->column('column_to_update')
    ->merge(function($collection,$data){
        //HERE your code
    });

In case of mergeUnMatched, the first callback takes the new elements to be added and is called for each chunk (By default 10), _(*20)

$diff->tables('base_table','merge_table')
    ->pivot('id')
    ->column('column_to_update')
    ->mergeUnMatched(function($list){
        //HERE your code
    });

Event

Once the merge is done the package fires an event call Edujugon\TableDiff\Events\MergeDone with some useful parameters, _(*21)

Parameters:, _(*22)

• Merge type
• Report
• Extra payload

Extra payload can be anything you want to add the the event, _(*23)

$diff->eventPayload(['user' => 'John Doe']);

Kepp in mind that eventPayload method have to be called before calling merge method., _(*24)

That is perfect when need to do some actions after merging like store it in db, send notification, etc.., _(*25)