https://github.com/capsulescodes/laravel-population
Laravel command to manage your database in real time
https://github.com/capsulescodes/laravel-population
laravel migration population
Last synced: 4 months ago
JSON representation
Laravel command to manage your database in real time
- Host: GitHub
- URL: https://github.com/capsulescodes/laravel-population
- Owner: capsulescodes
- License: mit
- Created: 2023-10-05T10:59:35.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-06-01T22:28:08.000Z (4 months ago)
- Last Synced: 2025-06-02T08:34:30.105Z (4 months ago)
- Topics: laravel, migration, population
- Language: PHP
- Homepage:
- Size: 174 KB
- Stars: 33
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
Simplify database migrations and ensure consistency with your database tables effortlessly.
Laravel Population package provides a set of commands that parses your migrations and detects any disparities between them and your database tables. If differences are found, a wizard is triggered to help you migrate and seed the new tables with converted records.
Typically, your `users` table might have a `name` column, but you need two separate columns : `first_name` and `last_name`. However, your database is already full of records.
[This article](https://capsules.codes/en/blog/fyi/en-fyi-modify-tables-and-records-with-laravel-population) provides an in-depth exploration of the package.
> [!WARNING]
> We recommend exercising caution when using this package on production.
## Installation
```bash
composer require --dev capsulescodes/laravel-population
```
## Usage
Let's say, your current `users` table have a `name` column, but you need two separate columns : `first_name` and `last_name`. First, modify your migration :
```diff
...
Schema::create( 'users', function( Blueprint $table )
{
$table->id();
- $table->string( 'name' );
+ $table->string( 'first_name' );
+ $table->string( 'last_name' );
} );
...
```
Now unleash the magic :
```bash
php artisan populate
```
The populate command will display the changes made in the migration files and ask for confirmation.
```bash
INFO Migration changes :
create_users_table .......................................................................................................................... DONE
INFO Table 'users' has changes.
⇂ delete column : 'name' => type : varchar
⇂ create column : 'first_name' => type : varchar
⇂ create column : 'last_name' => type : varchar
┌ Do you want to proceed on populating the 'users' table? ─────┐
│ Yes │
└──────────────────────────────────────────────────────────────┘
┌ How would you like to convert the records for the column 'first_name' of type 'varchar'? 'fn( $attribute, $model ) => $attribute' ┐
│ fn( $a, $b ) => explode( ' ', $b->name )[ 0 ] │
└────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
┌ How would you like to convert the records for the column 'last_name' of type 'varchar'? 'fn( $attribute, $model ) => $attribute' ┐
│ fn( $a, $b ) => explode( ' ', $b->name )[ 1 ] │
└───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
INFO Population succeeded.
```
Your `users` table has been updated and seeded with converted records. Simple.
```diff
App\Models\User
{
id: 1,
- name: "Louie Wolff",
+ first_name: "Louie",
+ last_name: "Wolff",
},
App\Models\User
{
id: 2,
- name: "Holly Waters",
+ first_name: "Holly",
+ last_name: "Waters",
},
App\Models\User
{
id: 3,
- name: "Colton Mueller",
+ first_name: "Colton",
+ last_name: "Mueller",
},
...
```
```bash
# The populator will ask you the formula to convert existing records
'fn( $attribute, $model ) => $attribute'
# The inital representation of the parameters
$attribute = 'name'
$model = '$user'
# But you can decide to use any Laravel helpers instead
'fn() => fake()->firstName()'
```
If you want to rollback the latest population :
```bash
php artisan populate:rollback
```
```bash
WARN The rollback command will only set back the latest copy of your database(s). You'll have to modify your migrations and models manually.
INFO Database dump successfully reloaded.
```
## Options
```bash
php artisan populate --path={path-to-migrations-to-populate} --realpath={true|false} --database={database-name} --daptabase={database-name}
```
- Laravel Population supports SQLite, MySQL, MariaDB and PostgreSQL.
- Laravel Population can work with multiple databases.
- Laravel Population supports both anonymous and named migrations classes.
- Laravel Population supports multiple table creation in migration files.
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
In order to run MySQL tests, credentials have to be configured in the intended TestCases.
## Credits
[Capsules Codes](https://github.com/capsulescodes)
## License
[MIT](https://choosealicense.com/licenses/mit/)