Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/envor/laravel-database-manager
A small library for managing databases
https://github.com/envor/laravel-database-manager
laravel mariadb mysql
Last synced: 6 days ago
JSON representation
A small library for managing databases
- Host: GitHub
- URL: https://github.com/envor/laravel-database-manager
- Owner: envor
- License: mit
- Created: 2023-03-02T13:51:00.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-02-08T01:11:22.000Z (9 months ago)
- Last Synced: 2024-08-12T04:54:39.470Z (3 months ago)
- Topics: laravel, mariadb, mysql
- Language: PHP
- Homepage:
- Size: 91.8 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Abondoned! Use instead
# A small library for managing databases
Create and delete `mysql` and `sqlite` databases. Soft deletes, or "recycles" databases by default. Also it can clean up old recycled databases.
## Installation
You can install the package via composer:
```bash
composer require envor/laravel-database-manager
```
> [!WARNING]
> If you are using laravel 10, you will have to manually install doctrine/dbal
> doctrine/dbal is not a requirement for Laravel 11
```bash
composer require doctrine/dbal
```
You can publish the config file with:
```bash
php artisan vendor:publish --tag="database-manager-config"
```
This is the contents of the published config file:
```php
// config for Envor/DatabaseManager
return [
/***
* The disk where the sqlite database files will be stored.
*/
'sqlite_disk' => 'local',
/***
* Available drivers that can be managed.
*/
'managers' => [
'sqlite' => \Envor\DatabaseManager\SQLiteDatabaseManager::class,
'mysql' => \Envor\DatabaseManager\MySQLDatabaseManager::class,
]
];
```
## Usage
### Faking
This package tests things like creating and deleting physical databases so that you don't have to. You simply call `DatabaseManager::fake()` then test your application's feature logic (validation, etc)
```php
// controller
public function store(Request $request)
{
$this->validate($request->all());
$databaseManager = (new Envor\DatabaseManager)
->manage($request->database_driver)
->createDatabase($request->database_name);
if($databaseManager){
$request->user()->databases()->create([
'name' => $request->database_name,
'driver' => $request->database_driver,
]);
}
}
```
```php
// test
public function test_it_can_create_a_database(): void
{
$this->actingAs($user = User::factory()->create());
Envor\DatabaseManager\Facades\DatabaseManager::fake();
$this->post(route('database.create'), [
'database_driver' => 'sqlite',
'database_name' => 'test_database',
]);
$this->assertDatabaseHas('databases', [
'user_id' => $user->id,
'driver' => 'sqlite',
'name' => 'test_database',
]);
}
```
### SQLite
Creates an sqlite database at `storage/app/my-new-database.sqlite`
```php
$databaseManager = (new Envor\DatabaseManager)
->manage('sqlite')
->createDatabase('my-new-database');
```
Soft deletes the database and moves it to `storage/app/.trash/2023/03/02/07_04_38_my-new-database.sqlite`:
> The package appends the .sqlite file extension on its own,
> and expects managed sqlite database files to have the extension
```php
echo now()->format('Y/m/d_h_i_s_');
// 2023/3/2/7_04_38_
$databaseManager->deleteDatabase(
databaseName: 'my-new-database',
deletedAt: now(), // optional: defaults to now() (Carbon date)
);
```
Erases the database permanently from disk:
```php
// erase the database permanently from disk
$databaseManager->eraseDatabase('.trash/2023/03/02/07_04_38_my-new-database');
```
Erases all the database files in the .trash folder with mtime more than one day old:
```php
$databaseManager->cleanupOldDatabases(
daysOld: 1, // optional, defaults to one
);
```
### MYSQL
Sets the connection then creates a new database.
> [!NOTE]
> The sqlite driver to doesn't need a connection because it uses the `Illuminate\Support\Storage` helper under the hood.
```php
$databaseManager = (new Envor\DatabaseManager)
->manage('mysql')
->setConnection('any-mysql-connection')
->createDatabase('my_new_database');
```
Soft deletes the database and moves it to `deleted_2023_3_2_7_04_38_my_new_database`
```php
echo now()->format('Y_m_d_h_i_s_');
// 2023/3/2/7_04_38_
$databaseManager->deleteDatabase(
databaseName: 'my_new_database',
deletedAt: now(), // optional: defaults to now(). Uses Carbon.
);
```
No mtime for mysql, simply compares `$daysOld` against the formated time segment in the deleted name `2023_3_2_7_04_38_`.
This is done by using `Carbon::createFromFormat('Y_m_H_h_i_s_')`.
```php
$databaseManager->cleanupOldDatabases(
daysOld: 1, // optional, defaults to one
);
```
## Creating Managers
Out of the box this package includes managers for sqlite and mysql. You can create your own managers and add them to the managers array in the database-manager config.
Feel free to submit a `PR` for any additional custom managers that use standard laravel drivers, such as postgres.
## Testing
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [inmanturbo](https://github.com/envor)
- [All Contributors](../../contributors)
- Parts of this package are inspired by the `DatabaseManager` classes in [Tenancy for Laravel](https://github.com/archtechx/tenancy)
- [CONTRIBUTING](.github/CONTRIBUTING.md) was copied verbatim from [Spatie's CONTRIBUTING.md](https://github.com/spatie/.github/blob/main/CONTRIBUTING.md)
- This package was generated using [spatie/package-skeleton-laravel](https://github.com/spatie/package-skeleton-laravel)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.