README.md 1.88 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
# MySQL Workbench Model Document Generation

A Python script to generate documentation from MySQL Workbench ERR diagram. This README file is adpated based on the README.md from [this repository](https://github.com/letrunghieu/mysql-workbench-plugin-doc-generating/releases/tag/1.0.2) (retrieved on Apriil 16, 2021). The codes in mysql-workbench-plugin-doc-generating.py is slightly adjusted.

## Installation

* Open the MySQL Workbench
* Navigate to menu **Scripting** > **Install Plugin/Module...**
* Browse and select the extracted `mysql-workbench-plugin-doc-generating.py` file in this folder
* Restart the Workbench

## Usage

14
An example output of the Nexus-e database can be found at [documentation-example.md](documentation-example.md).
15
16
17
18
19

### Generate documentation from ERR digram

* Open the ERR digram
* Navigate to menu **Tools** > **Utilities** > **Generate Documentation (Markdown)**
20
* When you see the status bar text changed to *Documentation generated into the clipboard. Paste it to your editor.*, paste to (i.e., **overwrite**) the file `docs/sources/nexus-e-database.md`.
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44

### Generate ERR digram from physical database

In case that you do not have the ERR diagram, you have to create a diagram from your physical database first. Don't worry, MySQL Workbench has a greate tool to do this for you called **Reverse Engineer**.

* Open Workbench
* Navigate to menu **Database** > **Reverse Engineer...**
* Choose the connection, **Next**
* Wait and **Next**
* Select the datbase you want to create ERR diagram from, **Next**
* Wait and **Next**
* Select tables that you want to include in the ERR diagram, **Execute>**
* Wait and **Next**
* **Finish**

You have a new ERR diagram, you can generate the documentation from this diagram as the previous step.


After that, you can convert the output Markdown document into any format that you want.


## License

This script is released under the MIT license.