根据现有数据库表的数据生成一个新的 Laravel 数据库种子文件。

1.2 2019-06-29 06:22 UTC

This package is auto-updated.

Last update: 2024-09-29 05:09:02 UTC


README

逆种子生成器(iSeed) 是一个 Laravel 包,提供了一种基于现有数据库表数据生成新种子文件的方法。

Build Status Latest Stable Version Total Downloads Analytics

安装

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 及以下版本,请记住将其添加到 /app/config/app.php 中的 providers 数组中

// ...
Orangehill\Iseed\IseedServiceProvider::class,

Artisan 命令选项

[表名]

必填参数,用于定义将用于种子创建的表。使用 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

强制

可选参数,用于自动覆盖所需表的任何现有种子。

示例:以下命令将在 Laravel 的种子目录中如果存在的情况下覆盖 UsersTableSeeder.php

php artisan iseed users --force

dumpauto

可选布尔参数,用于控制 composer dump-autoload 命令的执行。默认为 true。

示例:以下命令将阻止 composer dump-autoload 执行。

php artisan iseed users --dumpauto=false

清理

可选参数,在创建新的种子类之前将清理 app/database/seeds/DatabaseSeeder.php

示例

php artisan iseed users --clean

数据库

可选参数,指定 DB 连接名称。

示例

php artisan iseed users --database=mysql2

最大值

可选参数,定义从指定表中种入的最大条目数。在多个表的情况下,限制将应用于所有表。

示例

php artisan iseed users --max=10

数据块大小

可选参数,定义每个插入查询的数据块大小。

示例

php artisan iseed users --chunksize=100

排除

可选参数,接受逗号分隔的列列表,您希望从导出的表中排除。在多个表的情况下,排除将应用于所有表。

示例

php artisan iseed users --exclude=id
php artisan iseed users --exclude=id,created_at,updated_at

预运行

可选参数,将 laravel 事件名称分配给在播种之前要触发的事件。如果事件监听器返回 false,种子将自动失败。您可以通过传递逗号分隔的 DB 名称数组,并为每个 DB 名称传递逗号分隔的事件名称数组来为多个表名分配多个预运行。

示例:以下命令将创建一个在播种之前触发名为 'someEvent' 事件的种子文件。

php artisan iseed users --prerun=someEvent

以下示例将 someUserEvent 分配给 users 表种子,并将 someGroupEvent 分配给 groups 表种子,在播种之前执行。

php artisan iseed users,groups --prerun=someUserEvent,someGroupEvent

以下示例仅将 someGroupEvent 分配给 groups 表种子,在播种之前执行。这里省略了 users 表的预运行值,因此 users 表种子没有分配预运行事件。

php artisan iseed users,groups --prerun=,someGroupEvent

后运行

可选参数,用于在数据填充后触发一个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

如果您尝试生成已经存在的种子文件,命令将询问您是否要覆盖它。如果您希望默认使用--force Artisan命令选项来覆盖它,例如: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