- This package provides to audit process of reviewing and evaluating a mysql and sqlite database system.
- DB Auditor scan your mysql/sqlite database and give insights of standards, constraints and provide option to add the constraints through CLI.
- The result of audit process shows list of tables & columns which doesn't have proper standards.
Requires PHP 8.0+ | Laravel 8.0+
Require Laravel DB Auditor using Composer:
composer require --dev vcian/laravel-db-auditor
You can access DB Auditor using below artisan commands.
This command give you options to select feature like check the database standards or check the constraint.
Now, you can skip tables which you don't want to check. Add skip table name in the .db-auditor.php file.
Note:
If you want to check standalone feature then you can execute below artisan command one by one.
This command gives you result with list of tables with primary,foreign,unique,index constraint.
You can add more constraint to the table by seeing existing constraint with table.
Below example give insights about the how to see constraints in table and how to add.
Note :- SQLite does not allow to define PRIMARY KEY or FOREIGN KEY into a existing table. Therefore , you will not show any constraint edit option in this case.
This command give you result with list of table with standard follow indication.
You can also see table specific column name which doesn't have standard followed.
Below example give insights of database standards reports and suggestions.
Note:This command give you the track of the database files. Like when it's created with how many field in which table or whom created. this type of information show in the result.
You can also filter with --table=, --action=, --status=. Note: "created by" return the github username and if it's not git repo than it shows system username.
You have to set your database name with DB_DATABASE parameter in you laravel .env file to use this feature.
You can also access this feature through WEB UI. To access web UI, kindly execute below command.
php artisan vendor:publish --tag=public
select "db-auditor"
Route - To access the web UI "/laravel-db-auditor"
Please see CHANGELOG for more information what has changed recently.
Please see CONTRIBUTING for details.
We believe in
๐
ACT NOW
PERFECT IT LATER
CORRECT IT ON THE WAY.
If you discover any security-related issues, please email [email protected] instead of using the issue tracker.
The MIT License (MIT). Please see License File for more information.