xvlady / iseed
基于现有数据库表数据生成新的Laravel数据库种子文件。
Requires
- php: >=5.4.0
Requires (Dev)
- illuminate/filesystem: 5.x
- mockery/mockery: dev-master
This package is not auto-updated.
Last update: 2022-03-14 02:21:41 UTC
README
反向种子生成器(iSeed) 是一个Laravel包,提供了一种根据现有数据库表数据生成新种子文件的方法。
安装
-
对于Laravel 5安装,编辑项目的
composer.json
文件,以要求xvlady/iseed
。"require": { "xvlady/iseed": "dev-master" }
如果希望在Laravel 4上安装,应要求1.1版本
"require": {
"orangehill/iseed": "1.1"
}
-
通过打开
app/config/app.php
文件,并在providers
数组中添加新项目来添加服务提供者。'Orangehill\Iseed\IseedServiceProvider'
-
通过CLI更新Composer
composer update
Artisan命令选项
[table_name]
必填参数,用于定义哪些表将用于种子创建。使用CSV表示法表示多个表。将为每个表生成种子文件。
示例
php artisan iseed my_table
php artisan iseed my_table,another_table
force
可选参数,用于自动覆盖所需表中的任何现有种子
示例:以下命令将覆盖laravel的种子目录中已存在的 UsersTableSeeder.php
。
php artisan iseed users --force
clean
可选参数,将在创建新种子类之前清理 app/database/seeds/DatabaseSeeder.php
。
示例
php artisan iseed users --clean
database
可选参数,指定数据库连接名称。
示例
php artisan iseed users --database=mysql2
max
可选参数,定义从指定表种入的最大条目数。对于多个表,限制将应用于所有表。
示例
artisan iseed users --max=10
prerun
可选参数,将Laravel事件名称分配给在播种之前要触发的事件。如果事件监听器返回 false
,则种子将自动失败。您可以通过传递以逗号分隔的DB名称的数组并分别传递以逗号分隔的prerun事件名称的数组,为多个表名称分配多个prerun。
示例:以下命令将生成一个种子文件,该文件在播种之前将触发名为 'someEvent' 的事件。
artisan iseed users --prerun=someEvent
以下示例将 someUserEvent
分配给 users
表种子,将 someGroupEvent
分配给 groups
表种子,并在播种之前执行。
artisan iseed users,groups --prerun=someUserEvent,someGroupEvent
以下示例仅将 someGroupEvent
分配给 groups
表种子,并在播种之前执行。在此处省略了users表的prerun值,因此 users
表种子没有分配prerun事件。
artisan iseed users,groups --prerun=,someGroupEvent
postrun
可选参数,用于在播种完成后触发一个laravel事件名。如果事件监听器返回false
,则播种将执行,但会抛出播种后运行失败的异常。您可以通过传递用逗号分隔的数据库名称数组,并分别传递用逗号分隔的事件名称数组来为多个表名分配多个postrun。
示例:以下命令将创建一个播种文件,播种完成后将触发名为'someEvent'的事件。
artisan iseed users --postrun=someEvent
以下示例将someUserEvent
分配给users
表的播种,将someGroupEvent
分配给groups
表的播种,以便在播种后执行。
artisan iseed users,groups --postrun=someUserEvent,someGroupEvent
以下示例将仅将someGroupEvent
分配给groups
表的播种,以便在播种后执行。这里省略了用户表postrun的值,因此users
表的播种将不会分配postrun事件。
artisan iseed users,groups --postrun=,someGroupEvent
使用方法
要为您用户表生成一个播种文件,只需调用:\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