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

1.1.1 2023-02-28 10:02 UTC

This package is auto-updated.

Last update: 2024-09-28 13:30:25 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 及以下版本,请记住将其添加到 providers 数组中的 /app/config/app.php

// ...
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

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

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

示例

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 为多个表名称分配多个 preruns。

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

php artisan iseed users --prerun=someEvent

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

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

以下示例将仅在生成前将一个 someGroupEvent 分配给 groups 表种子,以便在生成前执行。这里省略了用户表的预运行值,因此 users 表种子将不会分配预运行事件。

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

生成后

这是一个可选参数,它将一个 Laravel 事件名称分配给生成完成后要触发的事件。如果事件监听器返回 false,则种子将被执行,但会抛出一个异常,指出生成后失败。您可以通过传递以逗号分隔的数据库名称数组和相应地传递以逗号分隔的生成后事件名称数组,为多个表名分配多个生成后事件。

示例:以下命令将创建一个种子文件,在生成完成后触发名为 'someEvent' 的事件。

php artisan iseed users --postrun=someEvent

以下示例将 someUserEvent 分配给 users 表种子,并将 someGroupEvent 分配给 groups 表种子,以便在生成后执行。

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

以下示例将仅在生成后将 someGroupEvent 分配给 groups 表种子,以便在生成后执行。这里省略了用户表的生成后值,因此 users 表种子将不会分配生成后事件。

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

noindex

使用 --noindex 选项,种子可以生成一个非索引数组。此功能的用例是当您需要合并两个种子文件时。

示例

php artisan iseed users --noindex

用法

要为您用户的表生成种子文件,只需调用:\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

如果您尝试生成已存在的种子文件,则命令将询问您是否要覆盖它。如果您希望默认覆盖它,请使用 --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)。

请注意,一些用户遇到了大型数据库表导出的问题(从包含许多记录的表中种子的错误)。通过将输入数据分成每个插入语句的元素的小块来解决此问题。由于您可能需要在 DB 表具有大量列的极端情况下更改块大小值,因此块大小可以在 iSeed 的 config.php 文件中配置

'chunk_size' => 500 // Maximum number of rows per insert statement