WB Datadict: Generate Data Dictionaries from Database Schemas

Abstract

WB Datadict is a plugin for MySQL Workbench Community Edition 6.x. This plugin allows you to generate an HTML data dictionary from the database schema selected in the application.

Warning

This entry is out of date. Please visit the website of the plugin to see the latest version and user manual.

Figure 1.

Figure 1. Screenshot of the plugin being used in MySQL Workbench CE 6.x.

Installation

  1. Download WB Datadict.

  2. Uncompress the file.

  3. Open MySQL Workbench.

  4. Select the option Scripting → Install Plugin/Module.

  5. Browse to the WB Datadict directory (extracted in step 2) and select the file datadict_grt.py.

    You should see a message like this:

    Plugin Installed
    Plugin /path/to/datadict_grt.py was installed, please restart Workbench to use it.
    

    Lastly, press OK and restart MySQL Workbench.

Usage

  1. Open a database model file or create a new one (File → New Model).
  2. Go to Tools → Catalog → Generate HTML Data Dictionary (see Figure 1).

Note that if your Model file has several schemas, you'll have to select the schema for which you want to generate the data dictionary first. To do this:

  1. Click on the MySQL Model tab.
  2. In the Physical Schemas section, click on the tab of a schema.
  3. Generate the data dictionary.

After this, an HTML data dictionary will be generated and displayed in your Web browser. The following image shows the data dictionary for the Sakila sample database that comes with Workbench.

Screenshot of a data dictionary.

Article Updates

Version 3 (2015-10-30)
Updated the text for WB Datadict 1.0.1.
Version 2 (2014-09-11)
Updated the text for WB Datadict 1.0.0.

✮ Comment ✮

Post information:

Author

sirgazil

Topics