Professional Documents
Culture Documents
8
Installation Guide
© 2017 Quest Software Inc.
ALL RIGHTS RESERVED.
This guide contains proprietary information protected by copyright. The software described in this guide is
furnished under a software license or nondisclosure agreement. This software may be used or copied only in
accordance with the terms of the applicable agreement. No part of this guide may be reproduced or transmitted
in any form or by any means, electronic or mechanical, including photocopying and recording for any purpose
other than the purchaser’s personal use without the written permission of Quest Software Inc.
The information in this document is provided in connection with Quest Software products. No license, express
or implied, by estoppel or otherwise, to any intellectual property right is granted by this document or in
connection with the sale of Quest Software products. EXCEPT AS SET FORTH IN THE TERMS AND
CONDITIONS AS SPECIFIED IN THE LICENSE AGREEMENT FOR THIS PRODUCT, QUEST SOFTWARE
ASSUMES NO LIABILITY WHATSOEVER AND DISCLAIMS ANY EXPRESS, IMPLIED OR STATUTORY
WARRANTY RELATING TO ITS PRODUCTS INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTY
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT. IN NO EVENT
SHALL QUEST SOFTWARE BE LIABLE FOR ANY DIRECT, INDIRECT, CONSEQUENTIAL, PUNITIVE,
SPECIAL OR INCIDENTAL DAMAGES (INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OF
PROFITS, BUSINESS INTERRUPTION OR LOSS OF INFORMATION) ARISING OUT OF THE USE OR
INABILITY TO USE THIS DOCUMENT, EVEN IF QUEST SOFTWARE HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES. Quest Software makes no representations or warranties with respect to the
accuracy or completeness of the contents of this document and reserves the right to make changes to
specifications and product descriptions at any time without notice. Quest Software does not make any
commitment to update the information contained in this document.
If you have any questions regarding your potential use of this material, contact:
Quest Software Inc.
Attn: LEGAL Dept
4 Polaris Way
Aliso Viejo, CA 92656
Refer to our web site (www.quest.com) for regional and international office information.
Patents
Quest Software is proud of our advanced technology. Patents and pending patents may apply to this product.
For the most current information about applicable patents for this product, please visit our website at
www.quest.com/legal.
Trademarks
Quest, Quest Software, Spotlight, LiteSpeed, SQL Navigator, vWorkspace, Toad, and the Quest logo are
trademarks of Quest Software Inc. in the U.S.A. and other countries. For a complete list of Quest Software
trademarks, please visit our website at www.quest.com/legal. Microsoft, Windows, Windows Server, Windows
Vista, Visual Studio, SQL Server, SharePoint, Access and Excel are either registered trademarks or trademarks
of Microsoft Corporation in the United States and/or other countries. Oracle is a trademark or registered
trademark of Oracle and/or its affiliates in the United States and other countries. Citrix® and XenApp™ are
trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United
States Patent and Trademark Office and in other countries. Subversion is a trademark of the Apache Software
Foundation. All other trademarks, servicemarks, registered trademarks, and registered servicemarks are
property of their respective owners.
Toad for SQL Server 6.8
Installation Guide
Thursday, August 10, 2017
Contents
Contents 3
Installation 5
System Requirements 5
Client Requirements 5
Server Requirements 6
Virtualization Support 7
User Requirements 7
Install Toad 8
Specify Application Data Directory Location 8
Install Toad Silently 9
Silent Installation Using the Executable 9
Install Toad on Citrix® Systems 11
Upgrade Toad 11
Upgrade Automation Scripts and Scheduling Tasks 12
Upgrade Automation Scripts to Newer Version of Toad 12
Migrate Scheduling Tasks to Newer Version of Toad 12
Files Migrated During Upgrades 13
Integration between Toad and Microsoft SQL Server Management Studio 15
Install and Uninstall Toad Plug-In 15
Uninstall Toad 16
Licensing 16
Notes for Toad for SQL Server Users 17
About Us 39
We are more than just a name 39
Our brand, our vision. Together. 39
Contact Quest 39
Technical Support Resources 39
Index 40
System Requirements
Review the following client and database server requirements for Toad® for SQL Server.
Client Requirements
Before installing Toad, ensure that your client system meets the following minimum hardware and software
requirements:
Requirement Details
Platform 2 GHz processor (recommended minimum)
Memory 4 GB of RAM minimum, 16 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
Hard Disk Space 104 MB to run Toad
Note: The disk space required may vary based on the edition of Toad selected for
installation.
Operating System Windows Vista® Service Pack 2 (32-bit or 64-bit)
Windows Server® 2008 Service Pack 2 (32-bit or 64-bit)
Windows Server® 2008 R2 Service Pack 1 (64-bit)
Windows Server® 2012
Windows Server® 2012 R2
Windows® 7 (32-bit or 64-bit)
Windows® 8 (32-bit or 64-bit)
Windows® 8.1 (32-bit or 64-bit)
Windows® 10
Important: Toad uses the Microsoft® Distributed Transaction Coordinator (DTC) when
opening a SQL file to get Full-Text Search status, but DTC is disabled by default on
Windows Vista, Windows Server 2008 and Windows 7. If you are using either operating
system, ensure that Network DTC access is enabled on the Toad client. See
http://technet.microsoft.com/en-us/library/cc753510(WS.10).aspx for more information
about enabling DTC access.
.NET Framework Microsoft® .NET Framework 4.5.1
Additional Web Browser
Server Requirements
Before installing Toad, ensure that your server meets the following minimum hardware and software
requirements:
Requirement Details
Database Server Limited support of SQL Server® 2000 (Service Pack 3 or later)
Note: The following features are not available:
l Index Defragmentation
l Storage Management
l Performance Monitor
l Spotlight Essentials Performance Analytics
l Altering procedures, functions, views in the Editor
l Version Control
SQL Server 2005 (Service Pack 2 or later) and SQL Server 2005 Express
SQL Server 2008 and SQL Server 2008 Express
SQL Server 2008 R2 and SQL Server 2008 R2 Express
SQL Server 2012 and SQL Server 2012 Express
SQL Server 2014 Enterprise and SQL Server 2014 Express
SQL Server 2016
Notes:
l SQL Server Compact Edition is not supported.
l Storage Management is not available on SQL Server Express.
User Requirements
To install Toad
1. Run the Installer.
2. Accept the License Agreement.
3. Select the products you want to install and click Install.
Note: When installing Toad using Quest Software Installer on Windows 7 64-bit, Program
Compatibility Assistant may appear with “This program might not have installed correctly” message.
Select This program installed correctly to continue installation.
See the following table for default (Roaming) and resulting (Local) directory path.
Caution: All current Toad settings will be lost after applying this Registry setting unless you manually copy
the settings files from the default location (Roaming directory) to the new location (Local directory). Copy the
settings files BEFORE you add the Registry setting and BEFORE opening Toad.
You can customize MSIEXEC command-line options and overrides for your installation similar to the
following command:
“ToadInstaller.exe” /S /Lx “C:\temp\installLog.txt” INSTALLDIR=”Drive:\your_
install_path” USERNAME=”some_user” COMPANYNAME=”your_company” ALLUSERS=1
Use the following descriptions to customize the command-line options and overrides for your installation.
Option Description
/L “C:\temp\ (Optional) Write installation messages to the specified log. You can append
installLog.txt” other options, such as x for debug (used in the previous example) or v for a
verbose log. See the log section at http://msdn2.microsoft.com/en-
us/library/aa367988.aspx for more information about additional logging
options.
Also, substitute “C:\temp\installLog.txt” in the example with the fully qualified
name of the log file. Enclose this value in double quotations. The installation
process creates this file if it does not exist. Otherwise, the existing file is
overwritten.
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 in which you want to install
Toad. If you do not include this path, the installation program defaults to:
C:\Program Files (x86)\Quest Software\Toad for SQL Server6.8.
ALLUSERS (Optional) Specify one of the following:
l For a per-machine installation, specify 1. This value allows any user to
use the Toad shortcut on the desktop after the installation completes.
l For a per-user installation, enter the empty string value (“”) This value
allows only the user specified for USERNAME (and the user that installed
Toad) to see the Toad shortcut on the target desktop. If USERNAME is
omitted, only the user that installed Toad sees the shortcut.
Note: If you do not specify this property, the installation program defaults to a per-
user installation.
USERNAME (Optional) Specify the user that intends to use Toad on the target computer.
Notes:
l If ALLUSERS is omitted or defined with the empty string value (""), only
the user specified here (and the user that installed Toad) can see the
Toad shortcut on the desktop after the installation completes.
l If ALLUSERS is omitted or defined with the empty string value ("") and you
omit the USERNAME option, only the user that installed Toad sees the
Toad shortcut on the desktop.
l If ALLUSERS is 1, the USERNAME value is ignored during installation.
COMPANYNAME (Optional) Specify the name of the company that owns this installation.
INSTALLSSMS (Optional) Set the property to "No" not to install Toad plug-in for Microsoft SQL
Server Management Studio.
Note: If you do not specify this property or specify any other value except "No",
Toad plug-in for Microsoft SQL Server Management Studio will be installed.
Notes:
l All default installation option overrides are case-sensitive.
l Enclose all values (except for the ALLUSERS value) in double quotations.
4. During installation, select the Anyone who uses this computer checkbox when prompted.
5. Repeat steps 2 through 4 for each server in the Citrix farm.
Note: Although you must install Toad on every server in the Citrix farm, you only need to
publish Toad once.
6. Review the following considerations regarding licensing:
l A license supplied by an administrator always overrides a user-supplied license in a Citrix
environment.
l If you need to provide the same Toad functionality to all users, you can enter the default license
key for all users.
l If you have users with different license requirements (for example, some have Standard licenses
and others have Professional licenses), individual licenses should be entered for each user. You
should not enter the default license key because it enables all functionality in Toad.
Upgrade Toad
To upgrade Toad
1. Run Toad installer from the DVD or downloaded file.
2. Select the products you want to install and click Install.
If you are upgrading from a previous version of Toad, you are prompted to migrate your settings the first time you
start Toad. The settings files include database connections, layout customizations, shortcut keys, and options
customized in the Options pages.
To migrate the settings again, remove or rename the current version's Application Data folder and migrate the
files from the previous version's Application Data folder.
Note: The Diagnostic Server is no longer used by Toad for SQL Server. If the Diagnostic Server was installed
with a previous release of Toad for SQL Server then uninstall that program. Use Control Panel | Programs and
Features | Uninstall or change a program and select to uninstall the Toad for SQL Server Diagnostic Server.
Caution: If you upgrade an automation script, it will no longer be compatible with earlier
versions of Toad.
3. Select No (and do not elect to save the script), to keep the script compatible with the previous version.
4. If you selected Yes, Toad upgrades your script and saves a backup copy of the original script in the
following location:
<application data directory>\Automation\bak\
5. If the script you upgraded is also scheduled, you must migrate the scheduling task, otherwise the
upgraded script will fail to run.
Caution! Migrating settings from a previous version of Toad may overwrite new settings files, implemented
for the current release (for example, updated reports templates, layouts, etc).
File Description
Action.log Tracks your usage within Toad. If you agree to share this data, the file is
automatically sent to Quest Software on a periodic basis.
l Schema Compare
l Importing and Exporting Data
l Session Browser
l Performance Monitor
l Index Fragmentation
l and etc.
Note: If you have several editions of Toad for SQL Server installed side-by-side (for example, Beta, Trial and
Commercial) and you uninstall one of them, Toad Plug-in files are removed as a part of un-installation
process. See "Troubleshoot SQL Server® Issues" on page 20 for more information about how to manually
restore Toad Plug-in.
Where:
[Type of Product/Mode] can be Uninstall, Freeware, Beta, Commercial, Trial
[TSS Installation Directory] is the directory where Toad for SQL Server resides.
Example:
C:\Program Files (x86)\Quest Software\Toad for SQL Server 6.8\SSMS
Installation\SsmsInstallation.exe Commercial "C:\Program Files (x86)\Quest
Software\Toad for SQL Server 6.8"
Uninstall Toad
If you uninstall Toad, it may not uninstall completely. When you use Toad, you create new files such as SQL
scripts, data output, or temp files, etc. The following types of files are not removed when you uninstall:
l Any new files you create
l Any copies of files you make for backup purposes
l Settings files
You can uninstall Toad for SQL Server by using the Windows install/uninstall programs feature.
To uninstall Toad
1. Open the Windows Control Panel and select Programs and Features.
2. Select the product that you want to uninstall.
3. Click Uninstall.
Licensing
To enter your license key
1. Select Help | Licensing from the menu (ALT+H+L).
2. Review the following for additional information:
Note: Your license key determines the edition of Toad (Pro, Xpert, etc.) and will enable the functionality
accordingly. In many cases, if functionality is disabled within Toad, you may not have an appropriate
license to use it. When Toad is running, you can see which components are licensed by selecting Help |
About. For complete list of features shipped with your Toad edition see http://www.quest.com/.
Trial Keys
The commercial version of Toad for SQL Server comes pre-installed with a trial license key for your
convenience. This allows you to use the application while waiting for your commercial key to be delivered.
The trial license key remains active for the designated trial period, even after you enter your commercial license
key (the splash screen may continue to indicate your application is a trial version). This is helpful if you are
previewing an upgrade or an advanced module.
Important: When installing commercial Toad for SQL Server bundle after trial Toad for SQL Server bundle,
the commercial bundle recognizes a license key from the trial bundle and expires the same date as the trial
bundle's key. To continue working with the commercial bundle please input a valid (commercial or new trial)
license key.
If you entered your commercial license key and do not require the trial version, you can delete the trial key.
Important: If you delete the Trial key, any advanced features not included in your purchased edition will
be disabled.
4. Click Connect to save the connection and immediately connect to the database.
or
Click Save to save the connection without connecting to the database.
Tip: Connections are stored in the connections.xml file and can be found by clicking the Application Data
Directory link in Help | About.
1. Click .
Issue Cause/Solution
When installing Toad on Solution:
Windows 7 64-bit, Program Select This program installed correctly to continue installation. For more
Example:
C:\Program Files (x86)\Quest Software\Toad for SQL
Server 6.8\SSMS Installation\SsmsInstallation.exe
Commercial "C:\Program Files (x86)\Quest
Software\Toad for SQL Server 6.8"
Connection Issues
Review the following solutions to help troubleshoot SQL Server connection issues in Toad.
Issue Cause/Solution
Cannot specify a port number Currently, Toad does not have a separate field for specifying a port number.
when connecting Solution:
You can connect if you know the port number for the instance by entering
the following in the Server name field on the New Connection window:
ServerName,Port
or
Prerequisites
You must install a supported version control client on the computer where Toad is installed. The following table
lists the supported version control providers and the versions tested with Toad.
Supported
Provider Server Version Tested Client Version Tested
Apache Subversion 1.7.5 on CollabNet Subversion Command-Line Client 1.7.5
Subversion™ Windows Note: Any Subversion client must have svn.exe in its installation
directory to use version control in Toad.
Git Toad works only with the local repository. For commands such as clone, pull and push use
an external tool.
Team TFS 2008, 2010, 2012, Visual Studio® (2008, 2010, 2012, 2013) Team Explorer Client
Foundation 2013, 2015
Server (TFS)
File system Toad allows to utilize practically any version control system using the external client tool. In
based this case Toad Version Control tool works with the directories at local HDD while you commit
changes to the repository with version control client tool.
TABLE
VIEW
STORED PROCEDURE
FUNCTION
SEQUENCE
UDDT
RULE
DEFAULT
SQL SCRIPT
Note: Additional functionality and compatibility with older clients is possible but out of scope of what we are
able to test.
Note: Even if you previously configured version control for objects, you must run the Version Control
Wizard again to configure version control for files.
3. Use the wizard to provide information about your version control system to Toad. Review the following
for additional information:
Field/Button
Version Control System Page
Type Select Subversion.
Properties Click the Properties button and enter the path to the Subversion
executable (svn.exe) on the client computer. For example, if using
TortoiseSVN, the path might be:
C:\Program Files\TortoiseSVN\bin
Note: Do not include svn.exe in the path.
Server Enter the URL for the Subversion repository on the Subversion
server.
Login and Password Enter the user name and password for your Subversion account.
Default Version Control
Settings Page
Version Control Folder Select the folder on the Subversion server where you want to
check in files.
If you currently have files under version control, select the folder on
the server where these files are located.
Working Folder Select a folder on the client computer to use as the root working
folder. This is the location into which you will check out files.
If you currently have files under version control, select your
existing working folder.
Action Description
Open Open the file in Toad.
Commit Commit your changes. Available for Modified or Untracked files.
Undo Changes Discards your changes and reverts to the previous revision of the file
(previous commit). Available when the file status is Modified.
Get Latest Version Check out the latest revision from the remote repository. Available when
the file status is OutOfDate.
Additional Actions
l To open the folder where a file is located, open the file and then right-click the document tab and select
File Version Control | Open in Windows Explorer.
4. Manage object and scripts using Version Control. See "Manage Objects under Version Control" on page
28 for more information.
Use To...
Show perspective Select to review all controlled objects for current configuration.
Diff Select to review differences between the object script in your local
database and the object's revision that was applied to it.
Note: Diff is unavailable for File System Based configuration.
Diff with latest revision Select to review differences between the object script in your local
database and the latest revision in the version control repository.
Example: You got the latest object revision from the repository 2 days ago. By the time you did it, the
latest revision was 5. Yesterday your colleague worked with the same object and committed changes
in the repository, which are now marked as revision 6.
Today you altered the object's script and want to see the differences. You can select one of the
following:
l Diff—To compare the object in your local database with revision 5.
l Diff with latest revision—To compare the object in your local database with revision 6.
Show history Select to review all commits for selected object.
Tip: Select Show history on database to review all commits.
Note: Show History is unavailable for File System Based
configuration.
Get latest revision Select to apply object's changes from the version control repository to
your local database. The synchronization script is generated to update
selected object to the latest revision.
Commit Select to apply object's changes from your local database to the
version control repository.
Note: You should write a comment when committing changes.
Undo changes Select to rollback changes in your local database. The synchronization
script is generated to revert object to the revision which was a applied
last time.
Update status Select to compare a script in your local database with the script in the
repository. New status will be issued according to the comparison
results.
Add to ignore list Select to exclude object from the version control. Ignored objects are
not listed in Controlled Objects pane, Commit and Get latest revision
are disabled.
Remove from ignore list Select to set object status as Untracked and add it to version control.
Open in Windows Explorer Select to navigate to the file in the Windows Explorer.
l In previous releases, the method Toad used to generate the script was different than the current method.
After upgrading Toad and reconfiguring version control, the local revision of the objects differs from
version control repository (The objects have Unknown status). If the object in your database is current,
you should commit it into version control.
Apache Description
Subversion™
Issues
System If a message stating that, “The system cannot find the file specified” displays, this usually
cannot find means that the Subversion executable cannot be found in the path you specified in the
file BinaryPath field of the Command Based Version Control Properties window. Verify that
svn.exe exists in the directory you specified in this field.
Command When executing Subversion commands, user input is not allowed. This presents an issue
execution when the user is using Subversion with the SSH method and must enter a password to
establish the Secure Shell.
Workaround:
Generate identity keys that automatically authenticate between the client and the server
when connecting with SSH.
OutOfMemory When adding a large number of objects, Subversion may encounter OutOfMemory
exception exception.
when adding Workaround:
a large
Commit objects in several steps.
number of
objects
SVN is If Subversion is missing in the list of available version control providers, it means that
missing in the Subversion.xml was removed or corrupted.
list of Workaround:
available
Contact Support to get a new Subversion.xml and place it under <Toad install
providers
path>/Templates/Version Control/.
Object Issues Description
Adding When you add multiple objects to version control, the objects are grouped and added in
multiple batches (for example, all the tables for a particular schema are added at once). If an error
objects failed (for example, failure to support Korean characters) causes this command to fail, none of
the objects are added.
SQL Server 2012 and SQL Server 2014 Platforms Tested for Debugging
Client Server
2003 EE
(SP1)
Vista
Server
2008
Client Server
2003 EE
(SP1)
Vista
Server
2008
Client Server
2003 EE
(SP1)
Vista
Server
2008
Client Server
2003 EE
(SP1)
Vista
Server
2008
2. If autocommit is disabled, commit or rollback the connection in Toad before starting the
debugging session.
Note: If you are unable to locate this file, you can run the remote debugging setup component
(rdbgsetup.exe). This file is located by default in the following directory on the server where SQL
Server 2005 is installed:
C:\Program Files\Microsoft SQL Server\90\Shared\1033
2. Make sure the following permissions are set:
l Your Windows account that Toad is running under must be a member of sysadmin server role in
the SQL Server being debugged.
l Your server login must also be a member of the sysadmin role. This login can be your Windows
user account (Windows authentication), or a SQL Server login (SQL Server authentication).
To create a server login from your Windows account and add it to the sysadmin role, a user who
already has sysadmin privileges must execute the following:
sp_addsrvrolemember 'Domain\Name', 'sysadmin'
Note: The Remote Procedure Call (RPC) service should be started on both the Toad
client and server.
2. Make sure the following permissions are set:
l Your Windows account that Toad is running under must be a member of the sysadmin server role
for the instance you are debugging.
l Your server login must also be a member of the sysadmin role. This login can be your Windows
Set Up Debugging
The Debugger Setup wizard checks your database library and settings files on both the server and client system
to identify conflicts with the Debugger.
The wizard verifies the following on the server:
l Existence of the corresponding DLL files
l DLL version (determines whether Toad has permission for their verification)
l COM registration
l DCOM support
Contact Quest
For sales or other inquiries, visit www.quest.com/company/contact-us.aspx or call 1-949-754-8000.
A L
application virtualization 7 license keys 16
automation
M
migrate scheduled tasks 13
manage objects under Version Control 28
upgrade scripts 12
R
C
requirements
Citrix
Citrix 7
install 11
client 5
requirements 7
virtualization 7
client requirements 5
connections
S
create SQL Azure 19 server virtualization 7
create connections 19
D
troubleshoot 20
debugger
Subversion, configure 27
configure SQL Server 33
system requirements 5
verify installed components 38
desktop virtualization 7
T
Team Foundation Server, configure 27
I
TFS, configure 27
install 8
Toad Plug-in 15
Citrix 11
troubleshoot
Citrix support 7
SQL Server connections 20
client requirements 5
version control 31
silent 9
intergration with Management Studio 15
U
uninstall 16