PHPackages cswni/iseed - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Database & ORM](/categories/database) 4. / 5. cswni/iseed ActiveLibrary[Database & ORM](/categories/database) cswni/iseed =========== Generate a new Laravel database seed file based on data from the existing database table. v13.1(1mo ago)0220BSD-2-ClausePHPPHP ^7.2|^8.0.2 Since Mar 3Pushed 1mo ago1 watchersCompare [ Source](https://github.com/cswni/iseed)[ Packagist](https://packagist.org/packages/cswni/iseed)[ RSS](/packages/cswni-iseed/feed)WikiDiscussions main Synced 1mo ago READMEChangelogDependencies (10)Versions (3)Used By (0) **Inverse seed generator (iSeed)** is a Laravel package that provides a method to generate a new seed file based on data from the existing database table. Installation ------------ [](#installation) ### 1. Require with [Composer](https://getcomposer.org/) [](#1-require-with-composer) ``` composer require cswni/iseed ``` Artisan command options from original package --------------------------------------------- [](#artisan-command-options-from-original-package) ### \[table\_name\] [](#table_name) Optional. This parameter defines which table(s) will be used for seed creation. If provided: Use CSV notation to list one or more table names. A seed file will be generated for each specified table. Examples Generate a seed file for a single table: ``` php artisan iseed my_table ``` Example Generate seed files for multiple tables: ``` php artisan iseed my_table,another_table ``` If omitted: The command automatically retrieves all table names from your database and generates seeders for every table. Examples: ``` php artisan iseed ``` ### classnameprefix & classnamesuffix [](#classnameprefix--classnamesuffix) Optionally specify a prefix or suffix for the Seeder class name and file name. This is useful if you want to create an additional seed for a table that has an existing seed without overwriting the existing one. Examples: ``` php artisan iseed my_table --classnameprefix=Customized ``` outputs CustomizedMyTableSeeder.php ``` php artisan iseed my_table,another_table --classnameprefix=Customized ``` outputs CustomizedMyTableSeeder.php and CustomizedAnotherTableSeeder.php ``` php artisan iseed my_table --classnamesuffix=Customizations ``` outputs MyTableCustomizationsSeeder.php ``` php artisan iseed my_table,another_table --classnamesuffix=Customizations ``` outputs MyTableCustomizationsSeeder.php and AnotherTableCustomizationsSeeder.php ### force [](#force) Optional parameter which is used to automatically overwrite any existing seeds for desired tables Example: The following command will overwrite `UsersTableSeeder.php` if it already exists in laravel's seeds directory. ``` php artisan iseed users --force ``` ### dumpauto [](#dumpauto) Optional boolean parameter that controls the execution of `composer dump-autoload` command. Defaults to true. Example that will stop `composer dump-autoload` from execution: ``` php artisan iseed users --dumpauto=false ``` ### clean [](#clean) Optional parameter which will clean `app/database/seeds/DatabaseSeeder.php` before creating new seed class. Example: ``` php artisan iseed users --clean ``` ### database [](#database) Optional parameter which specifies the DB connection name. Example: ``` php artisan iseed users --database=mysql2 ``` ### max [](#max) Optional parameter which defines the maximum number of entries seeded from a specified table. In case of multiple tables, limit will be applied to all of them. Example: ``` php artisan iseed users --max=10 ``` ### chunksize [](#chunksize) Optional parameter which defines the size of data chunks for each insert query. Example: ``` php artisan iseed users --chunksize=100 ``` ### orderby [](#orderby) Optional parameter which defines the column which will be used to order the results by, when used in conjunction with the max parameter that allows you to set the desired number of exported database entries. Example: ``` artisan iseed users --max=10 --orderby=id ``` ### direction [](#direction) Optional parameter which allows you to set the direction of the ordering of results; used in conjuction with orderby parameter. Example: ``` artisan iseed users --max=10 --orderby=id --direction=desc ``` ### exclude [](#exclude) Optional parameter which accepts comma separated list of columns that you'd like to exclude from tables that are being exported. In case of multiple tables, exclusion will be applied to all of them. Example: ``` php artisan iseed users --exclude=id php artisan iseed users --exclude=id,created_at,updated_at ``` ### prerun [](#prerun) Optional parameter which assigns a laravel event name to be fired before seeding takes place. If an event listener returns `false`, seed will fail automatically. You can assign multiple preruns for multiple table names by passing an array of comma separated DB names and respectively passing a comma separated array of prerun event names. Example: The following command will make a seed file which will fire an event named 'someEvent' before seeding takes place. ``` php artisan iseed users --prerun=someEvent ``` The following example will assign `someUserEvent` to `users` table seed, and `someGroupEvent` to `groups` table seed, to be executed before seeding. ``` php artisan iseed users,groups --prerun=someUserEvent,someGroupEvent ``` The following example will only assign a `someGroupEvent` to `groups` table seed, to be executed before seeding. Value for the users table prerun was omitted here, so `users` table seed will have no prerun event assigned. ``` php artisan iseed users,groups --prerun=,someGroupEvent ``` ### postrun [](#postrun) Optional parameter which assigns a laravel event name to be fired after seeding takes place. If an event listener returns `false`, seed will be executed, but an exception will be thrown that the postrun failed. You can assign multiple postruns for multiple table names by passing an array of comma separated DB names and respectively passing a comma separated array of postrun event names. Example: The following command will make a seed file which will fire an event named 'someEvent' after seeding was completed. ``` php artisan iseed users --postrun=someEvent ``` The following example will assign `someUserEvent` to `users` table seed, and `someGroupEvent` to `groups` table seed, to be executed after seeding. ``` php artisan iseed users,groups --postrun=someUserEvent,someGroupEvent ``` The following example will only assign a `someGroupEvent` to `groups` table seed, to be executed after seeding. Value for the users table postrun was omitted here, so `users` table seed will have no postrun event assigned. ``` php artisan iseed users,groups --postrun=,someGroupEvent ``` ### noindex [](#noindex) By using --noindex the seed can be generated as a non-indexed array. The use case for this feature is when you need to merge two seed files. Example: ``` php artisan iseed users --noindex ``` ### where [](#where) Optional parameter which allows you to specify a SQL WHERE clause to filter the rows that will be included in the seed file. The WHERE clause should be provided as a string and will be applied directly to the SQL query. Examples: ``` # Only seed users with example.com emails php artisan iseed users --where="email LIKE '%@example.com'" # Seed active users created after a specific date php artisan iseed users --where="active = 1 AND created_at > '2024-01-01'" # Combine with other options php artisan iseed users --where="role = 'admin'" --max=10 --orderby=created_at --direction=desc ``` **Note**: When using complex WHERE clauses with special characters or spaces, make sure to properly escape and quote the condition string according to your shell's requirements. Usage ----- [](#usage) To generate a seed file for your users table simply call: `\Iseed::generateSeed('users', 'connectionName', 'numOfRows');`. `connectionName` and `numOfRows` are not required arguments. This will create a file inside a `/database/seeds` (`/app/database/seeds` for Laravel 4), with the contents similar to following example: ```