Toad for MySQL Installation Guidedev.toadformysql.com/installation_guide/ToadForMySQL_7.9_Install... · Toadhasbeentestedwithscreenresolutionsupto1920x1080.Toad maysupportotherscreenresolutions,butpleasenotethathigher

Toad™ for MySQL 7.9

Installation Guide

© 2016 Dell Inc.ALL RIGHTS RESERVED.

This product is protected by U.S. and international copyright and intellectual property laws.

This guide contains proprietary information protected by copyright. The software described inthis guide is furnished under a software license or nondisclosure agreement. This softwaremay be used or copied only in accordance with the terms of the applicable agreement. Nopart of this guide may be reproduced or transmitted in any form or by any means, electronicor mechanical, including photocopying and recording for any purpose other than thepurchaser’s personal use without the written permission of Dell Inc.

The information in this document is provided in connection with Dell products. No license,express or implied, by estoppel or otherwise, to any intellectual property right is granted bythis document or in connection with the sale of Dell products. EXCEPT AS SET FORTH INTHE TERMS AND CONDITIONS AS SPECIFIED IN THE LICENSE AGREEMENT FORTHIS PRODUCT, DELL ASSUMES NO LIABILITY WHATSOEVER AND DISCLAIMSANY EXPRESS, IMPLIED OR STATUTORY WARRANTY RELATING TO ITSPRODUCTS INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTY OFMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT. IN NO EVENT SHALL DELL BE LIABLE FOR ANY DIRECT,INDIRECT, CONSEQUENTIAL, PUNITIVE, SPECIAL OR INCIDENTAL DAMAGES(INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OF PROFITS, BUSINESSINTERRUPTION OR LOSS OF INFORMATION) ARISING OUT OF THE USE ORINABILITY TO USE THIS DOCUMENT, EVEN IF DELL HAS BEEN ADVISED OF THEPOSSIBILITY OF SUCH DAMAGES. Dell makes no representations or warranties withrespect to the accuracy or completeness of the contents of this document and reserves theright to make changes to specifications and product descriptions at any time without notice.Dell 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:

Dell Inc.Attn: LEGAL Dept5 Polaris WayAliso Viejo, CA 92656

Refer to our web site (software.dell.com) for regional and international office information.

Trademarks

Dell, the Dell logo, Quest, SQL Navigator, vWorkspace, and Toad are trademarks of Dell Inc.and/or its affiliates. Microsoft, Windows, Windows Server, Windows Vista, Visual Studio,SharePoint, Access and Excel are either registered trademarks or trademarks of MicrosoftCorporation in the United States and/or other countries. Oracle is a trademark or registeredtrademark of Oracle and/or its affiliates in the United States and other countries. Citrix® andXenApp™ are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, andmay 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 Unionand other countries. Subversion is a trademark of the Apache Software Foundation. Othertrademarks and trade names may be used in this document to refer to either the entitiesclaiming the marks and names or their products. Dell disclaims any proprietary interest in themarks and names of others.

http://www.software.dell.com/

Toad for MySQL 7.9Installation GuideTuesday, June 21, 2016

Table of Contents

Installation 5

System Requirements 5

Client Requirements 5

Server Requirements 6

Virtualization Support 7

User Requirements 7

Install Toad 8

Specify Application Data Directory Location 8

Install Toad Silently 9

Determine Which Installer to Use 9

Silent Installation Prerequisites 10

Silent Installation Using the Executable 10

Silent Installation Using the Microsoft Installer 12

Install Toad on Citrix® Systems 15

Upgrade Toad 16

Upgrade Automation Scripts and Scheduling Tasks 16

Upgrade Automation Scripts to Newer Version of Toad 16

Migrate Scheduling Tasks to Newer Version of Toad 17

Uninstall Toad 18

Licensing 19

Create and Troubleshoot Connections 20

Understand Toad Connections 20

Toad Open Connections 20

Sharing a Connection Among Windows 20

Create MySQL Connections 21

Troubleshoot MySQL Issues 22

Toad for MySQL Installation GuideTable of Contents

4

Configure Version Control 24

About Version Control 24

Prerequisites 24

Version Control for Toad Files 25

Configure Version Control for Objects 28

Manage Objects under Version Control 30

Troubleshoot Version Control 33

Troubleshoot Upgrades 33

Troubleshoot Other Issues 33

About Dell 35

Contact Dell 35

Technical Support Resources 35

Toad Community 36

Index 37

Installation

System RequirementsReview 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 hardwareand software requirements:

Requirement Details

Platform 1 GHz minimum

Memory 512 MB of RAM minimum, 1 GB recommendedNote: 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 DiskSpace

800 MB to install Toad

OperatingSystem

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)Important: Toad uses the Microsoft® Distributed TransactionCoordinator (DTC) when opening a SQL file to get Full-Text Searchstatus, but DTC is disabled by default on Windows Vista, WindowsServer 2008 and Windows 7. If you are using either operating system,ensure that Network DTC access is enabled on the Toad client. Seehttp://technet.microsoft.com/en-us/library/cc753510(WS.10).aspx formore information about enabling DTC access.

1

http://technet.microsoft.com/en-us/library/cc753510(WS.10).aspx

Toad for MySQL Installation GuideInstallation

6

Requirement Details

.NETFramework

The Microsoft® .NET Framework is required. The version isdependent on the operating system.

.NET 4.5 Windows Vista SP2, Windows 7, Windows 8,Windows Server 2008 (SP2 or earlier), WindowsServer 2008 R2, Windows Server 2012

.NET 4.0 Windows XP, Windows Vista (SP1 or earlier),Windows Server 2003Notes:

l This information is provided to aidinstallation. Toad is not tested onWindows XP. Windows Vista (SP1 orearlier), and Windows Server 2003.

l The .NET Framework 4 Client Profile isnot supported.

AdditionalRequirements

Web BrowserMicrosoft® Internet Explorer® 6.0 or laterScreenToad has been tested with screen resolutions up to 1920 x 1080. Toadmay support other screen resolutions, but please note that higherresolutions have not been tested.Toad supports display DPI settings up to 125% (Medium).

Server Requirements

Before installing Toad, ensure that your server meets the following minimum hardware andsoftware requirements:

Requirement Details

DatabaseServer

MySQL 4.1, 5.0, 5.1, 5.5, 5.6Clustrix 5.2MariaDB 5.5.5

CloudDatabaseService

Toad can manage Amazon RDS and any other cloud or serviceoffering compatible with MySQL, including Amazon Aurora.


7

Virtualization Support

Requirement Details

ApplicationVirtualization

Limited testing has been performed for Citrix® XenApp™ 5.0 onWindows Server 2003 and Citrix XenApp 6.5 on Windows Server2008 R2.Limited testing has been performed for Citrix support on WindowsServer 2003 Enterprise Server (Service Pack 2) using the MetaFramePresentation Server 5.0 and Citrix Presentation Server Clients 10.2.See "Install Toad on Citrix® Systems" (page 15) for more information.

Note: Toad may work in virtualization environments other than the ones in which it wastested.

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 thedesktop 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 Associate file extensions.

l View the Toad shortcut icon on the desktop or the Toad menu options in theWindows Start menu. As a workaround, Restricted Users can create a shortcut to Toadfrom 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, anddelete it. All other users need only the ability to read the QuestSoftware.ToadSecuritytable to use Toad Security features.


8

Install ToadTo install Toad

1. Run the ToadInstaller.exe.

2. Complete the wizard.

Specify Application Data Directory LocationToad for MySQL 7.9 stores settings files in the user's Application Data directory. The defaultlocation cannot be modified from within the application. Toad provides two methods tochange the default location: by using a Registry setting or by using a command switch in aToad shortcut.

Use the Registry setting method to change the application data directory from Roaming toLocal. 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\QuestSoftware\Toad for MySQL\7.9), 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 youmanually copy the settings files from the default location (Roaming directory) to the newlocation (Local directory). Copy the settings files BEFORE you add the Registry setting andBEFORE opening Toad.

Operating System Default Location New Location whenLOCALSETTINGS = 1

Windows VistaWindows Server 2008Windows 7Windows 8

C:\Users\username\AppData\Roaming\QuestSoftware\Toad for MySQL7.9

C:\Users\username\AppData\Local\QuestSoftware\ Toad for MySQL7.9

To change Toad Application Data directory location using a command-line switch

You can override the default Application Data directory by running Toad with thecommand switch:

Toad.exe --datadir="YourNewDirPath"


9

To instruct Toad to always use the new directory path, add the command switch and the newdirectory 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).

Install Toad SilentlySilent 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 whichinstaller to use:

Installer Advantages Disadvantages

Executablefile (.exe)

Silent installation using the .exefile has the followingadvantages:

l Verifies whether theprerequisite software isinstalled, and if not,redirects you to thedownload location.

Silent installation using the .exefile has the followingdisadvantages:

l Cannot deploy customToad settings files orlicense keys.

l Installer automaticallyexits if the prerequisitesoftware is not installed.

MicrosoftInstaller file(.msi)

Supports deployment of Toadsettings files and license keys.

Silent installation using the .msifile has the followingdisadvantages:

l Requires manualverification anddownload of anyprerequisite software.

l Requires a manualuninstall of the previousversion of Toad usingAdd/Remove Programs.


10

Silent Installation Prerequisites

Before you perform a silent installation, you must install the following software on everycomputer 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 differentdirectory) 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 theexecutable for Toad is located. (This file can be downloaded from the Dell SoftwareWeb 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 yourinstallation similar to the following command:

“ToadInstaller.exe” /S /Lx “C:\temp\installLog.txt”INSTALLDIR=”Drive:\your_install_path” USERNAME=”some_user”COMPANYNAME=”your_company” ALLUSERS=1

Use the following descriptions to customize the command-line options and overridesfor 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 inthe previous example) or v for a verbose log. See the logsection at http://msdn2.microsoft.com/en-us/library/aa367988.aspx for more information aboutadditional logging options.Also, substitute “C:\temp\installLog.txt” in the examplewith the fully qualified name of the log file. Enclose thisvalue in double quotations. The installation process createsthis file if it does not exist. Otherwise, the existing file isoverwritten.

http://msdn2.microsoft.com/en-us/library/aa367988.aspx


11

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 inwhich you want to install Toad. If you do not include thispath, the installation program defaults to:C:\Program Files (x86)\Dell\Toad for MySQL7.9.

ALLUSERS (Optional) Specify one of the following:

l For a per-machine installation, specify 1. Thisvalue allows any user to use the Toad shortcut onthe desktop after the installation completes.

l For a per-user installation, enter the empty stringvalue (“”) This value allows only the userspecified for USERNAME (and the user thatinstalled Toad) to see the Toad shortcut on thetarget desktop. If USERNAME is omitted, only theuser that installed Toad sees the shortcut.

Note: If you do not specify this property, the installationprogram defaults to a per-user installation.

USERNAME (Optional) Specify the user that intends to use Toad onthe target computer.Notes:

l If ALLUSERS is omitted or defined with theempty string value (""), only the user specifiedhere (and the user that installed Toad) can see theToad shortcut on the desktop after the installationcompletes.

l If ALLUSERS is omitted or defined with theempty string value ("") and you omit theUSERNAME option, only the user that installedToad sees the Toad shortcut on the desktop.

l If ALLUSERS is 1, the USERNAME value isignored during installation.

COMPANYNAME (Optional) Specify the name of the company that ownsthis installation.

Notes:

l All default installation option overrides are case-sensitive.

l Enclose all values (except for the ALLUSERS value) in double quotations.


12

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 msiinstaller 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 similarto 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 bto hide the Cancel button during the installation.

Note: All command-line options are case-insensitive. Seehttp://msdn2.microsoft.com/en-us/library/aa367988.aspx for a complete list ofcommand-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 inwhich you want to install Toad. If you do not include thispath, the installation program defaults to:C:\Program Files (x86)\Dell\Toad for MySQL7.9.

ALLUSERS (Optional) Specify one of the following:

http://msdn2.microsoft.com/en-us/library/aa367988.aspx


13

Option Description

l For a per-machine installation, specify 1. Thisvalue allows any user to use the Toad shortcut onthe desktop after the installation completes.

l For a per-user installation, enter the empty stringvalue (“”) This value allows only the userspecified for USERNAME (and the user thatinstalled Toad) to see the Toad shortcut on thetarget desktop. If USERNAME is omitted, only theuser that installed Toad sees the shortcut.

Note: If you do not specify this property, the installationprogram defaults to a per-user installation.

USERNAME (Optional) Specify the user that intends to use Toad onthe target computer.Notes:

l If ALLUSERS is omitted or defined with theempty string value (""), only the user specifiedhere (and the user that installed Toad) can see theToad shortcut on the desktop after the installationcompletes.

l If ALLUSERS is omitted or defined with theempty string value ("") and you omit theUSERNAME option, only the user that installedToad sees the Toad shortcut on the desktop.

l If ALLUSERS is 1, the USERNAME value isignored during installation.

COMPANYNAME (Optional) Specify the name of the company that ownsthis 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 alsouse the .msi file to perform a basic silent install using the default directory (or install to adifferent directory) and to specify command-line options and default installation overrides.See "Perform Silent Installation Using MSI" (page 12) for more information if you are notcreating a transform file.


14

Note: (MSI installs on Windows Vista and 7) If you are using MSI to install Toad onWindows Vista or 7 with UAC enabled, you can install a file that adds a "Run asadministrator" option when right-clicking the MSIfile: 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 forthe 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 WindowsInstaller is installed. After customizing Toad settings, you will use the Wise Installerto 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 alicense key.

4. Select Tools | Configuration Wizard from the Toad menu and complete theConfiguration 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. Theseoptions create a module settings folder and files.

7. Select View | Connection Manager from the menu in Toad to open theConnection 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 stepsdescribe how to use the Wise for Windows Installer to create the file.

a. Select File | New.

b. Select Custom Templates under Categories, and then select the Transformtemplate in the New Installation File window.

c. Select the ToadInstaller.msi file in the Select the .MSI file to base thistransform on window.

d. Save the project.

e. Select Files from the Feature Details view.

http://www.symantec.com/connect/downloads/msi-run-administrator-context-menu-vista


15

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\ QuestSoftware\Toad for MySQL 7.9.

ModuleSettingsfolder and files

C:\Users\username\AppData\Roaming\ QuestSoftware\Toad for MySQL 7.9\ModuleSettings.

Connections.xml C:\Users\username\AppData\Roaming\ QuestSoftware\Toad for MySQL 7.9.

g. Save the project and compile it to create the transform (MST) file.

11. Perform a silent install. See "Perform Silent Installation Using MSI" (page 12) for moreinformation.

Install Toad on Citrix® SystemsToad must be installed on the Citrix server by the Citrix administrator. Users then connect tothis instance through their Citrix login.

Note: Limited testing has been performed for Citrix XenApp™ 5.0 support on WindowsServer® 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 whenprompted.

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 onlyneed to publish Toad once.

6. Review the following considerations regarding licensing:

l A license supplied by an administrator always overrides a user-supplied licensein a Citrix environment.

l If you need to provide the same Toad functionality to all users, you can enterthe default license key for all users.


16

l If you have users with different license requirements (for example, some haveStandard licenses and others have Professional licenses), individual licensesshould be entered for each user. You should not enter the default license keybecause it enables all functionality in Toad.

Upgrade ToadTo upgrade Toad

1. Run the ToadInstaller.exe installation program from the DVD or downloaded file.

2. Select Uninstall Toad and continue with install.


If you are upgrading from a previous version of Toad, you are prompted to migrate yoursettings the first time you start Toad. The settings files include database connections, layoutcustomizations, shortcut keys, and options customized in the Options pages.

To migrate the settings again, remove or rename the current version's Application Data folderand migrate the files from the previous version's Application Data folder.

Upgrade Automation Scripts and SchedulingTasksIf you upgrade to a newer version of Toad, Automation scripts created in a previous versionmust be upgraded before you can open them in the newer version. Toad prompts you toautomatically 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 theywere created. After upgrading Toad, those previously-created, scheduled scripts will notexecute in the newer version until you migrate each script's scheduling task. Toad promptsyou 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 upgradethe script. Toad automatically prompts you to upgrade the script the first time you open it inthe newer version.


17

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.

Caution: An automation script is no longer compatible with previous versions ofToad after an upgrade.

3. Select No (and do not elect to save the script), to keep the script compatible with theprevious version.

4. If you selected Yes, Toad upgrades your script and saves a backup copy of theoriginal 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 taskspecifies which version of Toad to use by specifying the version's application path. Toadprovides you with two easy ways to migrate your scheduled scripts' scheduling tasks whenyou upgrade Toad. First, Toad prompts you to migrate scheduling tasks upon initial launch ofthe application after installation. Next, you can migrate scheduling tasks at any time usingthe Job Manager.

Notes:

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.

l 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 inthe newer version).


18

To migrate scheduling tasks upon initial launch

1. After upgrading Toad, and upon initial launch of the application, the MigrateScheduled Tasks dialog opens.

2. Select the scheduled tasks (scheduled Automation scripts) to migrate to the newversion of Toad.

3. Click OK to close the dialog.

4. Toad immediately prompts you for your Windows password. Enter your password tomigrate 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 MigrateScheduled Tasks dialog.

4. Toad immediately prompts you for your Windows password. Enter your password tomigrate 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.

To manually edit a scheduling task

1. In the Job Manager (Tools | Administer | Job Manager), right-click a task andselect Edit Task.

2. To change the version of Toad used to run the script, in the Actions tab, change thefolder name in the toad.exe path.

Uninstall ToadIf you uninstall Toad, it may not uninstall completely. When you use Toad, you create newfiles such as SQL scripts, data output, or temp files, etc. The following types of files are notremoved when you uninstall:

l Any new files you create

l Any copies of files you make for backup purposes

l Settings files


19

You can uninstall Toad for MySQL by using the Installer or by using the WindowsAdd/Remove Programs (or Uninstall a program) feature. Using the Installer is the preferredway to uninstall Toad for MySQL.

To uninstall Toad

1. Run the ToadInstaller.exe.

2. Select Uninstall Toad for MySQL only.


LicensingTo 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 thefunctionality accordingly. In many cases, if functionality is disabled within Toad, youmay not have an appropriate license to use it. When Toad is running, you can seewhich components are licensed by selecting Help | About. For complete list offeatures shipped with your Toad edition see http://software.dell.com/.

http://software.dell.com/

Create and Troubleshoot Connections

Understand Toad ConnectionsReview 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 moreactual connections to the database. When you open a database connection in Toad:

l Toad creates an initial database connection for general use.

l Toad also creates a separate database connection for each Editor (the first time youexecute a statement) and for each Data tab in the Database Explorer (the first time youselect the tab and query data).

The connection associated with the window (or tab) remains open until you close thewindow. If a window has an associated connection, but a statement is not currentlyexecuting, 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 inthe Connection/Navigation Manager pane or in the connection drop-down list.

To use the Background Processes pane

l When a statement is executing, a progress bar displays in the Status bar located at thebottom of the Toad application window. Click the executing progress bar to open theBackground Processes pane.

l To cancel statement execution, use the Background Processes pane.

Note: It is recommended that you cancel only your own processes, becauseterminating 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 Editorwindows 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.

Toad for MySQL Installation GuideCreate and Troubleshoot Connections

21

3. When this option is not selected, Toad attempts to use a single connection for anynew windows or query execution. For example, if you share a database connection,you can execute a query in the Editor, execute another query in a new Editor, andthen select the Data tab from the same connection.

If the single connection is in use when Toad attempts to execute it, thefollowing occurs:

l If your database does not support executing multiple queries on a sharedconnection, a dialog prompts you to either permanently associate the windowwith a new database connection, cancel the previous operation, or add thequery to a queue until the current operation completes, and the execute it. Ifyou place multiple queries in the queue, each one executes in the order that itwas added to the queue.

Note: Although you can share a database connection, any commits apply to the selectedwindow only.

Create MySQL ConnectionsYou can create a new connection, or connect to an existing connection from the Create NewConnection window. See "Troubleshoot MySQL Issues" (page 22) for more information abouttroubleshooting MySQL connection issues.

To create a MySQL connection

1. Click on the toolbar (ALT+F+N).

2. Select MySQL from the Group list box.


Login Tab Description

Connectiontype

Select the protocol to use when connecting.

Host Enter the name of the host computer where the database isinstalled.

Password Enter the password to use when connecting.Tip: After connecting, you can set a master password to furthersecure your connection in Tools | Options| Environment |Security.

Connectiontimeout

Enter the number of seconds to wait when connecting beforethe application times out. The default is 15 seconds.


22

SSL If you selected SSL as the connection type, review thefollowing for additional information:

l Private key—browse to the location of the SSL key fileto use when connecting.

l CA cert—browse to the location of the trusted certificateauthority to use when connecting.

l Cert—browse to the location of the SSL certificate fileto use when connecting.

Compress Select this checkbox to compress the value of any strings andreturn binary values.

UseMySQLlibraries

Select this checkbox to use an embedded MySQL libraryinstead of the MySQL .NET provider.Note: If you select this option, you must specify libMySQL.dllin the path.

Category Select or create a category if you want to color code Editor tabsfor a specific connection. This can help differentiate betweendevelopment and production databases. You can also set anoption to color code the Object Explorer pane and object editorwindows (Create, Alter, Drop, etc.). Click here to view avideo 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 theApplication Data Directory link in Help | About.

Troubleshoot MySQL IssuesReview the following solutions to help troubleshoot MySQL connection issues pertaining todatabase connections in Toad.

Issue Cause/Solution

"InvalidCastException" errorwhen connecting to MYSQL4.1.14-nt database

This is a known issue in MySQL.Solution:Review the known issue and download a patchfrom: http://bugs.mysql.com/bug.php?id=12771

"System.IO.DirectoryNot Solution:

http://www.toadworld.com/products/toad-for-sql-server/m/media-library/1330.aspx

http://bugs.mysql.com/bug.php?id=12771


23

Issue Cause/Solution

FoundException"error occurseach time you attempt toconnect after installing Toadinto a directory other than thedefault directory.

1. Exit Toad.

2. Locate the MySQL.xml file in theC:\Documents and Settings\username\LocalSettings\ Application Data\Quest Software\Toad for MySQLversion\ ModuleSettings

3. Rename or delete the MySQL.xml file.

4. Restart Toad.

Configure Version Control

About Version ControlToad integrates with your existing version control system so you can maintain multiplerevisions of objects. See "Configure Version Control for Objects" (page 28) for moreinformation on configuring version control in Toad.

For Version Control of your files handled by Toad see Version Control for ToadFiles (page 25).

Important: See "Troubleshoot Version Control" (page 33) for more information about issueswhen upgrading version control from a previous version.

Notes:

l If you want to place database objects under version control, you must configureversion control for objects using the Object Explorer. See "Manage Objects underVersion Control" (page 30) for more information.

l If you rename a version controlled object, Toad drops the original object and itshistory from version control and prompts you to add the renamed object to versioncontrol. 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 isinstalled. The following table lists the supported version control providers and the versionstested with Toad.

SupportedProvider

Server VersionTested

Client Version Tested

ApacheSubversion™

Subversion 1.7.5on Windows

CollabNet Subversion Command-Line Client1.7.5Note: Any Subversion client must have svn.exe inits installation directory to use version control inToad.

TeamFoundationServer (TFS)

TFS 2008, 2010,2012

Visual Studio® (2008, 2010, 2012) Team ExplorerClient

File systembased

Toad allows to utilize practically any version control system using theexternal client tool. In this case Toad Version Control tool works with

3

Toad for MySQL Installation GuideConfigure Version Control

25

SupportedProvider

Server VersionTested

Client Version Tested

the directories at local HDD while you commit changes to therepository with version control client tool.

Note: Toad connects to your version control system based on login information includedin the configuration. Your version control client does not need to run for Toad toconnect.

Version Control for Toad FilesToad can integrate with your existing version control system allowing you to maintainmultiple 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 changesand 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 forobjects is configured separately from version control for files. For more information aboutversion control for objects, see Configure Version Control for Objects (page 28).

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 windowtab and select File Version Control | Version Control Wizard. This action opensthe Version Control Wizard which allows you to configure Toad for your versioncontrol system.

Note: Even if you previously configured version control for objects, you must run theVersion Control Wizard again to configure version control for files.

3. Use the wizard to provide information about your version control system to Toad.Review the following for additional information:

Field/Button

Version Control SystemPage


26

Field/Button

Type Select Subversion.

Properties Click the Properties button and enter the pathto the Subversion executable (svn.exe) on theclient computer. For example, if usingTortoiseSVN, 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 onthe Subversion server.

Login and Password Enter the user name and password for yourSubversion account.

Default Version ControlSettings Page

Version Control Folder Select the folder on the Subversion serverwhere you want to check in files.If you currently have files under versioncontrol, select the folder on the server wherethese files are located.

Working Folder Select a folder on the client computer to use asthe root working folder. This is the locationinto which you will check out files.If you currently have files under versioncontrol, 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 controlfrom within Toad. Right-click a document window tab and select File VersionControl | 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 toversion control.

To browse the repository

1. Right-click the document window tab (of one of the supported file types) and selectFile Version Control | Repository Browser.


27

2. In the Repository Browser you can right-click a file to perform one of the followingactions. Available actions depend on the file's status.

Action Description

Open Open the file in Toad.

Commit Commit your changes. Available for Modified orUntracked files.

Undo Changes Discards your changes and reverts to the previousrevision of the file (previous commit). Availablewhen the file status is Modified.

Get Latest Version Check out the latest revision from the remoterepository. Available when the file status isOutOfDate.

To commit your changes

l After modifying a file, right-click the document window tab and select File VersionControl | Commit.

To compare revisions (Editor files only)

l After modifying and saving an Editor file, you might want to compare your changesto the remote copy (last commit) before committing your changes. Right-click thedocument tab and select File Version Control | Diff with latest revision.

l You can compare two revisions of an Editor file (.tef, .sql, or .txt) by using theHistory dialog.

1. To open a file's History dialog, right-click the document tab and select FileVersion Control | Show history.

2. Select two revisions to compare. Then right-click the revisions and selectCompare revisions.

3. For an OutOfDate file, right-click the latest revision in the History dialog andselect Compare with working copy to compare the remote file to yourworking copy.

To check file status

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.

l 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 selectUpdate folder.

l Review the following file status definitions.


28

File Status Definition

Untracked The file has not been added to version control. Right-click thefile in the Repository Browser and select Commit to add it toversion control.

UpToDate The file in your working folder is synchronized with the filein the remote repository. No changes are detected. No actionis required.

Modified The working copy of this file was modified. The changes arestored in the working folder only. Commit this file to add thechanges to the remote repository.

OutOfDate A more recent revision of this file exists in the remoterepository. To update your working copy, check out the latestrevision from the remote repository (right-click the file andselect Get Latest Version).

Unknown The file is under version control, but its status cannot bedetermined.

Deleted The file was under version control, but it was dropped orrenamed in the working folder and exists only in the remoterepository.

Additional Actions

l To open the folder where a file is located, open the file and then right-click thedocument tab and select File Version Control | Open in Windows Explorer.

Configure Version Control for ObjectsTo configure version control for files, see Version Control for Toad Files (page 25).

To configure version control for Objects

1. Ensure that a supported version control client is installed on the computer where Toadis installed. See "About Version Control" (page 24) for more information about testedversion control clients and supported versions.

2. Right-click one or more objects in the Object Explorer and select Version Control |Version Control Wizard.

Note: Version control is configured .



29

Version ControlSystem Page

Description

Type Select the version control system name:

l Apache Subversion™Note: The version number beside Subversion is aninternal file definition used by Toad to check if anupdate for this file is available. It is not the actualversion number for the version control provider.

l Team Foundation ServerNote: If you select TFS, you must specify theworkspace name for the provider in the TeamFoundation Server Properties window thatdisplays.

l File system based

Properties (Subversion only) Click this button (beside the Typefield) and complete the binary path. Enter the path wherethe Subversion client that contains svn.exe is installed.For example, if you installed the CollabNet SubversionClient, you would enter:C:\Program Files\CollabNet Subversion ClientNote: Do not include svn.exe in the path.

Server Select one of the following:

l Subversion—Specify the existing working folderfor the version control repository or specify theserver string (for example: svn://MyServer).

l TFS—Specify the server where your versioncontrol provider is installed and the port number(default is 8080) to use in the following format:

o http://MyServer:Port for TSF 2008o http://MyServer:Port/TFS for TFS 2010,

2012

l File System Based—Specify a directory at yourlocal machine.

User name/Password

Enter your Subversion command-line user name andpassword and click Login.Note: For TFS only, if you leave the user name andpassword fields blank, Toad uses your default Windowscredentials.


30

Default VersionControl SettingsPage

Description

Version controlfolder

Select the folder on the version control server where youwant to check objects in.If you already have objects under version control, selectthe folder on the server where these objects are located.Note: Version control automatically checks out objects inthis folder and any subfolders to the location you specifyin the Working folder field.

Working folder Select the root repository folder on the client computer touse as the default working folder for checking objectsout. 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 VersionControl" (page 30) for more information.

Manage Objects under Version ControlNote: Version Control should be configured in Toad before you start managing objects. See"Configure Version Control for Objects" (page 28) for more information.

To add objects under version control

» Right-click an object and select Commit.

Tips:

l The objects under version control are marked with sign at the top right corner ofthe object's icon.

l If you rename a version controlled object, Toad drops the original object and itshistory from version control and prompts you to add the renamed object to versioncontrol 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 ObjectExplorer to see its status. Review the following for additional information:

Version Controlstatus

Description

Uninitialized The object status is undetermined yet. This is atemporary status that is issued for all objects during


31


Description

version control status processing.

Untracked The object is not added to version control.

Ignored The object is added to ignore list and excluded fromversion control.

UpToDate The object is under version control and is synchronizedwith version control repository. No changes aredetected.

Modified The object is under version control and has beenmodified by user. The changes are stored in localdatabase only and need to be synchronized with versioncontrol repository.

Merge The object is under version control and has beenmodified in both local database and version controlrepository.Note:: Toad's Version Control feature does not allow tomerge object scripts.

OutOfDate The object is under version control and has beenmodified in version control repository.

Unknown The object is under version control but for some reasonits status cannot be determined (for example, youcreated a script in your local database while the scriptwith the same name already exists in version controlrepository, or you upgraded to a higher version of Toadand configured version control for the same repositorywhile you have some uncommitted changes in thedatabase).Tip: If you are sure that the object is up to date but islisted as unknown, commit the object in version controlsystem to resolve unknown status.

Deleted The object was under version control, but it wasdropped or renamed in local database and exists only inversion control repository.Tip: You can see deleted objects in the Controlledobjects pane only. To access it right-click any objectand select Show perspective. Once you commit changesin Controlled objects pane, the object with all historywill be deleted from version control repository.


32


Description

NotInView The object is under version control and exists in versioncontrol 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 currentconfiguration.

Diff Select to review differences between the object script inyour local database and the object's revision that wasapplied to it.Note: Diff is unavailable for File System Basedconfiguration.

Diff with latestrevision

Select to review differences between the object script inyour local database and the latest revision in the versioncontrol repository.

Example: You got the latest object revision from the repository 2 days ago. Bythe time you did it, the latest revision was 5. Yesterday your colleague workedwith the same object and committed changes in the repository, which are nowmarked as revision 6.Today you altered the object's script and want to see the differences. You canselect 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 databasewith revision 6.

Show history Select to review all commits for selected object.Tip: Select Show history on database to review allcommits.Note: Show History is unavailable for File SystemBased configuration.

Get latest revision Select to apply object's changes from the version controlrepository to your local database. The synchronizationscript is generated to update selected object to the latestrevision.

Commit Select to apply object's changes from your localdatabase to the version control repository.


33

Use To...

Note: You should write a comment when committingchanges.

Undo changes Select to rollback changes in your local database. Thesynchronization script is generated to revert object tothe revision which was a applied last time.

Update status Select to compare a script in your local database withthe script in the repository. New status will be issuedaccording to the comparison results.

Add to ignore list Select to exclude object from the version control.Ignored objects are not listed in Controlled Objectspane, Commit and Get latest revision are disabled.

Remove from ignorelist

Select to set object status as Untracked and add it toversion control.

Open in WindowsExplorer

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 usedversion control in Toad, the following may occur:

l Version control settings are not migrated from the previous version of Toad, so youhave to reconfigure version control in Toad.

l In previous releases, the method Toad used to generate the script was different thanthe current method. After upgrading Toad and reconfiguring version control, the localrevision of the objects differs from version control repository (The objects haveUnknown status). If the object in your database is current, you should commit it intoversion control.

Troubleshoot Other Issues

Review the following to help troubleshoot issues with version control:

ApacheSubversion™

Description


34

Issues

System cannotfind file

If a message stating that, “The system cannot find the file specified”displays, this usually means that the Subversion executable cannotbe found in the path you specified in the BinaryPath field of theCommand Based Version Control Properties window. Verify thatsvn.exe exists in the directory you specified in this field.

Commandexecution

When executing Subversion commands, user input is not allowed.This presents an issue when the user is using Subversion with theSSH method and must enter a password to establish the SecureShell.Workaround:Generate identity keys that automatically authenticate between theclient and the server when connecting with SSH.

OutOfMemoryexceptionwhen addinga largenumber ofobjects

When adding a large number of objects, Subversion may encounterOutOfMemory exception.Workaround:Commit objects in several steps.

SVN ismissing in thelist ofavailableproviders

If Subversion is missing in the list of available version controlproviders, it means that Subversion.xml was removed or corrupted.Workaround:Contact Support to get a new Subversion.xml and place it under<Toad install path>/Templates/Version Control/.

Object Issues Description

Addingmultipleobjects failed

When you add multiple objects to version control, the objects aregrouped and added in batches (for example, all the tables for aparticular schema are added at once). If an error (for example, failureto support Korean characters) causes this command to fail, none ofthe objects are added.

Script Issues Description

Canceledcheck-in

SQL scripts remain checked out if a change was made to the text,but check-in was canceled during the prompt for a check-incomment. This behavior is by design—that is; the user can eitherundo the checkout or check in the script using the right-click menuin 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 changedcopy; click No to refresh the local copy from the source repository;click Cancel to cancel the prompt.

About Dell

Contact DellDell listens to customers and delivers worldwide innovative technology, business solutionsand services they trust and value. For more information, visit www.software.dell.com.

For sales or other inquiries, visit http://software.dell.com/company/contact-us.aspx or call 1-949-754-8000.

Technical Support ResourcesTechnical support is available to customers who have purchased Dell software with a validmaintenance contract and to customers who have trial versions. To access the Support Portal,go to http://software.dell.com/support/.

The Support Portal provides self-help tools you can use to solve problems quickly andindependently, 24 hours a day, 365 days a year. In addition, the portal provides direct accessto product support engineers through an online Service Request system.

The site enables you to:

l Create, update, and manage Service Requests (cases)

l View Knowledge Base articles

l Obtain product notifications

l Download software. For trial software, go to Trial Downloads.

l View how-to videos

l Engage in community discussions

l Chat with a support engineer

http://www.software.dell.com/

http://software.dell.com/company/contact-us.aspx

http://software.dell.com/support/

http://software.dell.com/trials

Toad for MySQL Installation GuideContacting Dell

36

Toad Community

Get the latest product information, find helpful resources, and join a discussion with the Toadfor MySQL team and other community members. Join the Toad for MySQL Community.

Please be advised before installing: Toad for MySQL is an official Dell Software Inc.Freeware Product. This license does not entitle Licensee to receive technical supportfrom Dell .

Get the latest product information and find helpful resources at the Toad for MySQLCommunity at http://toadformysql.com/index.jspa.

http://toadformysql.com/index.jspa

http://toadformysql.com/index.jspa

IndexA

application virtualization 7

automation

migrate scheduled tasks 18

upgrade scripts 16

C

Citrix

install 15

requirements 7

client requirements 5

connections

create MariaDB 21

create MySQL 21

share for all session windows 20

understand 20

corporate deployment 9

D

Dell

contact 35

desktop virtualization 7

I

install 8

Citrix 15

Citrix support 7

client requirements 5

silent 9

L

license keys 19

M

manage objects under VersionControl 30

mst file 13

MySQL

create connections 21

troubleshoot 22

R

requirements

Citrix 7

client 5

virtualization 7

S

server virtualization 7

silent install 9

create transform file 13

prerequisites 10

Subversion, configure 28

system requirements 5

T

Team Foundation Server, configure 28

TFS, configure 28

transform file 13

troubleshoot

MySQL 22

version control 33

Toad for MySQL Installation GuideIndex

38

U

uninstall 18

V

Version Control

about 24

configure Subversion 28

configure TFS 28

File system based 28

manage objects 30

troubleshoot 33

virtualization support 7