Toad For Mysql: Installation Guide

Download as pdf or txt
Download as pdf or txt
You are on page 1of 36

Toad® for MySQL 4.

Installation Guide
© 2010 Quest Software, Inc.

ALL RIGHTS RESERVED.

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

The information in this document is provided in connection with Quest products. No


license, express or implied, by estoppel or otherwise, to any intellectual property right is
granted by this document or in connection with the sale of Quest products. EXCEPT AS
SET FORTH IN QUEST'S TERMS AND CONDITIONS AS SPECIFIED IN THE LICENSE
AGREEMENT FOR THIS PRODUCT, QUEST ASSUMES NO LIABILITY
WHATSOEVER AND DISCLAIMS ANY EXPRESS, IMPLIED OR STATUTORY
WARRANTY RELATING TO ITS PRODUCTS INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE, OR NON-INFRINGEMENT. IN NO EVENT SHALL QUEST BE LIABLE FOR
ANY DIRECT, INDIRECT, CONSEQUENTIAL, PUNITIVE, SPECIAL OR INCIDENTAL
DAMAGES (INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OF
PROFITS, BUSINESS INTERRUPTION OR LOSS OF INFORMATION) ARISING OUT OF
THE USE OR INABILITY TO USE THIS DOCUMENT, EVEN IF QUEST HAS BEEN
ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. Quest makes no representations
or warranties with respect to the accuracy or completeness of the contents of this document
and reserves the right to make changes to specifications and product descriptions at any
time without notice. Quest does not make any commitment to update the information
contained in this document.

If you have any questions regarding your potential use of this material, contact:

Quest Software World Headquarters


LEGAL Dept
5 Polaris Way
Aliso Viejo, CA 92656

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.

Toad for MySQL 4.6

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

Platform 1 GHz minimum

Hard Disk 54 MB to run Toad


Space

Memory 512 MB of RAM minimum, 1 GB recommended


Note: The memory required may vary based on the following:
l Applications that are running on your system when using Toad
l Size and complexity of the database
l Amount of database activity
l Number of concurrent users accessing the database

Operating Windows Server 2003


System Windows XP Professional (32-bit or 64-bit)
Windows Vista (32-bit or 64-bit)
Windows Server 2008 (32-bit or 64-bit)
Windows 7 (32-bit or 64-bit)

.NET Microsoft .NET Framework 3.5 (Service Pack 1)


Framework Note: The following conditions apply:
l The .NET Framework Client Profile is not supported.
l To run Toad, the .NET security policy must be set to
unrestricted. See "System Requirements" (page 4) for more
information.

Additional Web Browser


Requirements Microsoft Internet Explorer 6.0 or later
Toad for MySQL Installation Guide 5
Installation

Server Requirements
Ensure that the server meets the following minimum requirements:

Component Requirement

Operating l Windows 2000 Service Pack 4 or later


System
l Windows 2003
l Windows XP (32-bit or 64-bit)
l Windows Vista (32-bit or 64-bit)

Database l MySQL 5.1


Support Note: Toad can manage Amazon RDS and any other cloud or
service offering compatible with MySQL.

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

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 run Toad, the .NET security policy must be set to Unrestricted. To modify the
security policy:
Toad for MySQL Installation Guide 6
Installation

1. Select Control Panel from the Windows Start menu.


2. Double-click Administrative Tools.
3. Double-click Microsoft .NET Framework 2.0 Configuration.
4. Select My Computer, and then select the Runtime Security Policy node.
5. Select Evaluate Assembly from the list of tasks in the right panel and browse
to the location of Toad.exe in the File field.
6. Click Next and set the permission to Unrestricted.
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.

Install Toad
To install Toad

1. Run the ToadInstaller.exe from the CD or downloaded file.

2. Complete the wizard.

Install Toad on Citrix Systems


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

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.
Toad for MySQL Installation Guide 7
Installation

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 CD or downloaded file.


2. Select Uninstall Toad and continue with install.

3. Complete the wizard.

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

Files Migrated During Upgrades


When upgrading versions of Toad, the following files can be migrated from the previous
version's Application Data Directory (Help | About to select a link to navigate to the
location).

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.

Connections.xml Contains all connections stored in the Connection


Manager or the New Connection window.

ConnectionTrace.log Contains the SQL Output connection trace log file if you
select Tools | SQL Trace from the menu.

ExceptionTrace.log Contains a log of all exceptions encountered while


running Toad.

FTPConnection.log Contains a log of exceptions encountered when attempting


to connect to FTP servers.

FTPConnections.xml Contains connections to FTP servers stored in the FTP


 Connections window.

Settings.xml Contains many of the global configuration settings.

ToadSupportBundle.zip Contains the last support bundle you generated.


Toad for MySQL Installation Guide 8
Installation

Folder Description

Automation (temporary Used by automation when executing automation scripts.


folder)

Cache Used to spool cache database metadata to disk if enabled.


The data is in binary format and can always be recreated
by fetching it from the database.

CNSScripter (temporary Used by Compare plug-ins, script generation for Alter


folder) object windows, and the Script tab in the Object Explorer.

Context Contains settings that depend on the context within Toad


including the following:
l Adapter—Custom data editing statements.
l Filter—Unnamed filters defined in the Object
Explorer or Database Explorer.
l Named Filter—Named filters defined in the Object
Explorer or Database Explorer.
l TYPE—Tabs that display on the right when you
select an object in the Object Explorer or Database
Explorer.

Keyboard Contains custom keyboard shortcut layouts.

Layouts Contains layouts for some areas in Toad, such as tool


windows that automatically display in the Editor and
column layouts for the Messages tab.

ModuleSettings Contains general settings for various components in Toad,


such as whether the data grid defaults to read-only,
displays not null indicators, etc.

Plugins Used by Toad plugin components.

Session Contains desktop configurations, including toolbar


customizations and tool window locations.

SQLFormatter Contains pre-set and user created templates for formatting


SQL, and the SQL statement used to preview formatting
changes in the Formatting Options page.

SQLRecall Contains the SQL statements saved by SQL Recall.

Templates Contains the following templates:


l Scripts—Startup scripts to run when connecting.
l Snippets—Code Snippet entries.
Toad for MySQL Installation Guide 9
Installation

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:

l Any new files you create


l Any copies of files you make for backup purposes

To uninstall Toad

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


2. Select Uninstall Toad only.
3. Complete the wizard.
2
Configuration

Understand Toad Connections


In Toad, a connection represents one or more actual connections to the database. Toad creates
an initial database connection for general usage. It also creates a separate database connection
for each Editor (the first time you execute a statement) and a separate database connection for
each Data tab in the Database Explorer (the first time you select the tab and data is queried).
The database connection for each Editor and Data tab remain open until you close the
associated window; however, the connections remain in an inactive state if a statement is not
currently executing.

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.

Share Database Connections


Editors and Data tabs can share the same database connection when the connection is
inactive if you clear the Use specific connection for each open editor checkbox in Tools |
 Options | Editor | General. Any new executions or windows attempt to use this
connection first. 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 connection is in use and you attempt to execute it, one of 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.
Toad for MySQL Installation Guide 11
Configuration

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

3. Review the following for additional information:

Login Tab Description

Connection Select the protocol to use when connecting.


type

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

Connection Enter the number of seconds to wait when connecting before


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

Use Select this checkbox to use an embedded MySQL library


instead of the MySQL .NET provider.
Toad for MySQL Installation Guide 12
Configuration

MySQL Note: If you select this option, you must specify libMySQL.dll
libraries in the path.

Name Edit the nickname you want to display in the Connection


toolbar, status bar, and document windows, if needed. If this
field is blank, the name defaults to:
username@hostname (database)

Category (missing or bad snippet)

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

Issue Cause/Solution

"InvalidCastException" error This is a known issue in MySQL.


when connecting to MYSQL Solution:
4.1.14-nt database
Review the known issue and download a patch
from: http://bugs.mysql.com/bug.php?id=12771

"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

Configure Version Control

About Version Control


Toad integrates with your existing version control system so you can maintain multiple
revisions of objects, SQL scripts, and files.

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.

Supported Server Version Client Version Tested


Provider Tested

Visual VSS 6.0d VSS 6.0d


SourceSafe See "Configure TFS or VSS" (page 14) for more
(VSS) information.

Concurrent CVS 1.11.22 on CVSNT 2.5.03


Versions Solaris See "Configure CVS " (page 20) for more
System CVSNT 2.5.03 on information.
(CVS) Windows

Subversion Subversion 1.5.6 CollabNet Subversion Command-Line Client 1.5.6


on Windows Notes:
Note: Toad only
l Toad only supports Subversion 1.5.6 or
supports
later.
Subversion 1.5.6
or later. l Any Subversion client must have svn.exe
in its installation directory to use version
control in Toad.
l Tortoise SVN is no longer supported in
Toad because it no longer includes svn.exe
in its installation directory.
See "Configure Subversion" (page 27) for more
information.
Toad for MySQL Installation Guide 14
Configuration

Supported Server Version Client Version Tested


Provider Tested

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.

Configure TFS or VSS


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.

To configure TFS or VSS to work with SQL scripts in 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.

4. Click to open the Version Control wizard.

5. Review the following for additional information:


Toad for MySQL Installation Guide 15
Configuration

Version Description
Control
System Page

Type Select either Team Foundation Server or Visual SourceSafe.


Note: If you select TFS, you must specify the workspace name
for the provider in the Team Foundation Server Properties
window that displays.

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.

Server Select one of the following:


l For TFS, specify the server where your version control
provider is installed and the port number (default is
8080) to use in the following format:
http://MyServer:Port
l For VSS, select the folder where the Source Safe client is
installed and the srcsafe.ini file (for example:
C:\SourceSafe\VSS\srcsafe.ini).

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

Working Select the folder to use as the default working folder.


folder If you already have objects under version control, select the
working folder for these objects.

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.

3. Review the following for additional information:


Toad for MySQL Installation Guide 17
Configuration

Configuration Description
Type Page

Configuration Select one of the following configuration types:


l Server—Applies the same settings for all databases on
a server.
l Database—Applies custom settings for each database
on a server. If selected, you must re-run the Version
Control wizard for each database you want to place
under version control.
Tip: You can add databases to version control at a
later time by selecting the database under Tools |
Options | Version Control | Objects.

Version Control Description


System Page

Type Select either Team Foundation Server or Visual SourceSafe.


Note: If you select TFS, you must specify the workspace
name for the provider in the Team Foundation Server
Properties window that displays.

Server Select one of the following:


l For TFS, specify the server where your version
control provider is installed and the port number
(default is 8080) to use in the following format:
http://MyServer:Port
l For VSS, select the folder where the Source Safe
client is installed and the srcsafe.ini file (for example:
C:\SourceSafe\VSS\srcsafe.ini).

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 Control Description


Settings Page

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

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 folder to use as the default working folder.


folder If you already have objects under version control, select the
working folder for these objects.

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:

Object is under version control

Object is checked out by another user

Object is checked out by current user

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:

The following folders or nodes are available:

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.

Scripts Creates and manages SQL scripts that apply to individual


folder/node databases. If you are using the tree view, this displays below
each database node, as illustrated in the following example:

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

See Compare Revisions in the Toad help for more information.

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

To configure CVS to work with SQL scripts in 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.

4. Click to open the Version Control wizard.

5. Review the following for additional information:

Version Description
Control
System Page

Type Select CVS.

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

User Enter your CVS command-line user name and password and


name/ click Login.
password Note: The User name field is optional.
Toad for MySQL Installation Guide 22
Configuration

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.

3. Review the following for additional information:

Configuration Description
Type Page

Configuration Select one of the following configuration types:


l Server—Applies the same settings for all databases on
a server.
l Database—Applies custom settings for each database
on a server. If selected, you must re-run the Version
Control wizard for each database you want to place
under version control.
Tip: You can add databases to version control at a
later time by selecting the database under Tools |
Options | Version Control | Objects.

Version Control Description


System Page

Type Select CVS.

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.

Default Version Description


Control Settings
Page

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.

Working Select the root repository folder on the client computer to


folder use as 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.

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:

Object is under version control

Object is checked out by another user

Object is checked out by current user

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

The following folders or nodes are available:

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.

Scripts Creates and manages SQL scripts that apply to individual


folder/node databases. If you are using the tree view, this displays below
each database node, as illustrated in the following example:

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.

To configure Subversion to work with SQL scripts in 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.

4. Click to open the Version Control wizard.

5. Review the following for additional information:

Version Description
Control
System Page

Type Select Subversion.

Properties Click this button (beside the Type field) and complete the
Toad for MySQL Installation Guide 28
Configuration

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.
Important: 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:
svn://MyServer).

User Enter your Subversion command-line user name and password


name/ and click Login.
Password

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

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

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

Configuration Select one of the following configuration types:


l Server—Applies the same settings for all databases on
a server.
l Database—Applies custom settings for each database
on a server. If selected, you must re-run the Version
Control wizard for each database you want to place
under version control.
Tip: You can add databases to version control at a
later time by selecting the database under Tools |
Options | Version Control | Objects.
Toad for MySQL Installation Guide 30
Configuration

Version Control Description


System Page

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

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

User name/ Enter your Subversion command-line user name and


Password password and click Login.

Default Version Description


Control Settings
Page

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

Working Select the root repository folder on the client computer to


folder use as 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.

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:

Object is under version control

Object is checked out by another user

Object is checked out by current user

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:

The following folders or nodes are available:

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.

Scripts Creates and manages SQL scripts that apply to individual


folder/node databases. If you are using the tree view, this displays below
each database node, as illustrated in the following example:

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

See Compare Revisions in the Toad help for more information.

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

Troubleshoot Other Issues

Review the following to help troubleshoot issues with version control:

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.

Case VSS is not case-sensitive. Using version control on objects whose


insensitive names differ by case only can cause history and version-tracking issues.

CVS Issues Description

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.

Script Issues Description

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.

Appendix: Contact Quest

Contact Quest Software


Email [email protected]

Quest Software, Inc.


World Headquarters
Mail 5 Polaris Way
Aliso Viejo, CA 92656
USA

Web site www.quest.com

See our web site for regional and international office information.

About Quest Software


Now more than ever, organizations need to work smart and improve efficiency. Quest
Software creates and supports smart systems management products—helping our customers
solve everyday IT challenges easier and faster. Learn more at www.quest.com.
S
Index server requirements 5

SourceSafe, configure 14
C
Subversion, configure 27
Citrix
system requirements 4
installation 6

requirements 5 T

client requirements 4 Team Foundation Server, configure 14

connections TFS, configure 14

share for all session windows 10 troubleshoot

understand 10 MySQL 12

CVS, configure 20 version control 33

I U

installation 6 uninstall Toad 9

Citrix 5-6 user privilege requirements 5

client requirements 4
V
server requirements 5
Version Control 13
user privilege requirements 5
configure CVS 20

M configure Subversion 27

MySQL configure TFS 14

troubleshoot 12 configure VSS 14

troubleshoot 33
R
Visual SourceSafe, configure 14
requirements
VSS, configure 14
Citrix 5

client 4

server 5

user privilege 5

You might also like