natansdj / iseed
根据现有数据库表的数据生成新的Laravel数据库种子文件。
Requires
- php: ^7.2
- illuminate/support: ~5.5.0|~5.6.0|~5.7.0|~5.8.0|^6.0
Requires (Dev)
- illuminate/filesystem: ~5.5.0|~5.6.0|~5.7.0|~5.8.0|^6.0
- laravel/framework: ~5.5.0|~5.6.0|~5.7.0|~5.8.0|^6.0
- mockery/mockery: ^1.0.0
- phpunit/phpunit: ^8.0
README
反向种子生成器(iSeed)是一个Laravel包,它提供了一个基于现有数据库表数据生成新种子文件的方法。
安装
1. 使用Composer要求
composer require orangehill/iseed
Laravel 5.3.7及以下或Laravel 4需要指定版本
composer require orangehill/iseed:2.2 # Laravel 5.3.7 and below composer require orangehill/iseed:1.1 # Laravel 4
2. 添加服务提供者(Laravel 5.4及以下)
最新版本的Laravel有自动发现和自动添加服务提供者 - 如果你使用5.4.x及以下,请记住将其添加到providers数组中的/app/config/app.php
// ... Orangehill\Iseed\IseedServiceProvider::class,
Artisan命令选项
[table_name]
必选参数,用于定义哪些表将用于种子创建。使用CSV表示法表示多个表。将为每个表生成种子文件。
示例
php artisan iseed my_table
php artisan iseed my_table,another_table
类名前缀 & 类名后缀
可选参数,可指定 Seeder 类名和文件名的前缀或后缀。如果想要为没有现有种子的表创建额外的种子,而不覆盖现有种子,这很有用。
示例
php artisan iseed my_table --classnameprefix=Customized
输出 CustomizedMyTableSeeder.php
php artisan iseed my_table,another_table --classnameprefix=Customized
输出 CustomizedMyTableSeeder.php 和 CustomizedAnotherTableSeeder.php
php artisan iseed my_table --classnamesuffix=Customizations
输出 MyTableCustomizationsSeeder.php
php artisan iseed my_table,another_table --classnamesuffix=Customizations
输出 MyTableCustomizationsSeeder.php 和 AnotherTableCustomizationsSeeder.php
force
可选参数,用于自动覆盖所需表的任何现有种子
示例:以下命令将覆盖laravel的种子目录中已存在的UsersTableSeeder.php。
php artisan iseed users --force
dumpauto
可选布尔参数,用于控制composer dump-autoload命令的执行。默认为true。
示例:将阻止composer dump-autoload的执行
php artisan iseed users --dumpauto=false
clean
可选参数,将在创建新种子类之前清理app/database/seeds/DatabaseSeeder.php。
示例
php artisan iseed users --clean
database
可选参数,指定DB连接名称。
示例
php artisan iseed users --database=mysql2
max
可选参数,定义从指定表种化的最大条目数。对于多个表,限制将应用于所有表。
示例
php artisan iseed users --max=10
chunksize
可选参数,定义每个插入查询的数据块大小。
示例
php artisan iseed users --chunksize=100
orderby
可选参数,定义用于排序结果的列,当与允许您设置所需导出数据库条目数的max参数一起使用时。
示例
artisan iseed users --max=10 --orderby=id
direction
可选参数,允许您设置排序结果的顺序;与orderby参数一起使用。
示例
artisan iseed users --max=10 --orderby=id --direction=desc
exclude
可选参数,接受以逗号分隔的列列表,您希望从导出的表中排除。对于多个表,排除将应用于所有表。
示例
php artisan iseed users --exclude=id
php artisan iseed users --exclude=id,created_at,updated_at
prerun
可选参数,将laravel事件名称分配给在种子开始之前触发的事件。如果事件监听器返回false,则种子将自动失败。可以通过传递以逗号分隔的DB名称的数组,并分别传递以逗号分隔的事件名称数组,为多个表名称分配多个preruns。
示例:以下命令将创建一个种子文件,在种子开始之前触发名为'someEvent'的事件。
php artisan iseed users --prerun=someEvent
以下示例将someUserEvent分配给users表种子,将someGroupEvent分配给groups表种子,在播种之前执行。
php artisan iseed users,groups --prerun=someUserEvent,someGroupEvent
以下示例仅将someGroupEvent分配给groups表种子,在播种之前执行。此处省略了users表prerun的值,因此users表种子将没有prerun事件分配。
php artisan iseed users,groups --prerun=,someGroupEvent
postrun
这是一个可选参数,用于在播种完成后触发一个laravel事件名。如果事件监听器返回false,则播种将被执行,但将抛出一个postrun失败异常。您可以通过传递逗号分隔的数据库名称数组,以及相应地传递逗号分隔的postrun事件名称数组,为多个表名分配多个postrun。
示例:以下命令将在播种完成后触发名为'someEvent'的事件。
php artisan iseed users --postrun=someEvent
以下示例将someUserEvent分配给users表种子,将someGroupEvent分配给groups表种子,在播种之后执行。
php artisan iseed users,groups --postrun=someUserEvent,someGroupEvent
以下示例仅将someGroupEvent分配给groups表种子,在播种之后执行。此处省略了users表postrun的值,因此users表种子将没有postrun事件分配。
php artisan iseed users,groups --postrun=,someGroupEvent
noindex
使用--noindex,可以生成一个非索引数组。此功能的用例是在需要合并两个种子文件时。
示例
php artisan iseed users --noindex
用法
要为您的users表生成种子文件,请调用:\Iseed::generateSeed('users', 'connectionName', 'numOfRows');。`connectionName`和`numOfRows`不是必需的参数。
这将在/database/seeds(对于Laravel 4为/app/database/seeds)中创建一个文件,其内容类似于以下示例
<?php // File: /database/seeds/UsersTableSeeder.php class UsersTableSeeder extends Seeder { /** * Auto generated seed file * * @return void */ public function run() { \DB::table('users')->truncate(); \DB::table('users')->insert(array ( 0 => array ( 'id' => '1', 'email' => 'admin@admin.com', 'password' => '$2y$10$tUGCkQf/0NY3w1l9sobGsudt6UngnoVXx/lUoh9ElcSOD0ERRkK9C', 'permissions' => NULL, 'activated' => '1', 'activation_code' => NULL, 'activated_at' => NULL, 'last_login' => NULL, 'persist_code' => NULL, 'reset_password_code' => NULL, 'first_name' => NULL, 'last_name' => NULL, 'created_at' => '2013-06-11 07:47:40', 'updated_at' => '2013-06-11 07:47:40', ), 1 => array ( 'id' => '2', 'email' => 'user@user.com', 'password' => '$2y$10$ImNvsMzK/BOgNSYgpjs/3OjMKMHeA9BH/hjl43EiuBuLkZGPMuZ2W', 'permissions' => NULL, 'activated' => '1', 'activation_code' => NULL, 'activated_at' => NULL, 'last_login' => '2013-06-11 07:54:57', 'persist_code' => '$2y$10$C0la8WuyqC6AU2TpUwj0I.E3Mrva8A3tuVFWxXN5u7jswRKzsYYHK', 'reset_password_code' => NULL, 'first_name' => NULL, 'last_name' => NULL, 'created_at' => '2013-06-11 07:47:40', 'updated_at' => '2013-06-11 07:54:57', ), )); } }
此命令还将更新/database/seeds/DatabaseSeeder.php(对于Laravel 4为/app/database/seeds/DatabaseSeeder.php)以包含对新生成种子类的调用。
如果您希望定义自定义iSeed模板,其中所有调用都将放置在其中,您可以在/database/seeds/DatabaseSeeder.php(对于Laravel 4为/app/database/seeds/DatabaseSeeder.php)中的任何位置使用#iseed_start和#iseed_end模板,例如
<?php // File: /database/seeds/DatabaseSeeder.php class DatabaseSeeder extends Seeder { /** * Run the database seeds. * * @return void */ public function run() { Eloquent::unguard(); if(App::environment() == "local") { throw new \Exception('Only run this from production'); } #iseed_start // here all the calls for newly generated seeds will be stored. #iseed_end } }
或者,您可以从命令行使用Artisan运行Iseed,例如php artisan iseed users。对于生成多个种子文件,应将逗号分隔的表名列表作为命令的参数发送,例如php artisan iseed users,posts,groups。
如果您尝试生成已存在的种子文件,命令将询问您是否要覆盖它。如果默认情况下您希望覆盖它,请使用Artisan命令选项--force,例如php artisan iseed users --force。
如果您希望清除iSeed模板,可以使用Artisan命令选项--clean,例如php artisan iseed users --clean。这将清除模板从app/database/seeds/DatabaseSeeder.php,在创建新的种子类之前。
您可以通过使用Artisan命令选项--database=connection_name指定用于创建新种子文件的数据库连接,例如php artisan iseed users --database=mysql2。
要限制从表导出的行数,请使用Artisan命令选项--max=number_of_rows,例如php artisan iseed users --max=10。如果您在导出多个表时使用此选项,则将应用此限制到所有表。
要(重新)播种数据库,请转到终端并运行Laravel的db:seed命令(php artisan db:seed)。
请注意,一些用户在使用大数据库表导出时遇到了问题(从包含大量记录的表中导入时出错)。通过将输入数据分成更小的元素块(每条插入语句一个块)来解决这个问题。由于在某些极端情况下,数据库表具有大量列时可能需要更改块大小值,因此iSeed的config.php文件中可配置块大小。
'chunk_size' => 500 // Maximum number of rows per insert statement