Custom Fresh

---

Custom Fresh offers fine-grained control over migrations within your Laravel project, enabling you to select which tables will not be dropped when refreshing the database.

Tip

Always consider upgrading the package to the latest version, which is the most stable release.

• Installation
• Usage
  • Refreshing migrations
  • Glob patterns
  • Multiple connections
  • Dry run
  • Configuration
  • Events
  • Example
• Credits
• Support me

Installation

Install the package by using Composer:

composer require ramadan/custom-fresh

(Optional) publish the config file:

php artisan vendor:publish --tag=custom-fresh-config

Usage

After installing the package, you will see a new fresh:custom command.

Note

Since v1.2.0, the package scans your migration files more accurately, including nested folders, custom --path locations, and package migration paths registered through Laravel.

Refreshing migrations

You can exclude specific tables while refreshing the database inside your project:

php artisan fresh:custom users,foo

The same can be expressed with the --keep option (which can be combined with the positional argument):

php artisan fresh:custom --keep=users,personal_access_tokens

Important

Do not forget always to use the -h of the command to check out all supported options.

Glob patterns

Anything containing *, ?, or […] is expanded with fnmatch against the database tables, so you can preserve whole groups at once:

php artisan fresh:custom "users,oauth_*,telescope_*"

Multiple connections

Pass --database= to target a non-default connection. The connection is also forwarded to the migrate command:

php artisan fresh:custom users --database=tenant

Dry run

Use --explain to preview exactly what would happen without dropping a single table:

php artisan fresh:custom users --explain

It prints the resolved connection, the tables that would be preserved, the tables that would be dropped, and the migration rows that would be re-inserted into the migrations table.

Configuration

Publishing the config (see above) gives you config/custom-fresh.php:

return [
    'always_keep' => ['users', 'personal_access_tokens'],
    'patterns'    => ['oauth_*', 'telescope_*'],
    'confirm_in'  => ['production', 'staging'],
];

• always_keep — tables that are preserved on every run, even if you don't list them on the command line.
• patterns — glob patterns expanded against the database on every run.
• confirm_in — environments where the command must ask for confirmation. Use --force to bypass.

Events

Three events are dispatched during a run, perfect for backups, audit logs, or Slack notifications:

• Ramadan\CustomFresh\Events\RefreshingDatabase — fired before any destructive work, with the resolved preserve list and migration rows.
• Ramadan\CustomFresh\Events\TablesDropped — fired right after the drop step, with both the preserved and dropped tables.
• Ramadan\CustomFresh\Events\DatabaseRefreshed — fired after the underlying migrate finishes successfully.

Example

Credits

• Mahmoud Ramadan
• Contributors

Support me

• PayPal

License

The MIT License (MIT).