This package will provide you some helper for
- Backup your database
- Restore this backups
- Drop all tables from a schema
First things first, so require the package:
composer require spresnac/laravel-artisan-database-helper
That's all, you are ready to go now 😁
To backup your database, open up your console and type
php artisan db:backup
and in most cases, you are done. You will find your backup in
storage/app/backups
Ok, with "most cases", i meant this:
- your are using only one database
- you want to backup everthing
- you have set the path, so a call to
mysqldumpwill work
If you have all of this, you are ready and good to go.
Let's say, you are not one of the 90%, perhaps because
- you use more than database connection
- you want to export only the structure
- you have a
mysqldumpbut it is not in your path
I got you covered (like i had this problems too), so you can configure the way the backup is created with this options:
With the first parameter, you can define the connection that is beeing used. You can set the connection within your config/database.php
php artisan db:backup <connection_name>
Real world example needed for this option? Ok, short-format: I am using windows ... no more words needed ;)
The second parameter can be used to define a path that points to your mysqldump binary
php artisan db:backup <connection_name> <path_to_binary>
Hint: When you only need the path to be set, but use your default connection, use mysql as connection name:
php artisan db:backup mysql <path_to_binary>
Use the -S option to export only the structure of your database:
php artisan db:backup -S
This is one option that i personally need a lot. For details why, look in the 'How i use it for testing my apps' section.
php artisan db:backup -O
You can export with the actual date and time as a prefix to the export file name. It will look like 20190425153412_yourConnection.sql. The date format is YmdHis.
php artisan db:backup -D
All glued together (export a specific database, with a custom path, structure only with no options in it):
php artisan db:backup foobardb d:/www/mysql/bin -SO
You will find your backup in
storage/app/backups/<connection>_backup.sql
If you set the -S option, it looks like this
storage/app/backups/<connection>_structure.sql
When used with -D it will look like
storage/app/backups/<Ymd_><connection>_backup.sql
With this command you can quickly "emtpy" a given database schema without deleting the schema itself. For short, all tables in the given connection will be deleted.
php artisan db:drop-tables <connection>
If you want to use this in an automatic way, you can use the --force option to delete the tables without confirmation (you be warned!).
php artisan db:drop-tables <connection> --force
To restore a backup, simply use
php artisan db:restore
You can provide more options in case you need one of this:
php artisan db:restore <backup_name> <connection> <path_to_mysql> <port>
All this options are similar to the ones described in db:backup, so you are able to seamlessly restore a backuped database.
When having complex setups for very complex bugs it may happen that you are in need of some very specific database entries you do not want to reproduce all the time.
In this case, i do use this package as a helper for me to bugfix faster.
- Create a backup from the database with
db:backup. - Rename this backup like the bugticket i have.
- Setup my unit-test for this bug in a special group, that is not executed by default.
- In my testscript, i do define a testschema.
- Before running my tests, execute
db:drop-tableson the testschema. - Right after that, execute
db:restore <ticketnumber>.
With this, everytime i execute my tests for bugfing my database is reset to this very specific point where i can reproduce the bug and fix it fast.
... have fun 😉 and be productive with it.