MySQL Workbench

Abstract

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

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, Mac 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: 2014-09-12 (revision: 40107)


Table of Contents

Preface and Legal Notices
1 General Information
1.1 MySQL Workbench Editions
1.2 What Is New in MySQL Workbench 6.x
1.2.1 What Is New in MySQL Workbench 6.1
1.2.2 What Is New in MySQL Workbench 6.0
1.3 How To Report Bugs or Problems
1.4 MySQL Utilities
1.5 User Accessibility
2 Installing and Launching MySQL Workbench
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 Mac OS X
2.5.1 Installing
2.5.2 Launching
2.5.3 Uninstalling
3 MySQL Connections
3.1 MySQL Connections Home
3.2 Creating A New MySQL Connection
3.3 Manage Server Connections
3.3.1 Standard TCP/IP Connection Method
3.3.2 Local Socket/Pipe Connection Method
3.3.3 Standard TCP/IP over SSH Connection Method
3.3.4 System Profile
3.3.5 Configure Server Management Wizard
3.3.6 The Password Storage Vault
3.4 MySQL Connection Management Navigator
3.4.1 Navigator MANAGEMENT Actions
3.4.2 Navigator INSTANCE Actions
3.4.3 Navigator PERFORMANCE Actions
3.4.4 Navigator MYSQL ENTERPRISE Actions
4 Getting Started Tutorial
4.1 Creating a MySQL Connection
4.2 Creating a Model
4.3 Adding Data to Your Database
5 The Home Window
5.1 Workbench Shortcuts
5.2 MySQL Connections
5.3 Workbench Preferences
5.3.1 The General Tab
5.3.2 The Administrator Tab
5.3.3 The SQL Editor Tab
5.3.4 The SQL Queries Tab
5.3.5 The Model Tab
5.3.6 The Model:MySQL Tab
5.3.7 The Diagram Tab
5.3.8 The Appearance Tab
5.3.9 The Theming Tab
6 SQL Development
6.1 SQL Editor
6.1.1 Main Menu
6.1.2 Toolbar
6.1.3 SQL Query Panel
6.1.4 Sidebar
7 Data Modeling
7.1 Model Editor
7.1.1 Modeling Menus
7.1.2 The Toolbar
7.1.3 EER Diagrams
7.1.4 The Physical Schemata Panel
7.1.5 The Schema Privileges Panel
7.1.6 The SQL Scripts Panel
7.1.7 The Model Notes Panel
7.1.8 The History Palette
7.1.9 The Model Navigator Panel
7.1.10 The Catalog Tree Palette
7.1.11 The Layers Palette
7.1.12 The Properties Palette
7.2 EER Diagram Editor
7.2.1 The Vertical Toolbar
7.3 Working with Models
7.3.1 Creating Tables
7.3.2 Creating Foreign Key Relationships
7.3.3 Creating Views
7.3.4 Creating Routines and Routine Groups
7.3.5 Creating Layers
7.3.6 Creating Notes
7.3.7 Creating Text Objects
7.3.8 Creating Images
7.3.9 Reverse Engineering
7.3.10 Forward Engineering
7.4 Modeling Tutorials
7.4.1 Importing a Data Definition SQL Script
7.4.2 Using the Default Schema
7.4.3 Basic Modeling
7.4.4 Documenting the sakila Database
7.5 Printing
7.5.1 Printing Options
7.6 MySQL Workbench Schema Validation Plugins (Commercial Version)
7.6.1 General Validation
7.6.2 MySQL-Specific Validation
7.7 The DBDoc Model Reporting Dialog Window (Commercial Version)
7.8 Customizing DBDoc Model Reporting Templates
7.8.1 Supported Template Markers
7.8.2 Creating a Custom Template
8 Code Generation Overview
8.1 Generating SQL Statements
8.2 Generating PHP Code
9 MySQL Enterprise Features
9.1 MySQL Audit Inspector Interface
9.2 MySQL Enterprise Backup Interface
9.2.1 General Requirements
9.2.2 Online Backup
9.2.3 Backup Recovery
10 Database Migration Wizard
10.1 General installation requirements
10.1.1 ODBC Libraries
10.1.2 ODBC Drivers
10.2 Migration Overview
10.2.1 A visual guide to performing a database migration
10.2.2 Migrating from supported databases
10.2.3 Migrating from unsupported (generic) databases
10.3 Conceptual DBMS equivalents
10.4 Microsoft SQL Server migration
10.4.1 Preparations
10.4.2 Drivers
10.4.3 Connection Setup
10.4.4 Microsoft SQL Server Type Mapping
10.5 PostgreSQL migration
10.5.1 Preparations
10.5.2 Drivers
10.5.3 Connection Setup
10.5.4 PostgreSQL Type Mapping
10.6 MySQL migration
10.7 Using the MySQL Workbench Migration Wizard
10.7.1 Connecting to the databases
10.7.2 Schemata Retrieval and Selection
10.7.3 Reverse Engineering
10.7.4 Object Selection
10.7.5 Migration
10.7.6 Manual Editing
10.7.7 Target Creation Options
10.7.8 Schema Creation
10.7.9 Create Target Results
10.7.10 Data Migration Setup
10.7.11 Bulk Data Transfer
10.7.12 Migration Report
10.8 MySQL Workbench Migration Wizard FAQ
11 The wbcopytables Tool
12 Extending Workbench
12.1 GRT and Workbench Data Organization
12.2 Modules
12.3 Plugins / Tools
12.4 Adding a GUI to a Plugin Using MForms
12.5 The Workbench Scripting Shell
12.5.1 Exploring the Workbench Scripting Shell
12.5.2 The Shell Window
12.5.3 The Files, Globals, Classes, Modules, and Notifications Tabs
12.6 Tutorial: Writing Plugins
13 Keyboard Shortcuts
A MySQL Workbench Frequently Asked Questions
B MySQL Workbench and Utilities Change History
B.1 MySQL Workbench Change History
B.2 MySQL Utilities Change History
C Third Party Licenses
C.1 .NET Flat TabControl License
C.2 ANTLR License
C.3 Bitstream Vera License
C.4 Boost Library License
C.5 Cairo License
C.6 CTemplate (Google Template System) License
C.7 cURL (libcurl) License
C.8 DockPanel Suite License
C.9 Dojo Toolkit v1.7.0b1 License
C.10 GLib License (for MySQL Workbench)
C.11 Glitz License
C.12 GNU Lesser General Public License Version 2.1, February 1999
C.13 HtmlRenderer (System.Drawing.Html)
C.14 iODBC License
C.15 Libiconv License
C.16 Libintl License
C.17 libpng License
C.18 Libxml2 License
C.19 Libzip License
C.20 Lua (liblua) License
C.21 Paramiko License
C.22 PCRE License
C.23 Pixman License
C.24 PyCrypto 2.6 License
C.25 PyODBC License
C.26 PySQLite License
C.27 Python License
C.28 Scintilla License
C.29 ScintillaNET License
C.30 SQLCipher License
C.31 TinyXML License
C.32 TreeViewAdv for .NET License
C.33 VSQLite++ License
C.34 zlib License