README

Introduction

• Introducing "PHP DB Auditor" – your go-to solution for meticulous MySQL database system auditing. This powerful PHP package is your key to ensuring the utmost integrity and compliance with MySQL standards and constraints in your database. Dive into the world of database auditing with ease, thanks to its user-friendly command-line interface (CLI).

Key Points

1. Comprehensive Auditing: PHP DB Auditor is a specialized PHP package designed to perform comprehensive audits on MySQL database systems.

2. Thorough Evaluation: It conducts a thorough and detailed evaluation of the entire MySQL database structure.

3. Standards Compliance: The package employs advanced scanning techniques to assess the database's adherence to MySQL standards and constraints.

4. Command-Line Interface (CLI): Users can effortlessly interact with PHP DB Auditor through its intuitive command-line interface, making the auditing process seamless.

5. Constraint Management: PHP DB Auditor empowers you to add essential constraints directly to your MySQL database via the CLI.

6. Detailed Audit Report: Upon completion of the auditing process, the package generates a detailed report.

7. Identifying Non-Compliance: The audit report provides a comprehensive list of tables and columns that fall short of meeting established MySQL standards and constraints.

8. Database Integrity: With PHP DB Auditor, you can proactively maintain the integrity of your database and ensure it aligns with the necessary standards.

Installation

**Requires PHP 8.1+

As a standalone project under linux

# create directory (feel free to give your own)
mkdir dbauditor
cd dbauditor

# install package
composer require vcian/php-db-auditor

# create symbolic links
ln -s vendor/vcian/php-db-auditor/dbauditor dbauditor
ln -s vendor/vcian/php-db-auditor/src/config.php config.php

# edit config.php to configure the database settings

As a standalone project under windows

# create directory (feel free to give your own)
mkdir dbauditor
cd dbauditor

# install package
composer require vcian/php-db-auditor

# create symbolic links
mklink vendor/vcian/php-db-auditor/dbauditor dbauditor
mklink vendor/vcian/php-db-auditor/src/config.php config.php

# edit config.php to configure the database settings

Usage:

See database information

php dbauditor db:summary

See a list of table with standard follow indication

php dbauditor db:standard

See a list of tables with fields, primary, foreign, unique, index constraint.

php dbauditor db:constraint

You can add more constraint to a table.

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

   We believe in
        👇
      ACT NOW
  PERFECT IT LATER
CORRECT IT ON THE WAY.

Security

If you discover any security-related issues, please email ruchit.patel@viitor.cloud instead of using the issue tracker.

Credits

• All Contributors

License

The MIT License (MIT). Please see License File for more information.