README

This package provides a handy way to work with production seeding in Laravel.

Consider you have database tables you want to keep in-sync across environments. For instance some configuration table where you need to ensure a fixed number of rows, but not necessarily overwrite the values.

Laravel Production Seeding helps you achieve this in a styleful manner!

Inspired by Edward Coleridge Smith's Laracon talk on the subject: How to avoid database migration hell (YouTube)

Makeable is web- and mobile app agency located in Aarhus, Denmark.

Install

You can install this package via composer:

composer require makeabledk/laravel-production-seeding

Usage

Create a Laravel seeder as you normally would. Next implement the SyncStrategy, and apply the fixed rows onto your model from the run method.

Finally you can run the seeder as part of your deployment process to ensure all environments implements the same basic blueprint.

Examples

Syncing a configuration table

Sync a database configuration table with an array-blueprint. Note how we hardcode the service-id, but allow for separate keys.

class ConfigSeeder extends Seeder
{
    use \Makeable\ProductionSeeding\SyncStrategy;
    
    public $rows = [
        [
            'key' => 'some_service_id',
            'value' => '123456' 
        ],
        [
            'key' => 'some_service_public_key',
        ],
        [
            'key' => 'some_service_private_key',
        ],
    ];
    
    public function run()
    {
        $this->apply($this->rows, Config::class, 'key');
    }
}

Results in

| id | key                      | value  |
|----|--------------------------|--------|
| 1  | some_service_id          | 123456 |
| 2  | some_service_public_key  | NULL   |
| 3  | some_service_private_key | NULL   |

Syncing rows with an order

Sometimes you may want to have a fixed list of items and then apply a certain order in the database.

This can easily be achieved with a AppendsSortOrder trait. Re-arranging the array items will change the order value in the database, but leave the id's intact.

class LanguageSeeder extends Seeder
{
    use \Makeable\ProductionSeeding\SyncStrategy,
        \Makeable\ProductionSeeding\AppendsSortOrder;
    
    protected $sortKey = 'order'; // default if omitted
    
    public $rows = [
        [
            'code' => 'en_GB',
            'name' => 'English (GB)',
        ],
        [
            'code' => 'en_US',
            'name' => 'English (US)',
        ],
        [
            'code' => 'da_DK',
            'name' => 'Danish',
        ],
    ];
    
    public function run()
    {
        $this->apply($this->rows, LanguagesModel::class, 'code');
    }
}

Results in...

| id | code  | name         | order |
|----|-------|--------------|-------|
| 1  | en_GB | English (GB) | 1     |
| 2  | en_US | English (US) | 2     |
| 3  | da_DK | Danish       | 3     |

You could then re-arrange the array and run the seeder again. Then you could have...

| id | code  | name         | order |
|----|-------|--------------|-------|
| 1  | en_GB | English (GB) | 2     |
| 2  | en_US | English (US) | 1     |
| 3  | da_DK | Danish       | 3     |

Pretty cool, right?

Appending a configuration table

Using previous sync-strategy, any rows manually added to the database table would be deleted on seeding.

If this is not the behaviour you wish for, you may instead use AppendStrategy which would only append the new rows.

Let's assume our previous config table has an existing row:

| id | key                      | value      |
|----|--------------------------|------------|
| 1  | github_username          | makeabledk |

Next we setup our ConfigSeeder with an AppendStrategy:

class ConfigSeeder extends Seeder
{
    use \Makeable\ProductionSeeding\AppendStrategy;
    
    public $rows = [
        [
            'key' => 'some_service_id',
            'value' => '123456' 
        ],
        [
            'key' => 'some_service_public_key',
        ],
        [
            'key' => 'some_service_private_key',
        ],
    ];
    
    public function run()
    {
        $this->apply($this->rows, Config::class, 'key');
    }
}

Now our table would have the existing row plus the 3 new ones:

| id | key                      | value      |
|----|--------------------------|------------|
| 1  | github_username          | makeabledk |
| 2  | some_service_id          | 123456     |
| 3  | some_service_public_key  | NULL       |
| 4  | some_service_private_key | NULL       |

Change log

Please see CHANGELOG for more information what has changed recently.

Testing

You can run the tests with:

composer test

Contributing

We are happy to receive pull requests for additional functionality. Please see CONTRIBUTING for details.

Credits

License

Attribution-ShareAlike 4.0 International. Please see License File for more information.

makeabledk / laravel-production-seeding

Maintainers

Details