Toad for MySQL Installation Guide 73

8/20/2019 Toad for MySQL Installation Guide 73

1/36

Toad™ for MySQL 7.3

Installation Guide


2/36

© 2014 Dell 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 softwaremay 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 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 by

this document or in connection with the sale of Dell products. EXCEPT AS SET FORTH IN

THE TERMS AND CONDITIONS AS SPECIFIED IN THE LICENSE AGREEMENT FOR

THIS PRODUCT, DELL 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 DELL 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 DELL HAS BEEN ADVISED OF THE

POSSIBILITY OF SUCH DAMAGES. Dell 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.

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 Dept

5 Polaris Way

Aliso 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

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 itssubsidiaries, and may be registered in the United States Patent and Trademark Office and in

other countries. Subversion is a trademark of the Apache Software Foundation. Other

trademarks and trade names may be used in this document to refer to either the entities

claiming the marks and names or their products. Dell disclaims any proprietary interest in

the marks and names of others.

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


3/36

Toad for MySQL 7.3

Installation Guide

Friday, August 15, 2014


4/36

Table of Contents

Installation 5

System Requirements 5

Client Requirements 5

Server Requirements 6

Virtualization Support 6

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 Scri pts 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


5/36

Toad for MySQL Installation Guide

Table of Contents

4

Configure Version Control 24

About Version Control 24

Prerequisites 24

Configure Version Control 25

Manage Objects under Version Control 26

Troubleshoot Version Control 30

Troubleshoot Upgrades 30

Troubleshoot Other Issues 30

About Dell 32

Contact Dell 32

Technical Support Resources 32

Toad Community 33

Index 34


6/36

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:

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 t he 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)

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.

.NET

Framework

The Microsoft® .NET Framework is required. The version is

dependent on the operating system.

.NET 4.5 Windows Vista SP2, Windows 7, Windows 8,

1

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


7/36


Installation

6

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 This information is provided to aid

installation. Toad is not tested on

Windows XP. Windows Vista (SP1 or

earlier), and Windows Server 2003.

l The .NET Framework 4 Client Profile is

not supported.

Additional

Requirements

Web Browser

Microsoft® Internet Explorer® 6.0 or later

Server Requirements

Before installing Toad, ensure that your server meets the following minimum hardware and

software requirements:

Database

ServerMySQL 4.1, 5.0, 5.1, 5.5, 5.6

Clustrix 5.2

Cloud

DatabaseService

Toad can manage Amazon RDS and any other cloud or service

offering compatible with MySQL.

Virtualization Support

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" (page 15) for more information.

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

tested.


8/36


Installation

7

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

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


9/36


Installation

8

Install ToadTo install Toad

1. Run the ToadInstaller.exe.

2. Complete the wizard.

Specify Application Data Directory Location

Toad for MySQL 7.3 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\7.3), 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 andBEFORE opening Toad.

Operating System Default Location N ew Locati on when

LOCALSETTINGS = 1

Windows Vista

Windows Server 2008

Windows 7

Windows 8

C:\Users\username\

AppData\Roaming\Quest

Software\Toad for MySQL

7.3

C:\Users\username\

AppData\Local\Quest

Software\ Toad for MySQL

7.3

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"


10/36


Installation

9

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).

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:

l Verifies whether the

prerequisite software is

installed, and if not,

redirects you to the

download location.

Silent installation using the .exe


disadvantages:

l Cannot deploy custom

Toad settings files or

license keys.

l Installer automatically

exits if the prerequisite

software is not installed.

Microsoft

Installer file

(.msi)

Supports deployment of Toad

settings files and license keys.

Silent installation using the .msi


disadvantages:

l Requires manual

verification and

download of any

prerequisite software.

l Requires a manual

uninstall of the previous

version of Toad using

Add/Remove Programs.


11/36


Installation

10

Silent Installation Prerequisites

Before you perform a silent installation, you must install the following software 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 Dell 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_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/en-

us/library/aa367988.aspx for more information about

additional logging options.

Also, substitute “C:\temp\installLog.txt ” in the examplewith 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.

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


12/36


Installation

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 in

which you want to install Toad. If you do not include this

path, the installation program defaults to: C:\Program

Files\Quest Software\Toad for MySQL 7.3.

ALLUSERS (Optional) Specify one of the following:

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.

l For a per-user installation, enter the empty stringvalue (“”) 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 per-user 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 shortcut on the desktop after the installation

completes.


empty string value ("" ) and you omit the

USERNAME option, only the user that installed

Toad sees the Toad shortcut on the desktop.

l If ALLUSERS is 1, the USERNAME value is

ignored during installation.

COMPANYNAME (Optional) Specify the name of the company that owns

this installation.

Notes:

l All default installation opt ion overrides are case-sensitive.

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


13/36


Installation

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 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/en-us/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\Quest Software\Toad for MySQL 7.3.

ALLUSERS (Optional) Specify one of the following:

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


14/36


Installation

13

Option Description

l For a per-machine installation, specify 1 . This

value allows any user to use the Toad shortcut onthe desktop after the installation completes.

l 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 per-user installation.

USERNAME (Optional) Specify the user that intends to use Toad on

the target computer.Notes:


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.


empty string value ("" ) and you omit the

USERNAME option, only the user that installed

Toad sees the Toad shortcut on the desktop.

l If ALLUSERS is 1, the USERNAME value is

ignored during installation.

COMPANYNAME (Optional) Specify the name of the company that owns

this installation.

Notes:

l All default installation opt ion 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" (page 12) for more information if you are not

creating a transform file.


15/36


Installation

14

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 | C onnection 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.

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 this

transform 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


16/36


Installation

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\ Quest

Software\Toad for MySQL 7.3.

ModuleSettings

folder and files

C:\Users\username\AppData\Roaming\ Quest

Software\Toad for MySQL 7.3\ModuleSettings.

Connections.xml C:\Users\username\AppData\Roaming\ Quest

Software\Toad for MySQL 7.3.

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 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 A license supplied by an administrator always overrides a user-supplied license

in a Citrix environment.

l If you need to provide the same Toad functionality to all users, you can enter

the default license key for all users.


17/36


Installation

16

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

Upgrade Toad

To upgrade Toad

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

2. Select U ninstall Toad and continue wi th install.


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 SchedulingTasks

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 theywere 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.


18/36


Installation

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 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:

\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 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 t he 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).


19/36


Installation

18

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.

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 R un and Start in fields,

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


20/36


Installation

19

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.


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 (Base, Xpert, etc.) 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://software.dell.com/.

http://software.dell.com/


21/36

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 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 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 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.

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


22/36



21

3. When this option is not selected, Toad attempts to use a single connection for any

new 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, 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" (page 22) for more information about

troubleshooting connection issues.

Note: This topic focuses on information that may be unfamiliar to you. It does not include all

step and field descriptions.

To create a MySQL connection

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

2. Select MySQL from the Group list box.


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.


23/36



22

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 Private key—browse to the location of the SSL key file

to use when connecting.

l CA cert—browse to the location of the trusted certificate

authority to use when connecting.

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

UseMySQL

libraries

Select this checkbox to use an embedded MySQL libraryinstead 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 databases. You can also set an

option to color code the Object Explorer pane and object editor

windows (Create, Alter, Drop, etc.). 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

http://toadforsqlserver.com/entry.jspa?externalID=4370&categoryID=686


24/36



23

Issue Cause/Solution

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.

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


25/36

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" (page 25) for more information on

configuring version control in Toad.

Important: See "Troubleshoot Version Control" (page 30) for more information about issues

when upgrading version control from a previous version.

Notes:

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" (page 26) for more information.

l 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 V ersion Tested

Apache

Subversion™

Subversion 1.7.5

on Windows

CollabNet Subversion Command-Line Client

1.7.5

Note: Any Subversion client must have svn.exe in

its installation directory to use version control in

Toad.

Team

FoundationServer (TFS)

TFS 2008, 2010,

2012

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

Client

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.

3


26/36



25

Supported

Provider

Server Version

Tested

Client V ersion Tested

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.


To configure version control

1. Ensure that a supported version control client is installed on the computer where Toad

is installed. See "About Version Control" (page 24) for more information about tested

version 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 .


Version C ontrol

System Page

Description

Type 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 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 File system based

Properties (Subversion only) Click this button (beside the Type

field) and complete the binary path. Enter the path wherethe 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.


27/36



26

Server Select one of the following:

l Subversion—Specify the existing working folder

for the version control repository or specify the

server string (for example: svn:// MyServer ).

l 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

l File System Based—Specify a directory at your

local machine.

User name/

Password

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.

Default Version

Control Settings

Page

Description

Version control

folder

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" (page 26) 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" (page 25) for more information.


28/36



27

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 of

the object's icon.

l 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 C ontrolstatus

Description

Uninitialized The object status is undetermined yet. This is a

temporary status that is issued for all objects during

version control status processing.

Unt racked The obj ect is not added to versi on control.

Ignored The obj ect is added t o ignore list and excluded from

version control.

UpToDate The object is under version control and is synchronized

with version control repository. No changes aredetected.

Modified The obj ect 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.

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


29/36



28

Version C ontrol

status

Description

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 Controlledobjects 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


30/36



29

Use To...

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 i n 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 latestrevision.

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 last time.

Update status Select to compare a script in your local database with

the 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 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.


31/36



30

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 Version cont rol settings are not migrated from the previous version of Toad, so you

have to reconfigure version control in Toad.

l 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 fileIf 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.

OutOfMemory

exception

when addinga large

number of

objects

When adding a large number of objects, Subversion may encounter

OutOfMemory exception.

Workaround:Commit objects in several steps.

SVN is

missing in the

If Subversion is missing in the list of available version control

providers, it means that Subversion.xml was removed or corrupted.


32/36



31

list of

available

providers

Workaround:

Contact Support to get a new Subversion.xml and place it under

/Templates/Version Control/.

Object Issues Description

Adding

multiple

objects failed

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.

Script Issues Description

Canceled

check-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-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 Y es to use the locally changed

copy; click No to refresh the local copy from the source repository;

click Cancel to cancel the prompt.


33/36

About Dell

Contact Dell

Dell listens to customers and delivers worldwide innovative technology, business solutions

and services they trust and value. For more information, visit www.software.dell.com.

Technical Support:

Online support

Product Questions and Sales:

(800) 306-9329

Email:[email protected]

Technical Support Resources

Technical support is available to customers who have purchased Dell software with a valid

maintenance 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 and

independently, 24 hours a day, 365 days a year. In addition, the portal provides direct access

to 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/mailto:[email protected]://software.dell.com/trialshttp://software.dell.com/support/mailto:[email protected]://software.dell.com/support/http://www.software.dell.com/


34/36


Contacting Dell

33

Toad Community

Get the latest product information, find helpful resources, and join a discussion with the Toad

for 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 support

from Dell .

Get the latest product information and find helpful resources at the Toad for MySQL

Community at http://toadformysql.com/index.jspa.

http://toadformysql.com/index.jspahttp://toadformysql.com/index.jspa


35/36

Index

A

application virtualization 6

automation

migrate scheduled tasks 18

upgrade scripts 16

C

Citrix

install 15

requirements 6

client requirements 5

connections

create MySQL 21

share for all session windows 20

understand 20

corporate deployment 9

D

Dell

contact 32

desktop virtualization 6

I

install 8

Citrix 15

Citrix support 6

client requirements 5

silent 9

L

license keys 19

M

manage objects under Version

Control 26

mst file 13

MySQL

create connections 21

troubleshoot 22

R

requirements

Citrix 6

client 5

virtualization 6

S

server virtualization 6

silent install 9

create transform file 13

prerequisites 10

Subversion, configure 25

system requirements 5

T

Team Foundation Server, configure 25

TFS, configure 25

transform file 13

troubleshoot

MySQL 22

version control 30

U

uninstall 18


36/36


Index

35

V

Version Control

about 24

configure Subversion 25

configure TFS 25

File system based 25

manage objects 26

troubleshoot 30

virtualization support 6