Toad® for MySQL 8.0
Installation Guide
© 2017 Quest Software Inc.
ALL RIGHTS RESERVED.
This guide contains proprietary information protected by copyright. The software described in this guide is
furnished under a software license or nondisclosure agreement. This software may be used or copied only in
accordance with the terms of the applicable agreement. No part of this guide may be reproduced or transmitted
in any form or by any means, electronic or mechanical, including photocopying and recording for any purpose
other than the purchaser’s personal use without the written permission of Quest Software Inc.
The information in this document is provided in connection with Quest Software products. No license, express
or implied, by estoppel or otherwise, to any intellectual property right is granted by this document or in
connection with the sale of Quest Software products. EXCEPT AS SET FORTH IN THE TERMS AND
CONDITIONS AS SPECIFIED IN THE LICENSE AGREEMENT FOR THIS PRODUCT, QUEST SOFTWARE
ASSUMES NO LIABILITY WHATSOEVER AND DISCLAIMS ANY EXPRESS, IMPLIED OR STATUTORY
WARRANTY RELATING TO ITS PRODUCTS INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTY
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT. IN NO EVENT
SHALL QUEST SOFTWARE BE LIABLE FOR ANY DIRECT, INDIRECT, CONSEQUENTIAL, PUNITIVE,
SPECIAL OR INCIDENTAL DAMAGES (INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OF
PROFITS, BUSINESS INTERRUPTION OR LOSS OF INFORMATION) ARISING OUT OF THE USE OR
INABILITY TO USE THIS DOCUMENT, EVEN IF QUEST SOFTWARE HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES. Quest Software makes no representations or warranties with respect to the
accuracy or completeness of the contents of this document and reserves the right to make changes to
specifications and product descriptions at any time without notice. Quest Software does not make any
commitment to update the information contained in this document.
If you have any questions regarding your potential use of this material, contact:
Quest Software Inc.
Attn: LEGAL Dept
4 Polaris Way
Aliso Viejo, CA 92656
Refer to our web site (www.quest.com) for regional and international office information.
Patents
Quest Software is proud of our advanced technology. Patents and pending patents may apply to this product.
For the most current information about applicable patents for this product, please visit our website at
www.quest.com/legal.
Trademarks
Quest, Quest Software, SQL Navigator, vWorkspace, Toad, and the Quest logo are trademarks of Quest
Software Inc. in the U.S.A. and other countries. For a complete list of Quest Software trademarks, please visit
our website at www.quest.com/legal. Microsoft, Windows, Windows Server, Windows Vista, Visual Studio,
SharePoint, Access and Excel are either registered trademarks or trademarks of Microsoft Corporation in the
United States and/or other countries. Oracle is a trademark or registered trademark of Oracle and/or its affiliates
in the United States and other countries. Citrix® and XenApp™ are trademarks of Citrix Systems, Inc. and/or
one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in
other countries. MySQL is a registered trademark of MySQL AB in the United States, the European Union and
other countries. Subversion is a trademark of the Apache Software Foundation. All other trademarks,
servicemarks, registered trademarks, and registered servicemarks are property of their respective owners.
Toad for MySQL 8.0
Installation Guide
Friday, April 14, 2017
Contents
Contents
3
Installation
5
System Requirements
Client Requirements
Server Requirements
Virtualization Support
User Requirements
5
5
6
6
7
Install Toad
8
Specify Application Data Directory Location
8
Install Toad Silently
Determine Which Installer to Use
Silent Installation Prerequisites
Silent Installation Using the Executable
Silent Installation Using the Microsoft Installer
9
9
9
9
11
Install Toad on Citrix® Systems
13
Upgrade Toad
14
Upgrade Automation Scripts and Scheduling Tasks
Upgrade Automation Scripts to Newer Version of Toad
Migrate Scheduling Tasks to Newer Version of Toad
14
14
15
Uninstall Toad
16
Licensing
16
Create and Troubleshoot Connections
17
Understand Toad Connections
Toad Open Connections
Sharing a Connection Among Windows
17
17
17
Create MySQL Connections
18
Troubleshoot MySQL Issues
19
Configure Version Control
20
About Version Control
Prerequisites
20
20
Version Control for Toad Files
21
Configure Version Control for Objects
23
Manage Objects under Version Control
25
Troubleshoot Version Control
Troubleshoot Upgrades
Troubleshoot Other Issues
27
27
27
Toad for MySQL 8.0 Installation Guide
Contents
3
About Us
29
We are more than just a name
29
Our brand, our vision. Together.
29
Contact Quest
29
Technical Support Resources
29
Index
31
Toad for MySQL 8.0 Installation Guide
Contents
4
1
Installation
System Requirements
Review the following client and database server requirements for Toad® for MySQL.
Client Requirements
Before installing Toad, ensure that your client system meets the following minimum hardware and software
requirements:
Requirement
Details
Platform
1 GHz minimum
Memory
512 MB of RAM minimum, 1 GB recommended
Note: The memory required may vary based on the following:
l
Applications that are running on your system when using Toad
l
Size and complexity of the database
l
Amount of database activity
l
Number of concurrent users accessing the database
Hard Disk Space
800 MB to install Toad
Operating System
Windows Server® 2008 R2 (64-bit)
Windows® 7 (32-bit or 64-bit)
Windows® 8 (32-bit and 64-bit)
Windows® 8.1 (32-bit and 64-bit)
Windows® 10
Important: Toad uses the Microsoft® Distributed Transaction Coordinator (DTC) when
opening a SQL file to get Full-Text Search status, but DTC is disabled by default on
Windows Vista, Windows Server 2008 and Windows 7. If you are using either operating
system, ensure that Network DTC access is enabled on the Toad client. See
http://technet.microsoft.com/en-us/library/cc753510(WS.10).aspx for more information
about enabling DTC access.
Toad for MySQL 8.0 Installation Guide
Installation
5
Requirement
Details
.NET Framework
The Microsoft® .NET Framework is required. The version is dependent on the
operating system.
.NET 4.5.1 or later
Windows 10
.NET 4.5.1
Windows Vista SP2, Windows 7, Windows 8, Windows Server
2008 (SP2 or earlier), Windows Server 2008 R2, Windows
Server 2012
.NET 4.0
Windows XP, Windows Vista (SP1 or earlier), Windows Server
2003
Notes:
l
l
Additional
Requirements
This information is provided to aid installation. Toad is
not tested on Windows XP. Windows Vista (SP1 or
earlier), and Windows Server 2003.
The .NET Framework 4 Client Profile is not supported.
Web Browser
Microsoft® Internet Explorer® 6.0 or later
Screen
Toad supports screen resolutions up to 3200 x 1800 and display DPI settings up to
150%.
Server Requirements
Before installing Toad, ensure that your server meets the following minimum hardware and software
requirements:
Requirement
Details
Database Server
MySQL 4.1, 5.0, 5.1, 5.5, 5.6
Clustrix 5.2
MariaDB 5.5.5
Cloud Database
Service
Toad can manage Amazon RDS and any other cloud or service offering compatible
with MySQL, including Amazon Aurora.
Virtualization Support
Requirement
Details
Application
Virtualization
Limited testing has been performed for Citrix® XenApp™ 5.0 on Windows Server 2003
and Citrix XenApp 6.5 on Windows Server 2008 R2.
Limited testing has been performed for Citrix support on Windows Server 2003
Enterprise Server (Service Pack 2) using the MetaFrame Presentation Server 5.0 and
Citrix Presentation Server Clients 10.2.
See "Install Toad on Citrix® Systems" on page 13 for more information.
Note: Toad may work in virtualization environments other than the ones in which it was tested.
Toad for MySQL 8.0 Installation Guide
Installation
6
User Requirements
User Requirements to Install Toad
Only Windows Administrators and Power Users can install Toad.
If an Administrator installs Toad, the Administrator can share the Toad shortcut icon on the desktop and menu
items with any user—a Power User, Restricted User, Vista standard user—on the computer.
If a Power User installs Toad, a Restricted User cannot do the following:
l
l
Associate file extensions.
View the Toad shortcut icon on the desktop or the Toad menu options in the Windows Start menu. As a
workaround, Restricted Users can create a shortcut to Toad from the install directory and place the
shortcut on their desktop.
User Requirements and Restrictions for Running Toad
The following describes the requirements and restrictions for users who launch and run Toad:
l
To create or modify the QuestSoftware.ToadSecurity table to enable Toad Security, the user who
maintains this table must have privileges to create, insert, update, and delete it. All other users need only
the ability to read the QuestSoftware.ToadSecurity table to use Toad Security features.
Toad for MySQL 8.0 Installation Guide
Installation
7
Install Toad
To install Toad
1. Run the ToadInstaller.exe.
2. Complete the wizard.
Specify Application Data Directory
Location
Toad for MySQL 8.0 stores settings files in the user's Application Data directory. The default location cannot be
modified from within the application. Toad provides two methods to change the default location: by using a
Registry setting or by using a command switch in a Toad shortcut.
Use the Registry setting method to change the application data directory from Roaming to Local. Use the
command switch method to change the location to any new path.
To change Toad Application Data directory location from Roaming to Local
In the Registry under Toad for MySQL (Computer\HKEY_CURRENT_USER\Software\Quest Software\Toad for
MySQL\8.0), add LOCALSETTINGS with a value of 1.
See the following table for default (Roaming) and resulting (Local) directory path.
Caution: All current Toad settings will be lost after applying this Registry setting unless you manually copy
the settings files from the default location (Roaming directory) to the new location (Local directory). Copy the
settings files BEFORE you add the Registry setting and BEFORE opening Toad.
Operating System
Default Location
New Location when
LOCALSETTINGS = 1
Windows Vista
C:\Users\username\
AppData\Roaming\Quest
Software\Toad for MySQL 8.0
C:\Users\username\
AppData\Local\Quest Software\ Toad
for MySQL 8.0
Windows Server 2008
Windows 7
Windows 8
To change Toad Application Data directory location using a command-line switch
You can override the default Application Data directory by running Toad with the command switch:
Toad.exe --datadir="YourNewDirPath"
To instruct Toad to always use the new directory path, add the command switch and the new directory path to a
Toad desktop shortcut. Then use the desktop shortcut when opening Toad.
1. To add the command switch, right-click the Toad shortcut and select Properties.
2. Enter the command switch and add the directory path in quotes (replace "YourNewDirPath" with your
directory path).
Toad for MySQL 8.0 Installation Guide
Installation
8
Install Toad Silently
Silent installation provides a convenient method for deploying Toad to multiple machines. With some
customization, you can also deploy the license key and settings at the same time.
Determine Which Installer to Use
Before performing a silent installation, review the following to determine which installer to use:
Installer
Advantages
Disadvantages
Executable file
(.exe)
Silent installation using the .exe file has
the following advantages: Silent installation using the .exe file has
the following disadvantages: l
Microsoft Installer
file (.msi)
Verifies whether the prerequisite
software is installed, and if not,
redirects you to the download
location.
Supports deployment of Toad settings
files and license keys.
l
l
Cannot deploy custom Toad
settings files or license keys.
Installer automatically exits if the
prerequisite software is not
installed.
Silent installation using the .msi file has
the following disadvantages: l
l
Requires manual verification and
download of any prerequisite
software.
Requires a manual uninstall of the
previous version of Toad using
Add/Remove Programs.
Silent Installation Prerequisites
Before you can perform a silent installation, the following software must be installed on every computer where
you are installing Toad: l
Microsoft .NET Framework 4.5
Silent Installation Using the Executable
Use the executable file to perform a silent install to the default directory (or to a different directory) and to specify
options such as logging installation messages.
To perform a silent install using the executable file
1. At a Windows command prompt, switch to the drive or directory where the executable for Toad is
located. (This file can be downloaded from the Quest Software Web site or can be found on the Toad
installation CD-ROM.)
2. For a standard installation with all features enabled, enter the following command:
“ToadInstaller.exe” /S
You can customize MSIEXEC command-line options and overrides for your installation similar to the
following command:
“ToadInstaller.exe” /S /Lx “C:\temp\installLog.txt” INSTALLDIR=”Drive:\your_
Toad for MySQL 8.0 Installation Guide
Installation
9
install_path” USERNAME=”some_user” COMPANYNAME=”your_company” ALLUSERS=1
Use the following descriptions to customize the command-line options and overrides for your installation.
Command-Line Options
The following MSIEXEC command-line options are used in this example:
Option
Description
/L “C:\temp\
installLog.txt”
(Optional) Write installation messages to the specified log. You can append
other options, such as x for debug (used in the previous example) or v for a
verbose log. See the log section at http://msdn2.microsoft.com/enus/library/aa367988.aspx for more information about additional logging
options.
Also, substitute “C:\temp\installLog.txt” in the example with the fully qualified
name of the log file. Enclose this value in double quotations. The installation
process creates this file if it does not exist. Otherwise, the existing file is
overwritten.
Toad Default Installation Option Overrides
You can specify the following values to override Toad’s default installation options. Enclose each value
in double quotations.
Option
Description
INSTALLDIR
(Optional) Specify the absolute path for the directory in which you want to install
Toad. If you do not include this path, the installation program defaults to:
C:\Program Files (x86)\Quest Software\Toad for MySQL8.0.
ALLUSERS
(Optional) Specify one of the following:
l
l
For a per-machine installation, specify 1. This value allows any user to
use the Toad shortcut on the desktop after the installation completes.
For a per-user installation, enter the empty string value (“”) This value
allows only the user specified for USERNAME (and the user that installed
Toad) to see the Toad shortcut on the target desktop. If USERNAME is
omitted, only the user that installed Toad sees the shortcut.
Note: If you do not specify this property, the installation program defaults to a peruser installation.
USERNAME
(Optional) Specify the user that intends to use Toad on the target computer.
Notes:
l
l
l
COMPANYNAME
If ALLUSERS is omitted or defined with the empty string value (""), only
the user specified here (and the user that installed Toad) can see the
Toad shortcut on the desktop after the installation completes.
If ALLUSERS is omitted or defined with the empty string value ("") and you
omit the USERNAME option, only the user that installed Toad sees the
Toad shortcut on the desktop.
If ALLUSERS is 1, the USERNAME value is ignored during installation.
(Optional) Specify the name of the company that owns this installation.
Notes:
l
All default installation option overrides are case-sensitive.
l
Enclose all values (except for the ALLUSERS value) in double quotations.
Toad for MySQL 8.0 Installation Guide
Installation
10
Silent Installation Using the Microsoft Installer
Perform Silent Installation Using MSI
To perform a silent install using msi
1. At a Windows command prompt, switch to the drive or directory where the msi installer for Toad
is located.
2. For a standard installation with all features enabled, enter the following command:
msiexec /i “ToadInstaller.msi” /q
You can customize command-line options and overrides for your installation similar to the following:
msiexec /i “ToadInstaller.msi” INSTALLDIR= “Drive:\your_install_path” /q
USERNAME=”someone” COMPANYNAME=”your_company” ALLUSERS=1
Command-Line Options
The following MSIEXEC command-line options are used in this example:
Option
Description
/i
Run the installation.
/q
Specify the user interface (UI) that displays during installation. You can append
other options, such as n to hide the UI or b to hide the Cancel button during the
installation.
Note: All command-line options are case-insensitive. See http://msdn2.microsoft.com/enus/library/aa367988.aspx for a complete list of command-line options.
Toad Default Installation Option Overrides
You can specify the following values to override Toad’s default installation options. Enclose each value
in double quotations.
Option
Description
INSTALLDIR
(Optional) Specify the absolute path for the directory in which you want to install
Toad. If you do not include this path, the installation program defaults to:
C:\Program Files (x86)\Quest Software\Toad for MySQL8.0.
ALLUSERS
(Optional) Specify one of the following:
l
l
For a per-machine installation, specify 1. This value allows any user to
use the Toad shortcut on the desktop after the installation completes.
For a per-user installation, enter the empty string value (“”) This value
allows only the user specified for USERNAME (and the user that installed
Toad) to see the Toad shortcut on the target desktop. If USERNAME is
omitted, only the user that installed Toad sees the shortcut.
Note: If you do not specify this property, the installation program defaults to a peruser installation.
USERNAME
(Optional) Specify the user that intends to use Toad on the target computer.
Notes:
l
If ALLUSERS is omitted or defined with the empty string value (""), only
the user specified here (and the user that installed Toad) can see the
Toad for MySQL 8.0 Installation Guide
Installation
11
Option
Description
Toad shortcut on the desktop after the installation completes.
l
l
COMPANYNAME
If ALLUSERS is omitted or defined with the empty string value ("") and you
omit the USERNAME option, only the user that installed Toad sees the
Toad shortcut on the desktop.
If ALLUSERS is 1, the USERNAME value is ignored during installation.
(Optional) Specify the name of the company that owns this installation.
Notes:
l
All default installation option overrides are case-sensitive.
l
Enclose all values (except for the ALLUSERS value) in double quotations.
Create Transform (MST) Files
You can create a Microsoft transform (.mst) file that deploys the license key, custom settings, and connections
for users when performing a silent install using the .msi file. You can also use the .msi file to perform a basic
silent install using the default directory (or install to a different directory) and to specify command-line options
and default installation overrides. See "Perform Silent Installation Using MSI" on page 11 for more information if
you are not creating a transform file.
Note: (MSI installs on Windows Vista and 7) If you are using MSI to install Toad on Windows Vista or 7 with UAC
enabled, you can install a file that adds a "Run as administrator" option when right-clicking the MSI
file: http://www.symantec.com/connect/downloads/msi-run-administrator-context-menu-vista.
Note: The installer does not verify that system requirements have been met before installing. If you do not want
to manually verify system requirements, you should use the .exe file for the silent install.
The following procedure uses the Wise Installer to create the transform file.
To create a transform file that includes custom Toad settings
1. Save and install the ToadInstaller.msi file on a computer where the Wise for Windows Installer is
installed. After customizing Toad settings, you will use the Wise Installer to create the transform file.
2. Open Notepad, and do the following:
a. Enter the license key in the first line.
b. Enter the site message in the second line.
c. Save the file with license.key as the file name in the Toad install directory. Make sure the file
extension is .key not .txt.
3. Launch Toad. The application should open without prompting you to enter a license key.
4. Select Tools | Configuration Wizard from the Toad menu and complete the Configuration wizard. This
wizard creates an initial settings file (Settings.xml).
5. Select Tools | Options from the menu in Toad to open the Options window.
6. Select each page in the window and set any options you want to deploy. These options create a module
settings folder and files.
7. Select View | Connection Manager from the menu in Toad to open the Connection Manager.
8. Create any connections you want to deploy.
9. Exit Toad. Upon exiting, a Connections file is created.
10. Create the Microsoft Transform file, using any appropriate tool. The following steps describe how to use
the Wise for Windows Installer to create the file. Toad for MySQL 8.0 Installation Guide
Installation
12
a. Select File | New.
b. Select Custom Templates under Categories, and then select the Transform template in the New
Installation File window.
c. Select the ToadInstaller.msi file in the Select the .MSI file to base this transform on window.
d. Save the project.
e. Select Files from the Feature Details view.
f. Locate the following files and click Add to add them to the project:
File to Add
Windows Vista, Windows Server 2008, Windows 7, Windows 8
Settings.xml
C:\Users\ username\AppData\Roaming\ Quest Software\Toad for
MySQL 8.0.
ModuleSettings folder and
files
C:\Users\username\AppData\Roaming\ Quest Software\Toad for
MySQL 8.0\ModuleSettings.
Connections.xml
C:\Users\username\AppData\Roaming\ Quest Software\Toad for
MySQL 8.0.
g. Save the project and compile it to create the transform (MST) file.
11. Perform a silent install. See "Perform Silent Installation Using MSI" on page 11 for more information.
Install Toad on Citrix® Systems
Toad must be installed on the Citrix server by the Citrix administrator. Users then connect to this instance
through their Citrix login.
Note: Limited testing has been performed for Citrix XenApp™ 5.0 support on Windows Server® 2003 and for
Citrix XenApp 6.5 on Windows Server 2008 R2.
To install Toad on a Citrix system
1. Connect to the Citrix Environment as an administrator.
2. Copy Toad to the Citrix server, if needed.
3. Start the Toad installation process.
4. During installation, select the Anyone who uses this computer checkbox when prompted.
5. Repeat steps 2 through 4 for each server in the Citrix farm.
Note: Although you must install Toad on every server in the Citrix farm, you only need to
publish Toad once.
6. Review the following considerations regarding licensing:
l
l
l
A license supplied by an administrator always overrides a user-supplied license in a Citrix
environment.
If you need to provide the same Toad functionality to all users, you can enter the default license
key for all users.
If you have users with different license requirements (for example, some have Standard licenses
and others have Professional licenses), individual licenses should be entered for each user. You
should not enter the default license key because it enables all functionality in Toad.
Toad for MySQL 8.0 Installation Guide
Installation
13
Upgrade Toad
To upgrade Toad
1. Run the ToadInstaller.exe installation program from the DVD or downloaded file.
2. Select Uninstall Toad and continue with install.
3. Complete the wizard.
If you are upgrading from a previous version of Toad, you are prompted to migrate your settings the first time you
start Toad. The settings files include database connections, layout customizations, shortcut keys, and options
customized in the Options pages.
To migrate the settings again, remove or rename the current version's Application Data folder and migrate the
files from the previous version's Application Data folder.
Upgrade Automation Scripts and
Scheduling Tasks
If you upgrade to a newer version of Toad, Automation scripts created in a previous version must be upgraded
before you can open them in the newer version. Toad prompts you to automatically upgrade a script when you
attempt to open it in a newer version.
In addition, scheduled scripts are scheduled to run using the version of Toad in which they were created. After
upgrading Toad, those previously-created, scheduled scripts will not execute in the newer version until you
migrate each script's scheduling task. Toad prompts you to migrate scheduling tasks when you initially launch
the application after installation.
Upgrade Automation Scripts to Newer Version of Toad
An automation script is compatible with the version of Toad in which the script was created. If you want to open
and/or modify a script using a newer version of Toad, you must upgrade the script. Toad automatically prompts
you to upgrade the script the first time you open it in the newer version.
To upgrade an Automation script
1. Open the script in Toad. Toad prompts you to upgrade the script.
2. To upgrade the script, select Yes.
Toad for MySQL 8.0 Installation Guide
Installation
14
Caution: An automation script is no longer compatible with previous versions of Toad after
an upgrade.
3. Select No (and do not elect to save the script), to keep the script compatible with the previous version.
4. If you selected Yes, Toad upgrades your script and saves a backup copy of the original script in the
following location:
<application data directory>\Automation\bak\
5. If the script you upgraded is also scheduled, you must migrate the scheduling task, otherwise the
upgraded script will fail to run.
Migrate Scheduling Tasks to Newer Version of Toad
Each scheduled Automation script uses a Windows scheduling task. The scheduling task specifies which
version of Toad to use by specifying the version's application path. Toad provides you with two easy ways to
migrate your scheduled scripts' scheduling tasks when you upgrade Toad. First, Toad prompts you to migrate
scheduling tasks upon initial launch of the application after installation. Next, you can migrate scheduling tasks
at any time using the Job Manager.
Notes:
l
l
If you upgrade a previously-created script by opening it in a newer version of Toad, you must also
migrate the scheduling task to the newer version.
If you install the newer version of Toad side-by-side with the older version, previously-created,
scheduled scripts will continue to execute using the older version, until you migrate the scheduling tasks
(provided that you do not open the scripts in the newer version).
To migrate scheduling tasks upon initial launch
1. After upgrading Toad, and upon initial launch of the application, the Migrate Scheduled Tasks
dialog opens.
2. Select the scheduled tasks (scheduled Automation scripts) to migrate to the new version of Toad.
3. Click OK to close the dialog.
4. Toad immediately prompts you for your Windows password. Enter your password to migrate the
scheduled tasks.
To migrate scheduling tasks using the Job Manager
1. Select Tools | Administer | Job Manager.
2. Click
on the Job Manager toolbar.
3. Select the scheduled tasks to migrate and click OK.
Note: Only currently-scheduled tasks (enabled or disabled) are listed in the Migrate Scheduled
Tasks dialog.
4. Toad immediately prompts you for your Windows password. Enter your password to migrate the
scheduled tasks.
Manually Edit Scheduling Tasks
On occasion you may need to modify the application path in a Windows scheduling task. You can do this by
manually editing the scheduling task using the following procedure.
Toad for MySQL 8.0 Installation Guide
Installation
15
To manually edit a scheduling task
1. In the Job Manager (Tools | Administer | Job Manager), right-click a task and select Edit Task.
2. To change the version of Toad used to run the script, in the Actions tab, change the folder name in the
toad.exe path.
Uninstall Toad
If you uninstall Toad, it may not uninstall completely. When you use Toad, you create new files such as SQL
scripts, data output, or temp files, etc. The following types of files are not removed when you uninstall:
l
Any new files you create
l
Any copies of files you make for backup purposes
l
Settings files
You can uninstall Toad for MySQL by using the Installer or by using the Windows Add/Remove Programs (or
Uninstall a program) feature. Using the Installer is the preferred way to uninstall Toad for MySQL.
To uninstall Toad
1. Run the ToadInstaller.exe.
2. Select Uninstall Toad for MySQL only.
3. Complete the wizard.
Licensing
To enter your license key
1. Select Help | Licensing from the menu (ALT+H+L).
2. Review the following for additional information:
Authorization key
Enter the license key for Toad.
Site message
Enter the site message included with the license key.
Note: Your license key determines the edition of Toad and will enable the functionality accordingly. In
many cases, if functionality is disabled within Toad, you may not have an appropriate license to use it.
When Toad is running, you can see which components are licensed by selecting Help | About. For
complete list of features shipped with your Toad edition see http://www.quest.com/.
Toad for MySQL 8.0 Installation Guide
Installation
16
2
Create and Troubleshoot Connections
Understand Toad Connections
Review this topic to learn about open database connections in Toad.
Toad Open Connections
In Toad, an open connection in the Connection/Navigation Manager represents one or more actual connections
to the database. When you open a database connection in Toad:
l
l
Toad creates an initial database connection for general use.
Toad also creates a separate database connection for each Editor (the first time you execute a
statement) and for each Data tab in the Database Explorer (the first time you select the tab and
query data).
The connection associated with the window (or tab) remains open until you close the window. If a
window has an associated connection, but a statement is not currently executing, the connection is in an
inactive state.
To view information for an open connection
l
To view the number of actual database connections that exist for a Toad connection, including the
number of active connections, place the cursor over the connection in the Connection/Navigation
Manager pane or in the connection drop-down list.
To use the Background Processes pane
l
l
When a statement is executing, a progress bar displays in the Status bar located at the bottom of the
Toad application window. Click the executing progress bar to open the Background Processes pane.
To cancel statement execution, use the Background Processes pane.
Note: It is recommended that you cancel only your own processes, because terminating Toad activities
could cause unexpected behavior.
Sharing a Connection Among Windows
You can instruct Toad to share an open connection among windows. In this way, the Editor windows and Data
tabs can share the same connection when the connection is inactive.
To share a database connection among windows in Toad
1. Select Tools | Options | Editor | General.
2. Clear the checkbox for the Use individual connection for each open editor option.
3. When this option is not selected, Toad attempts to use a single connection for any new windows or query
Toad for MySQL 8.0 Installation Guide
Create and Troubleshoot Connections
17
execution. For example, if you share a database connection, you can execute a query in the Editor,
execute another query in a new Editor, and then select the Data tab from the same connection.
If the single connection is in use when Toad attempts to execute it, the following occurs:
l
If your database does not support executing multiple queries on a shared connection, a dialog
prompts you to either permanently associate the window with a new database connection, cancel
the previous operation, or add the query to a queue until the current operation completes, and
the execute it. If you place multiple queries in the queue, each one executes in the order that it
was added to the queue.
Note: Although you can share a database connection, any commits apply to the selected window only.
Create MySQL Connections
You can create a new connection, or connect to an existing connection from the Create New Connection
window. See "Troubleshoot MySQL Issues" on page 19 for more information about troubleshooting MySQL
connection issues.
To create a MySQL connection
1. Click
on the toolbar (ALT+F+N).
2. Select MySQL from the Group list box.
3. Review the following for additional information:
Login Tab
Description
Connection
type
Select the protocol to use when connecting.
Host
Enter the name of the host computer where the database is installed.
Password
Enter the password to use when connecting.
Tip: After connecting, you can set a master password to further secure your
connection in Tools | Options| Environment | Security.
Connection
timeout
Enter the number of seconds to wait when connecting before the application
times out. The default is 15 seconds.
SSL
If you selected SSL as the connection type, review the following for additional
information: l
l
l
Private key—browse to the location of the SSL key file to use when
connecting.
CA cert—browse to the location of the trusted certificate authority to use
when connecting.
Cert—browse to the location of the SSL certificate file to use when
connecting.
Compress
Select this checkbox to compress the value of any strings and return binary
values.
Use MySQL
libraries
Select this checkbox to use an embedded MySQL library instead of the MySQL
.NET provider.
Note: If you select this option, you must specify libMySQL.dll in the path.
Category
Select or create a category if you want to color code Editor tabs for a specific
connection. This can help differentiate between development and production
Toad for MySQL 8.0 Installation Guide
Create and Troubleshoot Connections
18
Click here to view a video of this feature.
4. Click Connect to save the connection and immediately connect to the database.
or
Click Save to save the connection without connecting to the database.
Tip: Connections are stored in the connections.xml file and can be found by clicking the Application Data
Directory link in Help | About.
Troubleshoot MySQL Issues
Review the following solutions to help troubleshoot MySQL connection issues pertaining to database
connections in Toad.
Issue
Cause/Solution
"InvalidCastException" error when
connecting to MYSQL 4.1.14-nt database
This is a known issue in MySQL.
Solution:
Review the known issue and download a patch from:
http://bugs.mysql.com/bug.php?id=12771
"System.IO.DirectoryNot
FoundException"error occurs each time
you attempt to connect after installing
Toad into a directory other than the default
directory.
Solution:
1. Exit Toad.
2. Locate the MySQL.xml file in the C:\Documents and
Settings\username\Local Settings\ Application
Data\Quest Software\ Toad for MySQLversion\
ModuleSettings
3. Rename or delete the MySQL.xml file.
4. Restart Toad.
Toad for MySQL 8.0 Installation Guide
Create and Troubleshoot Connections
19
3
Configure Version Control
About Version Control
Toad integrates with your existing version control system so you can maintain multiple revisions of objects. See
"Configure Version Control for Objects" on page 23 for more information on configuring version control in Toad.
For Version Control of your files handled by Toad see Version Control for Toad Files.
Important: See "Troubleshoot Version Control" on page 27 for more information about issues when upgrading
version control from a previous version.
Notes: l
l
If you want to place database objects under version control, you must configure version control for
objects using the Object Explorer. See "Manage Objects under Version Control" on page 25 for more
information.
If you rename a version controlled object, Toad drops the original object and its history from version
control and prompts you to add the renamed object to version control. This newly renamed object does
not have any history associated with it.
Prerequisites
You must install a supported version control client on the computer where Toad is installed. The following table
lists the supported version control providers and the versions tested with Toad.
Supported
Provider
Server Version Tested
Client Version Tested
Apache
Subversion™
Subversion 1.7.5 on
Windows
CollabNet Subversion Command-Line Client 1.7.5
Git
Toad works only with the local repository. For commands such as clone, pull and push use
an external tool.
Team
Foundation
Server (TFS)
TFS 2008, 2010, 2012,
2013
File system
based
Toad allows to utilize practically any version control system using the external client tool. In
this case Toad Version Control tool works with the directories at local HDD while you commit
changes to the repository with version control client tool.
Note: Any Subversion client must have svn.exe in its installation
directory to use version control in Toad.
Visual Studio® (2008, 2010, 2012, 2013) Team Explorer Client
Note: Toad connects to your version control system based on login information included in the configuration.
Your version control client does not need to run for Toad to connect.
Details of Team Foundation Server support:
Toad for MySQL 8.0 Installation Guide
Configure Version Control
20
Visual Studio/Team Explorer
version
TFS 2013
support
notes
TFS 2012
support
notes
TFS 2010
support
notes
Visual Studio 2015
Supported
(RTM or
latest
update)
Supported
(RTM or
latest
update)
Supported
(RTM or
latest
update)
Visual Studio/Team Explorer
2013
Supported
(RTM or
latest
update)
Supported
(RTM or
latest
update)
Supported
(RTM or
latest
update)
Visual Studio/Team Explorer
2012
Requires
latest
Visual
Studio
2012
update.
Supports
Git with
Visual
Studio
Tools for
Git
extension
Supported
(RTM or
latest
update).
Supports
Git with
Visual
Studio
Tools for
Git
extension
Supported
(RTM or
latest
update).
Supports
Git with
Visual
Studio
Tools for
Git
extension
Note: Additional functionality and compatibility with older clients is possible but out of scope of what we are
able to test.
Version Control for Toad Files
Toad can integrate with your existing version control system allowing you to maintain multiple versions of Toad
files. After you integrate Toad with your version control system, you can perform version control tasks directly
from within Toad, such as commit file changes and retrieve revisions.
Toad supports the following version control systems for managing Toad files:
l
Apache Subversion™—Toad has been tested with Subversion 1.7.5 and 1.8.
The following types of files can be managed using version control from within Toad: Editor (.tef, .sql, .txt), Query
Builder (.tsm), ER Diagram (.ter), and Automation (.tas).
Toad supports version control for database objects, as well as files. Version control for objects is configured
separately from version control for files. For more information about version control for objects, see Configure
Version Control for Objects.
To configure version control for Toad files
1. Ensure that an Apache Subversion client is installed on the same computer as Toad.
2. In Toad, open one of the supported file types. Then right-click the document window tab and select File
Version Control | Version Control Wizard. This action opens the Version Control Wizard which allows
you to configure Toad for your version control system.
Note: Even if you previously configured version control for objects, you must run the Version Control
Wizard again to configure version control for files.
Toad for MySQL 8.0 Installation Guide
Configure Version Control
21
3. Use the wizard to provide information about your version control system to Toad. Review the following
for additional information:
Field/Button
Version Control System Page
Type
Select Subversion.
Properties
Click the Properties button and enter the path to the Subversion
executable (svn.exe) on the client computer. For example, if using
TortoiseSVN, the path might be:
C:\Program Files\TortoiseSVN\bin
Note: Do not include svn.exe in the path.
Server
Enter the URL for the Subversion repository on the Subversion
server.
Login and Password
Enter the user name and password for your Subversion account.
Default Version Control
Settings Page
Version Control Folder
Select the folder on the Subversion server where you want to
check in files.
If you currently have files under version control, select the folder on
the server where these files are located.
Working Folder
Select a folder on the client computer to use as the root working
folder. This is the location into which you will check out files.
If you currently have files under version control, select your
existing working folder.
To add a file to version control
1. After configuring version control for files, you can start adding files to version control from within Toad.
Right-click a document window tab and select File Version Control | Add file to working folder.
2. Select a location in your working folder in which to save the file. Click Save.
3. In the Commit dialog, enter a comment and click OK to add the file to version control.
To browse the repository
1. Right-click the document window tab (of one of the supported file types) and select File Version Control
| Repository Browser.
2. In the Repository Browser you can right-click a file to perform one of the following actions. Available
actions depend on the file's status.
Action
Description
Open
Open the file in Toad.
Commit
Commit your changes. Available for Modified or Untracked files.
Undo Changes
Discards your changes and reverts to the previous revision of the file
(previous commit). Available when the file status is Modified.
Get Latest Version
Check out the latest revision from the remote repository. Available when
the file status is OutOfDate.
To commit your changes
l
After modifying a file, right-click the document window tab and select File Version Control | Commit.
Toad for MySQL 8.0 Installation Guide
Configure Version Control
22
To compare revisions (Editor files only)
l
l
After modifying and saving an Editor file, you might want to compare your changes to the remote copy
(last commit) before committing your changes. Right-click the document tab and select File Version
Control | Diff with latest revision.
You can compare two revisions of an Editor file (.tef, .sql, or .txt) by using the History dialog.
1. To open a file's History dialog, right-click the document tab and select File Version Control |
Show history.
2. Select two revisions to compare. Then right-click the revisions and select Compare revisions.
3. For an OutOfDate file, right-click the latest revision in the History dialog and select Compare with
working copy to compare the remote file to your working copy.
To check file status
l
l
l
The status of a currently open file displays in the status bar of the document window. You can also place
the cursor over the document tab to display status.
You can check the status of one or more files by using the Repository Browser. To update file status in
the Repository Browser, right-click a folder and select Update folder.
Review the following file status definitions.
File Status
Definition
Untracked
The file has not been added to version control. Right-click the file in the Repository
Browser and select Commit to add it to version control.
UpToDate
The file in your working folder is synchronized with the file in the remote
repository. No changes are detected. No action is required.
Modified
The working copy of this file was modified. The changes are stored in the working
folder only. Commit this file to add the changes to the remote repository.
OutOfDate
A more recent revision of this file exists in the remote repository. To update your
working copy, check out the latest revision from the remote repository (right-click
the file and select Get Latest Version).
Unknown
The file is under version control, but its status cannot be determined.
Deleted
The file was under version control, but it was dropped or renamed in the working
folder and exists only in the remote repository.
Additional Actions
l
To open the folder where a file is located, open the file and then right-click the document tab and select
File Version Control | Open in Windows Explorer.
Configure Version Control for Objects
To configure version control for files, see Version Control for Toad Files.
To configure version control for Objects
1. Ensure that a supported version control client is installed on the computer where Toad is installed. See
"About Version Control" on page 20 for more information about tested version control clients and
supported versions.
Toad for MySQL 8.0 Installation Guide
Configure Version Control
23
2. Right-click one or more objects in the Object Explorer and select Version Control | Version
Control Wizard.
Note: Version control is configured .
3. Review the following for additional information:
Version Control
System Page
Type
Description
Select the version control system name:
l
Apache Subversion™
Note: The version number beside Subversion is an internal file
definition used by Toad to check if an update for this file is available. It
is not the actual version number for the version control provider.
l
Git
l
Team Foundation Server
Note: If you select TFS, you must specify the workspace name for the
provider in the Team Foundation Server Properties window that
displays.
l
Properties
File system based
(Subversion only) Click this button (beside the Type field) and complete the
binary path. Enter the path where the Subversion client that contains svn.exe
is installed. For example, if you installed the CollabNet Subversion Client,
you would enter:
C:\Program Files\CollabNet Subversion Client
Note: Do not include svn.exe in the path.
Server
Select one of the following:
l
l
l
Repository Settings
User name/
Password
Subversion—Specify the existing working folder for the version
control repository or specify the server string (for example:
svn://MyServer).
TFS—Specify the server where your version control provider is
installed and the port number (default is 8080) to use in the following
format:
o
http://MyServer:Port for TSF 2008
o
http://MyServer:Port/TFS for TFS 2010, 2012
File System Based—Specify a directory at your local machine.
Set your local Working Folder and your Version Control Folder will be
automatically filled.
Enter your Subversion command-line user name and password and click
Login.
Note: For TFS only, if you leave the user name and password fields blank,
Toad uses your default Windows credentials.
Version Control
General Options
Page
Description
Prompt to Commit on
Close
You will be asked to commit your changes before each version controlled file
is closed
Toad for MySQL 8.0 Installation Guide
Configure Version Control
24
Version Control
Configurations
Options Page
Version control
folder
Description
Select the folder on the version control server where you want to check
objects in.
If you already have objects under version control, select the folder on the
server where these objects are located.
Note: Version control automatically checks out objects in this folder and any
subfolders to the location you specify in the Working folder field.
Working folder
Select the root repository folder on the client computer to use as the default
working folder for checking objects out. If you already have objects under
version control, select the existing working folder for these.
4. Manage object and scripts using Version Control. See "Manage Objects under Version Control" on page
25 for more information.
Manage Objects under Version Control
Note: Version Control should be configured in Toad before you start managing objects. See "Configure Version
Control for Objects" on page 23 for more information.
To add objects under version control
»
Right-click an object and select Commit.
Tips:
l
l
The objects under version control are marked with
sign at the top right corner of the object's icon.
If you rename a version controlled object, Toad drops the original object and its history from version
control and prompts you to add the renamed object to version control This newly renamed object does
not have any history associated with it.
To manage objects under version control
1. Determine object's version control status. Hover a mouse over the object in the Object Explorer to see its
status. Review the following for additional information:
Version Control status
Description
Uninitialized
The object status is undetermined yet. This is a temporary status that is
issued for all objects during version control status processing.
Untracked
The object is not added to version control.
Ignored
The object is added to ignore list and excluded from version control.
UpToDate
The object is under version control and is synchronized with version
control repository. No changes are detected.
Modified
The object is under version control and has been modified by user.
The changes are stored in local database only and need to be
synchronized with version control repository.
Merge
The object is under version control and has been modified in both
local database and version control repository.
Note:: Toad's Version Control feature does not allow to merge object
scripts.
Toad for MySQL 8.0 Installation Guide
Configure Version Control
25
Version Control status
Description
OutOfDate
The object is under version control and has been modified in version
control repository.
Unknown
The object is under version control but for some reason its status
cannot be determined (for example, you created a script in your local
database while the script with the same name already exists in version
control repository, or you upgraded to a higher version of Toad and
configured version control for the same repository while you have
some uncommitted changes in the database).
Tip: If you are sure that the object is up to date but is listed as
unknown, commit the object in version control system to resolve
unknown status.
Deleted
The object was under version control, but it was dropped or renamed
in local database and exists only in version control repository.
Tip: You can see deleted objects in the Controlled objects pane only.
To access it right-click any object and select Show perspective. Once
you commit changes in Controlled objects pane, the object with all
history will be deleted from version control repository.
NotInView
The object is under version control and exists in version control
repository only.
2. Right-click an object and select one of the following actions:
Use
To...
Show perspective
Select to review all controlled objects for current configuration.
Diff
Select to review differences between the object script in your local
database and the object's revision that was applied to it.
Note: Diff is unavailable for File System Based configuration.
Diff with latest revision
Select to review differences between the object script in your local
database and the latest revision in the version control repository.
Example: You got the latest object revision from the repository 2 days ago. By the time you did it, the
latest revision was 5. Yesterday your colleague worked with the same object and committed changes
in the repository, which are now marked as revision 6.
Today you altered the object's script and want to see the differences. You can select one of the
following:
l
Diff—To compare the object in your local database with revision 5.
l
Diff with latest revision—To compare the object in your local database with revision 6.
Show history
Select to review all commits for selected object.
Tip: Select Show history on database to review all commits.
Note: Show History is unavailable for File System Based
configuration.
Get latest revision
Select to apply object's changes from the version control repository to
your local database. The synchronization script is generated to update
selected object to the latest revision.
Commit
Select to apply object's changes from your local database to the
version control repository.
Note: You should write a comment when committing changes.
Undo changes
Select to rollback changes in your local database. The synchronization
script is generated to revert object to the revision which was a applied
Toad for MySQL 8.0 Installation Guide
Configure Version Control
26
Use
To...
last time.
Update status
Select to compare a script in your local database with the script in the
repository. New status will be issued according to the comparison
results.
Add to ignore list
Select to exclude object from the version control. Ignored objects are
not listed in Controlled Objects pane, Commit and Get latest revision
are disabled.
Remove from ignore list
Select to set object status as Untracked and add it to version control.
Open in Windows Explorer
Select to navigate to the file in the Windows Explorer.
Tip: You can enable, disable, or delete a version control configuration under Tools | Options | Version Control
| Configurations.
Troubleshoot Version Control
Troubleshoot Upgrades
For this release, the back-end of version control has been rewritten. If you previously used version control in
Toad, the following may occur:
l
l
Version control settings are not migrated from the previous version of Toad, so you have to reconfigure
version control in Toad.
In previous releases, the method Toad used to generate the script was different than the current method.
After upgrading Toad and reconfiguring version control, the local revision of the objects differs from
version control repository (The objects have Unknown status). If the object in your database is current,
you should commit it into version control.
Troubleshoot Other Issues
Review the following to help troubleshoot issues with version control:
Apache
Subversion™
Issues
Description
System
cannot find
file
If a message stating that, “The system cannot find the file specified” displays, this usually
means that the Subversion executable cannot be found in the path you specified in the
BinaryPath field of the Command Based Version Control Properties window. Verify that
svn.exe exists in the directory you specified in this field.
Command
execution
When executing Subversion commands, user input is not allowed. This presents an issue
when the user is using Subversion with the SSH method and must enter a password to
establish the Secure Shell.
Workaround:
Generate identity keys that automatically authenticate between the client and the server
when connecting with SSH.
Toad for MySQL 8.0 Installation Guide
Configure Version Control
27
OutOfMemory
exception
when adding
a large
number of
objects
When adding a large number of objects, Subversion may encounter OutOfMemory
exception.
SVN is
missing in the
list of
available
providers
If Subversion is missing in the list of available version control providers, it means that
Subversion.xml was removed or corrupted.
Object Issues
Adding
multiple
objects failed
Script Issues
Canceled
check-in
Workaround:
Commit objects in several steps.
Workaround:
Contact Support to get a new Subversion.xml and place it under <Toad install
path>/Templates/Version Control/.
Description
When you add multiple objects to version control, the objects are grouped and added in
batches (for example, all the tables for a particular schema are added at once). If an error
(for example, failure to support Korean characters) causes this command to fail, none of
the objects are added.
Description
SQL scripts remain checked out if a change was made to the text, but check-in was
canceled during the prompt for a check-in comment. This behavior is by design—that is;
the user can either undo the checkout or check in the script using the right-click menu in
the Scripts node/folder/tab of the Object Explorer.
Note: If you alter the object again, you receive a prompt to use the “locally changed” script.
Click Yes to use the locally changed copy; click No to refresh the local copy from the
source repository; click Cancel to cancel the prompt.
Toad for MySQL 8.0 Installation Guide
Configure Version Control
28
About Us
We are more than just a name
We are on a quest to make your information technology work harder for you. That is why we build communitydriven software solutions that help you spend less time on IT administration and more time on business
innovation. We help you modernize your data center, get you to the cloud quicker and provide the expertise,
security and accessibility you need to grow your data-driven business. Combined with Quest’s invitation to the
global community to be a part of its innovation, and our firm commitment to ensuring customer satisfaction, we
continue to deliver solutions that have a real impact on our customers today and leave a legacy we are proud of.
We are challenging the status quo by transforming into a new software company. And as your partner, we work
tirelessly to make sure your information technology is designed for you and by you. This is our mission, and we
are in this together. Welcome to a new Quest. You are invited to Join the Innovation.
Our brand, our vision. Together.
Our logo reflects our story: innovation, community and support. An important part of this story begins with the
letter Q. It is a perfect circle, representing our commitment to technological precision and strength. The space in
the Q itself symbolizes our need to add the missing piece—you—to the community, to the new Quest.
Contact Quest
For sales or other inquiries, visit www.quest.com/company/contact-us.aspx or call 1-949-754-8000.
Technical Support Resources
Technical support is available to Quest customers with a valid maintenance contract and customers who have
trial versions. You can access the Quest Support Portal at https://support.quest.com.
The Support Portal provides self-help tools you can use to solve problems quickly and independently, 24 hours
a day, 365 days a year. The Support Portal enables you to:
l
Submit and manage a Service Request
l
View Knowledge Base articles
l
Sign up for product notifications
l
Download software and technical documentation
l
View how-to-videos
l
Engage in community discussions
l
Chat with support engineers online
l
View services to assist you with your product
Toad for MySQL 8.0 Installation Guide
About Us
29
Please be advised before installing: Toad for MySQL is an official Quest Software Inc. Freeware Product. This
license does not entitle Licensee to receive technical support from Quest Software.
Get the latest product information and find helpful resources at the Toad for MySQL Community at
http://toadformysql.com/index.jspa.
Toad for MySQL 8.0 Installation Guide
About Us
30
Index
MySQL
A
create connections 18
application virtualization 6
troubleshoot 19
automation
migrate scheduled tasks 15
R
upgrade scripts 14
requirements
Citrix 6
C
client 5
Citrix
virtualization 6
install 13
requirements 6
S
client requirements 5
server virtualization 6
connections
silent install 9
create MariaDB 18
create transform file 12
create MySQL 18
prerequisites 9
share for all session windows 17
Subversion, configure 23
understand 17
system requirements 5
corporate deployment 9
T
D
Team Foundation Server, configure 23
desktop virtualization 6
TFS, configure 23
I
transform file 12
install 8
troubleshoot
MySQL 19
Citrix 13
version control 27
Citrix support 6
client requirements 5
U
silent 9
uninstall 16
L
V
license keys 16
Version Control
M
manage objects under Version Control 25
mst file 12
about 20
configure Subversion 23
configure TFS 23
File system based 23
Toad for MySQL 8.0 Installation Guide
Index
31
manage objects 25
troubleshoot 27
virtualization support 6
Toad for MySQL 8.0 Installation Guide
Index
32
Download PDF
Similar pages