Toad for my sql 6.3 installation guide

Toad® for MySQL 6.3

Installation Guide

© 2012 Quest Software, Inc.

ALL RIGHTS RESERVED.

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

The information in this document is provided in connection with Quest products. Nolicense, express or implied, by estoppel or otherwise, to any intellectual property right isgranted by this document or in connection with the sale of Quest products. EXCEPT ASSET FORTH IN QUEST'S TERMS AND CONDITIONS AS SPECIFIED IN THE LICENSEAGREEMENT FOR THIS PRODUCT, QUEST ASSUMES NO LIABILITYWHATSOEVER AND DISCLAIMS ANY EXPRESS, IMPLIED OR STATUTORYWARRANTY RELATING TO ITS PRODUCTS INCLUDING, BUT NOT LIMITED TO,THE IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULARPURPOSE, OR NON-INFRINGEMENT. IN NO EVENT SHALL QUEST BE LIABLE FORANY DIRECT, INDIRECT, CONSEQUENTIAL, PUNITIVE, SPECIAL OR INCIDENTALDAMAGES (INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OFPROFITS, BUSINESS INTERRUPTION OR LOSS OF INFORMATION) ARISING OUT OFTHE USE OR INABILITY TO USE THIS DOCUMENT, EVEN IF QUEST HAS BEENADVISED OF THE POSSIBILITY OF SUCH DAMAGES. Quest makes no representationsor warranties with respect to the accuracy or completeness of the contents of this documentand reserves the right to make changes to specifications and product descriptions at anytime without notice. Quest does not make any commitment to update the informationcontained in this document.

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

Quest Software World HeadquartersLEGAL Dept5 Polaris WayAliso Viejo, CA 92656

www.quest.comemail: [email protected]

Refer to our web site for regional and international office information.

Trademarks

Quest, Quest Software, the Quest Software logo, Benchmark Factory, Toad, T.O.A.D.,Toad World, and vToad are trademarks and registered trademarks of Quest Software, Incin the United States of America and other countries. For a complete list of QuestSoftware’s trademarks, please see http://www.quest.com/legal/trademark-information.aspx.Other trademarks and registered trademarks used in this guide are property of theirrespective owners.

Toad for MySQL 6.3Installation GuideFriday, March 23, 2012

http://www.quest.com/

http://www.quest.com/legal/trademark-information.aspx

http://www.quest.com/legal/trademark-information.aspx

Table of Contents

Installation 5

System Requirements 5

Client Requirements 5

Server Requirements 6

Virtualization Support 7

User Requirements 7

Install Toad 8

Specify Application Data Directory Location 8

Install Toad Silently 9

Determine Which Installer to Use 9

Silent Installation Prerequisites 10

Silent Installation Using the Executable 10

Silent Installation Using the Microsoft Installer 12

Install Toad on Citrix Systems 16

Upgrade Toad 17

Uninstall Toad 17

Register Toad 18

Create and Troubleshoot Connections 19

Understand Toad Connections 19

Share Database Connections 19

Create MySQL Connections 20

Troubleshoot MySQL Issues 21

Configure Version Control 22

About Version Control 22

Prerequisites 22

Configure TFS or VSS 23

Toad for MySQL Installation GuideTable of Contents

4

Configure CVS 29

Configure Subversion 36

Troubleshoot Version Control 43

Troubleshoot Upgrades 43

Troubleshoot Other Issues 44

Appendix: Contact Quest 46

Contact Quest Support 46

Toad Community 46

Contact Quest Software 46

About Quest Software 47

Index 48

Installation

System Requirements

Client Requirements

Before installing Toad, ensure that your client system meets the following minimum hardwareand software requirements:

Platform 1 GHz minimum

Memory 512 MB of RAM minimum, 1 GB recommendedNote: The memory required may vary based on the following:

l Applications that are running on your system when using Toad

l Size and complexity of the database

l Amount of database activity

l Number of concurrent users accessing the database

Hard DiskSpace

1.33 GB to install ToadMB to runNote: The disk space required may vary based on the edition of Toadselected for installation.

OperatingSystem

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

.NETFramework

Microsoft .NET Framework 3.5 (Service Pack 1)Note: The following conditions apply:

1

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

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

Toad for MySQL Installation GuideInstallation

6

l If you have the .NET Framework 4.0 installed, you must stillinstall the .NET Framework 3.5 (Service Pack 1).

l The .NET Framework Client Profile is not supported.

l To run Toad, the .NET security policy must be set tounrestricted. See "User Requirements and Restrictions forRunning Toad " for more information.

AdditionalRequirements

Web BrowserMicrosoft Internet Explorer 6.0 or later

Server Requirements

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

OperatingSystem Windows 2000 Service Pack 4 or later

Windows 2003Windows XP (32-bit or 64-bit)Windows Vista (32-bit or 64-bit)Windows Server 2000 Service Pack 4 or laterWindows 2000 Professional Edition Service Pack 4 or laterWindows XP (32-bit with Service Pack 2 or later and 64-bit)Windows Server 2003 (32-bit or 64-bit) Service Pack 1 or laterWindows Vista (32-bit or 64-bit)Windows Server 2008 (32-bit or 64-bit)Windows Server 2008 R2 (64-bit)Windows 7 (32-bit or 64-bit)

DatabaseServer

MySQL 4.1, 5.0, 5.1

CloudDatabaseService

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


7

Virtualization Support

ApplicationVirtualization

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

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

User Requirements

User Requirements to Install Toad

Only Windows Administrators and Power Users can install Toad.

If an Administrator installs Toad, the Administrator can share the Toad shortcut icon on thedesktop and menu items with any user—a Power User, Restricted User, Vista standard user—on the computer.

If a Power User installs Toad, a Restricted User cannot do the following:

l Associate file extensions.

l View the Toad shortcut icon on the desktop or the Toad menu options in theWindows Start menu. As a workaround, Restricted Users can create a shortcut to Toadfrom the install directory and place the shortcut on their desktop.

User Requirements and Restrictions for Running Toad

The following describes the requirements and restrictions for users who launch and run Toad:

l To run Toad, the .NET security policy must be set to Unrestricted. To modify thesecurity policy:

1. Select Control Panel from the Windows Start menu.

2. Double-click Administrative Tools.

3. Double-click Microsoft .NET Framework version 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 locateand select 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


8

delete it. All other users need only the ability to read the QuestSoftware.ToadSecuritytable to use Toad Security features.

Install ToadTo install Toad

1. Run the ToadInstaller.exe.

2. Complete the wizard.

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

Use the Registry setting method to change the application data directory from Roaming toLocal. Use the command switch method to change the location to any new path.

To change Toad Application Data directory location from Roaming to Local

In the Registry under Toad for MySQL (Computer\HKEY_CURRENT_USER\Software\QuestSoftware\Toad for MySQL\6.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 youmanually copy the settings files from the default location (Roaming directory) to the newlocation (Local directory). Copy the settings files BEFORE you add the Registry setting andBEFORE opening Toad.


9

OperatingSystem

Default Location New Location whenLOCALSETTINGS = 1

Windows XP C:\Documents andSettings\<user>\Application Data\QuestSoftware\Toad for MySQL 6.3

C:\Documents andSettings\<user>\Localsettings\Application Data\QuestSoftware\Toad for MySQL 6.3

Windows 7 C:\Users\<user>\AppData\Roaming\QuestSoftware\Toad for MySQL 6.3

C:\Users\<user>\AppData\Local\QuestSoftware\Toad for MySQL 6.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 thecommand switch:

Toad.exe --datadir="YourNewDirPath"

To instruct Toad to always use the new directory path, add the command switch and the newdirectory path to a Toad desktop shortcut. Then use the desktop shortcut when opening Toad.

1. To add the command switch, right-click the Toad shortcut and select Properties.

2. Enter the command switch and add the directory path in quotes (replace"YourNewDirPath" with your directory path).

Install Toad SilentlySilent installation provides a convenient method for deploying Toad to multiple machines.With some customization, you can also deploy the license key and settings at the same time.

Note:

Determine Which Installer to Use

Before performing a silent installation, review the following to determine whichinstaller to use:

Installer Advantages Disadvantages

Executable file(.exe)

Silent installation using the .exe filehas the following advantages:

l Verifies whether theprerequisite software isinstalled, and if not, redirectsyou to the downloadlocation.

Silent installation using the.exe file has the followingdisadvantages:

l Cannot deploycustom Toadsettings files orlicense keys.

l Installer


10

Installer Advantages Disadvantages

automatically exitsif the prerequisitesoftware is notinstalled.

MicrosoftInstaller file(.msi)

Supports deployment of Toadsettings files and license keys.

Silent installation using the.msi file has the followingdisadvantages:

l Requires manualverification anddownload of anyprerequisitesoftware.

l Requires a manualuninstall of theprevious version ofToad usingAdd/RemovePrograms.

Silent Installation Prerequisites

Before you perform a silent installation, you must install the following software on everycomputer where you are installing Toad:

l Microsoft .NET Framework 3.5 (Service Pack 1)

Silent Installation Using the Executable

Use the executable file to perform a silent install to the default directory (or to a differentdirectory) and to specify options such as logging installation messages.

To perform a silent install using the executable file

1. At a Windows command prompt, switch to the drive or directory where theexecutable for Toad is located. (This file can be downloaded from the Quest web siteor can be found on the Toad installation CD-ROM.)

2. For a standard installation with all features enabled, enter the following command:

“ToadInstaller.exe” /S

You can customize MSIEXEC command-line options and overrides for yourinstallation similar to the following command:

“ToadInstaller.exe” /S /Lx “C:\temp\installLog.txt”


11

INSTALLDIR=”Drive:\your_install_path” USERNAME=”some_user”COMPANYNAME=”your_company” ALLUSERS=1

Use the following descriptions to customize the command-line options and overridesfor your installation.

Command-Line Options

The following MSIEXEC command-line options are used in this example:

Option Description

/L “C:\temp\installLog.txt”

(Optional) Write installation messages to the specified log.You can append other options, such as x for debug (used inthe previous example) or v for a verbose log. See the logsection at http://msdn2.microsoft.com/en-us/library/aa367988.aspx for more information aboutadditional logging options.Also, substitute “C:\temp\installLog.txt” in the examplewith the fully qualified name of the log file. Enclose thisvalue in double quotations. The installation process createsthis file if it does not exist. Otherwise, the existing file isoverwritten.

Toad Default Installation Option Overrides

You can specify the following values to override Toad’s default installation options.Enclose each value in double quotations.

Option Description

INSTALLDIR (Optional) Specify the absolute path for the directory inwhich you want to install Toad. If you do not include thispath, the installation program defaults to: C:\ProgramFiles\Quest Software\Toad for MySQL 6.3.

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



12

Option Description

ALLUSERS (Optional) Specify one of the following:

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

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

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

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

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

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

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

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

Notes:

l All default installation option overrides are case-sensitive.

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

Silent Installation Using the Microsoft Installer

Create Transform (MST) Files

You can create a Microsoft transform (.mst) file that deploys the license key, custom settings,and connections for users when performing a silent install using the .msi file. You can alsouse the .msi file to perform a basic silent install using the default directory (or install to a


13

different directory) and to specify command-line options and default installation overrides.See "Perform Silent Installation Using MSI" (page 14) for more information if you are notcreating a transform file.

Note: (MSI installs on Windows Vista and 7) If you are using MSI to install Toad onWindows Vista or 7 with UAC enabled, you can install a file that adds a "Run asadministrator" option when right-clicking the MSIfile: http://www.symantec.com/connect/downloads/msi-run-administrator-context-menu-vista.

Note: The installer does not verify that system requirements have been met before installing.If you do not want to manually verify system requirements, you should use the .exe file forthe silent install.

The following procedure uses the Wise Installer to create the transform file.

To create a transform file that includes custom Toad settings

1. Save and install the ToadInstaller.msi file on a computer where the Wise for WindowsInstaller is installed. After customizing Toad settings, you will use the Wise Installerto create the transform file.

2. Open Notepad, and do the following:

a. Enter the license key in the first line.

b. Enter the site message in the second line. The file should look similar to thefollowing:

AAABBBBCCCCCCEDXDWLMV0WJ9-123-45678-B2

Quest Software

c. Save the file with license.key as the file name in the Toad install directory.Make sure the file extension is .key not .txt.

3. Launch Toad. The application should open without prompting you to enter alicense key.

4. Select Tools | Configuration Wizard from the Toad menu and complete theConfiguration wizard. This wizard creates an initial settings file (Settings.xml).

5. Select Tools | Options from the menu in Toad to open the Options window.

6. Select each page in the window and set any options you want to deploy. Theseoptions create a module settings folder and files.

7. Select View | Connection Manager from the menu in Toad to open theConnection Manager.

8. Create any connections you want to deploy.

9. Exit Toad. Upon exiting, a Connections file is created.

10. Create the Microsoft Transform file, using any appropriate tool. The following stepsdescribe how to use the Wise for Windows Installer to create the file.

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







14

a. Select File | New.

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

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

d. Save the project.

e. Select Files from the Feature Details view.

f. Locate the following files and click Add to add them to the project:

File to Add Location

Settings.xml This file is located in the following directory:C:\Documents and Settings\username\ApplicationData\Quest Software\ Toad for MySQL 6.3.

ModuleSettingsfolder and files

This folder and related files are located in thefollowing directory: C:\Documents andSettings\username\Application Data\Quest Software\Toad for MySQL 6.3\ModuleSettings.

Connections.xml This file is located in the following directory:C:\Documents and Settings\username\ApplicationData\Quest Software\Toad for MySQL 6.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 14) for moreinformation.

Perform Silent Installation Using MSI

To perform a silent install using msi

1. At a Windows command prompt, switch to the drive or directory where the msiinstaller for Toad is located.

2. For a standard installation with all features enabled, enter the following command:

msiexec /i “ToadInstaller.msi” /q

You can customize command-line options and overrides for your installation similarto the following:

msiexec /i “ToadInstaller.msi” INSTALLDIR= “Drive:\your_install_path” /q USERNAME=”someone” COMPANYNAME=”your_company” ALLUSERS=1


15

Command-Line Options

The following MSIEXEC command-line options are used in this example:

Option Description

/i Run the installation.

/q Specify the user interface (UI) that displays during installation.You can append other options, such as n to hide the UI or bto hide the Cancel button during the installation.

Note: All command-line options are case-insensitive. Seehttp://msdn2.microsoft.com/en-us/library/aa367988.aspx for a complete list ofcommand-line options.

Toad Default Installation Option Overrides

You can specify the following values to override Toad’s default installation options.Enclose each value in double quotations.

Option Description

INSTALLDIR (Optional) Specify the absolute path for the directory inwhich you want to install Toad. If you do not include thispath, the installation program defaults to: C:\ProgramFiles\Quest Software\Toad for MySQL 6.3.

ALLUSERS (Optional) Specify one of the following:

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

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

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

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

l If ALLUSERS is omitted or defined with theempty string value (""), only the user specified




16

Option Description

here (and the user that installed Toad) can see theToad shortcut on the desktop after the installationcompletes.

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

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

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

Notes:

l All default installation option overrides are case-sensitive.

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

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

Note: Limited testing has been performed for Citrix XenApp 5.0 support on WindowsServer 2003.

To install Toad on a Citrix system

1. Connect to the Citrix Environment as an administrator.

2. Copy Toad to the Citrix server, if needed.

3. Start the Toad installation process.

4. During installation, select the Anyone who uses this computer checkbox whenprompted.

5. Repeat steps 2 through 4 for each server in the Citrix farm.

Note: Although you must install Toad on every server in the Citrix farm, you onlyneed to publish Toad once.

6. Review the following considerations regarding licensing:

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


17

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

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

Upgrade ToadTo upgrade Toad

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

2. Select Uninstall Toad and continue with install.


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

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

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

l Any new files you create

l Any copies of files you make for backup purposes

l Settings files

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

To uninstall Toad

1. Run the ToadInstaller.exe.

2. Select Uninstall Toad for MySQL only.



18

Register ToadTo register Toad

1. Select Help | Licensing from the menu (ALT+H+L).

2. Review the following for additional information:

Authorizationkey

Enter the license key for Toad.

Site message Enter the site message included with the license key.

Create and Troubleshoot Connections

Understand Toad ConnectionsIn Toad, a connection represents one or more actual connections to the database. Toad createsan initial database connection for general usage. It also creates a separate database connectionfor each Editor (the first time you execute a statement) and a separate database connection foreach 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 theassociated window; however, the connections remain in an inactive state if a statement is notcurrently executing.

Tips:

l To view the number of actual database connections that exist for a Toad connectionand how many of those database connections are active, place the cursor over theconnection in the Connection Manager or the Connection toolbar.

l You can view the progress of statements executing in the background in a progressbar 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. It isrecommended to cancel only your own processes, as terminating Toad activities maylead to unexpected behavior.

Share Database Connections

Editors and Data tabs can share the same database connection when the connection isinactive 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 thisconnection first. For example; if you share a database connection, you can execute a queryin the Editor, execute another query in a new Editor, and then select the Data tab from thesame connection. If the connection is in use and you attempt to execute it, one of thefollowing occurs:

l If your database does not support executing multiple queries on a shared connection, adialog prompts you to either permanently associate the window with a new databaseconnection, cancel the previous operation, or add the query to a queue until thecurrent operation completes, and the execute it. If you place multiple queries in thequeue, 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 selectedwindow only.

Toad for MySQL Installation GuideCreate and Troubleshoot Connections

20

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

Note: This topic focuses on information that may be unfamiliar to you. It does not include allstep 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

Connectiontype

Select the protocol to use when connecting.

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

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

Connectiontimeout

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

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

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

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

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

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

UseMySQL

Select this checkbox to use an embedded MySQL libraryinstead of the MySQL .NET provider.

Toad for MySQL Installation GuideCreate and Troubleshoot Connections

21

libraries Note: If you select this option, you must specify libMySQL.dllin the path.

Category Select or create a category if you want to color code Editor tabsfor a specific connection. This can help differentiate betweendevelopment and production databases. You can also set anoption to color code the Object Explorer pane and object editorwindows (Create, Alter, Drop, etc.). Click here to view avideo of this feature.

4. Click Connect to save the connection and immediately connect to the database.

or

Click Save to save the connection without connecting to the database.

Tip: Connections are stored in the connections.xml file and can be found by clicking theApplication Data Directory link in Help | About.

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

Issue Cause/Solution

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

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

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

Solution:

1. Exit Toad.

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

3. Rename or delete the MySQL.xml file.

4. Restart Toad.

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

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

Configure Version Control

About Version ControlToad integrates with your existing version control system so you can maintain multiplerevisions of objects, SQL scripts, and files.

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

Prerequisites

You must install a supported version control client on the computer where Toad isinstalled. The following table lists the supported version control providers and the versionstested with Toad.

SupportedProvider

Server VersionTested

Client Version Tested

VisualSourceSafe(VSS)

VSS 6.0d VSS 6.0d See "Configure TFS or VSS" (page 23) for moreinformation.

ConcurrentVersionsSystem(CVS)

CVS 1.11.22 onSolarisCVSNT 2.5.03 onWindows

CVSNT 2.5.03See "Configure CVS " (page 29) for moreinformation.

Subversion Subversion 1.5.6on WindowsNote: Toad onlysupportsSubversion 1.5.6or later.

CollabNet Subversion Command-Line Client 1.5.6Notes:

l Toad only supports Subversion 1.5.6 orlater.

l Any Subversion client must have svn.exein its installation directory to use versioncontrol in Toad.

l Tortoise SVN is no longer supported inToad because it no longer includes svn.exein its installation directory.

See "Configure Subversion" (page 36) for moreinformation.

Toad for MySQL Installation GuideConfigure Version Control

23

SupportedProvider

Server VersionTested

Client Version Tested

TeamFoundationServer(TFS)

TFS 2005, 2008 Visual Studio (2005, 2008) Team Explorer ClientSee "Configure TFS or VSS" (page 23) for moreinformation.

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

Configure TFS or VSSYou can configure version control to work with SQL scripts in the Editor, or you canconfigure it to work with database objects and SQL scripts in the Object Explorer. See"Troubleshoot Version Control" (page 43) for more information.

Notes:

l If you want to place database objects under version control, you must configureversion control for objects using the Object Explorer. Once configured, you can alsomanage SQL scripts in the Object Explorer. The main advantage of managing scriptsin the Object Explorer is that you can easily share them with team members who haveversion control configured.

l If you do not want to manage version controlled scripts from the Object Explorer, youmust 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 Toadis installed. See "About Version Control" (page 22) for more information about testedversion control clients and supported versions.

2. Open an Editor window.

3. Right-click anywhere in the toolbar area and select Version Control to display theVersion Control toolbar.

Tip: You can also access version control functionality from the File | VersionControl menu when the Editor window has focus.

4. Click to open the Version Control wizard.



24

VersionControlSystem Page

Description

Type Select either Team Foundation Server or Visual SourceSafe.Note: If you select TFS, you must specify the workspace namefor the provider in the Team Foundation Server Propertieswindow that displays.

Properties (TFS only) Click this button (beside the Type field) and specifythe workspace name for the provider in the Team FoundationServer Properties window.

Server Select one of the following:

l For TFS, specify the server where your version controlprovider is installed and the port number (default is8080) to use in the following format:http://MyServer:Port

l For VSS, select the folder where the Source Safe client isinstalled and the srcsafe.ini file (for example:C:\SourceSafe\VSS\srcsafe.ini).

Username/Password

Enter login information for the version control provider andclick Login.Note: For TFS only, if you leave the user name and passwordfields blank, Toad uses your default Windows credentials.

VersionControlSettingsPage

Description

Versioncontrolfolder

Select the folder on the version control server where you want tocheck the scripts in.If you already have the Editor-managed scripts under versioncontrol, select the folder on the server where these scripts arelocated.Notes:

l Version control automatically checks out the scripts inthis folder and any subfolders to the location you specifyin the Working folder field.

l If you are managing SQL scripts from the Editor insteadof the Object Explorer, make sure the version controlfolder used for Editor-managed scripts is different fromthe one used for objects and scripts managed in theDatabase Explorer.


25

Workingfolder

Select the root repository folder on the client computer to use asthe default working folder for checking SQL scripts out.If you already have Editor-managed SQL scripts under versioncontrol, 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 script from the Historytab; and can also right-click a revision to send it to the Diff Viewer to comparedifferences.

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 whenchecking objects and scripts in or out, avoid checking scripts in automatically whenexecuting 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


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


ConfigurationType Page

Description

Configuration Select one of the following configuration types:

l Server—Applies the same settings for all databases ona server.

l Database—Applies custom settings for each databaseon a server. If selected, you must re-run the Version


26

Control wizard for each database you want to placeunder version control.Tip: You can add databases to version control at alater time by selecting the database under Tools |Options | Version Control | Objects.

Version ControlSystem Page

Description

Type Select either Team Foundation Server or Visual SourceSafe.Note: If you select TFS, you must specify the workspacename for the provider in the Team Foundation ServerProperties window that displays.

Server Select one of the following:

l For TFS, specify the server where your versioncontrol 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 Safeclient is installed and the srcsafe.ini file (for example:C:\SourceSafe\VSS\srcsafe.ini).

User name/Password

Enter login information for the version control provider andclick Login.Note: For TFS only, if you leave the user name andpassword fields blank,Toad uses your default Windowscredentials.

Version ControlSettings Page

Description


27

Versioncontrol folder

Select the folder on the version control server where youwant 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 scriptsare located.Notes:

l Version control automatically checks out objects orscripts in this folder and any subfolders to thelocation you specify in the Working folder field.

l If you are managing SQL scripts from the Editorinstead of the Object Explorer, make sure the versioncontrol folder used for Editor-managed scripts isdifferent from the one used for objects and scriptsmanaged in the Database Explorer.

Workingfolder

Select the folder to use as the default working folder.If you already have objects under version control, select theworking folder for these objects.

Create/Changefile nameformats

Specify the default format to use for objects. Objects arearchived as script files in the version control provider.To change the default order, delete the default format andclick + to select the order.

Use defaultmode

Clear this checkbox to override default folders for actions,such as create or alter scripts for each object (recommendedfor objects that are already under version control).

4. Complete the wizard and add objects to version control. Depending on the number ofobjects selected, this process may take time.

The following indicators display in the top-right corner of any object underversion 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 ObjectOptions page in Tools | Options | Version Control | Objects and select thecheckbox for that object.

5. Use the right-click menu to check files in/out, get the latest version, update the status,and other actions.


28

6. If you configured version control for database objects, you can also version controlSQL scripts using the Scripts tab (tab view or drop-down list mode) in the ObjectExplorer, as illustrated in the following example:

The following folders or nodes are available:

Server Scriptsfolder/node

Creates and manages SQL scripts that apply to all databases ona server.Note: This folder/node is only available if you configuredversion control at the server level.

Scriptsfolder/node

Creates and manages SQL scripts that apply to individualdatabases. If you are using the tree view, this displays beloweach database node, as illustrated in the following example:

Tips:

l You can use the Script tab in the Object Details pane to view revision informationabout each script and historical create/alter scripts (initially collapsed). You can alsoright-click a revision date to compare differences or update version control history.


29

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 theObject Explorer. The History folder/node is read-only, and you cannot perform anyactions on the objects using it. Also, the Object Details pane remains empty when theHistory folder/node is selected.

l You can modify current settings, including whether to require comments whenchecking objects and scripts in or out, adding or removing objects from versioncontrol, disable or delete a version control configuration, etc., from Tools | Options |Version Control | <options page>.

Configure CVSYou can configure version control to work with SQL scripts in the Editor, or you canconfigure it to work with database objects and SQL scripts in the Object Explorer. See"Troubleshoot Version Control" (page 43) for more information.

Notes:




30

To configure CVS to work with SQL scripts in the Editor








Description

Type Select CVS.

Properties Click this button (beside the Type field) and complete thefollowing in the Command Based Version Control Propertieswindow:

l BinaryPath—Enter the path where the CVS client isinstalled. For example, if you installed CVSNT, youwould enter:C:\Program Files\CVSNT

l BranchRevision—Leave this field blank if you areworking from the trunk in version control. If you areworking from a branch, enter the branch number or namein this field.Caution: Specifying HEAD for the BranchRevisionparameter can cause errors. Leave the parameter blankwhen working with the HEAD revision.

Server Select the existing working folder for the version controlrepository or specify the server string. For example, if you areconnecting using pserver, you should specify the server string asfollows::pserver:MyServer:Port:/MyWorkingRepository

Username/password

Enter your CVS command-line user name and password andclick Login.Note: The User name field is optional.


31

DefaultVersionControlSettingsPage

Description





Workingfolder


6. See "Add Scripts Using the Editor" in the online help for more information.

Tips:





32

To configure CVS to work with objects and SQL scripts in the Object Explorer





Description



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


Description

Type Select CVS.


l BinaryPath—Enter the path where the CVS client isinstalled. For example, if you installed CVSNT, youwould enter:C:\Program Files\CVSNT

l BranchRevision—Leave this field blank if you areworking from the trunk in version control. If you areworking from a branch, enter the branch number orname in this field.

Server Select the existing working folder for the version controlrepository or specify the server string. For example, if youare connecting using pserver, you should specify the serverstring as follows: :pserver:MyServer:Port:/MyWorkingRepository


33

User name/Password

Enter your CVS command-line user name and password andclick Login.Note: The User name field is optional.

Default VersionControl SettingsPage

Description





Workingfolder

Select the root repository folder on the client computer touse as the default working folder for checking objects andSQL scripts out.If you already have objects or SQL scripts under versioncontrol, select the existing working folder for these.



Use defaultmode


4. Complete the wizard and add objects to version control. Depending on the number ofobjects selected, this process may take time.


34






5. Right-click one or more objects in the Object Explorer to check them in/out, get thelatest version, update the status, and other actions.



35




Scriptsfolder/node


Tips:



36




Configure SubversionYou can configure version control to work with SQL scripts in the Editor, or you canconfigure it to work with database objects and SQL scripts in the Object Explorer. See"Troubleshoot Version Control" (page 43) for more information.

Notes:




37

To configure Subversion to work with SQL scripts in the Editor








Description

Type Select Subversion.


l BinaryPath—Enter the path where the Subversion clientthat contains svn.exe is installed. For example, if youinstalled the CollabNet Subversion Client, you wouldenter:C:\Program Files\CollabNet Subversion ClientNote: Do not include svn.exe in the path.

l BranchRevision—Leave this field blank if you areworking from the trunk in version control. If you areworking from a branch, enter the branch number or namein this field.Important: Specifying HEAD for the BranchRevisionparameter can cause errors. Leave the parameter blankwhen working with the HEAD revision.

Server Select the existing working folder for the version controlrepository or specify the server string (for example:svn://MyServer).


38

Username/Password

Enter your Subversion command-line user name and passwordand click Login.

DefaultVersionControlSettingsPage

Description





Workingfolder


6. See "Add Scripts Using the Editor" in the Toad help for more information.

Tips:




39


To configure Subversion to work with objects and SQL scripts in the Object Explorer





Description



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


Description

Type Select Subversion.Note: The version number beside Subversion is an internalfile definition used by Toad to check if an update for thisfile is available. It is not the actual version number for theversion control provider.


l BinaryPath—Enter the path where the Subversionclient that contains svn.exe is installed. For example,if you installed the CollabNet Subversion Client, youwould enter:C:\Program Files\CollabNet Subversion ClientNote: Do not include svn.exe in the path.


40

l BranchRevision—Leave this field blank if you areworking from the trunk in version control. If you areworking from a branch, enter the branch number orname in this field.

Server Select the existing working folder for the version controlrepository or specify the server string (for example:svn://MyServer).

User name/Password

Enter your Subversion command-line user name andpassword and click Login.

Default VersionControl SettingsPage

Description







Workingfolder

Select the root repository folder on the client computer touse as the default working folder for checking objects andSQL scripts out.If you already have objects or SQL scriptsunder version control, select the existing working folder forthese.

Use defaultmode


4. Complete the wizard and add objects to version control. Depending on the number of


41

objects selected, this process may take time.






5. Right-click one or more objects in the Object Explorer to check them in/out, get thelatest version, update the status, and other actions.



42




Scriptsfolder/node


Tips:



43




Troubleshoot Version Control

Troubleshoot Upgrades

For this release, the back-end of version control has been rewritten. If you previously usedversion control in Toad, the following may occur:

l If you migrate settings when upgrading Toad, you may have to reconfigure therepository setting in version control if a "Failed to open the settings for moduleVersionControl reverting to defaults" error displays. To reconfigure the repository,select Tools | Options | Version Control | Defaults and select the previous repositoryin 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 thanthe current method. After upgrading Toad, a message may display stating that objects


44

or files in version control are different than the local version. If your local version iscurrent, you should check the objects or files into version control.

Troubleshoot Other Issues

Review the following to help troubleshoot issues with version control:

VSS Issues Description

Languagesupport

VSS 6.0 uses ANSI strings. Consequently, the English-encoded VSSserver and client do not handle certain characters in other languages.This issue may also exist on previous or later VSS languageinstallations.

Caseinsensitive

VSS is not case-sensitive. Using version control on objects whosenames differ by case only can cause history and version-tracking issues.

CVS Issues Description

Systemcannotfind file

If a message stating that, “The system cannot find the file specified”displays, this usually means that the CVS executable cannot be foundin the path you specified in the BinaryPath field of the CommandBased Version Control Properties window. Verify that cvs.exe exists inthe directory you specified in this field

Commandexecution

When executing CVS commands, user input is not allowed. Thispresents an issue when the user is using CVS with the SSH method andmust enter a password to establish the Secure Shell.Workaround:Generate identity keys that automatically authenticate between theclient and the server when connecting with SSH.

SubversionIssues

Description

Systemcannotfind file

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

Commandexecution

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


45

ObjectIssues

Description

Addingmultipleobjects

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

Script Issues Description

Canceledcheck-in

SQL scripts remain checked out if a change was made to the text, butcheck-in was canceled during the prompt for a check-in comment. Thisbehavior is by design—that is; the user can either undo the checkout orcheck in the script using the right-click menu in the Scriptsnode/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; clickCancel to cancel the prompt.

Appendix: Contact Quest

Contact Quest SupportQuest Support is available to customers who have a trial version of a Quest product or whohave purchased a Quest product and have a valid maintenance contract. Quest Supportprovides unlimited 24x7 access to SupportLink, our self-service portal. Visit SupportLink athttp://support.quest.com.

From SupportLink, you can do the following:

l Retrieve thousands of solutions from our online Knowledgebase

l Download the latest releases and service packs

l Create, update and review Support cases

View the Global Support Guide for a detailed explanation of support programs, onlineservices, contact information, policies and procedures. The guide is available at:http://support.quest.com.

Toad Community

Get the latest product information, find helpful resources, and join a discussion with the Toadfor MySQL team and other community members. Join the Toad for MySQL community athttp://toadformysql.com/index.jspa.

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

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

Contact Quest Software

Email [email protected]

Mail

Quest Software, Inc.World Headquarters5 Polaris WayAliso Viejo, CA 92656 USA

Web site www.quest.com

See our web site for regional and international office information.

http://support.quest.com/

http://support.quest.com/

http://toadformysql.com/index.jspa

http://toadformysql.com/index.jspa


Toad for MySQL Installation GuideContact Quest Support

47

About Quest SoftwareQuest Software simplifies and reduces the cost of managing IT for more than 100,000customers worldwide. Our innovative solutions make solving the toughest IT managementproblems easier, enabling customers to save time and money across physical, virtual andcloud environments. For more information about Quest go to www.quest.com.


IndexA

application virtualization 7

C

Citrix

install 16

requirements 7

client requirements 5

connections

create MySQL 20

share for all session windows 19

understand 19

contact support 46

corporate deployment 9

CVS, configure 29

D

desktop virtualization 7

I

install 8

Citrix 16

Citrix support 7

client requirements 5

silent 9

L

license keys 18

M

mst file 12

MySQL

create connections 20

troubleshoot 21

R

requirements

Citrix 7

client 5

virtualization 7

S

server virtualization 7

silent install 9

create transform file 12

Microsoft installer (MSI) 12

prerequisites 10

SourceSafe, configure 23

Subversion, configure 36

system requirements 5

T

Team Foundation Server, configure 23

TFS, configure 23

transform file 12

troubleshoot

MySQL 21

version control 43

U

uninstall 17

V

Version Control 22

configure CVS 29

Toad for MySQL Installation GuideIndex

49

configure Subversion 36

configure TFS 23

configure VSS 23

troubleshoot 43

virtualization support 7

Visual SourceSafe, configure 23

VSS, configure 23

Date post:	14-Jul-2015
Category:	Education
Upload:	radha-krishna
View:	574 times
Download:	4 times

Toad for my sql 6.3 installation guide

Education