https://github.com/snowlaboratory/laravel-seeder-reset
Easily truncate tables while seeding in Laravel
https://github.com/snowlaboratory/laravel-seeder-reset
laravel laravel-package seeding truncate
Last synced: 4 months ago
JSON representation
Easily truncate tables while seeding in Laravel
- Host: GitHub
- URL: https://github.com/snowlaboratory/laravel-seeder-reset
- Owner: SnowLaboratory
- License: mit
- Created: 2023-08-13T15:34:09.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-08-13T23:38:43.000Z (about 2 years ago)
- Last Synced: 2025-06-11T06:04:27.911Z (4 months ago)
- Topics: laravel, laravel-package, seeding, truncate
- Language: PHP
- Homepage:
- Size: 127 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
- [Introduction](#introduction)
- [Installation](#installation)
- [Usage](#usage)
- [List tables to truncate](#list-tables-truncate)
- [Reset seeders](#reset-seeders)
- [Override seeder](#override-seeder)
- [Hooks](#hooks)
- [Roadmap](#roadmap)
- [Changelog](#changelog)
- [Contributing](#contributing)
- [Security Vulnerabilities](#security)
- [Code of Conduct](#code-of-conduct)
- [License](#license)
## Introduction
Prompt developers to truncate tables and delete old data before executing seeders. Great for seeding projects that prohibit duplicate data!
You can install the package via composer:
```bash
composer require snowbuilds/laravel-seeder-reset
```
## Usage
Include the `SnowBuilds\SeederReset\Concerns\SeederTruncate` trait in your seeder class. Next time you run the seeder, you will be prompted to truncate seeders. When choose to truncate, the specified models are truncated before running the seeder:
```php
use SnowBuilds\SeederReset\Concerns\SeederTruncate;
use Illuminate\Database\Seeder;
class PostSeeder extends Seeder
{
use SeederTruncate;
public $truncate = [
App\Models\User::class,
App\Models\Comment::class,
App\Models\Post::class,
];
public function run () {
//
}
}
```
### List tables to truncate
When the truncate property is not enough, you can return an array from the `getTruncate` method:
```php
use SnowBuilds\SeederReset\Concerns\SeederTruncate;
use Illuminate\Database\Seeder;
class PostSeeder extends Seeder
{
use SeederTruncate;
public function getTruncate() {
return [
App\Models\User::class,
App\Models\Comment::class,
App\Models\Post::class,
]
};
public function run () {
//
}
}
```
### Reset Seeders - Call Truncate
Sometimes you may have seeders which call other seeders. If you only want to be prompted once you can invoke the truncate method:
```php
use SnowBuilds\SeederReset\Concerns\SeederTruncate;
use Illuminate\Database\Seeder;
class DatabaseSeeder extends Seeder
{
use SeederTruncate;
public function run () {
$this->truncate([
UserSeeder::class,
RecipeSeeder::class,
]);
$this->call([
UserSeeder::class,
RecipeSeeder::class,
]);
}
}
```
### Reset Seeders - Replace Call
If you are looking for something a little more implicit, you can replace the `call` method with the `reset` method, which will reset each seeder before invoking:
```php
use SnowBuilds\SeederReset\Concerns\SeederTruncate;
use Illuminate\Database\Seeder;
class DatabaseSeeder extends Seeder
{
use SeederTruncate;
public function run () {
$this->reset([
UserSeeder::class,
RecipeSeeder::class,
]);
}
}
```
### Override Seeder
If you want to keep the same API but want to call other seeders we recommend extending `SnowBuilds\SeederReset\Seeder`:
```php
use SnowBuilds\SeederReset\Concerns\SeederTruncate;
use SnowBuilds\SeederReset\Seeder;
class DatabaseSeeder extends Seeder
{
public function run () {
$this->call([
UserSeeder::class,
RecipeSeeder::class,
]);
}
}
```
### Hooks
Sometimes truncating is not enough, and you need delete specific rows before seeding. We included `beforeTruncate` and `afterTruncate` hooks which can be used to delete whatever you want. If the hook fails the operation will rollback.
> **Important**
> The truncate operation is not performed in a transaction due to MySql limitations. If a hook fails, tables that were truncated will remain empty.
```php
use SnowBuilds\SeederReset\Concerns\SeederTruncate;
use SnowBuilds\SeederReset\Seeder;
class DatabaseSeeder extends Seeder
{
public function beforeTruncate()
{
User::moderators()->delete();
User::customers()->delete();
}
public function run () {
$this->call([
UserSeeder::class,
RecipeSeeder::class,
]);
}
}
```
## Roadmap
- [x] Truncate tables from list of models
- [x] Truncate using table names
- [x] Delete data using queries
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
If you discover any security-related issues, please email dev@snowlaboratory.com instead of using the issue tracker.
In order to ensure that the Laravel community is welcoming to all, please review and abide by the [Code of Conduct](https://laravel.com/docs/contributions#code-of-conduct).
- [Snow Labs](https://github.com/snowbuilds)
- [All Contributors](../../contributors)
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.