Understanding MySQL Workbench

MySQL Workbench is built on a highly flexible runtime system called Generic Runtime (GRT) Environment. This system enables all users to automate and expand the tool in an easy, straight forward fashion.

In order to make use of this system a few concepts have to understood and the integration into the scripting language of choice has to be studied.

Please use the following links as starting points to learn more about the GRT and the Workbench plugin interface.

MySQL Forge Wiki – MySQL Workbench
A general introduction to the Workbench architecture.

MySQL Forge Wiki – MySQL Workbench Scripting
An introduction to Workbench scripting.

MySQL Forge Wiki – MySQL Workbench Plugin Coding
An introduction to writing plugins for the Workbench.

MySQL Forge Wiki – Lua
A short introduction to the Lua scripting language which is integrated in the Workbench

Sample Code and Tutorials
Workbench Plugin Tutorial: Load INSERTs from a File
A Utility Library for MySQL Workbench
MySQL Workbench – LUA-Script For Batch Renaming Of Foreign Keys
Automate Figure Arrangement In Workbench


This documentation is yet incomplete but will be expanded over time. Please feel free to contribute to the wiki by adding examples or new pages.