<p><strong>MySQL Workbench </strong></p><p><strong>MySQL Workbench </strong></p><p><strong>Abstract </strong></p><p>This manual documents the MySQL Workbench SE version 5.2 and the MySQL Workbench OSS version 5.2. If you have not yet installed MySQL Workbench OSS please download your free copy from the <a href="/goto?url=http://dev.mysql.com/downloads/workbench" target="_blank">download site</a>. MySQL Workbench OSS is available for Windows, Mac OS X, and Linux. </p><p>Document generated on: 2012-05-01 (revision: 30311) For legal information, see the <a href="#7_0">Legal Notice</a>. </p><p><strong>Table of Contents </strong></p><p><a href="#7_1">Preface and Legal Notice </a>................................................................................................................. <a href="#7_1">vii </a><a href="#9_0">1. MySQL Workbench Introduction </a>..................................................................................................... <a href="#9_0">1 </a><a href="#11_0">2. MySQL Workbench Editions </a>........................................................................................................... <a href="#11_0">3 </a><a href="#13_0">3. Installing and Launching MySQL Workbench </a>................................................................................... <a href="#13_0">5 </a><br><a href="#13_1">Hardware Requirements </a>............................................................................................................. <a href="#13_1">5 </a><a href="#13_2">Software Requirements </a>.............................................................................................................. <a href="#13_2">5 </a><a href="#14_0">Starting MySQL Workbench </a>....................................................................................................... <a href="#14_0">6 </a><br><a href="#15_0">Installing MySQL Workbench on Windows </a>.......................................................................... <a href="#15_0">7 </a><a href="#15_1">Launching MySQL Workbench on Windows </a>........................................................................ <a href="#15_1">7 </a><a href="#16_0">Uninstalling MySQL Workbench on Windows </a>...................................................................... <a href="#16_0">8 </a><a href="#17_0">Installing MySQL Workbench on Linux </a>................................................................................ <a href="#17_0">9 </a><a href="#17_1">Launching MySQL Workbench on Linux </a>............................................................................. <a href="#17_1">9 </a><a href="#17_2">Uninstalling MySQL Workbench on Linux </a>............................................................................ <a href="#17_2">9 </a><a href="#18_0">Installing MySQL Workbench on Mac OS X </a>...................................................................... <a href="#18_0">10 </a><a href="#19_0">Launching MySQL Workbench on Mac OS X </a>.................................................................... <a href="#19_0">11 </a><a href="#19_1">Uninstalling MySQL Workbench on Mac OS X </a>.................................................................. <a href="#19_1">11 </a><br><a href="#21_0">4. Getting Started Tutorial </a>................................................................................................................ <a href="#21_0">13 </a><br><a href="#21_1">Administering a MySQL Server </a>................................................................................................. <a href="#21_1">13 </a><a href="#0_0">Creating a Model </a>..................................................................................................................... <a href="#0_0">25 </a><a href="#0_1">Adding Data to Your Database </a>................................................................................................. <a href="#0_1">31 </a><br><a href="#0_2">5. The Home Window </a>...................................................................................................................... <a href="#0_2">35 </a><br><a href="#0_3">Workbench Central </a>.................................................................................................................. <a href="#0_3">36 </a><a href="#0_4">Workspace </a>.............................................................................................................................. <a href="#0_4">37 </a><a href="#0_5">Workbench Application Minimum Window Size </a>.......................................................................... <a href="#0_5">37 </a><a href="#0_6">Workbench Preferences </a>........................................................................................................... <a href="#0_6">37 </a><br><a href="#0_2">The General Tab </a>............................................................................................................. <a href="#0_2">39 </a><a href="#0_7">The Administrator Tab </a>...................................................................................................... <a href="#0_7">39 </a><a href="#0_8">The SQL Editor Tab </a>........................................................................................................ <a href="#0_8">39 </a><a href="#0_9">The Model Tab </a>................................................................................................................ <a href="#0_9">41 </a><a href="#0_10">The MySQL Tab </a>.............................................................................................................. <a href="#0_10">42 </a><a href="#0_11">The Diagram Tab </a>............................................................................................................. <a href="#0_11">42 </a><a href="#0_2">The Appearance Tab </a>....................................................................................................... <a href="#0_2">43 </a><br><a href="#0_2">6. SQL Development </a>........................................................................................................................ <a href="#0_2">45 </a><br><a href="#0_12">Open Connection to Start Querying </a>.......................................................................................... <a href="#0_12">45 </a><a href="#0_13">New Connection </a>...................................................................................................................... <a href="#0_13">46 </a><a href="#0_14">Edit Table Data </a>....................................................................................................................... <a href="#0_14">46 </a><a href="#0_15">Edit SQL Script </a>........................................................................................................................ <a href="#0_15">46 </a><a href="#0_16">Manage Connections </a>............................................................................................................... <a href="#0_16">46 </a><a href="#0_17">Manage DB Connections Dialog </a>............................................................................................... <a href="#0_17">46 </a><br><a href="#0_18">The Password Storage Vault </a>............................................................................................ <a href="#0_18">47 </a><a href="#0_19">Standard TCP/IP Connection </a>............................................................................................ <a href="#0_19">48 </a><a href="#0_20">Local Socket/Pipe Connection </a>.......................................................................................... <a href="#0_20">49 </a><a href="#0_21">Standard TCP/IP over SSH Connection </a>............................................................................ <a href="#0_21">50 </a><br><a href="#0_22">SQL Editor </a>.............................................................................................................................. <a href="#0_22">50 </a><br><a href="#0_23">Main Menu </a>...................................................................................................................... <a href="#0_23">51 </a><a href="#0_24">Toolbar </a>............................................................................................................................ <a href="#0_24">52 </a><a href="#0_25">SQL Query Panel </a>............................................................................................................ <a href="#0_25">53 </a><a href="#0_26">Main Tabsheets </a>............................................................................................................... <a href="#0_26">54 </a><a href="#0_27">Sidebar </a>............................................................................................................................ <a href="#0_27">59 </a><br><a href="#0_2">7. Data Modeling </a>............................................................................................................................. <a href="#0_2">65 </a><br><a href="#0_28">Open an Existing EER Model </a>................................................................................................... <a href="#0_28">66 </a></p><p>iii <br>MySQL Workbench <br><a href="#0_29">Create New EER Model </a>........................................................................................................... <a href="#0_29">66 </a><a href="#0_30">Create EER Model from Existing Database </a>............................................................................... <a href="#0_30">66 </a><a href="#0_31">Create EER Model from SQL Script </a>......................................................................................... <a href="#0_31">66 </a><a href="#0_32">Model Editor </a>............................................................................................................................ <a href="#0_32">67 </a><br><a href="#0_33">Modeling Menus </a>.............................................................................................................. <a href="#0_33">68 </a><a href="#0_34">The Toolbar </a>..................................................................................................................... <a href="#0_34">77 </a><a href="#0_35">EER Diagrams </a>................................................................................................................. <a href="#0_35">78 </a><a href="#0_36">The Physical Schemata Panel </a>.......................................................................................... <a href="#0_36">78 </a><a href="#0_37">The Schema Privileges Panel </a>........................................................................................... <a href="#0_37">79 </a><a href="#0_38">The SQL Scripts Panel </a>.................................................................................................... <a href="#0_38">80 </a><a href="#0_39">The Model Notes Panel </a>................................................................................................... <a href="#0_39">80 </a><a href="#0_2">The History Palette </a>.......................................................................................................... <a href="#0_2">81 </a><a href="#0_40">The Model Navigator Panel </a>.............................................................................................. <a href="#0_40">81 </a><a href="#0_41">The Catalog Tree Palette </a>................................................................................................. <a href="#0_41">81 </a><a href="#0_42">The Layers Palette </a>.......................................................................................................... <a href="#0_42">82 </a><a href="#0_43">The Properties Palette </a>..................................................................................................... <a href="#0_43">82 </a><br><a href="#0_44">EER Diagram Editor </a>................................................................................................................ <a href="#0_44">83 </a><br><a href="#0_45">The Vertical Toolbar </a>........................................................................................................ <a href="#0_45">83 </a><br><a href="#0_46">Working with Models </a>................................................................................................................ <a href="#0_46">87 </a><br><a href="#0_47">Creating Tables </a>............................................................................................................... <a href="#0_47">87 </a><a href="#0_48">Creating Foreign Key Relationships </a>................................................................................ <a href="#0_48">101 </a><a href="#0_49">Creating Views </a>............................................................................................................... <a href="#0_49">105 </a><a href="#0_50">Creating Routines and Routine Groups </a>........................................................................... <a href="#0_50">107 </a><a href="#0_51">Creating Layers </a>............................................................................................................. <a href="#0_51">110 </a><a href="#0_52">Creating Notes </a>............................................................................................................... <a href="#0_52">112 </a><a href="#0_53">Creating Text Objects </a>.................................................................................................... <a href="#0_53">112 </a><a href="#0_54">Creating Images </a>............................................................................................................. <a href="#0_54">113 </a><a href="#0_55">Reverse Engineering </a>...................................................................................................... <a href="#0_55">114 </a><a href="#0_56">Forward Engineering </a>...................................................................................................... <a href="#0_56">123 </a><br><a href="#0_57">Modeling Tutorials </a>.................................................................................................................. <a href="#0_57">143 </a><br><a href="#0_21">Importing a Data Definition SQL Script </a>............................................................................ <a href="#0_21">144 </a><a href="#0_58">Using the Default Schema </a>.............................................................................................. <a href="#0_58">145 </a><a href="#0_59">Basic Modeling </a>.............................................................................................................. <a href="#0_59">147 </a><a href="#0_60">Documenting the </a><a href="#0_60">sakil</a><a href="#0_60">a</a><a href="#0_60">Database </a>............................................................................... <a href="#0_60">149 </a><br><a href="#0_2">Printing </a>.................................................................................................................................. <a href="#0_2">151 </a><br><a href="#0_61">Printing Options </a>............................................................................................................. <a href="#0_61">151 </a><br><a href="#0_62">MySQL Workbench Schema Validation Plugins (Commercial Version) </a>....................................... <a href="#0_62">151 </a><br><a href="#0_63">General Validation </a>.......................................................................................................... <a href="#0_63">151 </a><a href="#0_64">MySQL-Specific Validation </a>.............................................................................................. <a href="#0_64">152 </a><br><a href="#0_2">The DBDoc Model Reporting Dialog Window (Commercial Version) </a>.......................................... <a href="#0_2">153 </a><a href="#0_65">Customizing DBDoc Model Reporting Templates </a>..................................................................... <a href="#0_65">157 </a><br><a href="#0_2">Supported Template Markers </a>.......................................................................................... <a href="#0_2">161 </a><a href="#0_66">Creating a Custom Template </a>.......................................................................................... <a href="#0_66">164 </a><br><a href="#0_2">8. Server Administration </a>................................................................................................................. <a href="#0_2">169 </a><br><a href="#0_67">Server Administration </a>............................................................................................................. <a href="#0_67">169 </a><a href="#0_68">New Server Instance </a>.............................................................................................................. <a href="#0_68">170 </a><a href="#0_69">Manage Data Import/Export </a>.................................................................................................... <a href="#0_69">170 </a><a href="#0_70">Manage Security </a>.................................................................................................................... <a href="#0_70">170 </a><a href="#0_71">Manage Server Instances </a>....................................................................................................... <a href="#0_71">170 </a><a href="#0_72">Creating and Managing Server Instances </a>................................................................................ <a href="#0_72">170 </a><br><a href="#0_73">New Server Instance Wizard </a>.......................................................................................... <a href="#0_73">170 </a><a href="#0_74">Manage Server Instances Dialog </a>.................................................................................... <a href="#0_74">173 </a><br><a href="#0_75">Server Administration and Configuration </a>.................................................................................. <a href="#0_75">175 </a><br><a href="#0_76">The Startup Tab </a>............................................................................................................. <a href="#0_76">177 </a></p><p>iv <br>MySQL Workbench <br><a href="#0_77">The Configuration Tab </a>.................................................................................................... <a href="#0_77">178 </a><a href="#0_78">The Accounts Tab </a>.......................................................................................................... <a href="#0_78">179 </a><a href="#0_79">The Connections Tab </a>..................................................................................................... <a href="#0_79">181 </a><a href="#0_80">The Variables Tab </a>......................................................................................................... <a href="#0_80">182 </a><a href="#0_81">The Data Dump Tab </a>...................................................................................................... <a href="#0_81">183 </a><a href="#0_80">The Logs Tab </a>................................................................................................................ <a href="#0_80">186 </a><br><a href="#0_2">9. Extending Workbench </a>................................................................................................................ <a href="#0_2">189 </a><br><a href="#0_82">GRT and Workbench Data Organization </a>................................................................................. <a href="#0_82">189 </a><a href="#0_83">Modules </a>................................................................................................................................. <a href="#0_83">190 </a><a href="#0_84">Plugins </a>.................................................................................................................................. <a href="#0_84">191 </a><a href="#0_85">Adding a GUI to a Plugin Using MForms </a>................................................................................ <a href="#0_85">192 </a><a href="#0_86">The Workbench Scripting Shell </a>............................................................................................... <a href="#0_86">193 </a><br><a href="#0_87">Exploring the Workbench Scripting Shell </a>......................................................................... <a href="#0_87">193 </a><a href="#0_88">The Shell Window </a>.......................................................................................................... <a href="#0_88">194 </a><a href="#0_89">The Globals, Classes, and Modules Tabs </a>....................................................................... <a href="#0_89">195 </a><br><a href="#0_90">Tutorial: Writing Plugins </a>.......................................................................................................... <a href="#0_90">195 </a><br><a href="#0_2">10. Keyboard Shortcuts </a>.................................................................................................................. <a href="#0_2">199 </a><a href="#0_2">11. MySQL Utilities </a>........................................................................................................................ <a href="#0_2">203 </a><br><a href="#0_91">Introduction </a>............................................................................................................................ <a href="#0_91">203 </a><br><a href="#0_92">Introduction to MySQL Utilities </a>........................................................................................ <a href="#0_92">203 </a><a href="#0_93">Connection Parameters </a>.................................................................................................. <a href="#0_93">204 </a><a href="#0_2">Introduction to extending the MySQL Utilities </a>................................................................... <a href="#0_2">205 </a><br><a href="#0_94">Commands </a>............................................................................................................................ <a href="#0_94">211 </a><a href="#0_95">mysql.utilities.command.grep — Search Databases for Objects </a>......................................... <a href="#0_95">211 </a><a href="#0_96">mysql.utilities.command.proc — Search Processes on Servers </a>......................................... <a href="#0_96">212 </a><br><a href="#0_21">Manual Pages </a>........................................................................................................................ <a href="#0_21">214 </a><br><a href="#0_97">Brief overview of command-line utilities </a>........................................................................... <a href="#0_97">214 </a><a href="#0_98">mut </a><a href="#0_98">- MySQL Utilities Testing </a>......................................................................................... <a href="#0_98">216 </a><a href="#0_99">mysqldbcompar</a><a href="#0_99">e</a><a href="#0_99">- Compare Two Databases and Identify Differences </a>............................. <a href="#0_99">218 </a><a href="#0_100">mysqldbcop</a><a href="#0_100">y</a><a href="#0_100">- Copy Database Objects Between Servers </a>.............................................. <a href="#0_100">225 </a><a href="#0_101">mysqldbexpor</a><a href="#0_101">t</a><a href="#0_101">- Export Object Definitions or Data from a Database </a>.............................. <a href="#0_101">229 </a><a href="#0_102">mysqldbimpor</a><a href="#0_102">t</a><a href="#0_102">- Import Object Definitions or Data into a Database </a>............................... <a href="#0_102">236 </a><a href="#0_103">mysqldif</a><a href="#0_103">f</a><a href="#0_103">- Identify Differences Among Database Objects </a>............................................. <a href="#0_103">239 </a><a href="#0_104">mysqldiskusag</a><a href="#0_104">e</a><a href="#0_104">- Show Database Disk Usage </a>............................................................ <a href="#0_104">243 </a><a href="#0_105">mysqlfailove</a><a href="#0_105">r</a><a href="#0_105">- Automatic replication health monitoring and failover </a>............................. <a href="#0_105">246 </a><a href="#0_106">mysqlindexchec</a><a href="#0_106">k</a><a href="#0_106">- Identify Potentially Redundant Table Indexes </a>.................................. <a href="#0_106">253 </a><a href="#0_107">mysqlmetagre</a><a href="#0_107">p</a><a href="#0_107">- Search Database Object Definitions </a>................................................... <a href="#0_107">255 </a><a href="#0_108">mysqlprocgre</a><a href="#0_108">p</a><a href="#0_108">- Search Server Process Lists </a>.............................................................. <a href="#0_108">259 </a><a href="#0_109">mysqlreplicat</a><a href="#0_109">e</a><a href="#0_109">- Set Up and Start Replication Between Two Servers </a>........................... <a href="#0_109">262 </a><a href="#0_110">mysqlrpladmi</a><a href="#0_110">n</a><a href="#0_110">- Administration utility for MySQL replication </a>......................................... <a href="#0_110">265 </a><a href="#0_106">mysqlrplchec</a><a href="#0_106">k</a><a href="#0_106">- Check Replication Prerequisities </a>........................................................ <a href="#0_106">273 </a><a href="#0_111">mysqlrplsho</a><a href="#0_111">w</a><a href="#0_111">- Show Slaves for Master Server </a>............................................................ <a href="#0_111">276 </a><a href="#0_112">mysqlserverclon</a><a href="#0_112">e</a><a href="#0_112">- Clone Existing Server to Create New Server </a>................................. <a href="#0_112">279 </a><a href="#0_113">mysqlserverinf</a><a href="#0_113">o</a><a href="#0_113">- Display Common Diagnostic Information from a Server </a>.................... <a href="#0_113">281 </a><a href="#0_114">mysqluserclon</a><a href="#0_114">e</a><a href="#0_114">- Clone Existing User to Create New User </a>.......................................... <a href="#0_114">283 </a><br><a href="#0_115">Parsers </a>.................................................................................................................................. <a href="#0_115">285 </a><a href="#0_116">mysql.utilities.parser — Parse MySQL Log Files </a>.............................................................. <a href="#0_116">285 </a><br><a href="#0_117">Appendix </a>............................................................................................................................... <a href="#0_117">287 </a><br><a href="#0_118">MySQL Utilities FAQ </a>...................................................................................................... <a href="#0_118">287 </a><br><a href="#0_2">A. Third Party Licenses </a>.................................................................................................................. <a href="#0_2">289 </a><br><a href="#0_119">.NET Flat TabControl License </a>................................................................................................. <a href="#0_119">290 </a><a href="#0_120">ANTLR 3.4 License </a>................................................................................................................ <a href="#0_120">290 </a><a href="#0_121">Bitstream Vera License </a>.......................................................................................................... <a href="#0_121">291 </a><a href="#0_122">Boost Library License </a>............................................................................................................. <a href="#0_122">292 </a></p>