iSeed

https://github.com/orangehill/iseed
Admin
iSeed is a Laravel package that generates seed files based on existing database table data, allowing...
Tokens:8,836
Snippets:86
Trust Score:6.2
License:BSD-2-Clause
Update:9 months ago
Show doc for...
Tokens:
Raw
### Updated DatabaseSeeder.php Example

Source: https://context7.com/orangehill/iseed/llms.txt

An example of how `DatabaseSeeder.php` is updated when generating all seeders. It includes calls to the generated seeders, typically enclosed within `#iseed_start` and `#iseed_end` comments.

```php
<?php

class DatabaseSeeder extends Seeder {
    public function run()
    {
        #iseed_start
        $this->call(UsersTableSeeder::class);
        $this->call(PostsTableSeeder::class);
        $this->call(CommentsTableSeeder::class);
        #iseed_end
    }
}
```

--------------------------------

### Install iSeed with Composer

Source: https://github.com/orangehill/iseed/blob/master/README.md

This snippet shows how to install the iSeed Laravel package using Composer. It includes commands for the latest version and specific versions for older Laravel frameworks (5.3.7 and below, and Laravel 4).

```sh
composer require orangehill/iseed
```

```sh
composer require orangehill/iseed:2.2 # Laravel 5.3.7 and below
composer require orangehill/iseed:1.1 # Laravel 4
```

--------------------------------

### Install iSeed Package (Composer)

Source: https://context7.com/orangehill/iseed/llms.txt

This command installs the latest version of the iSeed package using Composer, making it available for Laravel 5.5 and above. For older Laravel versions, manual registration in `config/app.php` is required.

```bash
composer require orangehill/iseed
```

--------------------------------

### Specify Database Connection

Source: https://github.com/orangehill/iseed/blob/master/README.md

This command allows you to specify which database connection to use for generating the seed files, useful for multi-database setups.

```sh
php artisan iseed users --database=mysql2
```

--------------------------------

### PHP Seeder Class Example

Source: https://context7.com/orangehill/iseed/llms.txt

An example of a generated seeder class for the 'users' table. It uses `DB::table()->insert()` to populate the table with data, including an array of records with their respective columns and values.

```php
<?php

class UsersTableSeeder extends Seeder {
    public function run()
    {
        \DB::table('users')->insert(array (
            0 => array (
                'id' => '1',
                'email' => 'admin@example.com',
                'password' => '$2y$10$encrypted_password',
                'name' => 'Admin User',
                'created_at' => '2024-01-15 10:30:00',
                'updated_at' => '2024-01-15 10:30:00',
            ),
            1 => array (
                'id' => '2',
                'email' => 'user@example.com',
                'password' => '$2y$10$another_encrypted_password',
                'name' => 'Regular User',
                'created_at' => '2024-01-16 14:22:00',
                'updated_at' => '2024-01-16 14:22:00',
            ),
        ));
    }
}
```

--------------------------------

### Generate Seeders for Multiple Tables (Artisan)

Source: https://context7.com/orangehill/iseed/llms.txt

This command generates seeder files for a comma-separated list of tables. For example, running `php artisan iseed users,posts,comments` will create `UsersTableSeeder.php`, `PostsTableSeeder.php`, and `CommentsTableSeeder.php`.

```bash
php artisan iseed users,posts,comments
```

--------------------------------

### Add Pre-run and Post-run Events to Seeds

Source: https://context7.com/orangehill/iseed/llms.txt

Execute custom Laravel events either before or after the seeding process for specific tables. This allows for custom logic, setup, or cleanup operations related to seeding.

```bash
# Fire event before seeding
php artisan iseed users --prerun=PrepareUserSeed

# Fire event after seeding
php artisan iseed users --postrun=UserSeededEvent

# Multiple tables with different events
php artisan iseed users,groups --prerun=PrepareUserSeed,PrepareGroupSeed --postrun=UserSeeded,GroupSeeded
```

```php
<?php

class UsersTableSeeder extends Seeder {
    public function run()
    {
        // Pre-run event check
        $response = Event::until(new PrepareUserSeed());
        if ($response === false) {
            throw new Exception("Prerun event failed, seed wasn't executed!");
        }

        \DB::table('users')->insert(array (
            // ... data ...
        ));

        // Post-run event check
        $response = Event::until(new UserSeededEvent());
        if ($response === false) {
            throw new Exception("Seed was executed but the postrun event failed!");
        }
    }
}
```

--------------------------------

### PHP Seeder Class Excluding Columns Example

Source: https://context7.com/orangehill/iseed/llms.txt

An example seeder class where specific columns (e.g., 'id', 'created_at', 'updated_at') have been excluded from the export. The `DB::table('users')->insert()` statement only includes the non-excluded columns.

```php
<?php

class UsersTableSeeder extends Seeder {
    public function run()
    {
        \DB::table('users')->insert(array (
            0 => array (
                'email' => 'admin@example.com',
                'password' => '$2y$10$encrypted',
                'name' => 'Admin User',
                // id, created_at, updated_at excluded
            ),
        ));
    }
}
```

--------------------------------

### Generate Seed File using Helper Function (PHP)

Source: https://github.com/orangehill/iseed/blob/master/README.md

Generates a seed file for a specified table. Accepts optional connection name and number of rows. Creates the seed file in the /database/seeds directory and updates DatabaseSeeder.php.

```PHP
<?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',
            ),
        ));
    }

}
```

--------------------------------

### Add iSeed Service Provider (Laravel 5.4 and below)

Source: https://github.com/orangehill/iseed/blob/master/README.md

For Laravel versions 5.4 and below, this code demonstrates how to manually add the iSeed Service Provider to the `app.php` configuration file. Newer Laravel versions handle this automatically via package discovery.

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

--------------------------------

### Run iSeed via Artisan Command (CLI)

Source: https://github.com/orangehill/iseed/blob/master/README.md

Executes iseed functionality directly from the command line. Supports generating seeds for multiple tables, forcing overwrites, cleaning templates, specifying database connections, and limiting the number of rows.

```Shell
php artisan iseed users
php artisan iseed users,posts,groups
php artisan iseed users --force
php artisan iseed users --clean
php artisan iseed users --database=mysql2
php artisan iseed users --max=10
```

--------------------------------

### Clean DatabaseSeeder Before Seeding

Source: https://github.com/orangehill/iseed/blob/master/README.md

This command cleans the `app/database/seeds/DatabaseSeeder.php` file before creating new seed classes, ensuring a fresh state.

```sh
php artisan iseed users --clean
```

--------------------------------

### Assign Prerun Event for Seeding

Source: https://github.com/orangehill/iseed/blob/master/README.md

The --prerun option allows you to specify a Laravel event to be fired before a seed operation. If the event listener returns false, the seed will fail. This can be used for single tables or multiple tables by passing comma-separated lists.

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

--------------------------------

### Generate Seeds for Multiple Tables

Source: https://github.com/orangehill/iseed/blob/master/README.md

This command generates separate seed files for multiple specified database tables by listing them using CSV notation.

```sh
php artisan iseed my_table,another_table
```

--------------------------------

### Generate Seeder for a Single Table (Artisan)

Source: https://context7.com/orangehill/iseed/llms.txt

This Artisan command generates a seeder file (e.g., `UsersTableSeeder.php`) from the specified database table (e.g., 'users'). The generated file contains the existing data from the table, ready to be used for seeding.

```bash
php artisan iseed users
```

--------------------------------

### Run Generated Database Seeds

Source: https://context7.com/orangehill/iseed/llms.txt

Execute the seeders that have been generated by the Iseed package to populate your database. This can be done for all seeds, specific seed classes, or as part of a fresh migration process.

```bash
# Run all seeders defined in DatabaseSeeder.php
php artisan db:seed

# Run specific seeder class
php artisan db:seed --class=UsersTableSeeder

# Fresh migration with seeding
php artisan migrate:fresh --seed

# Refresh database and seed in one command
php artisan migrate:refresh --seed
```

--------------------------------

### Use Custom Database Connection for Seeding

Source: https://context7.com/orangehill/iseed/llms.txt

Generate seeders using a database connection that is different from the default one configured in `config/database.php`. This is useful for accessing legacy or secondary databases.

```bash
# Use 'mysql2' connection defined in config/database.php
php artisan iseed users --database=mysql2

# Generate seeds from legacy database
php artisan iseed legacy_users --database=legacy_db
```

--------------------------------

### Assign Postrun Event for Seeding

Source: https://github.com/orangehill/iseed/blob/master/README.md

The --postrun option lets you specify a Laravel event to be triggered after a seed operation completes. If the event listener returns false, an exception is thrown indicating the postrun failure. Similar to prerun, it supports single or multiple table seeding.

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

--------------------------------

### Order Seeded Entries by Column

Source: https://github.com/orangehill/iseed/blob/master/README.md

This command specifies the column to use for ordering the results when generating seeds. It's often used in conjunction with the `--max` parameter to control which records are included.

```sh
artisan iseed users --max=10 --orderby=id
```

--------------------------------

### Define Custom iSeed Template (PHP)

Source: https://github.com/orangehill/iseed/blob/master/README.md

Allows users to define custom templates for seed file generation by using #iseed_start and #iseed_end markers in DatabaseSeeder.php. This controls where generated seed calls are placed.

```PHP
<?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
    }

}
```

--------------------------------

### Generate Seeders for All Tables (Artisan)

Source: https://context7.com/orangehill/iseed/llms.txt

This command automatically discovers all tables in the database and generates corresponding seeder files. It also updates the `DatabaseSeeder.php` file to include calls to the newly generated seeders.

```bash
php artisan iseed
```

--------------------------------

### Limit Seeded Entries per Table

Source: https://github.com/orangehill/iseed/blob/master/README.md

This command limits the maximum number of entries to be seeded from each specified table. If multiple tables are selected, this limit applies to all of them.

```sh
php artisan iseed users --max=10
```

--------------------------------

### Set Chunk Size for Inserts

Source: https://github.com/orangehill/iseed/blob/master/README.md

This command defines the size of data chunks used for each insert query during the seeding process. This can impact performance.

```sh
php artisan iseed users --chunksize=100
```

--------------------------------

### Set Classname Prefix

Source: https://github.com/orangehill/iseed/blob/master/README.md

This command generates seed files with a custom prefix for the Seeder class and file names, useful for distinguishing generated seeds.

```sh
php artisan iseed my_table --classnameprefix=Customized
php artisan iseed my_table,another_table --classnameprefix=Customized
```

--------------------------------

### Force Overwrite Existing Seeds with Artisan

Source: https://context7.com/orangehill/iseed/llms.txt

This command allows for the automatic overwriting of existing seeder files without interactive prompts. It's particularly useful for automated scripts and CI/CD pipelines where manual intervention is not possible.

```bash
# Overwrite UsersTableSeeder.php if it exists
php artisan iseed users --force

# Overwrite multiple seeders
php artisan iseed users,posts,comments --force
```

--------------------------------

### Set Classname Suffix

Source: https://github.com/orangehill/iseed/blob/master/README.md

This command generates seed files with a custom suffix for the Seeder class and file names, useful for adding specific naming conventions.

```sh
php artisan iseed my_table --classnamesuffix=Customizations
php artisan iseed my_table,another_table --classnamesuffix=Customizations
```

--------------------------------

### Clean DatabaseSeeder Before Generation

Source: https://context7.com/orangehill/iseed/llms.txt

This command clears previous seeder calls from the `DatabaseSeeder.php` file, specifically removing any lines between `#iseed_start` and `#iseed_end` comments. It's useful when you need to regenerate the entire seed suite.

```bash
# Remove all previous calls between #iseed_start and #iseed_end
php artisan iseed users --clean

# Useful for regenerating entire seed suite
php artisan iseed --clean
```

--------------------------------

### Configure Chunk Size for Insert Statements

Source: https://context7.com/orangehill/iseed/llms.txt

Control the size of insert statements, which is beneficial for managing large datasets and avoiding memory issues. The default chunk size is 500, but this can be configured.

```bash
# Use chunks of 100 rows per insert statement
php artisan iseed products --chunksize=100
```

```php
<?php

class ProductsTableSeeder extends Seeder {
    public function run()
    {
        // First chunk - 100 rows
        \DB::table('products')->insert(array (
            // ... 100 rows ...
        ));

        // Second chunk - 100 rows
        \DB::table('products')->insert(array (
            // ... next 100 rows ...
        ));
    }
}
```

--------------------------------

### Filter Rows with WHERE Clause (Artisan)

Source: https://context7.com/orangehill/iseed/llms.txt

Use the `--where` option to filter rows based on specific criteria before generating the seeder. This allows for targeted data export, and can be combined with other options like `--max` and `--orderby`.

```bash
php artisan iseed users --where="role = 'admin'"
php artisan iseed users --where="active = 1 AND last_login > '2024-01-01'"
php artisan iseed users --where="email LIKE '%@example.com'"
php artisan iseed users --where="status = 'verified'" --max=50 --orderby=id --direction=asc
```

--------------------------------

### Force Overwrite Existing Seeds

Source: https://github.com/orangehill/iseed/blob/master/README.md

This command forces the overwriting of any existing seed files for the specified table(s). Use with caution.

```sh
php artisan iseed users --force
```

--------------------------------

### Programmatic Seed Generation via Facade

Source: https://context7.com/orangehill/iseed/llms.txt

Generate database seeders directly within your Laravel application code using the Iseed facade. This offers granular control over all available generation parameters.

```php
<?php

use Orangehill\Iseed\Facades\Iseed;

// Generate seed for users table
Iseed::generateSeed('users');

// With database connection and row limit
Iseed::generateSeed('users', null, null, 'mysql2', 100);

// Full parameter control
Iseed::generateSeed(
    table: 'users',
    prefix: 'Backup',
    suffix: '2024',
    database: 'mysql',
    max: 50,
    chunkSize: 100,
    exclude: ['id', 'created_at'],
    prerunEvent: 'PrepareUserSeed',
    postrunEvent: 'UserSeededEvent',
    dumpAuto: true,
    indexed: true,
    orderBy: 'created_at',
    direction: 'DESC',
    whereClause: "active = 1"
);

// Returns true on success, throws exception on failure
```

--------------------------------

### Generate Seed for Single Table

Source: https://github.com/orangehill/iseed/blob/master/README.md

This command generates a seed file for a single specified database table using the iSeed Artisan command.

```sh
php artisan iseed my_table
```

--------------------------------

### Customize Seeder Class Names (Artisan)

Source: https://context7.com/orangehill/iseed/llms.txt

Modify the generated seeder class names using `--classnameprefix` or `--classnamesuffix`. This is useful for versioning, organization, or preventing overwrites when generating multiple sets of seeders.

```bash
php artisan iseed users --classnameprefix=Backup
php artisan iseed users --classnamesuffix=2024
php artisan iseed users,posts --classnameprefix=Production
```

--------------------------------

### Configure Default Iseed Settings

Source: https://context7.com/orangehill/iseed/llms.txt

Customize the default behavior of the Iseed package by modifying its configuration file, `config/iseed.php`. You can adjust settings like the seed file path and the chunk size for insert statements.

```bash
// Publish config: php artisan vendor:publish --provider="Orangehill\Iseed\IseedServiceProvider"
// config/iseed.php
```

```php
<?php

// Publish config: php artisan vendor:publish --provider="Orangehill\Iseed\IseedServiceProvider"
// config/iseed.php

return [
    // Path where seed files will be generated
    'path' => '/database/seeders',

    // Maximum number of rows per insert statement
    // Lower values help with memory usage on large tables
    'chunk_size' => 500,
];
```

--------------------------------

### Limit Seed Rows Export (Artisan)

Source: https://context7.com/orangehill/iseed/llms.txt

This Artisan command allows you to limit the number of rows exported to the seeder file using the `--max` option. It can be combined with `--orderby` and `--direction` for more specific data subset generation.

```bash
php artisan iseed users --max=10
php artisan iseed users --max=10 --orderby=created_at --direction=desc
```

--------------------------------

### Disable Composer Dump-Autoload

Source: https://github.com/orangehill/iseed/blob/master/README.md

This command prevents the `composer dump-autoload` command from executing after seed generation. This can be useful in certain deployment scenarios.

```sh
php artisan iseed users --dumpauto=false
```

--------------------------------

### Set Ordering Direction

Source: https://github.com/orangehill/iseed/blob/master/README.md

This command sets the direction (ascending or descending) for ordering results when used with the `--orderby` parameter.

```sh
artisan iseed users --max=10 --orderby=id --direction=desc
```

--------------------------------

### Filter Seeded Rows with WHERE Clause

Source: https://github.com/orangehill/iseed/blob/master/README.md

The --where option enables you to specify a SQL WHERE clause to filter which rows are included in the seed file. The clause is applied directly to the SQL query. Complex clauses may require shell escaping.

```sh
# Only seed users with example.com emails
php artisan iseed users --where="email LIKE '%@example.com'"

# Seed active users created after a specific date
php artisan iseed users --where="active = 1 AND created_at > '2024-01-01'"

# Combine with other options
php artisan iseed users --where="role = 'admin'" --max=10 --orderby=created_at --direction=desc
```

--------------------------------

### Generate Non-Indexed Seed Array

Source: https://github.com/orangehill/iseed/blob/master/README.md

Use the --noindex flag to generate a seed file as a non-indexed array. This is particularly useful when you need to merge multiple seed files, avoiding key conflicts.

```php
php artisan iseed users --noindex
```

--------------------------------

### Generate Non-Indexed Array Seeds

Source: https://context7.com/orangehill/iseed/llms.txt

Create seeder files that use non-indexed arrays for database inserts. This format can be beneficial when you need to merge or manipulate seed data more flexibly.

```bash
# Generate seeder without array indices
php artisan iseed users --noindex
```

```php
<?php

class UsersTableSeeder extends Seeder {
    public function run()
    {
        \DB::table('users')->insert(array (
            array (
                'email' => 'admin@example.com',
                'name' => 'Admin',
            ),
            array (
                'email' => 'user@example.com',
                'name' => 'User',
            ),
        ));
    }
}
```

--------------------------------

### Exclude Columns from Seed Export (Artisan)

Source: https://context7.com/orangehill/iseed/llms.txt

Omit specific columns from generated seeders using the `--exclude` option. This can be a single column name or a comma-separated list of columns to exclude from the output.

```bash
php artisan iseed users --exclude=id
php artisan iseed users --exclude=id,created_at,updated_at
```
Tokens:
Raw