Toad For Mysql: Installation Guide
Toad For Mysql: Installation Guide
Toad For Mysql: Installation Guide
Installation Guide
© 2010 Quest Software, Inc.
This guide contains proprietary information protected by copyright. The software described in
this guide is furnished under a software license or nondisclosure agreement. This software
may be used or copied only in accordance with the terms of the applicable agreement. No
part of this guide may be reproduced or transmitted in any form or by any means, electronic
or mechanical, including photocopying and recording for any purpose other than the
purchaser’s personal use without the written permission of Quest Software, Inc.
If you have any questions regarding your potential use of this material, contact:
www.quest.com
email: [email protected]
Refer to our Web site for regional and international office information.
Trademarks
Quest, Quest Software, the Quest Software logo, Toad, T.O.A.D., Toad World, and vToad are
trademarks and registered trademarks of Quest Software, Inc in the United States of America
and other countries. Other trademarks and registered trademarks used in this guide are
property of their respective owners.
Installation Guide
January 2010
Table of Contents
Installation 4
System Requirements 4
Install Toad 6
Install Toad on Citrix Systems 6
Upgrade Toad 7
Uninstall Toad 9
Configuration 10
Understand Toad Connections 10
Create MySQL Connections 11
Troubleshoot MySQL Issues 12
Configure Version Control 13
Appendix: Contact Quest 35
Contact Quest Software 35
About Quest Software 35
Index 36
1
Installation
System Requirements
Client Requirements
Ensure that the client computer meets the following minimum requirements:
Component Requirement
Server Requirements
Ensure that the server meets the following minimum requirements:
Component Requirement
Citrix Requirements
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 6) for more information.
User Requirements
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.
The following describes the requirements and restrictions for users who launch and run Toad:
l To run Toad, the .NET security policy must be set to Unrestricted. To modify the
security policy:
Toad for MySQL Installation Guide 6
Installation
Install Toad
To install Toad
3. Install Toad.
4. During installation, select the Anyone who uses this computer checkbox when
prompted.
Note: Although you must install Toad on every server in the Citrix farm, you only
need to publish Toad once.
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
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.
File Description
Action.log Tracks your usage within Toad. If you agree to share this
data, the file is automatically sent to Quest on a periodic
basis.
ConnectionTrace.log Contains the SQL Output connection trace log file if you
select Tools | SQL Trace from the menu.
Folder Description
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. The following types of files are not
removed when you uninstall:
To uninstall Toad
Tips:
l To view the number of actual database connections that exist for a Toad connection
and how many of those database connections are active, place the cursor over the
connection in the Connection Manager or the Connection toolbar.
l You can view the progress of statements executing in the background in a progress
bar located on the lower right side of the status bar. To cancel a script's execution,
click the progress bar to display the Background Processes window.
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.
Toad for MySQL Installation Guide 11
Configuration
Note: This topic focuses on information that may be unfamiliar to you. It does not include all
step and field descriptions.
Host Enter the name of the host computer where the database is
installed.
Compress Select this checkbox to compress the value of any strings and
return binary values.
MySQL Note: If you select this option, you must specify libMySQL.dll
libraries in the path.
4. Click Connect to save the connection and immediately connect to the database.
or
Tip: Connections are stored in the connections.xml file and can be found by clicking the
Application Data Directory link in Help | About.
Issue Cause/Solution
"System.IO.DirectoryNot Solution:
FoundException"error occurs
1. Exit Toad.
each time you attempt to
connect after installing Toad 2. Locate the MySQL.xml file in the
into a directory other than the C:\Documents and Settings\username\Local
default directory. Settings\ Application Data\Quest Software\
Toad for MySQLversion\ ModuleSettings
3. Rename or delete the MySQL.xml file.
4. Restart Toad.
Toad for MySQL Installation Guide 13
Configuration
Important: For this release, the back-end of version control has been rewritten. See
"Troubleshoot Version Control" (page 33) for more information about issues when upgrading
version control from a previous version.
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.
Team TFS 2005, 2008 Visual Studio (2005 and 2008) Team Explorer
Foundation Client
Server See "Configure TFS or VSS" (page 14) for more
(TFS) information.
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.
Notes:
l If you want to place database objects under version control, you must configure
version control for objects using the Object Explorer. Once configured, you can also
manage SQL scripts in the Object Explorer. The main advantage of managing scripts
in the Object Explorer is that you can easily share them with team members who have
version control configured.
l If you do not want to manage version controlled scripts from the Object Explorer, you
must create a separate version control configuration from the Editor.
1. Ensure that a supported version control client is installed on the computer where Toad
is installed. See "Configure Version Control" (page 13) for more information about
tested version control clients and supported versions.
2. Open an Editor window.
3. Right-click anywhere in the toolbar area and select Version Control to display the
Version Control toolbar.
Tip: You can also access version control functionality from the File | Version
Control menu when the Editor window has focus.
Version Description
Control
System Page
Properties (TFS only) Click this button (beside the Type field) and specify
the workspace name for the provider in the Team Foundation
Server Properties window.
User Enter login information for the version control provider and
name/ click Login.
Password Note: For TFS only, if you leave the user name and password
fields blank, Toad uses your default Windows credentials.
Version Description
Control
Settings
Page
Version Select the folder on the version control server where you want to
control check objects and scripts in.
folder If you already have objects or scripts under version control,
select the folder on the server where these objects or scripts are
located.
Notes:
l Version control automatically checks out objects or
scripts in this folder and any subfolders to the location
you specify in the Working folder field.
l If you want to manage SQL scripts from the Editor
instead of the Object Explorer, make sure you select a
different from the one used for database objects and
scripts.
Toad for MySQL Installation Guide 16
Configuration
6. See "Add Scripts Using the Editor" in the Toad help for more information.
Tips:
l You can view revision history and revision comments for a scipt from the History tab;
and can also right-click a revision to send it to the Diff Viewer to compare
differences.
l You can enable, disable, or delete a version control configuration under Tools |
Options | Version Control | General.
l You can modify current settings, including whether to require comments when
checking objects and scripts in or out, avoid checking scripts in automatically when
executing a script in the Editor, disable or delete a version control configuration, etc.,
from Tools | Options | Version Control | <options page>.
To configure TFS or VSS to work with objects and SQL scripts in the Object Explorer
1. Ensure that a supported version control client is installed on the computer where Toad
is installed. See "Configure Version Control" (page 13) 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.
Configuration Description
Type Page
User name/ Enter login information for the version control provider and
Password click Login.
Note: For TFS only, if you leave the user name and
password fields blank,Toad uses your default Windows
credentials.
Version Select the folder on the version control server where you
control folder want to check objects and scripts in.
If you already have objects or scripts under version control,
select the folder on the server where these objects or scripts
are located.
Notes:
Toad for MySQL Installation Guide 18
Configuration
Create/Change Specify the default format to use for objects. Objects are
file name archived as script files in the version control provider.
formats To change the default order, delete the default format and
click + to select the order.
Use default Clear this checkbox to override default folders for actions,
mode such as create or alter scripts for each object (recommended
for objects that are already under version control).
4. Complete the wizard and add objects to version control. Depending on the number of
objects selected, this process may take time.
The following indicators display in the top-right corner of any object under
version control:
If version control is configured but an indicator does not display, open the Object
Options page in the Toad help and select the checkbox for that object.
5. Use the right-click menu to check files in/out, get the latest version, update the status,
and other actions.
Toad for MySQL Installation Guide 19
Configuration
6. If you configured version control for database objects, you can also version control
SQL scripts using the Scripts tab (tab view or drop-down list mode) in the Object
Explorer, as illustrated in the following example:
Server Scripts Creates and manages SQL scripts that apply to all databases on
folder/node a server.
Note: This folder/node is only available if you configured
version control at the server level.
Tips:
l You can use the Script tab in the Object Details pane to view revision information
about each script and historical create/alter scripts (initially collapsed). You can also
right-click a revision date to compare differences or update version control history.
Toad for MySQL Installation Guide 20
Configuration
l You can view history for the last 100 check in operations by selecting History in the
Object Explorer. The History folder/node is read-only, and you cannot perform any
actions on the objects using it. Also, the Object Details pane remains empty when the
History folder/node is selected.
l You can modify current settings, including whether to require comments when
checking objects and scripts in or out, adding or removing objects from version
control, disable or delete a version control configuration, etc., from Tools | Options |
Version Control | <options page>.
Configure CVS
You can configure version control to work with SQL scripts in the Editor, or you can
configure it to work with database objects and SQL scripts in the Object Explorer. See
"Troubleshoot Version Control" (page 33) for more information.
Notes:
l If you want to place database objects under version control, you must configure
version control for objects using the Object Explorer. Once configured, you can also
manage SQL scripts in the Object Explorer. The main advantage of managing scripts
in the Object Explorer is that you can easily share them with team members who have
version control configured.
l If you do not want to manage version controlled scripts from the Object Explorer, you
must create a separate version control configuration from the Editor.
Toad for MySQL Installation Guide 21
Configuration
1. Ensure that a supported version control client is installed on the computer where Toad
is installed. See "Configure Version Control" (page 13) for more information about
tested version control clients and supported versions.
3. Right-click anywhere in the toolbar area and select Version Control to display the
Version Control toolbar.
Tip: You can also access version control functionality from the File | Version
Control menu when the Editor window has focus.
Version Description
Control
System Page
Properties Click this button (beside the Type field) and complete the
following in the Command Based Version Control Properties
window:
l BinaryPath—Enter the path where the CVS client is
installed. For example, if you installed CVSNT, you
would enter:
C:\Program Files\CVSNT
l BranchRevision—Leave this field blank if you are
working from the trunk in version control. If you are
working from a branch, enter the branch number or name
in this field.
Caution: Specifying HEAD for the BranchRevision
parameter can cause errors. Leave the parameter blank
when working with the HEAD revision.
Server Select the existing working folder for the version control
repository or specify the server string. For example, if you are
connecting using pserver, you should specify the server string as
follows:
:pserver:MyServer:Port:/MyWorkingRepository
Default Description
Version
Control
Settings
Page
Version Select the folder on the version control server where you want to
control check objects and scripts in.
folder If you already have objects or scripts under version control,
select the folder on the server where these objects or scripts are
located.
Notes:
l Version control automatically checks out objects or
scripts in this folder and any subfolders to the location
you specify in the Working folder field.
l If you want to manage SQL scripts from the Editor
instead of the Object Explorer, make sure you select a
different from the one used for database objects and
scripts.
Working Select the root repository folder on the client computer to use as
folder the default working folder for checking objects and SQL scripts
out.
If you already have objects or SQL scripts under version control,
select the existing working folder for these.
6. See "Add Scripts Using the Editor" in the Toad help for more information.
Tips:
l You can view revision history and revision comments for a scipt from the History tab;
and can also right-click a revision to send it to the Diff Viewer to compare
differences.
l You can enable, disable, or delete a version control configuration under Tools |
Options | Version Control | General.
l You can modify current settings, including whether to require comments when
checking objects and scripts in or out, avoid checking scripts in automatically when
executing a script in the Editor, disable or delete a version control configuration, etc.,
from Tools | Options | Version Control | <options page>.
Toad for MySQL Installation Guide 23
Configuration
To configure CVS to work with objects and SQL scripts in the Object Explorer
1. Ensure that a supported version control client is installed on the computer where Toad
is installed. See "Configure Version Control" (page 13) 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.
Configuration Description
Type Page
Properties Click this button (beside the Type field) and complete the
following in the Command Based Version Control Properties
window:
l BinaryPath—Enter the path where the CVS client is
installed. For example, if you installed CVSNT, you
would enter:
C:\Program Files\CVSNT
l BranchRevision—Leave this field blank if you are
working from the trunk in version control. If you are
working from a branch, enter the branch number or
name in this field.
Toad for MySQL Installation Guide 24
Configuration
Server Select the existing working folder for the version control
repository or specify the server string. For example, if you
are connecting using pserver, you should specify the server
string as follows:
:pserver:MyServer:Port:/MyWorkingRepository
User name/ Enter your CVS command-line user name and password and
Password click Login.
Note: The User name field is optional.
Version Select the folder on the version control server where you
control folder want to check objects and scripts in.
If you already have objects or scripts under version control,
select the folder on the server where these objects or scripts
are located.
Notes:
l Version control automatically checks out objects or
scripts in this folder and any subfolders to the
location you specify in the Working folder field.
l If you want to manage SQL scripts from the Editor
instead of the Object Explorer, make sure you select a
different from the one used for database objects and
scripts.
Create/Change Specify the default format to use for objects. Objects are
file name archived as script files in the version control provider.
formats To change the default order, delete the default format and
click + to select the order.
Use default Clear this checkbox to override default folders for actions,
mode such as create or alter scripts for each object (recommended
for objects that are already under version control).
4. Complete the wizard and add objects to version control. Depending on the number of
objects selected, this process may take time.
Toad for MySQL Installation Guide 25
Configuration
The following indicators display in the top-right corner of any object under
version control:
If version control is configured but an indicator does not display, open the Object
Options page in the Toad help and select the checkbox for that object.
5. Right-click one or more objects in the Object Explorer to check them in/out, get the
latest version, update the status, and other actions.
6. If you configured version control for database objects, you can also version control
SQL scripts using the Scripts tab (tab view or drop-down list mode) in the Object
Explorer, as illustrated in the following example:
Toad for MySQL Installation Guide 26
Configuration
Server Scripts Creates and manages SQL scripts that apply to all databases on
folder/node a server.
Note: This folder/node is only available if you configured
version control at the server level.
Tips:
l You can use the Script tab in the Object Details pane to view revision information
about each script and historical create/alter scripts (initially collapsed). You can also
right-click a revision date to compare differences or update version control history.
See Compare Revisions in the Toad help for more information.
Toad for MySQL Installation Guide 27
Configuration
l You can view history for the last 100 check in operations by selecting History in the
Object Explorer. The History folder/node is read-only, and you cannot perform any
actions on the objects using it. Also, the Object Details pane remains empty when the
History folder/node is selected.
l You can modify current settings, including whether to require comments when
checking objects and scripts in or out, adding or removing objects from version
control, disable or delete a version control configuration, etc., from Tools | Options |
Version Control | <options page>.
Configure Subversion
You can configure version control to work with SQL scripts in the Editor, or you can
configure it to work with database objects and SQL scripts in the Object Explorer. See
"Troubleshoot Version Control" (page 33) for more information.
Notes:
l If you want to place database objects under version control, you must configure
version control for objects using the Object Explorer. Once configured, you can also
manage SQL scripts in the Object Explorer. The main advantage of managing scripts
in the Object Explorer is that you can easily share them with team members who have
version control configured.
l If you do not want to manage version controlled scripts from the Object Explorer, you
must create a separate version control configuration from the Editor.
1. Ensure that a supported version control client is installed on the computer where Toad
is installed. See "Configure Version Control" (page 13) for more information about
tested version control clients and supported versions.
3. Right-click anywhere in the toolbar area and select Version Control to display the
Version Control toolbar.
Tip: You can also access version control functionality from the File | Version
Control menu when the Editor window has focus.
Version Description
Control
System Page
Properties Click this button (beside the Type field) and complete the
Toad for MySQL Installation Guide 28
Configuration
Server Select the existing working folder for the version control
repository or specify the server string (for example:
svn://MyServer).
Default Description
Version
Control
Settings
Page
Version Select the folder on the version control server where you want to
control check objects and scripts in.
folder If you already have objects or scripts under version control,
select the folder on the server where these objects or scripts are
located.
Notes:
l Version control automatically checks out objects or
scripts in this folder and any subfolders to the location
you specify in the Working folder field.
l If you want to manage SQL scripts from the Editor
instead of the Object Explorer, make sure you select a
different from the one used for database objects and
scripts.
Working Select the root repository folder on the client computer to use as
folder the default working folder for checking objects and SQL scripts
out.
Toad for MySQL Installation Guide 29
Configuration
6. See "Add Scripts Using the Editor" in the Toad help for more information.
Tips:
l You can view revision history and revision comments for a scipt from the History tab;
and can also right-click a revision to send it to the Diff Viewer to compare
differences.
l You can enable, disable, or delete a version control configuration under Tools |
Options | Version Control | General.
l You can modify current settings, including whether to require comments when
checking objects and scripts in or out, avoid checking scripts in automatically when
executing a script in the Editor, disable or delete a version control configuration, etc.,
from Tools | Options | Version Control | <options page>.
To configure Subversion to work with objects and SQL scripts in the Object Explorer
1. Ensure that a supported version control client is installed on the computer where Toad
is installed. See "Configure Version Control" (page 13) 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.
3. Review the following for additional information:
Configuration Description
Type Page
Properties Click this button (beside the Type field) and complete the
following in the Command Based Version Control Properties
window:
l BinaryPath—Enter the path where the Subversion
client that contains svn.exe is installed. For example,
if you installed the CollabNet Subversion Client, you
would enter:
C:\Program Files\CollabNet Subversion Client
Note: Do not include svn.exe in the path.
l BranchRevision—Leave this field blank if you are
working from the trunk in version control. If you are
working from a branch, enter the branch number or
name in this field.
Server Select the existing working folder for the version control
repository or specify the server string (for example:
svn://MyServer).
Version Select the folder on the version control server where you
control folder want to check objects and scripts in.
If you already have objects or scripts under version control,
select the folder on the server where these objects or scripts
are located.
Notes:
l Version control automatically checks out objects or
scripts in this folder and any subfolders to the
location you specify in the Working folder field.
l If you want to manage SQL scripts from the Editor
instead of the Object Explorer, make sure you select a
different from the one used for database objects and
scripts.
Toad for MySQL Installation Guide 31
Configuration
Create/Change Specify the default format to use for objects. Objects are
file name archived as script files in the version control provider.
formats To change the default order, delete the default format and
click + to select the order.
Use default Clear this checkbox to override default folders for actions,
mode such as create or alter scripts for each object (recommended
for objects that are already under version control).
4. Complete the wizard and add objects to version control. Depending on the number of
objects selected, this process may take time.
The following indicators display in the top-right corner of any object under
version control:
If version control is configured but an indicator does not display, open the Object
Options page in the Toad help and select the checkbox for that object.
5. Right-click one or more objects in the Object Explorer to check them in/out, get the
latest version, update the status, and other actions.
Toad for MySQL Installation Guide 32
Configuration
6. If you configured version control for database objects, you can also version control
SQL scripts using the Scripts tab (tab view or drop-down list mode) in the Object
Explorer, as illustrated in the following example:
Server Scripts Creates and manages SQL scripts that apply to all databases on
folder/node a server.
Note: This folder/node is only available if you configured
version control at the server level.
Tips:
l You can use the Script tab in the Object Details pane to view revision information
about each script and historical create/alter scripts (initially collapsed). You can also
right-click a revision date to compare differences or update version control history.
Toad for MySQL Installation Guide 33
Configuration
l You can view history for the last 100 check in operations by selecting History in the
Object Explorer. The History folder/node is read-only, and you cannot perform any
actions on the objects using it. Also, the Object Details pane remains empty when the
History folder/node is selected.
l You can modify current settings, including whether to require comments when
checking objects and scripts in or out, adding or removing objects from version
control, disable or delete a version control configuration, etc., from Tools | Options |
Version Control | <options page>.
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 If you migrate settings when upgrading Toad, you may have to reconfigure the
repository setting in version control if a "Failed to open the settings for module
VersionControl reverting to defaults" error displays. To reconfigure the repository,
select Tools | Options | Version Control | Defaults and select the previous repository
in the Version control folder field. Your previous project settings are applied.
l In previous releases, the method Toad used to generate the script was different than
the current method. After upgrading Toad, a message may display stating that objects
or files in version control are different than the local version. If your local version is
current, you should check the objects and files into version control.
Toad for MySQL Installation Guide 34
Configuration
VSS Issues Description
Language VSS 6.0 uses ANSI strings. Consequently, the English-encoded VSS
support server and client do not handle certain characters in other languages.
This issue may also exist on previous or later VSS language
installations.
System If a message stating that, “The system cannot find the file specified”
cannot displays, this usually means that the CVS executable cannot be found
find file in the path you specified in the BinaryPath field of the Command
Based Version Control Properties window. Verify that cvs.exe exists in
the directory you specified in this field
Command When executing CVS commands, user input is not allowed. This
execution presents an issue when the user is using CVS 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.
Subversion Description
Issues
System If a message stating that, “The system cannot find the file specified”
cannot displays, this usually means that the Subversion executable cannot be
find file 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 When executing Subversion commands, user input is not allowed. This
execution 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.
Object Description
Issues
Toad for MySQL Installation Guide 35
Appendix: Contact Quest
Adding When you add multiple objects to version control, the objects are
multiple grouped and added in batches (for example, all the tables for a
objects 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.
Cancelled SQL scripts remain checked out if a change was made to the text, but
check-in check-in was cancelled during the prompt for a check-in comment. This
behavior is by design—that is; the user can either undo the checkout or
check in the script using the right-click menu in the Scripts
node/folder/tab of the Object Explorer.
Note: If you alter the object again, you receive a prompt to use the
“locally changed” script. Click Yes to use the locally changed copy;
click No to refresh the local copy from the source repository; click
Cancel to cancel the prompt.
See our web site for regional and international office information.
SourceSafe, configure 14
C
Subversion, configure 27
Citrix
system requirements 4
installation 6
requirements 5 T
understand 10 MySQL 12
I U
client requirements 4
V
server requirements 5
Version Control 13
user privilege requirements 5
configure CVS 20
M configure Subversion 27
troubleshoot 33
R
Visual SourceSafe, configure 14
requirements
VSS, configure 14
Citrix 5
client 4
server 5
user privilege 5