+ All Categories
Home > Documents > Toad InstallGuide

Toad InstallGuide

Date post: 13-Apr-2015
Category:
Upload: serial3k
View: 101 times
Download: 0 times
Share this document with a friend
80
Toad ® for Data Analysts 2.6 Installation Guide
Transcript
Page 1: Toad InstallGuide

Toad® for Data Analysts 2.6

Installation Guide

Page 2: Toad InstallGuide

© 2010 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, LiteSpeed, Spotlight,SQL LiteSpeed, SQLab, Toad, T.O.A.D., Toad World, vOptimizer Pro, vSpotlight, and vToadare trademarks and registered trademarks of Quest Software, Inc in the United States ofAmerica and other countries. Other trademarks and registered trademarks used in this guideare property of their respective owners.

Toad for Data Analysts 2.6

Installation Guide

February 2010

Page 3: Toad InstallGuide

Table of Contents

Installation 1

System Requirements 1

Install Toad 6

Read-Only Installation 7

Install Toad Silently 8

Install Toad on Citrix Systems 15

Upgrade Toad 16

Register Toad 18

Uninstall Toad 18

Configuration 19

Configure Toad Layouts 19

Configure Connections 22

Troubleshoot Database Issues 48

Configure Version Control 64

Appendix: Contact Quest 74

Contact Quest Support 74

Contact Quest Software 74

About Quest Software 74

Index 75

Page 4: Toad InstallGuide

Installation

System Requirements

Client Requirements

Ensure that the client computer meets the following minimum requirements:

Component Requirement

Platform 1 GHz minimum

Hard DiskSpace

800 MB to install Toad

239 MB to run Toad

Memory 512 MB of RAM minimum, 1 GB recommended

Note: The memory required may vary based on the following:

l Applications that are running on your system when using Toad

l Size and complexity of the database

l Amount of database activity

l Number of concurrent users accessing the database

OperatingSystem

Windows Server 2003

Windows XP Professional (32-bit)

Windows Vista (32-bit or 64-bit)

Windows Server 2008 (32-bit or 64-bit)

Windows 7 (32-bit)

Important (SQL Server only): Toad uses the Microsoft DistributedTransaction Coordinator (DTC) when opening a SQL file to get Full-Text Search status, but DTC is disabled by default on Windows Vistaand Windows Server 2008. 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.

1

Page 5: Toad InstallGuide

Toad for Data Analysts Installation GuideInstallation

2

Component Requirement

.NETFramework

Microsoft .NET Framework 3.5 (Service Pack 1)

Note: The following conditions apply:

l The .NET Framework Client Profile is not supported.

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

AdditionalRequirements

Web Browser

Microsoft Internet Explorer 6.0 or later

Existing DB2 Client Support (DB2 native provider only)

Toad installs a DB2 9.7 client as part of the installation process. TheDB2 9.7 client can co-exist with an existing DB2 8 client; however, itis incompatible with a DB2 7 client. If a DB2 7 client is alreadyinstalled on the system, the Toad installation stops and cannotcomplete. You must first upgrade to the DB2 8 client. Then restart theToad installation to avoid losing functionality in some DB2 nativetools.

Oracle Client

Toad can connect to Oracle using Direct Connect (no need for anOracle Client) or can connect using an Oracle Client or Oracle InstantClient. However, if you want to use LDAP, you must install an OracleClient. See "Configure Connections" (page 22) for moreinformation.Toad supports 9i or later Oracle Clients and Oracle InstantClients. See "Create Oracle Connections" (page 22) for moreinformation about configuring an Oracle Instant Client to work withToad.

Server Requirements

Ensure that the server meets the following minimum requirements:

Component Requirement

OperatingSystem

Oracle Native Database Provider

l IBM AIX 5.1, 5.2, 5.3

l HP-UX 11i 1.5, 2 (32-bit or 64-bit)

l Red Hat Enterprise Linux AS release 3 and 4 (32-bit or 64-bit)

l Solaris 7, 8, 9, 10 (32-bit or 64-bit)

l SuSE 7, 8, 9

l Windows 2003 (32-bit or 64-bit)

l Windows XP

Page 6: Toad InstallGuide

Toad for Data Analysts Installation GuideInstallation

3

Component Requirement

SQL Server Native Database Provider

l Windows Server 2000 Service Pack 4 or later

l Windows 2000 Professional Edition Service Pack 4 or later

l Windows XP (32-bit with Service Pack 2 or later and 64-bit)

l Windows Server 2003 (32-bit or 64-bit) Service Pack 1 or later

l Windows Vista (32-bit or 64-bit)

l Windows Server 2008 (32-bit or 64-bit)

l Windows Server 2008 R2 (64-bit)

l Windows 7 (32-bit or 64-bit)

DB2 for z/OS Native Database Provider

l z/OS (V1R6 Base Services [5694-A01] or later)

DB2 for LUW Native Database Provider

l IBM AIX 5.1, 5.2, 5.3, 6.1

l HP-UX 11i 1.5, 2 (32-bit or 64-bit)

l Red Hat Enterprise Linux AS release 3 and 4 (32-bit or 64-bit)

l Solaris 7, 8, 9, 10 (32-bit or 64-bit)

l SuSE 7, 8, 9

l Windows 2000, 2003,(including 64-bit), 2008, XP, Vista,Windows 7

MySQL Native Database Provider

l Windows 2000 Service Pack 4 or later

l Windows 2003

l Windows XP (32-bit or 64-bit)

l Windows Vista (32-bit or 64-bit)

Page 7: Toad InstallGuide

Toad for Data Analysts Installation GuideInstallation

4

Component Requirement

NativeDatabaseSupport

Toad supports the following databases:

l Oracle 9i, 10g, 11g R2

l SQL Server 2000 (Service Pack 3 or later), 2005 (Service Pack2 or later), 2008

Note: SQL Server Compact Edition is not supported.

l IBM DB2 for LUW 8.1.5 or later, 9.1 or later

l IBM DB2 for z/OS 8 and 9

Notes:

l To run RUNSTATS and the native REORG utility ontablespaces and indexes in DB2 for LUW, Toadsupports DB2 for LUW 8.2.2 or later.

l At this time, Toad SQL Analysis for DB2 LUW doesnot support DB2 for LUW 9.7.

l Toad supports DB2 8 for z/OS running in Full Functionmode, but does not support DB2 8 for z/OS running inCompatibility mode.

l MySQL 5.1

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

l Sybase ASE 12.5, 15.0.2, 15.0.3 (limited testing)

l Access 2003, 2007

l Excel 2003, 2007

ODBCDatabaseSupport

Toad for Data Analysts supports almost all databases that you canconnect to using an ODBC 3.0 or later driver. For a list of databasesthat are not supported, see “Known Issues” in the release notes.

Toad for Data Analysts Quality Assurance has tested the followingdatabases using an ODBC 3.0 or later driver:

l DB2 for i5/OS V5R4 and IBM i 6.1 (limited testing)

l Informix Dynamic 10.00, 11.0 (limited testing)

l Ingres Community Edition 2006 R2 on Windows 32-bit(limited testing)

l Netezza Data Warehouse Appliance 4.6.6

l PostgreSQL 8.3.4

l Teradata V2R6.1 (limited testing)

Page 8: Toad InstallGuide

Toad for Data Analysts Installation GuideInstallation

5

Citrix Requirements

Limited testing has been performed for Citrix support on Windows Server 2003 EnterpriseServer (Service Pack 2) using the MetaFrame Presentation Server 5.0 and Citrix PresentationServer Clients 10.2. See "Install Toad on Citrix Systems" (page 15) for more information.

User Requirements

User Requirements to Install Toad

Only Windows Administrators and Power Users can install Toad.

Note: The following exceptions exist for Power Users:

l A Power User cannot install Toad on a computer running Windows Vista Enterprise.This is a Windows limitation because Vista does not support Power User mode.

l (DB2 only) A Power User cannot install Toad if a DB2 for LUW version earlier than8.1.7 already exists on the computer. Only an Administrator can install Toad underthis condition. However, if the computer has an existing DB2 for LUW 8.1.7 or laterinstallation, a Power User can install Toad as long as this user belongs to theDB2ADMNS or DBUSERS group.

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--onthe 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 (DB2 only) A Windows Power User or Restricted User must belong to theDB2ADMNS or DB2USERS group. To add the user to one of these groups, selectStart | Control Panel | Administrative Tools | Computer Management | SystemTools | Local Users and Groups | Groups | DB2ADMNS or DB2USERS.

l (DB2 only) A Windows Vista user must be either an administrator or a standard userthat belongs to an Vista Administrators group. Additionally, to enable fullfunctionality in Toad when Vista’s User Access Control security feature is turned on,the standard user must run Toad as an administrator. (Right-click the Toad icon on theVista desktop and select Run as administrator.) See the Toad for DB2 Release Notesfor a description of the restrictions that are in place when the standard user does notrun Toad as an administrator.

Page 9: Toad InstallGuide

Toad for Data Analysts Installation GuideInstallation

6

l (DB2 only) A Windows Power User or Restricted User does not have the authority toadd or remove DB2 catalog entries using the Toad Client Configuration wizard.However, these users can use the Import Profile function in the Toad ClientConfiguration wizard to import catalog entries to Toad.

l (DB2 only) As a minimum requirement to manage a DB2 for z/OS subsystem in Toad,the user ID defined in the Toad connection profile for the subsystem must either haveSYSADM privileges or SELECT privileges on the DB2 catalog tables.

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, anddelete it. All other users need only the ability to read the QuestSoftware.ToadSecuritytable to use Toad Security features.

Install Toad

Note: If you received Toad for Data Analysts with your purchase of Toad for Oracle, notethat by installing Toad for Data Analysts, you agree to use the software solely on the seat forwhich Toad for Oracle was purchased.

To install Toad

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

2. Complete the wizard.

Note: On the Read-Only Installation page, select whether to install Toad as a typicalinstall with all features enabled, or whether you want to install as read-only. In read-only mode, you cannot create, alter, or drop database objects.

Page 10: Toad InstallGuide

Toad for Data Analysts Installation GuideInstallation

7

Read-Only Installation

During installation, you can select an option to install Toad as a read-only application. Thislets you query data and view objects using Toad, but all actions that can impact the database(Create, Alter, Drop, Insert, Update, etc.,) are disabled or hidden. This ensures that you canuse Toad without worrying about committing a change to a sensitive production instance.The following image shows an example of differences between a typical and read-onlyinstallation:

To change an existing installation to read-only

» Reinstall Toad and select Read-only Install on the Install Type page.

Page 11: Toad InstallGuide

Toad for Data Analysts Installation GuideInstallation

8

Install Toad Silently

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

Determine Which Installer to Use

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

Installer Advantages Disadvantages

Executable file(.exe)

See "Install ToadSilently" (page8) for moreinformation.

Silent installation using an exe filehas the following advantages:

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

l Verifies whether a version ofToad already exists on thetarget computer. If so, theexecutable uninstalls theprevious version and theninstalls the current version.

Silent installation using anexe file has the followingdisadvantages:

l Cannot deploycustom Toadsettings files orlicense keys.

l Installerautomatically exitsif the prerequisitesoftware is notinstalled.

MicrosoftInstaller file(.msi)

See "Install ToadSilently" (page8) for moreinformation.

Supports deployment of Toadsettings files and license keys.

Silent installation using anmsi file has the followingdisadvantages:

l Requires manualverification anddownload of anyprerequisitesoftware.

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

Page 12: Toad InstallGuide

Toad for Data Analysts Installation GuideInstallation

9

Silent Installation Prerequisites

Before you perform a silent installation, the following software must be installed on everycomputer on which you are installing Toad:

l Microsoft .NET Framework 3.5 (Service Pack 1)

l (DB2 native provider only) Toad installs a DB2 9.7 client as part of the installationprocess. The DB2 9.7 client can co-exist with an existing DB2 8 client; however, it isincompatible with a DB2 7 client. If a DB2 7 client is already installed on the system,the Toad installation stops and cannot complete. You must first upgrade to the DB2 8client. Then restart the Toad installation to avoid losing functionality in some DB2native tools.

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

For a read-only installation with create, alter, and drop functionality disabled, enterthe following command:

“ToadInstaller.exe” /S READONLY=TRUE

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

“ToadInstaller.exe” /S /Lx “C:\temp\installLog.txt”INSTALLDIR=”Drive:\your_install_path” USERNAME=”some_user”COMPANYNAME=”your_company” ApplicationUsers=”AllUsers”

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

Page 13: Toad InstallGuide

Toad for Data Analysts Installation GuideInstallation

10

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 Data Analysts 2.5.

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

l If “OnlyCurrentUser” is defined for theApplicationUsers value (see description thatfollows), only the user specified here (and the userthat installed Toad) can see the Toad shortcut onthe desktop after the installation completes.

l If “OnlyCurrentUser” is defined but USERNAMEis not included in the installation, only the userthat installed Toad sees the Toad shortcut on thedesktop.

l If “AllUsers” is defined for ApplicationUsers, theUSERNAME value is ignored during installation.

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

Page 14: Toad InstallGuide

Toad for Data Analysts Installation GuideInstallation

11

Option Description

ApplicationUsers (Optional) Specify one of the following values:

l “AllUsers” allows any user to see the Toadshortcut on the desktop after installationcompletes.

l “OnlyCurrentUser” allows only the user specifiedfor USERNAME and the user that installed Toadto see the Toad shortcut on the target desktop. IfUSERNAME is not included in the installation,only the user that installed Toad sees the shortcut.

Note: If you do not specify a value, the installationprogram defaults to “AllUsers”.

Note: All default installation option overrides are case-sensitive.

Silent Installation Using the Microsoft Installer

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 can install to adifferent directory and specify command-line options and default installation overrides. See"Perform Silent Installation Using MSI" (page 13) for more information if you are not creatinga transform file.

Note: Review the following information about the msi installer:

l The .msi file is located on the Toad installation CD or is available as a downloadfrom SupportLink at https://support.quest.com/SUPPORT/index?page=home.

l 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 .exefile for the silent install.

Create Transform Files

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.

Page 15: Toad InstallGuide

Toad for Data Analysts Installation GuideInstallation

12

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. Use the Wise for Windows Installer to create the Microsoft Transform file:

a. Select File | New.

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

c. Select the ToadInstaller.msi file in the Select the .MSI file to base 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 Data Analysts 2.5.

Page 16: Toad InstallGuide

Toad for Data Analysts Installation GuideInstallation

13

File to Add Location

ModuleSettingsfolder and files

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

Connections.xml This file is located in the following directory:C:\Documents and Settings\username\ApplicationData\Quest Software\Toad for Data Analysts 2.5.

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 13) 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. This file is located on the Toad installation CD or isavailable as a download from SupportLink athttps://support.quest.com/SUPPORT/index?page=home.

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

msiexec /i “ToadInstaller.msi” /q

For a read-only installation with create, alter, and drop functionality disabled, enterthe following command:

msiexec /i “ToadInstaller.msi” /q READONLY=TRUE

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”ApplicationUsers=”AllUsers”

Page 17: Toad InstallGuide

Toad for Data Analysts Installation GuideInstallation

14

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 Data Analysts 2.5.

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

l If “OnlyCurrentUser” is defined for theApplicationUsers value (see description thatfollows), only the user specified here (and the userthat installed Toad) can see the Toad shortcut onthe desktop after the installation completes.

l If “OnlyCurrentUser” is defined but USERNAMEis not included in the installation, only the userthat installed Toad sees the Toad shortcut on thedesktop.

l If “AllUsers” is defined for ApplicationUsers, theUSERNAME value is ignored during installation.

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

Page 18: Toad InstallGuide

Toad for Data Analysts Installation GuideInstallation

15

Option Description

ApplicationUsers (Optional) Specify one of the following values:

l “AllUsers” allows any user to see the Toadshortcut on the desktop after installationcompletes.

l “OnlyCurrentUser” allows only the user specifiedfor USERNAME and the user that installed Toadto see the Toad shortcut on the target desktop. IfUSERNAME is not included in the installation,only the user that installed Toad sees the shortcut.

Note: If you do not specify a value, the installationprogram defaults to “AllUsers”.

Note: All default installation option overrides are case-sensitive.

Install Toad on Citrix Systems

To install Toad on a Citrix system

1. Connect to the Citrix Environment as an administrator.

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

3. Install Toad.

4. During installation, select the Anyone who uses this computer checkbox 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.

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

Page 19: Toad InstallGuide

Toad for Data Analysts Installation GuideInstallation

16

Upgrade Toad

To upgrade Toad

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

2. Select Uninstall Toad and continue with install.

3. Complete the wizard.

If you are upgrading from a previous version of Toad, you are prompted to migrateyour settings the first time you start Toad. The settings files include databaseconnections, layout customizations, shortcut keys, and options customized in theOptions pages.

Files Migrated During Upgrades

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

File Description

Action.log Tracks your usage within Toad. If you agree to share thisdata, the file is automatically sent to Quest on a periodicbasis.

Connections.xml Contains all connections stored in the Navigation Manageror the New Connection window.

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

ExceptionTrace.log Contains a log of all exceptions encountered whilerunning Toad.

FTPConnection.log Contains a log of exceptions encountered when attemptingto connect to FTP servers.

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

Settings.xml Contains many of the global configuration settings.

SqlServerPlanPrefs.xml Used to generate SQL Server execution plans.

ToadSupportBundle.zip Contains the last support bundle you generated.

Folder Description

Page 20: Toad InstallGuide

Toad for Data Analysts Installation GuideInstallation

17

Automation (temporaryfolder)

Used by automation when executing automation scripts.

Cache Used to spool cache database metadata to disk if enabled.The data is in binary format and can always be recreatedby fetching it from the database.

CNSScripter (temporaryfolder)

Used by Compare plug-ins, script generation for Alterobject windows, and the Script tab in the Object Explorer.

Context Contains settings that depend on the context within Toadincluding the following:

l Adapter—Custom data editing statements.

l Filter—Unnamed filters defined in the ObjectExplorer or Database Explorer.

l Named Filter—Named filters defined in the ObjectExplorer or Database Explorer.

l TYPE—Tabs that display on the right when youselect an object in the Object Explorer or DatabaseExplorer.

Keyboard Contains custom keyboard shortcut layouts.

Layouts Contains layouts for some areas in Toad, such as toolwindows that automatically display in the Editor andcolumn layouts for the Messages tab.

ModuleSettings Contains general settings for various components in Toad,such as whether the data grid defaults to read-only,displays not null indicators, etc.

Plugins Used by Toad plugin components.

Session Contains desktop configurations, including toolbarcustomizations and tool window locations.

SQLFormatter Contains pre-set and user created templates for formattingSQL, and the SQL statement used to preview formattingchanges in the Formatting Options page.

SQLRecall Contains the SQL statements saved by SQL Recall.

Templates Contains the following templates:

l Code Templates—Templates used to define defaultvalues when creating new objects in the ObjectExplorer or Database Browser.

l Scripts—Startup scripts to run when connecting.

l Snippets—Code Snippet entries.

Page 21: Toad InstallGuide

Toad for Data Analysts Installation GuideInstallation

18

Register Toad

You should register Toadto ensure that all the features you purchased are available.

Note: Consider the following:

l If you have an existing Toad for Oracle license key, you can enter it in this windowto enable Toad for Data Analysts.

l If you received Toad for Data Analysts with your purchase of Toad for Oracle, notethat by installing Toad for Data Analysts you agree to use the software solely on theseat for which Toad for Oracle was purchased.

To register Toad

1. Select Help | Licensing from the menu.

2. Use the information provided by sales or support to complete the fields.

Uninstall Toad

If you uninstall Toad, it may not uninstall completely. When you use Toad, you create newfiles such as SQL scripts, data output, or temp files. 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

To uninstall Toad

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

2. Select Uninstall Toad only.

3. Complete the wizard.

Page 22: Toad InstallGuide

Configuration

Configure Toad Layouts

Use the Configuration wizard to customize the look and feel of Toad to match Toad forOracle, SQL Navigator, or your native database tools. In addition, you can specify thewindows that display on startup or group functionality.

Note: This topic focuses on information that may be unfamiliar to you. It does not include allstep and field descriptions.

To configure Toad layouts

1. Click the arrow beside in the Standard toolbar and select Configuration Wizard(ALT+T+F).

2. Review the following for additional information:

Use thispage...

To....

Layout andSettings

Set one of the following:

l Toad for Data Analysts—Applies shortcut keys used byToad for Data Analysts, opens default windows, and addsa Document Grouping and Wizard toolbar.

l Toad for Oracle—Applies shortcut keys used by Toad forOracle and automatically opens the Project Manager,Editor, SQL Recall, and Output windows.

l MS Query Analyzer—Applies shortcut keys used byQuery Analyzer and automatically opens the ObjectExplorer, Code Snippets, and Editor windows.

l MS Management Studio—Applies shortcut keys used byManagement Studio and automatically opens theConnection Manager and Editor windows.

l SQL Navigator—Applies shortcut keys used by SQLNavigator and automatically opens the NavigationManager, Object Explorer, Editor, and Code Snippetswindows.

l Toad for SQL Server, DB2, MySQL—Applies shortcutkeys used by Toad for SQL Server, DB2, and MySQL;and automatically opens the Connection Manager, Object

2

Page 23: Toad InstallGuide

Toad for Data Analysts Installation GuideConfiguration

20

Use thispage...

To....

Explorer, Editor, and Code Snippets windows.

l Custom—Applies shortcut keys used by Toad for DataAnalysts, and lets you specify layout settings on theremaining pages.

Note: You can set or modify individual keyboard shortcuts inKeyboard Options in the Toad help.

Look andFeel

Set one of the following:

l Skin—Applies the skin style you select to documentwindows, tool windows, and modal dialogs.

l Grid style—Applies the grid style you select to the datagrid only.

When selecting an option, the current wizard page, including thesample data grid provides a preview of the change.

DatabaseExplorerStyle

Specify how objects display in the Object Explorer window.

QuickGuide

Display a Quick Start Guide that lets you quickly launchfrequently used features and tutorials until you are more familiarwith the application.

Tips:

l To view this window at anytime, select View | QuickGuide from the menu.

l To hide this window when starting Toad, select the Donot show on start up checkbox at the bottom of theQuick Guide window.

GroupDocuments

Specify the following options:

l Use document groups—Displays a Grouping toolbar thatcategorizes features into logical workgroups.

l Hide windows per group—Displays only those windowsthat are associated with the selected group. For example,if the Query group is selected and a Query Builderwindow is open, it will be hidden when you select theReport group.

Note: Unless the Hide windows per connection checkboxis selected, any connections that have a window open forthis group display.

Page 24: Toad InstallGuide

Toad for Data Analysts Installation GuideConfiguration

21

Use thispage...

To....

l Hide windows per connection—Displays only thosewindows for the current connection that are associatedwith the selected group.

Tip: To hide the Grouping toolbar, select Tools | Customizefrom the menu, and then clear the Grouping checkbox in theToolbar tab of the Customize window.

GroupDocumentDefaults

Select a default window to open for each connection when aselecting a group from the Grouping toolbar:

Understand

l ER Diagram—Easily identify relationships between tablesvia foreign keys.

l Database Explorer—Drill-down to details for each object.

Query

l Query Builder—Quickly create complex queries andsubqueries using a graphical interface.

l SQL Editor—Powerful editor for writing SQL queries andscripts.

Report

l Excel—Automatically export query results and open themin Excel.

l Toad Report—Send query results to the Toad Data Reportwizard.

Wizard Bar Display a list of frequently used actions for the current groupwindow in a toolbar at the bottom of the window.

AdditionalSettings

Specify whether to automatically add files to the ProjectManager when saving, executing, or sending the files to a report.This option can help you locate and manage your work.

Page 25: Toad InstallGuide

Toad for Data Analysts Installation GuideConfiguration

22

Configure Connections

Configure Oracle LDAP Support

You can create Oracle Lightweight Directory Access Protocol (LDAP) connections whenyour Oracle client is configured for LDAP. Once the client is configured, Toad retrievesnames from your LDAP server and displays them in the Database Name list in the CreateNew Connection window.

Notes:

l  To connect using LDAP, you must install an Oracle client on the computer.

l Toad supports a 9i, 10g, and 11 client and the Oracle Instant client. If you want to usethe instant client, you must configure it to work with Toad. See "Configure the OracleInstant Client" (page 23) for more information.

To configure the Oracle client for LDAP

1. Obtain the LDAP.ORA file from your database administrator.

2. Copy the LDAP.ORA file to the folder where the SQLNET.ORA file for your Oracleclient is located. The default folder is: ORACLE_HOME\network\admin

3. Open the SQLNET.ORA file and enter "(LDAP)" as the value for theNAMES.DIRECTORY_PATH as follows:

NAMES.DIRECTORY_PATH= (LDAP)

Note: If you are using multiple naming methods, add the (LDAP) value to existingparameter values. For example, if you are using both the TNSNAMES and LDAPnaming methods, add LDAP to TNSNAMES as follows:

NAMES.DIRECTORY_PATH= (TNSNAMES, LDAP)

4. Save the SQLNET.ORA file.

5. Launch Toad and select File | New | Connection.

6. Create an LDAP connection following the procedure in Create OracleConnections (page 22). In step 3, select a database on the LDAP server from theDatabase Name list.

Create Oracle Connections

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

You can connect to your database using a native Oracle database provider in Toad using oneof the following methods:

Page 26: Toad InstallGuide

Toad for Data Analysts Installation GuideConfiguration

23

Connection Method Advantages Disadvantages

Client connection (Clienttab)—Uses an installedOracle Client or OracleInstant Client to establisha connection to thedatabase from Toad.

l Supports LDAP (See"ConfigureConnections" (page22) for moreinformation aboutconfiguring theOracle client to useLDAP.)

l Requires an Oracleclient

Note: Toad supportsOracle clients andOracle Instantclients using version9i or later.

Direct connection (DirectConnect tab)—UsesTCP/IP to connectdirectly to the database.

l Does not require anOracle Client to beinstalled

l Recommended forconnecting toOracle 8i databases

l Only supportscommon data types.Some advancedOracle object typescannot be retrievedwhen connectingusing this method.

l Does not supportLDAP (To connectusing LDAP, usethe ClientConnection methodinstead.)

Note: Quest recommends using one of the methods described in this table to connect toOracle rather than an ODBC driver. Because ODBC connectivity is generic, it is not full-featured and may not be as robust as the fully exploited native database provider.

Configure the Oracle Instant Client

The Oracle Instant client installs only those files needed to connect to your database usingOCI. Because this client does not write to the registry (no ORACLE_HOMES) or add to theenvironmental path, you must manually set environment variables so the client can be usedwith Toad.

To configure the Oracle Instant Client to work with Toad

1. Save the Oracle Instant Client files in any location on the computer where Toad isinstalled.

2. On your Windows desktop, right-click My Computer and select Properties.

3. Select the Advanced tab and click Environment Variables.

4. Click New under System Variables and complete the following:

Page 27: Toad InstallGuide

Toad for Data Analysts Installation GuideConfiguration

24

Variablename

Variable Value

PATH <Path where Instant Client is installed>;%PATH%

For Example: C:\Program Files\OracleInstantClient;%PATH%

TNS_ADMIN

<Path where tnsnames.ora file is installed>

Create an Oracle Connection

To create an Oracle connection

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

2. Select Oracle from the Group list box.

3. Review the following for additional information:

Login Tab Description

Databasename

Select the alias to use when connecting. This list displaysaliases from LDAP as well as any local tnsnames.ora file.

Note: If you do not select a database, Toad uses the ORACLE_SID for the selected home. If an ORACLE_SID value does notexist and you do not specify a database, you cannot connect.

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

Connect as Select whether to connect as either SYSDBA or SYSOPER ifyou have the appropriate permissions. Otherwise, use thedefault.

Schema Select a schema if you frequently work in a different schemathan the one associated with your user name.

Explainplan table

(Optional) Specify the location of an existing explain plan tableto use instead of Toad automatically creating one for you whenyou execute a statement. This is useful if you do not havenecessary permissions to create explain plan tables or want touse an existing table.

Page 28: Toad InstallGuide

Toad for Data Analysts Installation GuideConfiguration

25

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

Savepassword

Select this checkbox if you plan to use Automation to generatereports.

OracleClient Tab

Description

Currenthome

Modify the Oracle home to use, if needed.

TNSNamesEditor

Click this button to edit your local TNSNames file.

Tip: You can press CTRL+F to open the Find/Replace windowto locate entries in the TNS Names Editor. Pressing F3 locatesthe next entry that matches your criteria.

SQLNETEditor

Click this button to edit SQLNET.ORA parameters. Beforeediting this file, you should create a backup copy. SeeSQLNET.ORA Profile Parameters in the Oracle documentationfor more information.

Direct Tab Description

SID Enter the ORACLE_SID value for the database. This value isspecified in the registry under each installed home.

Name Edit the nickname you want to display in the Connectiontoolbar, status bar, and document windows, if needed. If thisfield is blank, the name defaults to:

database (username), schema

AdvancedTab

Description

ODBCdriver

Select an ODBC driver to use when creating heterogeneousqueries in the Query Builder for this connection. Toaduses theMicrosoft Access ODBC driver for heterogeneous queries bydefault.

Tip: You can specify the ODBC driver to use for allconnections for this database provider in Tools | Options | Database | Oracle.

Page 29: Toad InstallGuide

Toad for Data Analysts Installation GuideConfiguration

26

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.

Configure DB2 LDAP Support

You can create DB2 Lightweight Directory Access Protocol (LDAP) connections when theDB2 client installed with Toad is configured for LDAP. Configuring the client consists ofenabling LDAP support and specifying the host name and port number of the LDAP server.Once the client is configured, Toad retrieves names from your LDAP server and displaysthem in the Database Alias list in the Connections window.

Notes:

l You must configure LDAP support for the DB2 client installed with Toadregardless of whether an existing DB2 client on the computer is already configuredto support LDAP.

l Currently, Toad for DB2 supports only the access of DB2 LDAP catalog entries. Toaddoes not support the management of these entries.

To configure the DB2 client for LDAP

1. Open the Command Window for the DB2 client installed with Toad by selectingStart | All Programs | IBM DB2 | <ToadCom, ToadEval, or ToadFree> |Command Line Tools | Command Window.

2. Enter the following command to enable LDAP support:

db2set DB2_ENABLE_LDAP=YES

3. Enter the following command to specify the TCP/IP host name and port number of theLDAP server:

db2set DB2LDAPHOST=<hostname[:port]>

The port number defaults to 389 (default LDAP port) if you leave the portnumber blank.

4. Exit the Command window.

5. Launch Toad and open the Connections window.

Databases on the LDAP server should be available from the Database alias drop-down list in the Connections window. To complete the Toad connection setup, you

Page 30: Toad InstallGuide

Toad for Data Analysts Installation GuideConfiguration

27

must create a Toad connection profile for each database. See "Create Toad ConnectionProfiles for DB2" (page 36) for more information.

Configure DB2 Client Connections

Toad requires two phases to set up connections to the DB2 for LUW databases and DB2 forz/OS subsystems that you want Toad to manage.

The first phase is to catalog each of these databases or subsystems on the DB2 client installedwith Toad. Toad provides three methods for cataloging the systems:

l Transfer an existing catalog from another DB2 client on your computer

You can transfer the catalog of an existing DB2 client on your local computer to thenew Toad DB2 client during initial setup or at any time later.

Transfer a Catalog During Initial Setup

When you first launch Toad after installation, Toad provides an opportunity totransfer the catalog of an existing DB2 client on your local computer to your newToad DB2 client. (In other words, Toad exports and imports the catalog for you.)

Toad makes this option available only when all of these conditions exist:

l You are launching Toad for the first time since installation.

l This installation is a first-time Toad installation on your computer, or it is anupgrade from a previous Toad version already on your computer.

l Toad detects other DB2 clients installed on your computer. These can includethe DB2 clients laid down with other installations.

If you choose not to transfer an existing catalog at this point, you can transfer acatalog later. See "Transfer a Catalog Any Time After Initial Setup" (page 28) for moreinformation.

Page 31: Toad InstallGuide

Toad for Data Analysts Installation GuideConfiguration

28

To migrate an existing DB2 catalog

1. Open Toad after installation is complete.

2. If Toad displays the Settings Migration Utility window, select whether tomigrate from your previously installed Toad. (These settings include Toadconnection profiles.)

l If you migrate settings, the window showing the option to transfer acatalog displays once the migration completes.

l If you do not migrate settings, the window showing the option totransfer a catalog displays when you select to create the firstconnection.

If the Settings Migration Utility window does not display, go to step 3.

3. On the window showing the option to transfer a catalog, locate the DB2Client list, and select the name of the existing DB2 client whose catalog youwant to transfer to your newly installed Toad .

This list contains all current previously installed DB2 clients on yourcomputer, including the default DB2 client instance and other Toad clientinstallations.

4. Click OK to proceed with the catalog transfer.

When the transfer completes, the Connections window displays. The Databasealias drop-down list now includes all the DB2 databases and subsystemswhose catalog entries you transferred.

Note: During the transfer process, DB2 does not automatically export catalogentries for the local DB2 instance and its databases installed on your computerunless these entries already exist in the catalog you are transferring. To includelocal node entries in your Toad DB2 client catalog, you must manually catalogthese databases.

5. Proceed to Create Toad Connection Profiles for DB2 (page 36) for the DB2databases and subsystems whose connection profiles you did not migrate (instep 2). For those profiles you migrated, simply select the connection in theConnections window, and provide the login ID and password to start theconnection.

Transfer a Catalog Any Time After Initial Setup

To transfer a catalog any time after initial setup

1. In the Connection Manager or on the Connections window, click inthe toolbar.

2. From the DB2 Client list, select the name of the existing DB2 client whose

Page 32: Toad InstallGuide

Toad for Data Analysts Installation GuideConfiguration

29

catalog you want to transfer to your newly installed Toad.

This list contains all current previously installed DB2 clients on yourcomputer, including the default DB2 client instance and other Toad clientinstallations.

3. Click OK.

4. Create Toad Connection Profiles for DB2 (page 36) for any of the transferredcatalog entries as needed.

l Import a DB2 Catalog previously exported to a file

Toad provides functionality to import an existing DB2 client catalog to your ToadDB2 client, saving you the effort of manually creating individual catalog entries onthe Toad DB2 client. This feature executes the DB2 Connectivity ConfigurationImport Tool command db2cfimp, which imports an export profile containing thecatalog exported the from a local or remote DB2 client or a local Toad DB2 client.Either of these functions export DB2 catalogs:

l Export Profile feature in the Toad Configuration wizard (for exporting yourcurrent Toad DB2 client catalog only). See Export the Catalog for the CurrentDB2 Client.

l DB2 Connectivity Configuration Export Tool Command db2cfexp. For moreinformation, see the following IBMdocumentation:http://publib.boulder.ibm.com/infocenter/db2luw/v8/index.jsp?topic=/com.ibm.db2.udb.doc/core/r0002442.htm.

Note: Do not attempt to manually import catalog entries from the IBM CLP windowprovided with Toad. If you have any DB2 ODBC entries, db2cfimp will override yourexisting ODBC system with DSN entries and can cause previously configured DB2ODBC connections to stop working.

To import an exported catalog profile

1. In the Connections (or Create New Connection) window, click beside theDatabase alias drop-down list to open the Client Configuration wizard.

2. On the Welcome page, select Import Profile.

3. Click Next.

4. Click in the Profile name field to browse for and select the exported profileyou want to import. When you select the profile, its contents display in thetext pane.

5. Complete the wizard.

Page 33: Toad InstallGuide

Toad for Data Analysts Installation GuideConfiguration

30

Once you close the wizard, the Database alias drop-down list in theConnections window includes all the DB2 databases and subsystems whosecatalog entries you imported.

Note: DB2 does not automatically export catalog entries for the local DB2instance and its databases on the computer from which the export is run (unlessthese entries already exist in the catalog). Therefore, the profile you areimporting might not include these node entries. To add the missing entries toyour Toad DB2 client catalog, you must manually catalog the databases. Ifthese databases are local to your computer, catalog them as remote databases.See "Manually catalog DB2 for LUW databases" (page 30) for moreinformation.

6. Proceed to catalog entries as needed. See "Create Toad Connection Profiles forDB2" (page 36) for more information.

l Manually catalog DB2 for LUW databases

To manually catalog a DB2 for LUW database

1. In the Connections (or Create New Connection) window, click beside theDatabase alias drop-down list to open the Client Configuration wizard. TheWelcome page displays, showing the Toad DB2 client's existing catalogconfiguration in a tree view.

2. If the host and node names for the database you want to configure are listed inthe tree, select them. These selections pre-fill certain fields required later in thewizard process. If these names are not listed, you must provide the necessaryhost and node information later in the wizard.

3. Click Add Catalog Entry.

4. Review the following for additional information:

Add a Host Description

Operatingsystem

Select the operating system for the server on whichthe DB2 for LUW instance containing the DB2database you are cataloging resides. For a list ofsupported server platforms, see the release notes.

Host name Enter the TCP/IP address or the system name for theserver on which the DB2 database resides.

Port number Enter the port number for the server on which theDB2 database resides.

Page 34: Toad InstallGuide

Toad for Data Analysts Installation GuideConfiguration

31

EnableSOCKSsecurity

Select this checkbox to enable the SOCKS secureprotocol to handle TCP traffic for this connection.SOCKS adds an authentication mechanism foradditional security.

Specify anInstance

Description

Node name Enter a user-defined name for the DB2 instancecontaining the database you are cataloging.

If you selected the node name from the tree on theWelcome page, this information is pre-filled (but youcan update it as needed).

Instance name Enter the real name of the DB2 instance.

Comment Enter a descriptive comment for the instance, ifneeded.

Add a Database Description

Database name Enter the real name of the DB2 database.

Database alias Enter a unique nickname to identify the database onyour system.

Authentication Select the authentication method that is required toconnect to the database.

Targetprincipal

Enter the service account name for server's servicewhere the database resides.

Note: This option is available only when Kerberos isselected as the authentication method.

5. Complete the wizard.

The Database alias drop-down list in the Connections window shows the aliasfor the newly cataloged database. To complete the Toad connection setup, youmust create a Toad connection profile for the database. See "Create ToadConnection Profiles for DB2" (page 36) for more information.

l Manually catalog DB2 for z/OS subsystems

Note: If you connect directly to a DB2 for z/OS subsystem, you cannot takeadvantage of Sysplex. If you want to use Sysplex, catalog an entry to a DB2 Connectgateway instead. See "Manually catalog DB2 Connect gateways" (page 33) for moreinformation.

Page 35: Toad InstallGuide

Toad for Data Analysts Installation GuideConfiguration

32

To manually catalog a DB2 for z/OS subsystem

1. In the Connections (or Create New Connection) window, click beside theDatabase alias drop-down list to open the Client Configuration wizard. TheWelcome page displays, showing the Toad DB2 client's existing catalogconfiguration in a tree view.

2. If the host name for the DB2 subsystem you want to configure is listed in thetree, select it. This selection pre-fills certain fields required later in the wizardprocess. If the host name is not listed, you must provide the necessary hostinformation later in the wizard.

3. Click Add Catalog Entry.

4. Review the following for additional information:

Add aHost

Description

Operatingsystem

Select z/OS for the server operating system.

Hostname

Enter the TCP/IP address or the system name for the serveron which the DB2 subsystem resides.

Portnumber

Enter the port number of the service for the DB2subsystem.

EnableSOCKSsecurity

Select this checkbox to enable the SOCKS secureprotocol to handle TCP traffic for this connection. SOCKSadds an authentication mechanism for additional security.

Add a DB2Subsystem

Description

Locationname

Enter the location name of the DB2 subsystem as definedduring the DB2 installation.

Databasealias

Enter a unique, user-defined alias to identify the DB2subsystem on your system. You can use the same nameyou used in the previous Location name field, as long asit does not already exist in the list aliases in the ToadDB2 client.

5. Complete the wizard. A message window informs you whether the entry wasadded successfully.

The Database alias drop-down list in the Connections window shows the aliasfor the newly cataloged subsystem. To complete the Toad connection setup,

Page 36: Toad InstallGuide

Toad for Data Analysts Installation GuideConfiguration

33

create a Toad connection profile for the database. See "Create Toad ConnectionProfiles for DB2" (page 36) for more information.

l Manually catalog DB2 Connect gateways

In order to connect to a DB2 for z/OS subsystem, you need to catalog two entries.First, you need to catalog the DB2 subsystem on the DB2 Connect gateway. Duringthis process, you define an alias for the DB2 subsystem. Second, you need tocatalog this DB2 subsystem alias in Toad. The procedure below describes bothcataloging events.

To manually catalog an entry to a DB2 Connect gateway

1. Catalog the DB2 subsystem on the DB2 Connect gateway. See the IBM DB2for z/OS documentation for more information.

2. In the Connections (or Create New Connection) window in Toad, clickbeside the Database alias drop-down list to open the ClientConfiguration wizard.

3. Click Add Catalog Entry.

4. Review the following for additional information:

Add a Host Description

Operatingsystem

Select the operating system for the server on whichthe DB2 Connect gateway resides.

Host name Enter the TCP/IP address or the system name for theserver on which the DB2 Connect gateway resides.

Port number Enter the port number of the service for the DB2Connect gateway.

EnableSOCKSsecurity

Select this checkbox to enable the SOCKS secureprotocol to handle TCP traffic for this connection.SOCKS adds an authentication mechanism foradditional security.

Specify anInstance

Description

Node name Enter an alias for the user-defined node name youspecify in the Instance name field.

Page 37: Toad InstallGuide

Toad for Data Analysts Installation GuideConfiguration

34

Instance name Enter a user-defined name for the gateway node oruse the same value entered in the Node name.

Note: This name does not point to an actual node onthe gateway system, but is needed to continue thecataloging process.

Add a Database Description

Database name Enter the database alias name for the DB2 subsystem.

Note: This alias name must match the alias catalogedon the DB2 Connect gateway.

Database alias Enter a unique, user-defined alias for the DB2Connect gateway. You can use the same alias youused in the previous Database name field, as long asit does not exist in the list of Toad for DB2 aliases.

Authentication Select the authentication method that matches themethod specified for the DB2 subsystem on the DB2Connect gateway.

5. Complete the wizard.

The Database alias drop-down list in the Connections window shows thename for the newly cataloged DB2 subsystem. To complete the Toadconnection setup, you must create a Toad connection profile for the subsystem.See "Create Toad Connection Profiles for DB2" (page 36) for more information.

Note: Toad for DB2 supports LDAP connections. See "Configure DB2 LDAP Support" (page26) for more information.

Additionally, Toad provides functionality to perform the following maintenance on thecatalog you set up for the current Toad DB2 client:

l Edit DB2 Catalog Entries

To edit a DB2 catalog entry

1. In the Connections (or Create New Connection) window, click beside theDatabase alias drop-down list to open the Client Configuration wizard.

2. In the catalog configuration tree for the Toad DB2 client, select the catalogentry for the DB2 database or subsystem that you want to edit.

3. Click Edit Catalog Entry.

4. On the Edit Catalog Entry page, update the catalog properties as needed. For adescription of the catalog properties, see the following links:

Page 38: Toad InstallGuide

Toad for Data Analysts Installation GuideConfiguration

35

l Manually catalog DB2 for LUW databases (page 30)

l Manually catalog DB2 for z/OS subsystems (page 31)

l Manually catalog DB2 Connect gateways (page 33)

5. Click Next to open the Catalog Script Review window.

6. Review and modify the script in the preview pane as needed.

7. Click Finish. A message window displays, informing you whether the updatesto the catalog entry completed successfully.

l Remove DB2 Catalog Entries

To remove a DB2 catalog entry

1. In the Connections (or Create New Connection) window, click beside theDatabase alias drop-down list to open the Client Configuration wizard.

2. In the catalog configuration tree for the Toad DB2 client, expand one or morenodes, and select the catalog entries that you want to remove. (PressCTRL+click to select multiple entries.)

Note: You can remove a node by selecting all database entries for that node.

3. Click Remove Catalog Entry.

4. On the Catalog Script Review page, modify the script in the previewpane as needed.

5. Click Finish. A message window displays, informing you whether theremovals completed successfully.

Export the Catalog for the Current DB2 Client

Toad for DB2 provides functionality to export your current Toad DB2 client catalog to a file,called an export profile. You can then import this profile to set up the catalog for anotherToad DB2 client.

To create the export profile containing the current Toad DB2 client catalog, Toad executesthe DB2 Connectivity Configuration Export Tool command db2cfexp. If you want to exportthe catalog of a remote or local DB2 client (other than your current Toad DB2 client), youmust manually execute this command. For more information, see the following IBMdocumentation: http://publib.boulder.ibm.com/infocenter/db2luw/v8/index.jsp?topic=/com.ibm.db2.udb.doc/core/r0002442.htm.

To export the Toad DB2 client catalog

1. In the Connections (or Create New Connection) window, click beside theDatabase alias drop-down list.

2. Click Export Profile in the Welcome window of the Client Configuration wizard.

Page 39: Toad InstallGuide

Toad for Data Analysts Installation GuideConfiguration

36

(You might need to click this button.)

3. Click Next.

4. Click in the Profile name field to browse for and select the path for the profile inwhich to export the current Toad DB2 client catalog.

5. Select the type of profile you want to create:

l Template to create a profile used as a template for other DB2 clients (defaultfor exporting a Toad DB2 catalog)

l Backup to create a profile used to back up a DB2 database instance

l Maintain to create a profile that contains only database or node informationrequired for updating other instances

For more information about these profile types, see the IBM documentation (ascited previously) describing the db2cfexp command.

6. Complete the wizard. A message window displays, informing you whether the exportcompleted successfully.

Note: DB2 does not automatically export catalog entries for the local DB2 instanceand its databases installed on your computer unless these entries already exist in thecatalog you are exporting. If you later import the export catalog to a Toad DB2 client,you must manually catalog the missing local-node databases as remote databases. See"Manually catalog DB2 for LUW databases" (page 30) for more information.

After you have set up the catalog on the current Toad DB2 client, you can proceed to thesecond phase of the Toad connection setup. This phase involves creating Toad connectionprofiles for the cataloged DB2 databases or subsystems. See "Create Toad Connection Profilesfor DB2" (page 36) for more information.

Create Toad Connection Profiles for DB2

Toad requires two phases to set up connections to the DB2 for LUW databases and DB2 forz/OS subsystems that you want Toad to manage.

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

The first phase is to catalog each of these databases or subsystems on the DB2 client installedwith Toad. See "Configure DB2 Client Connections" (page 27) for more information.

The second phase involves creating Toad connection profiles for the cataloged DB2databases or subsystems. Each profile contains the information that Toad needs to connect tothe system, such as the user ID and password, DB2 registry settings, and the default schema.This topic describes the three methods for setting up the profiles:

l Migrate existing connection profiles from another Toadinstallation on your computer(available during initial Toad setup only)

Page 40: Toad InstallGuide

Toad for Data Analysts Installation GuideConfiguration

37

When you first launch Toad after installation, Toad provides an opportunity tomigrate the settings of an existing Toad installation on your local computer to yournew Toad installation. These settings include, among other configuration parameters,the Toad connection profiles defined on the earlier installation. (Toad exports andimports these connection profiles for you.)

Toad makes this option available only when both of these conditions exist:

l You are launching Toad for the first time since installation.

l Toad detects earlier versions of Toad on your computer.

If you choose not to migrate the connection profiles at this point, you can perform themigration later using the Connection Managers' Import Connections and ExportConnections features.

To migrate Toad connection profiles

1. Open Toad after installation is complete. Toad displays the Settings MigrationUtility window if the conditions described previously exist.

2. Select the Toad installation whose connection profiles you want to migrate toyour new Toad installation, and click Migrate.

After the migration completes, Toad provides the option to transfer a localDB2 catalog to your new Toad DB2 client.

3. Select to transfer a DB2 catalog or to manually catalog entries later. See"Configure DB2 Client Connections" (page 27) for more information.

Note: The connection profiles you migrated are not usable unless you alsotransfer the DB2 catalog containing the corresponding entries for these profiles(or until you manually create these catalog entries later).

After the catalog transfer is complete, your Toad connection setup is completefor all those connections that have both a catalog entry on the Toad DB2client and a Toad connection profile. For any connection that does not have acorresponding DB2 catalog entry, create an entry. See "Configure DB2 ClientConnections" (page 27) for more information.

l Import Toad connection profiles previously exported to an XML file

(See "Export Connection Profiles to an XML File" (page 39) for moreinformationabout exporting a profile that you can later import.)

Note: The connection profiles are not usable unless you have also created entries inthe DB2 catalog for the DB2 databases and subsystems to which these profilescorrespond. See "Configure DB2 Client Connections" (page 27) for more information.

Page 41: Toad InstallGuide

Toad for Data Analysts Installation GuideConfiguration

38

To import connection profiles

1. In the Connections (or Create New Connection) window, click on thetoolbar, and select Connection file.

2. From the Import Connections window, browse for and select the XML filecontaining the connection profiles you want to import.

3. Click Open.

4. Select DB2 and click OK to complete the import.

The connections whose profiles you imported are listed on theConnections window.

l Manually define Toad connection profiles.

To create a Toad connection profile for a DB2 database or subsystem

1. In the Connections (or Create New Connection) window, click on thetoolbar (ALT+F+N).

2. Select DB2 from the Group list box.

3. Review the following for additional information:

Databasealias

Select the alias for the DB2 database or subsystem. Thisalias was defined when you cataloged this DB2 databaseor subsystem on the Toad DB2 client. See "ConfigureDB2 Client Connections" (page 27) for more informationif the alias does not display in the list.

Defaultschema/authID

Enter the SET SCHEMA value (DB2 for LUW) or the SETSCHEMA or SET CURRENT SQLID value (DB2 for z/OS) forthis connection.

Name Edit the nickname you want to display for this connectionthroughout Toad (for example, in the Connectionswindow, document windows, Connection toolbar, andstatus bar). If this field is blank, the name defaults to:

database_alias (login)

Category Select or create a category if you want to color codeEditor tabs for a specific connection. This can helpdifferentiate between development and productiondatabases. You can also set an option to color code theObject Explorer pane and object editor windows (Create,Alter, Drop, etc.).

Page 42: Toad InstallGuide

Toad for Data Analysts Installation GuideConfiguration

39

4. Select the Advanced tab to define special register values that are then in effecteach time Toad connects to the DB2 database or subsystem.

5. Click Connect to save the connection and immediately connect to thedatabase.

or

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

After you have completed both phases for configuring Toad connections to DB2 databases orsubsystems, the Connections window lists all the configured connections, allowing you toperform the following:

l Connect to and manage a DB2 database or subsystem through Toad

l Export Connection Profiles to an XML File

Toad for DB2 provides functionality to export one or more of your current Toadconnection profiles to an XML file. You can then import these exported connectionprofiles into another Toad installation. See "Import Toad connection profilespreviously exported to an XML file " (page 37) for more information.

To export connection profiles

1. In the Connections (or Create New Connection) window, select theconnections whose profiles you want to export.

2. Click on the toolbar, and select Connection file.

3. On the Export Connections window, review the selected connections,and click OK.

4. Browse for and select the path for the file in which to export theselected profiles.

l Import connection profiles from an XML file

l Import missing connections defined on the Toad client.

You can import all connection entries currently defined in the Toad DB2 clientcatalog but missing from your current list of Toad connections.See "Create ToadConnection Profiles for DB2" (page 36) for more information.

Note: The imported connection entries might be associated with incorrect or missingDB2 catalog or Toad connection profile information, making them currently invalid.To re-instate any of these connections, you might need to provide accurate DB2catalog and Toad profile information.

To import missing connections

» In the Connections or Connections Manager window, click .

Page 43: Toad InstallGuide

Toad for Data Analysts Installation GuideConfiguration

40

l Troubleshoot connection issues for DB2 for LUW databases or DB2 for z/OSsubsystems

Create Access Connections

Although this connection uses the ODBC driver, it is easier and faster to connect using thismethod. See "Troubleshoot Database Issues" (page 48) for more information abouttroubleshooting connection issues.

Notes:

l The Toad Sample database already has a username and password defined. Theconnection information for this database is:

Database file = C:\Program Files\QuestSoftware\ToadInstallDirectory\Plugins\Odbc\Sample Database\Quest_Stage.mdb

User = QUEST

Password = QUEST

Additional sample files for this database are available in the Project Manager.

l This topic focuses on information that may be unfamiliar to you. It does not includeall step and field descriptions.

To create an Access connection

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

2. Select Access from the Group list box.

3. Review the following for additional information:

Database file Select the database to use when connecting.

MDW file Select the MDW file that is linked to the database.

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

Name Edit the nickname you want to display in the Connectiontoolbar, status bar, and document windows, if needed.

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

Page 44: Toad InstallGuide

Toad for Data Analysts Installation GuideConfiguration

41

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.

Create Excel Connections

Although you can create a connection to an Excel file from the standard ODBC driver, thismethod uses the Microsoft Jet Database Engine, which makes connecting to Excel mucheasier and faster. See "Troubleshoot Excel" (page 49) 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 an Excel connection

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

2. Select Excel from the Group list box.

3. Review the following for additional information:

File name Select the Excel file you want to connect to.

Name Edit the nickname you want to display in the Connectiontoolbar, status bar, and document windows, if needed.

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

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.

Page 45: Toad InstallGuide

Toad for Data Analysts Installation GuideConfiguration

42

Create MySQL Connections

You can create a new connection, or connect to an existing connection from the Create NewConnection window. See "Troubleshoot MySQL Issues" (page 59) 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.

3. Review the following for additional information:

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

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.

UseMySQLlibraries

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

Note: If you select this option, you must specify libMySQL.dll

Page 46: Toad InstallGuide

Toad for Data Analysts Installation GuideConfiguration

43

in the path.

Name Edit the nickname you want to display in the Connectiontoolbar, status bar, and document windows, if needed. If thisfield is blank, the name defaults to:

username@hostname (database)

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

AdvancedTab

Description

ODBCdriver

Select an ODBC driver to use for heterogeneous queries for thisconnection.

Tip: You can specify the ODBC driver to use for allconnections for this database provider in Tools | Options | Database | MySQL.

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.

Create ODBC Connections

The purpose of the ODBC provider is to offer basic connection and querying capabilities toany database that supports an ODBC 3.0 or later driver. For a list of databases tested with theODBC provider, see the Release Notes. This form of connectivity allows connections todatabases such as Teradata, Netezza, IBM iSeries, and Ingres. Because this form ofconnectivity is generic, it is not full-featured and may not be as robust as the fully exploitedproviders for databases that use a native provider.

Scenario

You need to create an ODBC connection to an Oracle 11g database.

To create an ODBC connection

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

2. Select ODBC from the Group list box.

Page 47: Toad InstallGuide

Toad for Data Analysts Installation GuideConfiguration

44

3. Click in the Data Source Name field.

4. Click Add.

5. Select an ODBC driver from the list, and click Finish.

Scenario: Select the ODBC driver provided by Oracle. The Microsoft ODBC forOracle driver has less functionality than the driver provided by Oracle.

6. Specify the configuration properties required for the database.

Scenario: If you have an Oracle database with Unicode data, make sure to selectForce SQL_WCHAR Support on the Workarounds tab. If you do not, you will not beable to see the data.

7. Review the following fields on the Create New Connection window:

Data sourcename

Select the type of data source you want to connect to from thelist.

User Enter the user name to use when connecting.

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

Database Specify the location of the database schema. Click to create atemporary connection and display available schemas in the drop-down list.

Information Specify the following connection options.

DataSourceName

Displays they type of data source selected.

Driver Displays the ODBC driver associated with the data source.

ConnectionString

Enter the connection string.

Name Edit the nickname you want to display in the Connectiontoolbar, status bar, and document windows, if needed.

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

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

Page 48: Toad InstallGuide

Toad for Data Analysts Installation GuideConfiguration

45

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.

Create SQL Server Connections

You can create a new connection, or connect to an existing connection from the Create NewConnection window. See " " (page 62) for more information about troubleshootingconnection issues.

To create a new connection

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

2. Select SQL Server from the Group list box.

3. Review the following for additional information:

Login Tab Description

Servername

Enter the name of the server to use when connecting.

Click to display any servers running SQL Server that arecurrently active on the network.

Note: For named instances, enter theMachineName\InstanceName in this field.

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

Name Edit the nickname you want to display in the Connectiontoolbar, status bar, and document windows, if needed. If thisfield is blank, the name defaults to:

servername (login) database

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

AdvancedTab

Description

Page 49: Toad InstallGuide

Toad for Data Analysts Installation GuideConfiguration

46

OBDCdriver

Select an ODBC driver to use for heterogeneous queries for thisconnection.

Tip: You can specify the ODBC driver to use for allconnections for this database provider in Tools | Options | Database | SQL Server.

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.

Create Sybase ASE Connections

You can create a new connection, or connect to an existing connection from the Create NewConnection window. See "Troubleshoot Sybase ASE Issues" (page 63) for more informationabout troubleshooting 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 Sybase ASE connection

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

2. Select Sybase ASE from the Group list box.

3. Review the following for additional information:

Login Tab Description

CharSet Enter the client character set such as UTF-8 in this field if itdiffers from the default character set. This helps you avoidconnection issues.

Note: This field is not case sensitive.

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

Name Edit the nickname you want to display in the Connectiontoolbar, status bar, and document windows, if needed.

Category Select or create a category if you want to color code Editor tabsfor a specific connection. This can help differentiate between

Page 50: Toad InstallGuide

Toad for Data Analysts Installation GuideConfiguration

47

development and production databases. You can also set anoption to color code the Object Explorer pane and object editorwindows (Create, Alter, Drop, etc.).

AdvancedTab

Description

ODBCdriver

Select an ODBC driver to use for heterogeneous queries for thisconnection.

Tip: You can specify the ODBC driver to use for allconnections for this database provider in Tools | Options | Database | Oracle.

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.

Understand Toad Connections

In 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 (illustrated in thefollowing example).

Page 51: Toad InstallGuide

Toad for Data Analysts Installation GuideConfiguration

48

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.

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 (DB2 and Oracle only) If your database supports executing multiple queriessimultaneously on a shared connection, the query is placed in a queue and executes assoon as the current operation completes.

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.

Troubleshoot Database Issues

Troubleshoot Access Issues

Review the following solutions to help troubleshoot Access issues pertaining to missingfunctionality and object information and other problems in Toad.

Page 52: Toad InstallGuide

Toad for Data Analysts Installation GuideConfiguration

49

Missing Functionality and Object Information

Issue Cause/Solution

Some queries display in theView tab of the Object Explorer,but do not display in the Querytab.

The Access ODBC driver handles saved queries inthe following manner:

l If the stored query does not containparameters, it is treated as a view anddisplays in the View tab.

l If the stored query contains parameters, it istreated as a stored procedure and displays inthe Query tab.

Primary key information isunavailable.

The Microsoft Access ODBC driver does not returnprimary key information for databases. However, insome cases, Toad can obtain this informationthrough additional methods.

Other Issues

Issue Cause/Solution

A delay occurs between writinga value to a database via oneconnection and seeing theupdated value via anotherconnection.

This delay is the default when you are writing andreading data between two different Jet connections.The delay occurs even if the two connections residein the same client process.

Solution:

Use a single connection when updating data.

Troubleshoot Excel

Review the following solutions to help troubleshoot Excel:

l Connections

l Web Browser integration

Page 53: Toad InstallGuide

Toad for Data Analysts Installation GuideConfiguration

50

Connections

Issue Cause/Solution

Tables are limited to256 columns and65536 rows.

This is a known limitation with Excel worksheets.

Column names longerthan 64 characters aretruncated and theremaining charactersdisplay as null.

This is a known limitation with Excel worksheets.

Tables do not displaywhen connected.

or

The following errordisplays whenconnecting: "No usertables could be foundin spreadsheet_name.xls

This issue occurs because the worksheet does not includenamed regions. The Excel ODBC driver displays namedregions as user tables and worksheets as system tables with a'$' appended to the end of the name.

Solution 1: Show System Tables

To view the worksheet, select the Show system objectscheckbox in ODBC Options.

Solution 2: Define Named Regions in the Worksheet

1. Disconnect your connection to the Excel spreadsheetin Toad.

2. Open the spreadsheet in Excel.

3. Select the columns and rows you want to define as atable. Make certain you include the column names.

4. Select Insert | Name | Define from the menu.

5. Enter a name for the named region.

6. Save your spreadsheet and exit Excel.

7. Reconnect to the Excel spreadsheet in Toad. A tabledisplays with the name you specified for the namedregion.

Two worksheets withthe same name arecreated when creating anew table.

The Excel ODBC driver automatically creates one worksheetwith a named range and a new worksheet with the samename when you use the Create Table feature.

Page 54: Toad InstallGuide

Toad for Data Analysts Installation GuideConfiguration

51

Issue Cause/Solution

Columns that includetext values or specialcharacters as part of anumeric value as wellas entries with straightnumeric values result inthe one of the valuesets displaying as null.

When you connect to Excel, the driver automatically scansthe first eight rows in a column and applies the data typeused in a majority of those rows to all rows in the column.Any rows that do not meet the majority data type display asnull values.

Solution 1: Reformat Worksheet Column and Values as Text

1. Open the worksheet in Excel.

2. Format the column that contains mixed data types asText.

3. Re-enter each value in the column.

4. You can now connect to this spreadsheet from Toadwithout any null values displayed.

Solution 2: Force ODBC to Read All Rows as Text

You can force the ODBC driver to read all rows as Text toavoid null values; however, this can result in issues if youattempt to insert data.

Note: This option is not available if you use the ExcelMicrosoft Jet Database Engine to connect.

1. Open the Create New Connection window and selectODBC from the Group list box.

2. Complete the fields as described in Create ODBCConnections.

3. Enter "IMEX=1", in quotations, in theExtraParameters field.

4. Click Connect.

Column names thatcontain an exclamationpoint (!) are notsupported.

The exclamation point character has a special meaning inExcel. If a column name contains an exclamation point, it isinternally converted to a dollar sign ($) character.

Tables cannot bealtered.

The Excel ODBC driver does not support this functionality.

The Primary Keys andForeign Keys tabs areblank in the DatabaseExplorer.

Excel is a spreadsheet, and does not support primary andforeign keys so these tabs are always blank.

Views do not displayin the View tab in theObject Explorer, andattempting to create a

The Excel ODBC driver mistakenly indicates that views are

Page 55: Toad InstallGuide

Toad for Data Analysts Installation GuideConfiguration

52

Issue Cause/Solution

view displays amessage that theoperation is notsupported.

supported in Excel, when they are not. Although Toaddisplays the View tab in the Object Explorer based on theincorrect information, the tab remains blank and viewscannot be created.

The Procedures tab inthe Object Explorer isblank.

Excel does not support procedures.

Indexes cannot becreated or dropped.

The Excel ODBC driver does not support this functionality.

Unable to query Excelfiles without namedregions.

The worksheet you are querying does not have namedregions defined.

Solution:

You can query the worksheet from the Editor by entering adollar sign ($) followed by a cell range to limit the resultssimilar to the following statement:

Select * from (MyWorksheet$A1:C10)

You can also query the entire worksheet by entering a dollarsign ($) after the worksheet name; however, this returnsempty rows and columns in the worksheet.

Unable to query datausing an empty stringor null value.

The underlying data format cannot differentiate between anempty string and null data, so a query with a searchcondition that contains an empty string does not match anyempty strings in the table. This occurs because the emptystring is treated as a null value, and a null value nevermatches anything, not even another null value.

Unable to update ordelete rows in a table.

The Excel ODBC driver does not support this functionality.While it is possible to update values, DELETE statements donot remove a row from a table. Basically, you can only insertdata in a table.

Attempting to insertdata results in an errorstating, "Cannotexpand named range".

This error occurs if you have more than one named region inthe same worksheet; and the named regions are not separatedby a blank row.

Solution:

Add a blank row between named regions, or include onlyone named region in each worksheet.

Page 56: Toad InstallGuide

Toad for Data Analysts Installation GuideConfiguration

53

Web Browser Integration

Issue Cause/Solution

Excel menus do not display whenyou open Excel files in the WebBrowser.

The Web Browser cannot display Excel menus.

Solution:

Right-click the Excel toolbar and add theequivalent toolbar for the missing menu orfunctionality.

When two or more instances ofExcel are open in the WebBrowser, toolbars are active foronly one instance.

The Web Browser supports one Excel instance ata time. Opening more than one Excel filedisables the Excel toolbars for the additionalfiles.

Solution:

Open only one Excel file at a time.

Create Excel Connections (page 41)

Troubleshoot DB2 LUW Issues

Review the following solutions to help troubleshoot DB2 LUW issues pertaining to Toadinstallation and database connections.

Installation Issues

The following table describes issues related to installing Toad for DB2.

Issue Cause/Solution

System.IO.FileNotFoundException -File or assembly nameDB2AdminWrapper, or one of itsdependencies was not found

You are not a member of the DB2ADMIN orDB2USERS group. To install Toad, you mustbe a member of either group.

Solution:

Ensure that you have been added to one ofthese groups.

Cannot access IBM DB2 native toolsafter installing Toad for DB2 2.0 withprevious install of DB2 client v7.Error: "SQL10007N Message "-1390"could not be retrieved. Reason code:"2"."

Toad is bundled with the IBM DB2 v9 client.IBM does not support direct client migrationfrom v7 to v9, so installing Toad on a systemthat has an existing v7 client may cause errors.

Solution:

Upgrade the IBM DB2 v7 client to the v8client. If you upgrade the client after installingToad, you do not have to uninstall or reinstallToad.

Page 57: Toad InstallGuide

Toad for Data Analysts Installation GuideConfiguration

54

Issue Cause/Solution

Error: "Could not load file orassembly 'IBM.Data.DB2.9.1.0,Version=9.1.0.2, Culture=neutral,PublicKeyToken=7c307b91aa13d208'or one of its dependencies. Thesystem cannot find the file specified."

You installed a commercial version of Toadfor DB2 after uninstalling the freeware version.

Solution:

You must remove run time information for thefreeware version of Toad from the .NETsystem.config file.

To remove run time information

1. Exit Toad.

2. Navigate to the following .NETframework directory:C:\WINDOWS\Microsoft.NET\Framework\v2.0.50727\CONFIG

3. Create a backup copy of thesystem.config file.

4. Open the system.config file in Notepad.

5. Locate the <runtime> tag deleteeverything between the runtime tags(including <runtime> and </runtime>).

6. Save the file.

7. Restart Toad.

Page 58: Toad InstallGuide

Toad for Data Analysts Installation GuideConfiguration

55

Connection Issues

Issue Cause/Solution

ERROR [08001] [IBM]SQL1336N The remote host wasnot found. SQLSTATE=08001

You are attempting to connect to a database versionthat is not supported in Toad.

Solution:

Review the list of supported databases in theRelease Notes or Installation Guide.

ERROR [58031] [IBM]SQL1031N The databasedirectory cannot be found on theindicated file system.SQLSTATE=58031

Catalog entries have not been imported or definedfor the connection.

Solution:

See Configure DB2 Client Connections todetermine the best method for cataloging adatabase.

"The type initializer for'IBM.Data.DB2.DB2Connection'threw an exception."or

"SUCCESS - unable to allocatean environment handle."

A settings file might be corrupt.

Solution:

Rename your local settings directory so a new onecan be recreated.

To rename your local setting directory

1. Exit Toad.

2. Navigate to the following settings directory:C:\Documents and Settings\UserName\LocalSettings\ApplicationData\Quest Software

3. Rename the Toad for DB2 version# folder to"Toad for DB2 OLD".

4. Restart Toad and try to connect.

Note: Make sure you can view hidden folders inWindows Explorer.

Page 59: Toad InstallGuide

Toad for Data Analysts Installation GuideConfiguration

56

Troubleshoot DB2 z/OS Issues

Review the following solutions to help troubleshoot DB2 z/OS issues in Toad.

Installation Issues

Issue Cause/Solution

Error: "Could not load file orassembly 'IBM.Data.DB2.9.1.0,Version=9.1.0.2, Culture=neutral,PublicKeyToken=7c307b91aa13d208'or one of its dependencies. Thesystem cannot find the file specified."

You installed a commercial version of Toadfor DB2 after uninstalling the freeware version.

Solution:

You must remove run time information for thefreeware version of Toad from the .NETsystem.config file.

To remove run time information

1. Exit Toad.

2. Navigate to the following .NETframework directory:C:\WINDOWS\Microsoft.NET\Framework\v2.0.50727\CONFIG

3. Create a backup copy of thesystem.config file.

4. Open the system.config file in Notepad.

5. Locate the <runtime> tag deleteeverything between the runtime tags(including <runtime> and </runtime>).

6. Save the file.

7. Restart Toad.

Page 60: Toad InstallGuide

Toad for Data Analysts Installation GuideConfiguration

57

Connection Issues

Issue Cause/Solution

ERROR [08001] [IBM]SQL1336N The remote host wasnot found. SQLSTATE=08001

You are attempting to connect to a database versionthat is not supported in Toad.

Solution:

Review the list of supported databases in theRelease Notes or Installation Guide.

ERROR [58031] [IBM]SQL1031N The databasedirectory cannot be found on theindicated file system.SQLSTATE=58031

You do not have any catalog entries defined for theconnection.

Solution:

See Configure DB2 Client Connections todetermine the best method for cataloging adatabase.

ERROR [42501] [IBM][DB2]SQL0551N "UserName" doesnot have the privilege to performoperation "SELECT" on object"SYSIBM.SYSSTMT".SQLSTATE=42501

You do not have SYSADM privileges for the DB2for z/OS subsystem.

Solution:

Ensure that you are granted SELECT permissionson the DB2 catalog tables.

ERROR [] [IBM] SQL1460NThe environment variable"SOCKS_NS" required forSOCKS server name resolution isnot defined or not valid.

When using the Time-Sharing Option (TSO) toconnect, the user ID, port number, or IP addressentered may be incorrect.

Solution:

Ensure that you use the following for TSOconnections:

l DB2 user ID for the DB2 subsystem

l Port number that DB2 listens on, for remoteconnections, via the DB2 DDF addressspace

l IP address for the z/OS subsystem

Page 61: Toad InstallGuide

Toad for Data Analysts Installation GuideConfiguration

58

Issue Cause/Solution

ERROR [56038] [IBM][DB2]SQL0969N There is no messagetext corresponding to SQL error"-4700" in the message file onthis workstation.' whenconnecting to compatibilitymode database.

-or-

After connecting, some objectsdo not display properly or somefunctionality does not work asdesigned.

In general, Toad does not support a z/OS subsystemrunning in Compatibility mode.

Solution:

If possible, switch the subsystem's operating modeto Full Function mode.

If this is not possible, Toad now provides a messagewhen you connect to subsystem, informing you ofthat the subsystem is running in compatibility modeand that some features might not be available.

Missing Functionality or Object Information

Issue Cause/Solution

Unable to browse databases inDB2 for z/OS 8 or later.

The DB2 installation job DSNTISG defines a set ofDB2 procedures that the ODBC driver uses. Theinstallation assigns these procedures (namely, thosebeginning with SYSIBM.SQL*) to a specific WorkLoad Manager (WLM) environment, whichcurrently might not exist or be defined properly.

Solution:

Be sure that you have correctly set up and enabledthe WLM environment to which the proceduredefinitions point.

Cannot edit data incompatibility mode.

In compatibility mode, the ODBC driver does notreturn enough information for the CommandBuilderto correctly generate update or insert statements.

Solution:

No solution exists. However, when you connect toa subsystem running in compatibility mode, Toadnow provides a message, informing you of thiscondition and warning you that some featuresmight not be available.

Page 62: Toad InstallGuide

Toad for Data Analysts Installation GuideConfiguration

59

Other Issues

Issue Cause/Solution

[IBM][CLI Driver][DB2]SQL0104N An unexpectedtoken "/*" was found following"". Expected tokens may include:"FROM INTO".SQLSTATE=42601

The SQL script that you attempted to executecontains commented text delimited by charactersthat DB2 for z/OS 8 or earlier does not support.

Solution:

Set an option in Toad that removes commentsautomatically from a script before you execute it.

To have Toad remove comments automaticallyfrom SQL before execution

1. Select Tools | Options | Database | DB2 |General.

2. Select Remove comments from SQLstatements prior to execution.

Troubleshoot Informix Issues

Review the following solutions to help troubleshoot Informix issues in Toad.

Issue Cause/Solution

Unable to view all availabledatabases.

The InformixODBC driver does not returninformation about every available database.

Troubleshoot MySQL Issues

Review the following solutions to help troubleshoot MySQL connection issues pertaining todatabase connections and missing functionality or object information in Toad.

Page 63: Toad InstallGuide

Toad for Data Analysts Installation GuideConfiguration

60

Connection Issues

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.

Missing Functionality or Object Information

Issue Cause/Solution

Views tab is unavailable whenconnecting to MySQL using theODBC driver

You are attempting to connect using the 3.51ODBC driver. This driver is hard-coded to replythat the database does not support views because itneeds to connect to MySQL databases prior toversion 5.

Solution:

Use the native MySQL provider included in Toad

Note: Although a beta version of the ODBC 5driver resolves this issue, it is not recommended foruse with production systems. If needed, you candownload this driver from:http://dev.mysql.com/downloads/

Troubleshoot Oracle Issues

Review the following solutions to help troubleshoot Oracle issues pertaining to databaseconnections and missing functionality and object information in Toad.

Page 64: Toad InstallGuide

Toad for Data Analysts Installation GuideConfiguration

61

Connection Issues

Issue Cause/Solution

Attempting to connect whenOracle Instant Client is installedresults in aSystem.NullReferenceExceptionerror

Solution:

In order to connect using the Oracle Instant Client,the directory for the Instant Client must be includedin the environmental path, or you must copy theclient files for the instance to the root installdirectory of Toad for Data Analysts.

You can also connect to the database without usingan Oracle client or TNSNames file by selecting theDirect tab in the Create New Connection window.

Unable to select a 64-bit Oracleclient from the Current homefield in the Oracle Client tab

Toad runs as a 32-bit application, even wheninstalled on a 64-bit O/S. Because it is a 32-bitapplication, Toad is not compatible with 64-bitOracle clients.

An error occurs when attemptingto connect to Oracle Rdb usingan ODBC driver.

Toad does not support Oracle Rdb at this time.

Missing Functionality and Object Information

Issue Cause/Solution

Some schemas are not availablefrom the Schema drop-down listin the Object Explorer.

The Oracle ODBC driver cannot display schemasthat do not have any tables.

Unable to view table data on theData tab; SQLFetch generates anaccess violation.

The Oracle ODBC driver is accessing unallocatedmemory.

Solution:

Update the Oracle ODBC driver:

l For 9i drivers, update to 9.2.0.7.0 or later.

l For 10g drivers, update to 10.1.0.3.0 or later.

Page 65: Toad InstallGuide

Toad for Data Analysts Installation GuideConfiguration

62

Troubleshoot SQL Server Issues

Review the following solutions to help troubleshoot SQL Server connection issues in Toad.

Issue Cause/Solution

Cannot specify a portnumber whenconnecting

Currently, Toad does not have a separate field for specifyinga port number.

Solution:

You can connect if you know the port number for theinstance by entering the following in the Server name fieldon the New Connection window:

ServerName,Port

or

IPAddress,Port

For example:

10.1.29.129,1234 (where 1234 is the port number of theinstance)

Cannot connect to aremote instance in SQLServer 2005

Remote connections may not be enabled in SQL Server2005. Also, named instances are configured to use dynamicports and select an available port once the SQL ServerService starts. If you are connecting to a named instancethrough a firewall, configure the Database Engine to listenon a specific port, so that the appropriate port is opened inthe firewall.

Note: Remote connections are disabled by default in theExpress and Developer editions of SQL Server 2005.

Solution:

To enable remote connections, see "How to configure SQLServer 2005 to allow remote connections" at:http://support.microsoft.com/kb/914277

Page 66: Toad InstallGuide

Toad for Data Analysts Installation GuideConfiguration

63

Issue Cause/Solution

"Path is not of a legalform" error messagewhen connecting

or

"Could not find a partof the pathC:\Program Files\QuestSoftware\Toad for SQLServer\Template\Scripts\InitialSqlServer.Sql"error message whenconnecting

You attempted to migrate settings from a previous install ofToad to the current install, but the settings file(InitialSqlServer.Sql) for the previous install was eitherremoved, moved, or corrupt.

You may also receive this error if you installed Toad andmigrated settings from a previous version, and lateruninstalled the previous version.

Solution:

You must specify a valid location for the InitialSqlServer.Sqlfile in Toad.

To specify a valid location

1. Open the SQL Server options page under Tools |Options | Database | SQL Server.

2. Specify the location for the new install'sInitialSqlServer.Sql file in the Run Script on newconnection field.

By default, this file is located in the following directory:

C:\Program Files\Quest Software\Toad for SQL Serverversion# \Templates\Scripts

Note: Clicking may result in a "Path not found error". Ifyou receive this error, manually enter the location in thefield.

Troubleshoot Sybase ASE Issues

Review the following solutions to help troubleshoot SybaseASE issues pertaining to thefollowing in Toad:

l Database connections

l Missing functionality or object information

l Other issues

Connection Issues

Issue Cause/Solution

Unable to connect to thedatabase. The following messagedisplays: "The ODBCMDAprocedures have not beeninstalled on this database..."

Stored procedures that the ODBC driver requirescurrently do not exist on the server.

Solution:

Install the required procedures.

Page 67: Toad InstallGuide

Toad for Data Analysts Installation GuideConfiguration

64

Missing Functionality or Object Information

Issue Cause/Solution

Unable to view or export datafor objects with non-standardnames.

Sybase ODBC driver has issues handling non-standard names for objects.

Solution:

When setting up a Sybase connection in Toad,select Use quoted identifiers on the Connection tabin the Adaptive Server Enterprise window to enablethe use of quotations in identifiers.

Unable to view linked tables. Linked tables store DSN connection information.

Solution:

Set up the DSN connection information exactly thesame on all machines that access the database.

Other Issues

Issue Cause/Solution

DBMS name showing as SQLServer.

Older versions of the Sybase ODBC driver returnSQL Server as the DBMS name.

Solution:

Upgrade to the latest version of the Sybase ODBCdriver, which correctly returns Adaptive ServerEnterprise as the DBMS name.

Configure Version Control

About Version Control

Toad integrates with your existing version control system so you can maintain multiplerevisions of files.

Important: See "Troubleshoot Version Control" (page 72) 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.

Page 68: Toad InstallGuide

Toad for Data Analysts Installation GuideConfiguration

65

SupportedProvider

Server VersionTested

Client Version Tested

VisualSourceSafe(VSS)

VSS 6.0d VSS 6.0d

See "Configure TFS or VSS" (page 66) for moreinformation.

ConcurrentVersionsSystem(CVS)

CVS 1.11.22 onSolaris

CVSNT 2.5.03 onWindows

CVSNT 2.5.03

See "Configure CVS " (page 68) for moreinformation.

Subversion Subversion 1.5.6on Windows

Note: Toad onlysupportsSubversion 1.5.6or later.

CollabNet Subversion Command-Line Client 1.5.6

Notes:

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 70) for moreinformation.

TeamFoundationServer(TFS)

TFS 2005, 2008 Visual Studio (2005 and 2008) Team ExplorerClient

See "Configure TFS or VSS" (page 66) 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.

Page 69: Toad InstallGuide

Toad for Data Analysts Installation GuideConfiguration

66

Configure TFS or VSS

You can configure version control to work with SQL scripts in the Editor. See "TroubleshootVersion Control" (page 72) for more information.

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 "Configure Version Control" (page 64) for more information abouttested version control clients and supported versions.

2. Open an Editor window.

3. Right-click anywhere in the toolbar area and select Version Control to display 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.

5. Review the following for additional information:

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

Page 70: Toad InstallGuide

Toad for Data Analysts Installation GuideConfiguration

67

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

If you already have scripts under version control, select thefolder on the server where these scripts are located.

Notes:

l Version control automatically checks out scripts in thisfolder and any subfolders to the location you specify inthe Working folder field.

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.

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

Tips:

l You can view revision history and revision comments for a scipt from the History tab;and can also right-click a revision to send it to the Diff Viewer to 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>.

Page 71: Toad InstallGuide

Toad for Data Analysts Installation GuideConfiguration

68

Configure CVS

You can configure version control to work with SQL scripts in the Editor. See "TroubleshootVersion Control" (page 72) for more information.

To configure CVS to work with SQL scripts in the Editor

1. Ensure that a supported version control client is installed on the computer where Toadis installed. See "Configure Version Control" (page 64) for more information abouttested version control clients and supported versions.

2. Open an Editor window.

3. Right-click anywhere in the toolbar area and select Version Control to display 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.

5. Review the following for additional information:

VersionControlSystem Page

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:

Page 72: Toad InstallGuide

Toad for Data Analysts Installation GuideConfiguration

69

:pserver:MyServer:Port:/MyWorkingRepository

Username/password

Enter your CVS command-line user name and password andclick Login.

Note: The User name field is optional.

DefaultVersionControlSettingsPage

Description

Versioncontrolfolder

Select the folder on the version control server where you want tocheck scripts in.

If you already have scripts under version control, select thefolder on the server where these scripts are located.

Notes:

l Version control automatically checks out scripts in thisfolder and any subfolders to the location you specify inthe Working folder field.

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 SQL scripts under version control, select theexisting working folder for these.

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

Tips:

l You can view revision history and revision comments for a scipt from the History tab;and can also right-click a revision to send it to the Diff Viewer to 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>.

Page 73: Toad InstallGuide

Toad for Data Analysts Installation GuideConfiguration

70

Configure Subversion

You can configure version control to work with SQL scripts in the Editor. See "TroubleshootVersion Control" (page 72) for more information.

To configure Subversion to work with SQL scripts in the Editor

1. Ensure that a supported version control client is installed on the computer where Toadis installed. See "Configure Version Control" (page 64) for more information abouttested version control clients and supported versions.

2. Open an Editor window.

3. Right-click anywhere in the toolbar area and select Version Control to display 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.

5. Review the following for additional information:

VersionControlSystem Page

Description

Type Select Subversion.

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 Subversion clientthat contains svn.exe is installed. For example, if youinstalled the CollabNet Subversion Client, you wouldenter:

C:\Program Files\CollabNet Subversion Client

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

Page 74: Toad InstallGuide

Toad for Data Analysts Installation GuideConfiguration

71

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

Username/Password

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

DefaultVersionControlSettingsPage

Description

Versioncontrolfolder

Select the folder on the version control server where you want tocheck scripts in.

If you already have scripts under version control, select thefolder on the server where these scripts are located.

Notes:

l Version control automatically checks out scripts in thisfolder and any subfolders to the location you specify inthe Working folder field.

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 SQL scripts under version control, select theexisting working folder for these.

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

Tips:

l You can view revision history and revision comments for a scipt from the History tab;and can also right-click a revision to send it to the Diff Viewer to 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 when

Page 75: Toad InstallGuide

Toad for Data Analysts Installation GuideConfiguration

72

executing a script in the Editor, disable or delete a version control configuration, etc.,from Tools | Options | Version Control | <options page>.

Troubleshoot Version Control

Troubleshoot Upgrades

For this release, the back-end of version control has been rewritten. If you previously 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 files inversion control are different than the local version. If your local version is current, youshould check the files into version control.

Page 76: Toad InstallGuide

Toad for Data Analysts Installation GuideConfiguration

73

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.

Page 77: Toad InstallGuide

Appendix: Contact Quest

Contact Quest Support

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

• Retrieve thousands of solutions from our online Knowledgebase

• Download the latest releases and service packs

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

Contact Quest Software

Email [email protected]

Mail

Quest Software, Inc.

World Headquarters

5 Polaris Way

Aliso Viejo, CA 92656

USA

Web site www.quest.com

See our web site for regional and international office information.

About Quest Software

Now more than ever, organizations need to work smart and improve efficiency. QuestSoftware creates and supports smart systems management products—helping our customerssolve everyday IT challenges easier and faster. Learn more at www.quest.com.

Page 78: Toad InstallGuide

Index

A

Access

create connections 40

troubleshoot 48

C

Citrix

installation 15

requirements 5

client requirements 1

configure Toad 19

connections

configure DB2 client 27

create

Access 40

Excels 41

MySQL 42

ODBC 43

Oracle 22

SQL Server 45

Sybase ASE 46

DB2 LDAP support 26

Oracle LDAP support 22

share for all session windows 48

troubleshoot 62

Access 48

Informix 59

Oracle 60

Sybase ASE 63

troubleshoot DB2 LUW 53

troubleshoot DB2 z/OS 56

troubleshoot SQL Server 62

understand 47

contact support 74

corporate deployment 8

customize Toad 19

CVS, configure 68

D

DB2

troubleshoot LUW issues 53

troubleshoot z/OS issues 56

E

Excel

create connections 41

troubleshoot 49

I

Informix, troubleshoot 59

installation 6

Citrix 5, 15

client requirements 1

server requirements 2

silent 8

user privilege requirements 5

installation, read-only 7

Page 79: Toad InstallGuide

Toad for Data Analysts Installation Guide

Index76

L

LDAP

DB2 support 26

Oracle support 22

look and feel configuration 19

M

MySQL

create connections 42

troubleshoot 59

O

ODBC

create connections 43

Oracle

create connections 22

troubleshoot 60

R

read-only installation 7

register Toad 18

requirements

Citrix 5

client 1

server 2

user privilege 5

S

server requirements 2

shortcut keys

configure to match otherapplications

19

silent installation 8

create transform file 11

determine installer to use 8

executable 9

Microsoft installer (MSI) 11

prerequisites 9

SourceSafe, configure 66

SQL Server

troubleshoot 62

SQLServer

create connections 45

Subversion, configure 70

Sybase ASE

create connections 46

system requirements 1

T

Team Foundation Server, configure 66

TFS, configure 66

Toad

customize 19

transform file 11

troubleshoot

DB2 LUW connections 53

DB2 z/OS connections 56

Excel 49

Informix issues 59

Page 80: Toad InstallGuide

Toad for Data Analysts Installation Guide

Index77

MySQL 59

Oracle connections 60

SQL Server connections 62

version control 72

tutorials

create ODBC connections 43

U

uninstall Toad 18

user privilege requirements 5

V

Version Control 64

configure CVS 68

configure Subversion 70

configure TFS 66

configure VSS 66

troubleshoot 72

Visual SourceSafe, configure 66

VSS, configure 66


Recommended