jpswade / laravel-database-tools
Laravel Database Tools
Installs: 9 950
Dependents: 0
Suggesters: 0
Security: 0
Stars: 2
Watchers: 3
Forks: 1
Open Issues: 0
Type:laravel-package
Requires
- php: ^7.4|8.0.*|8.1.*
- ext-fileinfo: *
- ext-pdo: *
- ext-zip: *
- illuminate/console: *
- illuminate/filesystem: *
- illuminate/support: *
- laravel/framework: ~5.1|6.*|7.*|8.*|9.*
Requires (Dev)
- orchestra/testbench: ^6.25
- roave/security-advisories: dev-latest
Suggests
- league/flysystem-aws-s3-v3: Needed for db:getFromBackup command to use the S3 Driver.
- spatie/db-dumper: Needed for db:dump command to use the S3 Driver.
README
The "missing" database toolset for Laravel. A set of commonly used Database Tools for Laravel.
With this package you can:
- Create a database (if it does not exist)
- Dump from another database to file
- Get and unzip from a database backup created by the Spatie Backup package
- Import from file
- Update the charset and collation
- Fixes the "no such function" error by giving SQLite MySQL compatibility by creating the missing function using PDO for SQLite using PHP functions.
Install
Install the package into your Laravel application:
composer require --dev jpswade/laravel-database-tools
Note: It's wise to only install these tools in development by default, as it's rare you should need them in a production environment.
Configure
Publish and customise your own dbtools.php
file:
php artisan vendor:publish --provider="Jpswade\LaravelDatabaseTools\ServiceProvider" --tag="config"
This allows you to set the source database and/or filesystem for the backup.
dbtools.database
- Define the source database for thedb:dump
command, similar to Laravel databases config.dbtools.filesystem
- Define the source filesystem for thedb:getFromBackup
command, similar to Laravel filesystems config.dbtools.filesystem.path
- Define the path for thedb:getFromBackup
command.dbtools.import
- Here you can define themethod
(command or normal) for thedb:importFromFile
command.
Note:
- The
db:getFromBackup
command falls back to thespatie/laravel-backup
package for configuration.
Usage
The commands are:
db:create
- Creates the database schema.db:dump
- Fetch a copy of the latest database from the configured server.db:getFromBackup
- Download database backup file from backup.db:importFromFile {file?}
- Import data from a sql file into a database.db:charset
- Changes the charset and collation to whatever the database is set to use.
SQLite MySQL Compatability Provider
Follow the usual Registering Providers instructions:
In config/app.php
, find the providers
array and add:
'providers' => [ // Other Service Providers Jpswade\LaravelDatabaseTools\SqliteMysqlCompatibilityProvider::class, ],
Limitations
These are limitations you'll come across if you use certain commands:
- The
db:getFromBackup
command relies on theleague/flysystem-aws-s3-v3 "^1.0"
package, when you use the Amazon S3 Driver as per the Laravel docs. - The
db:dump
command depends onspatie/db-dumper
. - The commands have only been tested to work with MySQL at the moment, but could be extended to others.
Troubleshooting
Class 'League\Flysystem\AwsS3v3\AwsS3Adapter' not found
% composer require league/flysystem-aws-s3-v3:~1.0