gbhorwood/pollinate

Artisan command to create seed files from the database

0.0.3 2022-12-12 04:26 UTC

Requires

• php: ^7.4|^8.0
• ext-pdo: *
• doctrine/dbal: ^3.5

MIT

• grant horwood

README

Pollinate is a command for artisan for use in Laravel projects that creates database seed files from your database. If you have data in a database and want to turn it into seeds, pollinate is here. Pollinate was developed as an internal-use tool for fruitbat studios/cloverhitch technologies/kludgetastic implementations.

Install

Install via composer

composer require gbhorwood/pollinate

Prerequisites

Pollinate requires the following:

• PHP 7.4 or higher
• The pdo extension
• The composer package doctrine/dbal

Usage

The simplest usage of pollinate is:

php artisan gbhorwood:pollinate

This will create seed files for all the tables in your database, and all seed files and classnames will be prefixed with the default pollinate_ prefix.

note: some tables are automatically excluded from pollinations, such as passport tables and job tables. these are defined in the script in the ignoreTables array.

pollinating specific tables

If you only wish to create seed files for specified tables, you can provide a comma-separated list of table names as an argument:

php artisan gbhorwood:pollinate users,pets,user_pet

ignored tables

Some tables are preset to not bet pollinated. These are tables for things like passport or jobs. You can dump a list of ignored tables with

php artisan gbhorwood:pollinate --show-ignored

If you explicitly name a table in the tables list, it will be pollinated even if it is in the ignored list

php artisan gbhorwood:pollinate jobs,failed_jobs

specifying a prefix

By default, pollinate prefixes all seed file and class names with pollinate_. You can specify your own prefix with the --prefix= option:

php artisan gbhorwood:pollinate --prefix=mydevbox

this will create seed files and classes with names like mydevbox_Pets.php.

overwriting existing seed files

Pollinate's default behaviour is to not overwrite existing seed files. If one or more seed files exist that would be overwritten, pollinate will error and quit before doing any work.

If you wish to override this behaviour so that existing seed files are overwritten, you can pass the --overwrite option:

php artisan gbhorwood:pollinate --overwrite

missing or empty tables

Pollinate does not write seed files for missing or empty tables.

output

All non-error output can be suppressed by passing the --silent option.

If output is not suppressed, pollinate will output a list of classes that can be pasted into your DatabaseSeeder.php file.