MySQL Workbench


This is the MySQL™ Workbench Reference Manual. It documents both MySQL Workbench Commercial and MySQL Workbench Community editions 6.2 through 6.2.4.

If you have not yet installed MySQL Workbench Community please download your free copy from the download site. MySQL Workbench Community is available for Windows, OS X, and Linux.

For notes detailing the changes in each release, see the MySQL Workbench Release Notes.

For legal information, see the Legal Notices.

Document generated on: 2015-01-24 (revision: 41373)

Table of Contents

Preface and Legal Notices
1 General Information
1.1 What Is New in MySQL Workbench 6
1.1.1 New in MySQL Workbench 6.2
1.1.2 New in MySQL Workbench 6.1
1.1.3 New in MySQL Workbench 6.0
1.2 MySQL Workbench Editions
2 Installation
2.1 System Requirements
2.2 Command-line options
2.3 MySQL Workbench on Windows
2.3.1 Installing
2.3.2 Launching
2.3.3 Uninstalling
2.4 MySQL Workbench on Linux
2.4.1 Installing
2.4.2 Launching
2.4.3 Uninstalling
2.5 MySQL Workbench on OS X
2.5.1 Installing
2.5.2 Launching
2.5.3 Uninstalling
3 Configuration
3.1 User Accessibility Options
3.2 Workbench Preferences
3.2.1 General Editors Preferences
3.2.2 SQL Editor Preferences
3.2.3 Administration Preferences
3.2.4 Modeling Preferences
3.2.5 Fonts and Colors Preferences
3.2.6 Advanced Preferences
3.2.7 Other Preferences
3.3 MySQL Workbench Settings and Log Files
3.4 Tutorial: Add a Custom Link to the Home Page
4 The Home Screen
5 Administrative Tasks
5.1 Server Management
5.1.1 MySQL Connection Navigator
5.1.2 MySQL Connections
5.1.3 Server Logs
5.1.4 Service Control
5.1.5 Configuration (options file)
5.2 Users and Privileges
5.3 Server Status
5.4 Status and System Variables
5.5 Database Export and Import
5.6 MySQL Audit Inspector Interface
5.7 MySQL Enterprise Backup Interface
5.7.1 General Requirements
5.7.2 Online Backup
5.7.3 Backup Recovery
5.8 The wbcopytables Tool
6 Performance Tools
6.1 Performance Dashboard
6.2 Performance Schema Reports
6.3 Visual Explain Plan
6.4 Query Statistics
6.5 Tutorial: Using Visual Explain to improve query performance
7 Database Development
7.1 Visual SQL Editor
7.1.1 SQL Query Window
7.1.2 SQL Query Window Toolbar
7.1.3 Query and Edit Menus
7.1.4 Results Window
7.1.5 SQL Snippets tab
7.1.6 Context Sensitive Help
7.1.7 Output History Panel
7.1.8 Table Data Search Panel
7.1.9 Export a Result Set
7.1.10 Tutorial: Adding Data
7.1.11 The MySQL Table Editor
7.1.12 Code Generation Overview
7.2 Object Management
7.2.1 Object Browser and Editor Navigator
7.2.2 Session and Object Information Panel
7.2.3 Schema and Table Inspector
8 Database Design / Modeling
8.1 Modeling Interface
8.1.1 Model Editor
8.1.2 EER Diagram Editor
8.1.3 Creating Tables
8.1.4 Creating Foreign Key Relationships
8.1.5 Creating Views
8.1.6 Creating Routines and Routine Groups
8.1.7 Creating Layers
8.1.8 Creating Notes
8.1.9 Creating Text Objects
8.1.10 Creating Images
8.2 Additional Modeling Tools
8.2.1 Printing Diagrams
8.2.2 DBDoc Model Reporting
8.2.3 Schema Validation Plugins
8.3 Modeling Tutorials
8.3.1 Creating a Model
8.3.2 Basic Modeling
8.3.3 Importing a Data Definition SQL Script
8.3.4 Using the Default Schema
8.3.5 Documenting the sakila Database
8.4 Forward and Reverse Engineering
8.4.1 Forward Engineering
8.4.2 Reverse Engineering
8.5 Schema Synchronization and Comparison
8.5.1 Database Synchronization
8.5.2 Compare and Report Differences in Catalogs
8.6 Table Templates
8.7 Customizing DBDoc Model Reporting Templates
8.7.1 Supported Template Markers
8.7.2 Creating a Custom Template
9 Database Migration Wizard
9.1 General installation requirements
9.1.1 ODBC Libraries
9.1.2 ODBC Drivers
9.2 Migration Overview
9.2.1 A visual guide to performing a database migration
9.2.2 Migrating from supported databases
9.2.3 Migrating from unsupported (generic) databases
9.3 Conceptual DBMS equivalents
9.4 Microsoft Access Migration
9.5 Microsoft SQL Server migration
9.5.1 Preparations
9.5.2 Drivers
9.5.3 Connection Setup
9.5.4 Microsoft SQL Server Type Mapping
9.6 PostgreSQL migration
9.6.1 Preparations
9.6.2 Drivers
9.6.3 Connection Setup
9.6.4 PostgreSQL Type Mapping
9.7 MySQL migration
9.8 Using the MySQL Workbench Migration Wizard
9.8.1 Connecting to the databases
9.8.2 Schemata Retrieval and Selection
9.8.3 Reverse Engineering
9.8.4 Object Selection
9.8.5 Migration
9.8.6 Manual Editing
9.8.7 Target Creation Options
9.8.8 Schema Creation
9.8.9 Create Target Results
9.8.10 Data Migration Setup
9.8.11 Bulk Data Transfer
9.8.12 Migration Report
9.9 MySQL Workbench Migration Wizard FAQ
A MySQL Workbench Frequently Asked Questions
B Keyboard Shortcuts
C Extending Workbench
C.1 GRT and Workbench Data Organization
C.2 Modules
C.3 Plugins / Tools
C.4 Adding a GUI to a Plugin Using MForms
C.5 The Workbench Scripting Shell
C.5.1 Exploring the Workbench Scripting Shell
C.5.2 The Shell Window
C.5.3 The Files, Globals, Classes, Modules, and Notifications Tabs
C.6 Tutorial: Writing Plugins
D How To Report Bugs or Problems
E MySQL Enterprise Features
F MySQL Utilities
G MySQL Workbench Change History
H Third Party Licenses
H.1 .NET Flat TabControl License
H.2 ANTLR License
H.3 Bitstream Vera License
H.4 Boost Library License
H.5 Cairo License
H.6 CTemplate (Google Template System) License
H.7 cURL (libcurl) License
H.8 DockPanel Suite License
H.9 Dojo Toolkit v1.7.0b1 License
H.10 GDAL/OGR License
H.11 GLib License (for MySQL Workbench)
H.12 Glitz License
H.13 GNU Lesser General Public License Version 2.1, February 1999
H.14 HtmlRenderer (System.Drawing.Html)
H.15 iODBC License
H.16 Libiconv License
H.17 Libintl License
H.18 libpng License
H.19 Libxml2 License
H.20 Libzip License
H.21 Lua (liblua) License
H.22 Paramiko License
H.23 PCRE License
H.24 Pixman License
H.25 PROJ.4 License
H.26 PyCrypto 2.6 License
H.27 PyODBC License
H.28 PySQLite License
H.29 Python License
H.30 Scintilla License
H.31 ScintillaNET License
H.32 SQLCipher License
H.33 TinyXML License
H.34 TreeViewAdv for .NET License
H.35 VSQLite++ License
H.36 zlib License