π Universal Extensible Data Migrator (UXDM)
UXDM helps developers migrate data from one system or format to another.
Installation
UXDM can be easily installed using Composer. Just run the following command from the root of your project.
composer require divineomega/uxdm
If you have never used the Composer dependency manager before, head to the Composer website for more information on how to get started.
Quick Start
-
Create a new PHP file to contain your UXDM migration code. In this example, we'll call it
user-csv-import.php
. Remember to addrequire 'vendor/autoload.php'
and relevantuse
statements, if necessary. -
Create your source and destination objects. This example uses a CSV source and PDO (database) destination.
$csvSource = new CSVSource('users.csv');
$pdoDestination = new PDODestination(new PDO('mysql:dbname=test-database;host=127.0.0.1', 'root', 'password'), 'users');
- Create and configure a new UXDM migrator object.
$migrator = new Migrator;
$migrator->setSource($csvSource)
->setDestination($pdoDestination)
->setFieldsToMigrate(['id', 'email', 'name'])
->setKeyFields(['id'])
->withProgressBar()
->migrate();
- Run your newly created migration. In this example, we can just run
php user-csv-import.php
from the command line and will get a nice progress bar.
See the sections below for more information on the available source and destination objects, and more advanced usage examples.
Migrations
Each UXDM migration requires a source object and at least one destination object. These determine where and how data is read and written. The UXDM package comes with a variety of source and destination objects, including the following.
- PDO (PHP Database Object) Source & Destination
- Eloquent (as used in Laravel) Source & Destination
- Doctrine (as used in Symfony) Destination
- CSV (Comma Seperated Values) Source & Destination
- Associative Array Source & Destination
- JSON Files Source & Destination
- XML Source & Destination
- WordPress Post Source
- WordPress User Source
- Debug Output Destination
Source and destination objects can be used in any combination. Data can be migrated from a CSV and inserted into a database, just as easily as data can be migrated from a database to a CSV.
You can also use similar source and destination objects in the same migration. For example, a common use of UXDM is to use a PDO source and PDO destination to transfer data from one database to another.
Please see the Sources & Destinations page for more detailed documentation on their usage.
Examples
Database to database migration
An example of a basic database to database UXDM migration is shown below.
$pdoSource = new PDOSource(new PDO('mysql:dbname=old-test;host=127.0.0.1', 'root', 'password123'), 'users');
$pdoDestination = new PDODestination(new PDO('mysql:dbname=new-test;host=127.0.0.1', 'root', 'password456'), 'new_users');
$migrator = new Migrator;
$migrator->setSource($pdoSource)
->setDestination($pdoDestination)
->setFieldsToMigrate(['id', 'email', 'name'])
->setKeyFields(['id'])
->withProgressBar()
->migrate();
This migration will move the id
, email
and name
fields from the the users
table in the old-test
database, to the new_users
table in the new-test
database, replacing any existing records with the same id
(the key field).
Mapping field names from source to destination
This examples shows how UXDM can map field names from source to destination.
$migrator = new Migrator;
$migrator->setSource($pdoSource)
->setDestination($pdoDestination)
->setFieldsToMigrate(['id', 'email', 'name'])
->setKeyFields(['id'])
->setFieldMap(['name' => 'full_name'])
->withProgressBar()
->migrate();
This migration will move data from the source name
field into the destination full_name
field, while still moving the id
and email
fields normally.
Modifying data items during migration
The following example shows how you can use UXDM to modify items of data during the migration process.
$migrator = new Migrator;
$migrator->setSource($pdoSource)
->setDestination($pdoDestination)
->setFieldsToMigrate(['id', 'email', 'name'])
->setKeyFields(['id'])
->setDataItemManipulator(function($dataItem) {
if ($dataItem->fieldName=='name') {
$dataItem->value = strtoupper($dataItem->value);
}
})
->withProgressBar()
->migrate();
This migration will move user data between two databases. However, it will also convert the value in the name
field to uppercase.
Modifying data rows during migration
Adding data items
This examples shows how UXDM can modify each row of data while the migration is taking place.
$migrator = new Migrator;
$migrator->setSource($pdoSource)
->setDestination($pdoDestination)
->setFieldsToMigrate(['id', 'email', 'name'])
->setKeyFields(['id'])
->setDataRowManipulator(function($dataRow) {
$dataRow->addDataItem(new DataItem('random_number', rand(1,1000)));
})
->withProgressBar()
->migrate();
This migration will add a random number into a field called random_number
for each row of data. This will then be migrated to the destination database along with the other fields.
Removing data items
This example demonstrates how data items can be removed from a data row. You may wish to do this if you want to use its value, but not actually migrate it to the destination.
$migrator = new Migrator;
$migrator->setSource($pdoSource)
->setDestination($pdoDestination)
->setFieldsToMigrate(['id', 'email', 'name'])
->setKeyFields(['id'])
->setDataRowManipulator(function($dataRow) {
$emailDataItem = $dataRow->getDataItemByFieldName('email');
$dataRow->addDataItem(new DataItem('email_hash', md5($emailDataItem->value)));
$dataRow->removeDataItem($emailDataItem);
})
->withProgressBar()
->migrate();
This migration gets the data from the email
field in the source, creates a new email_hash
data item which contains an md5 of the email address, and then removes the original email
data item. This new email_hash
will then be migrated to the destination database along with the other fields, excluding the removed email
field.