Generating report for a given MySQL database as MD-Files
This class can generate a complete documentation of a MySQL database in Markdown format.
In the MD format the documentation can be made available for everyone who is involved
in an project containing a MySQL database. There are various scenarios:
- The easies way is just make the files accessible at the filesystem/fileserver
- More comfortable can be a webbased publication as part of an intra- or extranet
since the MD format is wide supported
- Or you can integrate it into other proprietaire layers (i.e. wikis,
documentation systems, ...)
The report contains
1. An overview file with links to datail files for
2. Details for tables and views
- all fields with datatype and keydefinition, nullable, defaultvalue
- defined triggers
- defined constraints
- tables referenced by this table
- tables that references this table
Details for precedures, functions and trigger
- create statement containing all infos
Create an `mysqli` connection to the database to build the report for.
Create an instance of the `MySqlInfoMD()` class and pass the DB connection
Set prefered directories and options
Call the `buildInfo()` method.
$strDBHost = 'localhost';
$strDBName = 'demo';
$strDBUser = 'demo';
$strDBPwd = 'demoPWD';
$oDB = mysqli_connect($strDBHost, $strDBUser, $strDBPwd, $strDBName);
$oInfo = new MySqlInfoMD($oDB, $MySqlInfoMD::STANDALONE);
$oInfo->setOptions(MySqlInfoMD::OPT_CREATE_SUBFOLDER | MySqlInfoMD::OPT_CREATE_STMT);
> Since the Markdown renderer that is used at phpClasses.org do not support MD
> tables, you will not get a satisfactory display if you look at the example directly
> in the source view window here in the package.
The report can be generated for
Create the MD files for standalone use (file or web based) to view with a browser
addon or any MD viewer
Build the MD files to upload to a Github-Wiki.
Build the MD files for display inside a self defined structure for more complex
recommended browser add-ons
A very good display quality you get e.g. with the browser add-on *'Markdown Viewer'*
(from somiv) that is available for most major browsers:
or visit on github
||PHP MySQL Info to MD
||Generate a MySQL table structure Markdown report
||GNU General Public License (GPL)
|All time users:
|All time rank:
|MySQL is a prevalent SQL database server type many PHP developers use.
Sometimes developers want an overview of the MySQL database table structure details. There are several SQL commands that MySQL supports to give that overview.
This package provides an excellent presentation of the MySQL database table structure details in a way that is easier to understand than the output of the SQL query results that return that information.
|Not yet rated by the users
||Applications that use this package
No pages of applications that use this class were specified.
If you know an application of this package, send a message to the author to add a link here.