Data dictionary is one of the document to present data content. It majorly used in ETL to ensure data capture correctly. In MySQL, data dictionary can generate with MySQL workbench plugin. This demo will show how to export data dictionary from existing database.
Steps of generate data dictionary in HTML format.
- Download plugin HTML schema generator.
DownloadHTMLSchemaReport.pyin repository https://github.com/tmsanchez/workbenchscripts . It can done with command belowwget -L https://github.com/tmsanchez/workbenchscripts/blob/master/HTMLSchemaReport.py
- Install plugin.
In MySQL workbench, click Script > Install Plugin / Module, select file downloaded in previous step, then restart application to apply settings.
- Execute plugin.
In MySQL workbench, open model which expected to export, then click Tools > Catalog > Database Schema Report in HTML Format.
- Save data dictionary report.
Select file name and path and click Save.
- Get exported result.
After render, it will popup dialog for result. Click OK to close dialog.
- Verify result.
Go to folder which select previously, expected file can found. If found, then open it and check database column is align with dictionary or not.
[Updated at 2023-02-21] If you are using MySQL workbench, please select HTMLSchemaReportWB8.py instead.
this will break ur workbench app dont do this
This article was documented in MySQL WorkBench 7.x a year ago so it might be outdated; If you are using WorkBench 8.x, you can try HTMLSchemaReportWB8.py instead.
Ref: https://github.com/tmsanchez/workbenchscripts/blob/master/HTMLSchemaReportWB8.py
Do not use this! it will break mysql-workbench.
if you do this, remove the following file:
“`Windows %AppData%\MySQL\Workbench\modules\HTMLSchemaReport.py
macOS ~username/Library/Application Support/MySQL/Workbench/modules/HTMLSchemaReport.py
Linux ~username/.mysql/workbench/modules/HTMLSchemaReport.py“`
and restart mysql-workbench
This article was documented in MySQL WorkBench 7.x a year ago so it might be outdated; If you are using WorkBench 8.x, you can try HTMLSchemaReportWB8.py instead.
Ref: https://github.com/tmsanchez/workbenchscripts/blob/master/HTMLSchemaReportWB8.py
Hi,
I used the below plugin but it is only working for MySql mydb schema. I have other schema as well and want to fetch the same information for second schema. How can i do this. Please help.
Ref: https://github.com/tmsanchez/workbenchscripts/blob/master/HTMLSchemaReportWB8.py
It works in v 8.x, Tks!