Download the PHP package timokoerber/laravel-json-seeder without Composer
On this page you can find all versions of the php package timokoerber/laravel-json-seeder. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download timokoerber/laravel-json-seeder
More information about timokoerber/laravel-json-seeder
Files in timokoerber/laravel-json-seeder
Package laravel-json-seeder
Short Description Create and use JSON files to seed your database in your Laravel applications
License MIT
Informations about the package laravel-json-seeder
Laravel JSON Seeder
Create and use JSON files to seed your database in your Laravel applications.
This package works both ways!
- Export your database into JSON files
- Use JSON files to seed your database
Installation
Require this package with composer. It is recommended to only require the package for development.
Next you need to publish the config file and register the required commands with ...
This will create the file config/jsonseeder.php
where you can find the configurations.
Next add the JsonSeederServiceProvider to the providers
array in config/app.php
...
Creating JSON seeds from database
Of course you can create the JSON files manually. But if you already have a good development database, you can easily export it into JSON seeds.
You can create seeds for every table in your database by calling ...
This will create one JSON file for watch table in your database (i.e. table users -> users.json, table posts -> posts.json, etc.).
If you only want to create a seed of one specific table (i.e. users
), call ...
Existing files won't be overwritten by default. If you call the command again, a sub-directory will be created and the JSON seeds will be stored there.
If you want to overwrite the existing seeds, use the overwrite
option like ...
or just use the command ...
Seeding
Go to your databas/seeds/DatabaseSeeder.php
and add the JsonSeeder inside the run()
method like this ...
You can now call the JSON Seeder with the usual Artisan command ...
Settings & Configurations
Directory
By default your seeds will be written into or read from the directory /database/json
. If you want a different directory, you can add the environment variable
JSON_SEEDS_DIRECTORY
in your .env
file ...
Ignoring tables
Some tables in your database might not require any seeds.
If you want to ignore these tables, you can put them into the setting ignore-tables
in the /config.jsonseeder.php
If a table in your database is empty, the LaravelJsonSeeder will create a JSON file with an empty array by default. This might be useful if you want your seeds to truncate this table.
If you don't want this, you can change the setting ignore-empty-tables
in config/jsonseeder.php
, so no JSON seed will be created.
Important!!! Do not forget to clear the cache after editing the config file:
php artisan cache:clear
Environments
The environment variable JSON_SEEDS_DIRECTORY
might be useful if you are using seeds in Unit Tests and want to use different seeds for this.
Development
Testing
Errors & Warnings
Error | Type | Solution |
---|---|---|
Table does not exist! | Error | The name of the JSON file does not match any table. Check the filename or create the table. |
JSON syntax is invalid! | Error | The JSON text inside the file seems to be invalid. Check if the JSON format is correct. |
Exception occured! Check logfile! | Error | There seems to be a problem with the Database. Check your system and your default logfile. |
JSON file is empty! | Error | The JSON file is completely empty, which makes it useless. If it should truncate the table, provide an empty array [] . Otherwise delelte it. |
JSON file has no rows! | Warning | The JSON file contains only an empty array [] . This results in a truncated table and might not be intended. |
Missing fields! | Warning | At least one row in the JSON file is missing a field, that is present in the database table. Check for typos or provide it in the JSON file. |
Unknown fields! | Warning | At least one row in the JSON file has a field that does not exist in the database. Check for typos or make sure to add it to the database table. |
License
Copyright © Timo Körber
Laravel JSON Seeder is open-sourced software licensed under the MIT license.