Toad for MySQL Installation Guidedev.toadformysql.com/installation_guide/Toad_InstallGuide.pdf ·...

Toad® for MySQL 8.0

Installation Guide

© 2017 Quest Software Inc.ALL RIGHTS RESERVED.

This guide contains proprietary information protected by copyright. The software described in this guide isfurnished under a software license or nondisclosure agreement. This software may be used or copied only inaccordance with the terms of the applicable agreement. No part of this guide may be reproduced or transmittedin any form or by any means, electronic or mechanical, including photocopying and recording for any purposeother 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 Software products. No license, expressor implied, by estoppel or otherwise, to any intellectual property right is granted by this document or inconnection with the sale of Quest Software products. EXCEPT AS SET FORTH IN THE TERMS ANDCONDITIONS AS SPECIFIED IN THE LICENSE AGREEMENT FOR THIS PRODUCT, QUEST SOFTWAREASSUMES NO LIABILITY WHATSOEVER AND DISCLAIMS ANY EXPRESS, IMPLIED OR STATUTORYWARRANTY RELATING TO ITS PRODUCTS INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTYOFMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT. IN NO EVENTSHALL QUEST SOFTWARE BE LIABLE FOR ANY DIRECT, INDIRECT, CONSEQUENTIAL, PUNITIVE,SPECIAL OR INCIDENTAL DAMAGES (INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OFPROFITS, BUSINESS INTERRUPTION OR LOSS OF INFORMATION) ARISING OUT OF THE USE ORINABILITY TO USE THIS DOCUMENT, EVEN IF QUEST SOFTWARE HAS BEEN ADVISED OF THEPOSSIBILITY OF SUCH DAMAGES. Quest Software makes no representations or warranties with respect to theaccuracy or completeness of the contents of this document and reserves the right to make changes tospecifications and product descriptions at any time without notice. Quest Software does not make anycommitment to update the information contained in this document.

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

Quest Software Inc.Attn: LEGAL Dept4 Polaris WayAliso Viejo, CA 92656

Refer to our web site (www.quest.com) for regional and international office information.

Patents

Quest Software is proud of our advanced technology. Patents and pending patents may apply to this product.For the most current information about applicable patents for this product, please visit our website atwww.quest.com/legal.

Trademarks

Quest, Quest Software, SQL Navigator, vWorkspace, Toad, and the Quest logo are trademarks of QuestSoftware Inc. in the U.S.A. and other countries. For a complete list of Quest Software trademarks, please visitour website at www.quest.com/legal. Microsoft, Windows, Windows Server, Windows Vista, Visual Studio,SharePoint, Access and Excel are either registered trademarks or trademarks of Microsoft Corporation in theUnited States and/or other countries. Oracle is a trademark or registered trademark of Oracle and/or its affiliatesin the United States and other countries. Citrix® and XenApp™ are trademarks of Citrix Systems, Inc. and/orone or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and inother countries. MySQL is a registered trademark of MySQL AB in the United States, the European Union andother countries. Subversion is a trademark of the Apache Software Foundation. All other trademarks,servicemarks, registered trademarks, and registered servicemarks are property of their respective owners.

Toad for MySQL 8.0Installation GuideFriday, April 14, 2017

http://www.quest.com/

http://www.quest.com/legal

https://www.quest.com/legal/

Contents

Contents 3

Installation 5System Requirements 5Client Requirements 5Server Requirements 6Virtualization Support 6User Requirements 7

Install Toad 8Specify Application Data Directory Location 8Install Toad Silently 9DetermineWhich Installer to Use 9Silent Installation Prerequisites 9Silent Installation Using the Executable 9Silent Installation Using theMicrosoft Installer 11

Install Toad on Citrix® Systems 13Upgrade Toad 14Upgrade Automation Scripts and Scheduling Tasks 14Upgrade Automation Scripts to Newer Version of Toad 14Migrate Scheduling Tasks to Newer Version of Toad 15

Uninstall Toad 16Licensing 16

Create and Troubleshoot Connections 17Understand Toad Connections 17ToadOpen Connections 17Sharing a Connection AmongWindows 17

CreateMySQLConnections 18Troubleshoot MySQL Issues 19

Configure Version Control 20About Version Control 20Prerequisites 20

Version Control for Toad Files 21Configure Version Control for Objects 23ManageObjects under Version Control 25Troubleshoot Version Control 27Troubleshoot Upgrades 27Troubleshoot Other Issues 27

Toad for MySQL 8.0 Installation GuideContents

3

About Us 29Wearemore than just a name 29Our brand, our vision. Together. 29Contact Quest 29Technical Support Resources 29

Index 31

Toad for MySQL 8.0 Installation GuideContents

4

Installation

System RequirementsReview the following client and database server requirements for Toad® for MySQL.

Client RequirementsBefore installing Toad, ensure that your client system meets the following minimum hardware and softwarerequirements:

Requirement Details

Platform 1 GHz minimum

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

l Applications that are running on your system when using Toad

l Size and complexity of the database

l Amount of database activity

l Number of concurrent users accessing the database

Hard Disk Space 800 MB to install Toad

Operating System Windows Server® 2008 R2 (64-bit)Windows® 7 (32-bit or 64-bit)Windows® 8 (32-bit and 64-bit)Windows® 8.1 (32-bit and 64-bit)Windows® 10Important: Toad uses the Microsoft® Distributed Transaction Coordinator (DTC) whenopening a SQL file to get Full-Text Search status, but DTC is disabled by default onWindows Vista, Windows Server 2008 and Windows 7. If you are using either operatingsystem, ensure that Network DTC access is enabled on the Toad client. Seehttp://technet.microsoft.com/en-us/library/cc753510(WS.10).aspx for more informationabout enabling DTC access.

1

Toad for MySQL 8.0 Installation GuideInstallation

5

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

Requirement Details

.NET Framework The Microsoft® .NET Framework is required. The version is dependent on theoperating system.

.NET 4.5.1 or later Windows 10

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

.NET 4.0 Windows XP, Windows Vista (SP1 or earlier), Windows Server2003Notes:

l This information is provided to aid installation. Toad isnot tested on Windows XP. Windows Vista (SP1 orearlier), and Windows Server 2003.

l The .NET Framework 4 Client Profile is not supported.

AdditionalRequirements

Web BrowserMicrosoft® Internet Explorer® 6.0 or laterScreenToad supports screen resolutions up to 3200 x 1800 and display DPI settings up to150%.

Server RequirementsBefore installing Toad, ensure that your server meets the following minimum hardware and softwarerequirements:

Requirement Details

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

Cloud DatabaseService

Toad can manage Amazon RDS and any other cloud or service offering compatiblewith MySQL, including Amazon Aurora.

Virtualization SupportRequirement Details

ApplicationVirtualization

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

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


6

User Requirements

User Requirements to Install ToadOnly 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 menuitems 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 aworkaround, Restricted Users can create a shortcut to Toad from the install directory and place theshortcut on their desktop.

User Requirements and Restrictions for Running ToadThe following describes the requirements and restrictions for users who launch and run Toad:

l To create or modify the QuestSoftware.ToadSecurity table to enable Toad Security, the user whomaintains this table must have privileges to create, insert, update, and delete it. All other users need onlythe ability to read the QuestSoftware.ToadSecurity table to use Toad Security features.


7

Install ToadTo install Toad

1. Run the ToadInstaller.exe.

2. Complete the wizard.

Specify Application Data DirectoryLocationToad for MySQL 8.0 stores settings files in the user's Application Data directory. The default location cannot bemodified from within the application. Toad provides two methods to change the default location: by using aRegistry setting or by using a command switch in a Toad shortcut.

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

To change Toad Application Data directory location from Roaming to Local

In the Registry under Toad for MySQL (Computer\HKEY_CURRENT_USER\Software\Quest Software\Toad forMySQL\8.0), add LOCALSETTINGS with a value of 1.

See the following table for default (Roaming) and resulting (Local) directory path.

Caution: All current Toad settings will be lost after applying this Registry setting unless you manually copythe settings files from the default location (Roaming directory) to the new location (Local directory). Copy thesettings files BEFORE you add the Registry setting and BEFORE opening Toad.

Operating System Default LocationNew Location whenLOCALSETTINGS = 1

Windows VistaWindows Server 2008Windows 7Windows 8

C:\Users\username\AppData\Roaming\QuestSoftware\Toad for MySQL 8.0

C:\Users\username\AppData\Local\Quest Software\ Toadfor MySQL 8.0

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

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

Toad.exe --datadir="YourNewDirPath"

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


8

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

Determine Which Installer to UseBefore performing a silent installation, review the following to determine which installer to use:

Installer Advantages Disadvantages

Executable file(.exe)

Silent installation using the .exe file hasthe following advantages:

l Verifies whether the prerequisitesoftware is installed, and if not,redirects you to the downloadlocation.

Silent installation using the .exe file hasthe following disadvantages:

l Cannot deploy custom Toadsettings files or license keys.

l Installer automatically exits if theprerequisite software is notinstalled.

Microsoft Installerfile (.msi)

Supports deployment of Toad settingsfiles and license keys.

Silent installation using the .msi file hasthe following disadvantages:

l Requires manual verification anddownload of any prerequisitesoftware.

l Requires a manual uninstall of theprevious version of Toad usingAdd/Remove Programs.

Silent Installation PrerequisitesBefore you can perform a silent installation, the following software must be installed on every computer whereyou are installing Toad:

l Microsoft .NET Framework 4.5

Silent Installation Using the ExecutableUse the executable file to perform a silent install to the default directory (or to a different directory) and to specifyoptions such as logging installation messages.

To perform a silent install using the executable file

1. At a Windows command prompt, switch to the drive or directory where the executable for Toad islocated. (This file can be downloaded from the Quest Software Web site or can be found on the Toadinstallation CD-ROM.)

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

“ToadInstaller.exe” /S

You can customize MSIEXEC command-line options and overrides for your installation similar to thefollowing command:

“ToadInstaller.exe” /S /Lx “C:\temp\installLog.txt” INSTALLDIR=”Drive:\your_


9

install_path” USERNAME=”some_user” COMPANYNAME=”your_company” ALLUSERS=1

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

Command-Line Options

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

Option Description

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

(Optional) Write installation messages to the specified log. You can appendother options, such as x for debug (used in the previous example) or v for averbose log. See the log section at http://msdn2.microsoft.com/en-us/library/aa367988.aspx for more information about additional loggingoptions.Also, substitute “C:\temp\installLog.txt” in the example with the fully qualifiedname of the log file. Enclose this value in double quotations. The installationprocess creates this 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 valuein double quotations.

Option Description

INSTALLDIR (Optional) Specify the absolute path for the directory in which you want to installToad. If you do not include this path, the installation program defaults to:C:\Program Files (x86)\Quest Software\Toad for MySQL8.0.

ALLUSERS (Optional) Specify one of the following:

l For a per-machine installation, specify 1. This value allows any user touse the Toad shortcut on the desktop after the installation completes.

l For a per-user installation, enter the empty string value (“”) This valueallows only the user specified for USERNAME (and the user that installedToad) to see the Toad shortcut on the target desktop. If USERNAME isomitted, only the user that installed Toad sees the shortcut.

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

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

l If ALLUSERS is omitted or defined with the empty string value (""), onlythe user specified here (and the user that installed Toad) can see theToad shortcut on the desktop after the installation completes.

l If ALLUSERS is omitted or defined with the empty string value ("") and youomit the USERNAME option, only the user that installed Toad sees theToad shortcut on the desktop.

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

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

Notes:l All default installation option overrides are case-sensitive.

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


10

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


Silent Installation Using the Microsoft Installer

Perform Silent Installation Using MSI

To perform a silent install using msi

1. At a Windows command prompt, switch to the drive or directory where the msi installer for Toadis located.

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

msiexec /i “ToadInstaller.msi” /q

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

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

Command-Line Options

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

Option Description

/i Run the installation.

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

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

Toad Default Installation Option Overrides

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

Option Description

INSTALLDIR (Optional) Specify the absolute path for the directory in which you want to installToad. If you do not include this path, the installation program defaults to:C:\Program Files (x86)\Quest Software\Toad for MySQL8.0.

ALLUSERS (Optional) Specify one of the following:

l For a per-machine installation, specify 1. This value allows any user touse the Toad shortcut on the desktop after the installation completes.

l For a per-user installation, enter the empty string value (“”) This valueallows only the user specified for USERNAME (and the user that installedToad) to see the Toad shortcut on the target desktop. If USERNAME isomitted, only the user that installed Toad sees the shortcut.

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

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

l If ALLUSERS is omitted or defined with the empty string value (""), onlythe user specified here (and the user that installed Toad) can see the


11



Option Description

Toad shortcut on the desktop after the installation completes.

l If ALLUSERS is omitted or defined with the empty string value ("") and youomit the USERNAME option, only the user that installed Toad sees theToad shortcut on the desktop.

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

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

Notes:l All default installation option overrides are case-sensitive.

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

Create Transform (MST) FilesYou can create a Microsoft transform (.mst) file that deploys the license key, custom settings, and connectionsfor users when performing a silent install using the .msi file. You can also use the .msi file to perform a basicsilent install using the default directory (or install to a different directory) and to specify command-line optionsand default installation overrides. See "Perform Silent Installation Using MSI" on page 11 for more information ifyou are not creating a transform file.

Note: (MSI installs on Windows Vista and 7) If you are using MSI to install Toad on Windows Vista or 7 with UACenabled, you can install a file that adds a "Run as administrator" 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 wantto manually verify system requirements, you should use the .exe file for the silent install.

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

To create a transform file that includes custom Toad settings

1. Save and install the ToadInstaller.msi file on a computer where the Wise for Windows Installer isinstalled. After customizing Toad settings, you will use the Wise Installer to create the transform file.

2. Open Notepad, and do the following:

a. Enter the license key in the first line.

b. Enter the site message in the second line.

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

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

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

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

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

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

8. Create any connections you want to deploy.

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

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


12

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

a. Select File | New.

b. Select Custom Templates under Categories, and then select the Transform template in the NewInstallation File window.

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

d. Save the project.

e. Select Files from the Feature Details view.

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

File to Add Windows Vista, Windows Server 2008, Windows 7, Windows 8

Settings.xml C:\Users\ username\AppData\Roaming\ Quest Software\Toad forMySQL 8.0.

ModuleSettings folder andfiles

C:\Users\username\AppData\Roaming\ Quest Software\Toad forMySQL 8.0\ModuleSettings.

Connections.xml C:\Users\username\AppData\Roaming\ Quest Software\Toad forMySQL 8.0.

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

11. Perform a silent install. See "Perform Silent Installation Using MSI" on page 11 for more information.

Install Toad on Citrix® SystemsToad must be installed on the Citrix server by the Citrix administrator. Users then connect to this instancethrough their Citrix login.

Note: Limited testing has been performed for Citrix XenApp™ 5.0 support on Windows Server® 2003 and forCitrix XenApp 6.5 on Windows Server 2008 R2.

To install Toad on a Citrix system

1. Connect to the Citrix Environment as an administrator.

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

3. Start the Toad installation process.

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

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

Note: Although you must install Toad on every server in the Citrix farm, you only need topublish Toad once.

6. Review the following considerations regarding licensing:

l A license supplied by an administrator always overrides a user-supplied license in a Citrixenvironment.

l If you need to provide the same Toad functionality to all users, you can enter the default licensekey for all users.

l If you have users with different license requirements (for example, some have Standard licensesand others have Professional licenses), individual licenses should be entered for each user. Youshould not enter the default license key because it enables all functionality in Toad.


13

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 your settings the first time youstart Toad. The settings files include database connections, layout customizations, shortcut keys, and optionscustomized in the Options pages.

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

Upgrade Automation Scripts andScheduling TasksIf you upgrade to a newer version of Toad, Automation scripts created in a previous version must be upgradedbefore you can open them in the newer version. Toad prompts you to automatically upgrade a script when youattempt to open it in a newer version.

In addition, scheduled scripts are scheduled to run using the version of Toad in which they were created. Afterupgrading Toad, those previously-created, scheduled scripts will not execute in the newer version until youmigrate each script's scheduling task. Toad prompts you to migrate scheduling tasks when you initially launchthe application after installation.

Upgrade Automation Scripts to Newer Version of ToadAn automation script is compatible with the version of Toad in which the script was created. If you want to openand/or modify a script using a newer version of Toad, you must upgrade the script. Toad automatically promptsyou to upgrade the script the first time you open it in the newer version.

To upgrade an Automation script

1. Open the script in Toad. Toad prompts you to upgrade the script.

2. To upgrade the script, select Yes.


14

Caution: An automation script is no longer compatible with previous versions of Toad afteran upgrade.

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

4. If you selected Yes, Toad upgrades your script and saves a backup copy of the original script in thefollowing location:

<application data directory>\Automation\bak\

5. If the script you upgraded is also scheduled, you must migrate the scheduling task, otherwise theupgraded script will fail to run.

Migrate Scheduling Tasks to Newer Version of ToadEach scheduled Automation script uses a Windows scheduling task. The scheduling task specifies whichversion of Toad to use by specifying the version's application path. Toad provides you with two easy ways tomigrate your scheduled scripts' scheduling tasks when you upgrade Toad. First, Toad prompts you to migratescheduling tasks upon initial launch of the application after installation. Next, you can migrate scheduling tasksat any time using the Job Manager.

Notes:

l If you upgrade a previously-created script by opening it in a newer version of Toad, you must alsomigrate the scheduling task to the newer version.

l If you install the newer version of Toad side-by-side with the older version, previously-created,scheduled scripts will continue to execute using the older version, until you migrate the scheduling tasks(provided that you do not open the scripts in the newer version).

To migrate scheduling tasks upon initial launch

1. After upgrading Toad, and upon initial launch of the application, the Migrate Scheduled Tasksdialog opens.

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

3. Click OK to close the dialog.

4. Toad immediately prompts you for your Windows password. Enter your password to migrate thescheduled tasks.

To migrate scheduling tasks using the Job Manager

1. Select Tools | Administer | Job Manager.

2. Click on the Job Manager toolbar.

3. Select the scheduled tasks to migrate and click OK.

Note: Only currently-scheduled tasks (enabled or disabled) are listed in the Migrate ScheduledTasks dialog.

4. Toad immediately prompts you for your Windows password. Enter your password to migrate thescheduled tasks.

Manually Edit Scheduling TasksOn occasion you may need to modify the application path in a Windows scheduling task. You can do this bymanually editing the scheduling task using the following procedure.


15

To manually edit a scheduling task

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

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

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

l Any new files you create

l Any copies of files you make for backup purposes

l Settings files

You can uninstall Toad for MySQL by using the Installer or by using the Windows Add/Remove Programs (orUninstall a program) feature. Using the Installer is the preferred way to uninstall Toad for MySQL.

To uninstall Toad

1. Run the ToadInstaller.exe.

2. Select Uninstall Toad for MySQL only.


LicensingTo enter your license key

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

2. Review the following for additional information:

Authorization key Enter the license key for Toad.

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

Note: Your license key determines the edition of Toad and will enable the functionality accordingly. Inmany cases, if functionality is disabled within Toad, you may not have an appropriate license to use it.When Toad is running, you can see which components are licensed by selecting Help | About. Forcomplete list of features shipped with your Toad edition see http://www.quest.com/.


16

http://www.quest.com/

Create and Troubleshoot Connections

Understand Toad ConnectionsReview this topic to learn about open database connections in Toad.

Toad Open ConnectionsIn Toad, an open connection in the Connection/Navigation Manager represents one or more actual connectionsto the database. When you open a database connection in Toad:

l Toad creates an initial database connection for general use.

l Toad also creates a separate database connection for each Editor (the first time you execute astatement) and for each Data tab in the Database Explorer (the first time you select the tab andquery data).

The connection associated with the window (or tab) remains open until you close the window. If awindow has an associated connection, but a statement is not currently executing, the connection is in aninactive state.

To view information for an open connection

l To view the number of actual database connections that exist for a Toad connection, including thenumber of active connections, place the cursor over the connection in the Connection/NavigationManager pane or in the connection drop-down list.

To use the Background Processes pane

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

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

Note: It is recommended that you cancel only your own processes, because terminating Toad activitiescould cause unexpected behavior.

Sharing a Connection Among WindowsYou can instruct Toad to share an open connection among windows. In this way, the Editor windows and Datatabs can share the same connection when the connection is inactive.

To share a database connection among windows in Toad

1. Select Tools | Options | Editor | General.

2. Clear the checkbox for the Use individual connection for each open editor option.

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

2

Toad for MySQL 8.0 Installation GuideCreate and Troubleshoot Connections

17

execution. For example, if you share a database connection, you can execute a query in the Editor,execute another query in a new Editor, and then select the Data tab from the same connection.

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

l If your database does not support executing multiple queries on a shared connection, a dialogprompts you to either permanently associate the window with a new database connection, cancelthe previous operation, or add the query to a queue until the current operation completes, andthe execute it. If you place multiple queries in the queue, each one executes in the order that itwas added to the queue.

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

Create MySQL ConnectionsYou can create a new connection, or connect to an existing connection from the Create New Connectionwindow. See "Troubleshoot MySQL Issues" on page 19 for more information about troubleshooting MySQLconnection issues.

To create a MySQL connection

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

2. SelectMySQL 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 is installed.

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

Connectiontimeout

Enter the number of seconds to wait when connecting before the applicationtimes out. The default is 15 seconds.

SSL If you selected SSL as the connection type, review the following for additionalinformation:

l Private key—browse to the location of the SSL key file to use whenconnecting.

l CA cert—browse to the location of the trusted certificate authority to usewhen connecting.

l Cert—browse to the location of the SSL certificate file to use whenconnecting.

Compress Select this checkbox to compress the value of any strings and return binaryvalues.

Use MySQLlibraries

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

Category Select or create a category if you want to color code Editor tabs for a specificconnection. This can help differentiate between development and production


18

Click here to view a video of this feature.

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

or

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

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

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

Issue Cause/Solution

"InvalidCastException" error whenconnecting to MYSQL 4.1.14-nt database

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

"System.IO.DirectoryNotFoundException"error occurs each timeyou attempt to connect after installingToad into a directory other than the defaultdirectory.

Solution:

1. Exit Toad.

2. Locate the MySQL.xml file in the C:\Documents andSettings\username\Local Settings\ ApplicationData\Quest Software\ Toad for MySQLversion\ModuleSettings

3. Rename or delete the MySQL.xml file.

4. Restart Toad.


19

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

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 multiple revisions of objects. See"Configure Version Control for Objects" on page 23 for more information on configuring version control in Toad.

For Version Control of your files handled by Toad see Version Control for Toad Files.

Important: See "Troubleshoot Version Control" on page 27 for more information about issues when upgradingversion control from a previous version.

Notes:

l If you want to place database objects under version control, you must configure version control forobjects using the Object Explorer. See "Manage Objects under Version Control" on page 25 for moreinformation.

l If you rename a version controlled object, Toad drops the original object and its history from versioncontrol and prompts you to add the renamed object to version control. This newly renamed object doesnot have any history associated with it.

PrerequisitesYou must install a supported version control client on the computer where Toad is installed. The following tablelists the supported version control providers and the versions tested with Toad.

SupportedProvider Server Version Tested Client Version Tested

ApacheSubversion™

Subversion 1.7.5 onWindows

CollabNet Subversion Command-Line Client 1.7.5Note: Any Subversion client must have svn.exe in its installationdirectory to use version control in Toad.

Git Toad works only with the local repository. For commands such as clone, pull and push usean external tool.

TeamFoundationServer (TFS)

TFS 2008, 2010, 2012,2013

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

File systembased

Toad allows to utilize practically any version control system using the external client tool. Inthis case Toad Version Control tool works with the directories at local HDD while you commitchanges to the repository with version control client tool.

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.

Details of Team Foundation Server support:

3

Toad for MySQL 8.0 Installation GuideConfigure Version Control

20

Visual Studio/Team Explorerversion

TFS 2013supportnotes



Visual Studio 2015 Supported(RTM orlatestupdate)

Supported(RTM orlatestupdate)


Visual Studio/Team Explorer2013




Visual Studio/Team Explorer2012

RequireslatestVisualStudio2012update.SupportsGit withVisualStudioTools forGitextension

Supported(RTM orlatestupdate).SupportsGit withVisualStudioTools forGitextension

Supported(RTM orlatestupdate).SupportsGit withVisualStudioTools forGitextension

Note: Additional functionality and compatibility with older clients is possible but out of scope of what we areable to test.

Version Control for Toad FilesToad can integrate with your existing version control system allowing you to maintain multiple versions of Toadfiles. After you integrate Toad with your version control system, you can perform version control tasks directlyfrom within Toad, such as commit file changes and retrieve revisions.

Toad supports the following version control systems for managing Toad files:

l Apache Subversion™—Toad has been tested with Subversion 1.7.5 and 1.8.

The following types of files can be managed using version control from within Toad: Editor (.tef, .sql, .txt), QueryBuilder (.tsm), ER Diagram (.ter), and Automation (.tas).

Toad supports version control for database objects, as well as files. Version control for objects is configuredseparately from version control for files. For more information about version control for objects, see ConfigureVersion Control for Objects.

To configure version control for Toad files

1. Ensure that an Apache Subversion client is installed on the same computer as Toad.

2. In Toad, open one of the supported file types. Then right-click the document window tab and select FileVersion Control | Version Control Wizard. This action opens the Version Control Wizard which allowsyou to configure Toad for your version control system.

Note: Even if you previously configured version control for objects, you must run the Version ControlWizard again to configure version control for files.


21

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

Field/Button

Version Control System Page

Type Select Subversion.

Properties Click the Properties button and enter the path to the Subversionexecutable (svn.exe) on the client computer. For example, if usingTortoiseSVN, the path might be:C:\Program Files\TortoiseSVN\bin

Note: Do not include svn.exe in the path.

Server Enter the URL for the Subversion repository on the Subversionserver.

Login and Password Enter the user name and password for your Subversion account.

Default Version ControlSettings Page

Version Control Folder Select the folder on the Subversion server where you want tocheck in files.If you currently have files under version control, select the folder onthe server where these files are located.

Working Folder Select a folder on the client computer to use as the root workingfolder. This is the location into which you will check out files.If you currently have files under version control, select yourexisting working folder.

To add a file to version control

1. After configuring version control for files, you can start adding files to version control from within Toad.Right-click a document window tab and select File Version Control | Add file to working folder.

2. Select a location in your working folder in which to save the file. Click Save.

3. In the Commit dialog, enter a comment and click OK to add the file to version control.

To browse the repository

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

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

Action Description

Open Open the file in Toad.

Commit Commit your changes. Available for Modified or Untracked files.

Undo Changes Discards your changes and reverts to the previous revision of the file(previous commit). Available when the file status is Modified.

Get Latest Version Check out the latest revision from the remote repository. Available whenthe file status is OutOfDate.

To commit your changes

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


22

To compare revisions (Editor files only)

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

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

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

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

3. For an OutOfDate file, right-click the latest revision in the History dialog and select Compare withworking copy to compare the remote file to your working copy.

To check file status

l The status of a currently open file displays in the status bar of the document window. You can also placethe cursor over the document tab to display status.

l You can check the status of one or more files by using the Repository Browser. To update file status inthe Repository Browser, right-click a folder and select Update folder.

l Review the following file status definitions.

File Status Definition

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

UpToDate The file in your working folder is synchronized with the file in the remoterepository. No changes are detected. No action is required.

Modified The working copy of this file was modified. The changes are stored in the workingfolder only. Commit this file to add the changes to the remote repository.

OutOfDate A more recent revision of this file exists in the remote repository. To update yourworking copy, check out the latest revision from the remote repository (right-clickthe file and selectGet Latest Version).

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

Deleted The file was under version control, but it was dropped or renamed in the workingfolder and exists only in the remote repository.

Additional Actions

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

Configure Version Control for ObjectsTo configure version control for files, see Version Control for Toad Files.

To configure version control for Objects

1. Ensure that a supported version control client is installed on the computer where Toad is installed. See"About Version Control" on page 20 for more information about tested version control clients andsupported versions.


23

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

Note: Version control is configured .


Version ControlSystem Page

Description

Type Select the version control system name:

l Apache Subversion™Note: The version number beside Subversion is an internal filedefinition used by Toad to check if an update for this file is available. Itis not the actual version number for the version control provider.

l Git

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

l File system based

Properties (Subversion only) Click this button (beside the Type field) and complete thebinary path. Enter the path where the Subversion client that contains svn.exeis installed. For example, if you installed the CollabNet Subversion Client,you would enter:C:\Program Files\CollabNet Subversion ClientNote: Do not include svn.exe in the path.

Server Select one of the following:

l Subversion—Specify the existing working folder for the versioncontrol repository or specify the server string (for example:svn://MyServer).

l TFS—Specify the server where your version control provider isinstalled and the port number (default is 8080) to use in the followingformat:

o http://MyServer:Port for TSF 2008

o http://MyServer:Port/TFS for TFS 2010, 2012

l File System Based—Specify a directory at your local machine.

Repository Settings Set your local Working Folder and your Version Control Folder will beautomatically filled.

User name/Password

Enter your Subversion command-line user name and password and clickLogin.Note: For TFS only, if you leave the user name and password fields blank,Toad uses your default Windows credentials.

Version ControlGeneral OptionsPage

Description

Prompt to Commit onClose

You will be asked to commit your changes before each version controlled fileis closed


24

Version ControlConfigurationsOptions Page

Description

Version controlfolder

Select the folder on the version control server where you want to checkobjects in.If you already have objects under version control, select the folder on theserver where these objects are located.Note: Version control automatically checks out objects in this folder and anysubfolders to the location you specify in theWorking folder field.

Working folder Select the root repository folder on the client computer to use as the defaultworking folder for checking objects out. If you already have objects underversion control, select the existing working folder for these.

4. Manage object and scripts using Version Control. See "Manage Objects under Version Control" on page25 for more information.

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

To add objects under version control

» Right-click an object and select Commit.

Tips:

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

l If you rename a version controlled object, Toad drops the original object and its history from versioncontrol and prompts you to add the renamed object to version control This newly renamed object doesnot have any history associated with it.

To manage objects under version control

1. Determine object's version control status. Hover a mouse over the object in the Object Explorer to see itsstatus. Review the following for additional information:

Version Control status Description

Uninitialized The object status is undetermined yet. This is a temporary status that isissued for all objects during version control status processing.

Untracked The object is not added to version control.

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

UpToDate The object is under version control and is synchronized with versioncontrol repository. No changes are detected.

Modified The object is under version control and has been modified by user.The changes are stored in local database only and need to besynchronized with version control repository.

Merge The object is under version control and has been modified in bothlocal database and version control repository.Note:: Toad's Version Control feature does not allow to merge objectscripts.


25

Version Control status Description

OutOfDate The object is under version control and has been modified in versioncontrol repository.

Unknown The object is under version control but for some reason its statuscannot be determined (for example, you created a script in your localdatabase while the script with the same name already exists in versioncontrol repository, or you upgraded to a higher version of Toad andconfigured version control for the same repository while you havesome uncommitted changes in the database).Tip: If you are sure that the object is up to date but is listed asunknown, commit the object in version control system to resolveunknown status.

Deleted The object was under version control, but it was dropped or renamedin local database and exists only in version control repository.Tip: You can see deleted objects in the Controlled objects pane only.To access it right-click any object and select Show perspective. Onceyou commit changes in Controlled objects pane, the object with allhistory will be deleted from version control repository.

NotInView The object is under version control and exists in version controlrepository only.

2. Right-click an object and select one of the following actions:

Use To...

Show perspective Select to review all controlled objects for current configuration.

Diff Select to review differences between the object script in your localdatabase and the object's revision that was applied to it.Note: Diff is unavailable for File System Based configuration.

Diff with latest revision Select to review differences between the object script in your localdatabase and the latest revision in the version control repository.

Example: You got the latest object revision from the repository 2 days ago. By the time you did it, thelatest revision was 5. Yesterday your colleague worked with the same object and committed changesin the repository, which are now marked as revision 6.Today you altered the object's script and want to see the differences. You can select one of thefollowing:

l Diff—To compare the object in your local database with revision 5.

l Diff with latest revision—To compare the object in your local database with revision 6.

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

Get latest revision Select to apply object's changes from the version control repository toyour local database. The synchronization script is generated to updateselected object to the latest revision.

Commit Select to apply object's changes from your local database to theversion control repository.Note: You should write a comment when committing changes.

Undo changes Select to rollback changes in your local database. The synchronizationscript is generated to revert object to the revision which was a applied


26

Use To...

last time.

Update status Select to compare a script in your local database with the script in therepository. New status will be issued according to the comparisonresults.

Add to ignore list Select to exclude object from the version control. Ignored objects arenot listed in Controlled Objects pane, Commit and Get latest revisionare disabled.

Remove from ignore list Select to set object status as Untracked and add it to version control.

Open in Windows Explorer Select to navigate to the file in the Windows Explorer.

Tip: You can enable, disable, or delete a version control configuration under Tools | Options | Version Control| Configurations.

Troubleshoot Version Control

Troubleshoot UpgradesFor this release, the back-end of version control has been rewritten. If you previously used version control inToad, the following may occur:

l Version control settings are not migrated from the previous version of Toad, so you have to reconfigureversion control in Toad.

l In previous releases, the method Toad used to generate the script was different than the current method.After upgrading Toad and reconfiguring version control, the local revision of the objects differs fromversion control repository (The objects have Unknown status). If the object in your database is current,you should commit it into version control.

Troubleshoot Other IssuesReview the following to help troubleshoot issues with version control:

ApacheSubversion™Issues

Description

Systemcannot findfile

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

Commandexecution

When executing Subversion commands, user input is not allowed. This presents an issuewhen the user is using Subversion with the SSH method and must enter a password toestablish the Secure Shell.Workaround:Generate identity keys that automatically authenticate between the client and the serverwhen connecting with SSH.


27

OutOfMemoryexceptionwhen addinga largenumber ofobjects

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

SVN ismissing in thelist ofavailableproviders

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

Object Issues Description

Addingmultipleobjects failed

When you add multiple objects to version control, the objects are grouped and added inbatches (for example, all the tables for a particular schema are added at once). If an error(for example, failure to support Korean characters) causes this command to fail, none ofthe objects are added.

Script Issues Description

Canceledcheck-in

SQL scripts remain checked out if a change was made to the text, but check-in wascanceled 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 inthe 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 thesource repository; click Cancel to cancel the prompt.


28

We are more than just a nameWe are on a quest to make your information technology work harder for you. That is why we build community-driven software solutions that help you spend less time on IT administration and more time on businessinnovation. We help you modernize your data center, get you to the cloud quicker and provide the expertise,security and accessibility you need to grow your data-driven business. Combined with Quest’s invitation to theglobal community to be a part of its innovation, and our firm commitment to ensuring customer satisfaction, wecontinue to deliver solutions that have a real impact on our customers today and leave a legacy we are proud of.We are challenging the status quo by transforming into a new software company. And as your partner, we worktirelessly to make sure your information technology is designed for you and by you. This is our mission, and weare in this together. Welcome to a new Quest. You are invited to Join the Innovation.

Our brand, our vision. Together.Our logo reflects our story: innovation, community and support. An important part of this story begins with theletter Q. It is a perfect circle, representing our commitment to technological precision and strength. The space inthe Q itself symbolizes our need to add the missing piece—you—to the community, to the new Quest.

Contact QuestFor sales or other inquiries, visit www.quest.com/company/contact-us.aspx or call 1-949-754-8000.

Technical Support ResourcesTechnical support is available to Quest customers with a valid maintenance contract and customers who havetrial versions. You can access the Quest Support Portal at https://support.quest.com.

The Support Portal provides self-help tools you can use to solve problems quickly and independently, 24 hoursa day, 365 days a year. The Support Portal enables you to:

l Submit and manage a Service Request

l View Knowledge Base articles

l Sign up for product notifications

l Download software and technical documentation

l View how-to-videos

l Engage in community discussions

l Chat with support engineers online

l View services to assist you with your product

About Us

Toad for MySQL 8.0 Installation GuideAbout Us

29

https://www.quest.com/company/contact-us.aspx

https://support.quest.com/

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

Get the latest product information and find helpful resources at the Toad for MySQL Community athttp://toadformysql.com/index.jspa.

Toad for MySQL 8.0 Installation GuideAbout Us

30

http://toadformysql.com/index.jspa

A

application virtualization 6

automation

migrate scheduled tasks 15

upgrade scripts 14

C

Citrix

install 13

requirements 6

client requirements 5

connections

create MariaDB 18

create MySQL 18

share for all session windows 17

understand 17

corporate deployment 9

D

desktop virtualization 6

I

install 8

Citrix 13

Citrix support 6

client requirements 5

silent 9

L

license keys 16

M

manage objects under Version Control 25

mst file 12

MySQL

create connections 18

troubleshoot 19

R

requirements

Citrix 6

client 5

virtualization 6

S

server virtualization 6

silent install 9

create transform file 12

prerequisites 9

Subversion, configure 23

system requirements 5

T

Team Foundation Server, configure 23

TFS, configure 23

transform file 12

troubleshoot

MySQL 19

version control 27

U

uninstall 16

V

Version Control

about 20

configure Subversion 23

configure TFS 23

File system based 23

Index

Toad for MySQL 8.0 Installation GuideIndex

31

manage objects 25

troubleshoot 27

virtualization support 6

Toad for MySQL 8.0 Installation GuideIndex

32

Date post:	14-Mar-2018
Category:	Documents
Upload:	truongliem
View:	240 times
Download:	2 times