envor/laravel-schema-macros

Some helpful (database level) macros for laravel's schema builder. Requires Laravel 11.

v1.1.6 2024-07-30 17:00 UTC

Requires

• php: ^8.2
• illuminate/contracts: ^11.0
• spatie/laravel-package-tools: ^1.16.2

Requires (Dev)

• larastan/larastan: *
• laravel/pint: *
• nunomaduro/collision: *
• orchestra/testbench: ^9.0
• pestphp/pest: ^2.33
• pestphp/pest-plugin-arch: ^2.7
• pestphp/pest-plugin-laravel: ^2.2
• spatie/docker: ^1.12

MIT

• inmanturbo

• laravel
• envor
• laravel-schema-macros

README

Some helpful (database level) macros for laravel's schema builder. Requires Laravel 11.

Installation

You can install the package via composer:

composer require envor/laravel-schema-macros

Usage

databaseExists()
createDatabaseIfNotExists()
trashDatabase()
emptyTrash()
copyTable()

#databaseExists()

The databaseExists() method determines if the given database exists:

use Illuminate\Support\Facades\Schema;

$database = database_path('my-new-database.sqlite');

Schema::connection('sqlite')->databaseExists($database);

// false

touch($database);

Schema::connection('sqlite')->databaseExists($database);

// true

Schema::connection('mysql')->databaseExists('abc');

// false

Schema::connection('mysql')->createDatabase('abc');


Schema::connection('mysql')->databaseExists('abc');

// true

#createDatabaseIfNotExists()

The createDatabaseIfNotExists() method creates the given database if it does not exist:

use Illuminate\Support\Facades\Schema;

$default = database_path('database.sqlite');

touch($default);

Schema::connection('sqlite')->createDatabaseIfNotExists($default);

// false

Schema::connection('sqlite')->createDatabaseIfNotExists(database_path('another_database'));

// true


Schema::connection('mysql')->createDatabaseIfNotExists('brand_new_database');

// true

The createDatabaseIfNotExists() method will also create sqlite database files recursively:

$newFile = database_path('/new/directories/will/be/created/recursively/db.sqlite');

Schema::connection('sqlite')->createDatabaseIfNotExists($newFile);

// true

#trashDatabase()

The trashDatabase() method will move the database to the trash and timestamp it:

Tip

Sqlite databases are moved to a .trash directory on the local storage disk by default.
You may optionally pass the name of another storage disk as a second argument.

$database = database_path('database.sqlite');

Schema::connection('sqlite')->trashDatabase($database);

// /home/forge/mysite.com/storage/app/.trash/2024-02-04_06-29-11_database.sqlite

Schema::connection('mariadb')->trashDatabase('schema_demo');

// trashed_2024-02-04_06-44-42_schema_demo

#emptyTrash()

The emptyTrash() method will erase all trashed databases from disk which are reachable from the current connection:

Tip

To only permanently erase databases trashed later than a given age and keep those which are newer,
you may pass the maximum age in days for the databases you want to keep.

$database = database_path('database.sqlite');

Schema::connection('sqlite')->trashDatabase($database);

// /home/forge/mysite.com/storage/app/.trash/2024-02-04_06-29-11_database.sqlite

Schema::connection('sqlite')->emptyTrash();

// 1

Schema::connection('mysql')->trashDatabase('schema_demo');

// trashed_2024-02-04_06-44-42_schema_demo

Schema::connection('mysql')->emptyTrash();

// 1

#copyTable()

The copyTable() method will copy the given table:

$database = database_path('database.sqlite');

Schema::connection('sqlite')->copyTable('users');

// users_copy

Schema::connection('sqlite')->copyTable('users', 'users_snapshot_1');

// users_snapshot_1

Testing

Important

Tests use spatie/docker for testing against various database servers.
Docker is required for running tests locally!

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• inmanturbo
• All Contributors

License

The MIT License (MIT). Please see License File for more information.