afoolzh/iseed

为 Laravel 数据库生成迁移文件。

2.0 2023-03-03 13:37 UTC

This package is auto-updated.

Last update: 2024-09-30 02:07:59 UTC


README

为 Laravel 数据库生成迁移文件。

安装

1. 使用 Composer 需求

composer require afoolzh/iseed

Artisan 命令选项

[table_name]

必填参数,定义了哪些表将用于种子创建。使用 CSV 表示法为多个表。将为每个表生成种子文件。

示例

php artisan iseed my_table
php artisan iseed my_table,another_table

classnameprefix & classnamesuffix

可选地指定 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 的 seeds 目录中已存在的 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

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

示例

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 名称数组,并分别传递逗号分隔的事件名称数组,为多个表名分配多个 prerun。

示例:以下命令将创建一个种子文件,该文件在种子之前将触发名为 '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');connectionNamenumOfRows 不是必需参数。

这将在 /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