Dell Toad for SQL Server 6.5 database software Installation Guide
विज्ञापन
विज्ञापन
Toad™ for SQL Server
®
6.5
Installation Guide
© 2014 Dell 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 Dell Inc.
The information in this document is provided in connection with Dell 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 Dell products. EXCEPT AS SET FORTH IN
THE TERMS AND CONDITIONS AS SPECIFIED IN THE LICENSE AGREEMENT FOR
THIS PRODUCT, DELL 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 DELL 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 DELL HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES. Dell 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.
Dell 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:
Dell Inc.
Attn: LEGAL Dept
5 Polaris Way
Aliso Viejo, CA 92656
Refer to our web site ( software.dell.com
) for regional and international office information.
Trademarks
Dell, the Dell logo, Quest, Spotlight, LiteSpeed, SQL Navigator, vWorkspace, and Toad are trademarks of Dell Inc. and/or its affiliates. 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. Other trademarks and trade names may be used in this document to refer to either the entities claiming the marks and names or their products. Dell disclaims any proprietary interest in the marks and names of others.
Toad for SQL Server 6.5
Installation Guide
Tuesday, 1 July 2014
Table of Contents
Installation
System Requirements
Install Toad
Specify Application Data Directory Location
Install Toad Silently
Determine Which Installer to Use
Silent Installation Prerequisites
Silent Installation Using the Executable
Silent Installation Using the Microsoft Installer
Install Toad on Citrix® Systems
Upgrade Toad
Upgrade Automation Scripts and Scheduling Tasks
Upgrade Automation Scripts to Newer Version of Toad
Migrate Scheduling Tasks to Newer Version of Toad
Files Migrated During Upgrades
Integration between Toad and Microsoft SQL Server Management Studio 24
Install and Uninstall Toad Plug-In 25
Uninstall Toad 26
Licensing
Notes for Toad for SQL Server Users
Create and Troubleshoot Connections
Understand Toad Connections
26
28
28
6
10
10
6
11
19
20
20
22
Toad for SQL Server Installation Guide
Table of Contents
4
Sharing a Connection Among Windows
Create SQL Server and SQL Azure Connections
Troubleshoot SQL Server® Issues
Toad Plug-in for Microsoft® SQL Server Management Studio Issues
Configure Version Control
About Version Control
Configure Version Control
Manage Objects under Version Control
Troubleshoot Version Control
Configure SQL Server Debugging
Configure SQL Server Debugging
Configure Debugging for SQL Server 2012 / SQL Server 2014
Configure Debugging for SQL Server 2008
Configure Debugging for SQL Server 2005
Configure Debugging for SQL Server 2000
Set Up Debugging
About Dell
Contact Dell
Technical Support Resources
38
42
35
35
36
31
29
44
44
50
52
52
52
Toad for SQL Server Installation Guide
Table of Contents
Index
5
54
1
Installation
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:
Platform
Memory
600 MHz minimum, 1 GHz recommended
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
Hard Disk
Space
Operating
System
104 MB to run Toad
Note: The disk space required may vary based on the edition of Toad selected for installation.
Windows Server® 2003
Windows® XP Professional (32-bit or 64-bit)
Windows Vista® (32-bit or 64-bit)
Windows Server 2008 (32-bit or 64-bit)
Windows Server 2008 R2 (64-bit)
Windows 7 (32-bit or 64-bit)
Windows 8 (32-bit and 64-bit)
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.
Toad for SQL Server Installation Guide
Installation
.NET
Framework
The Microsoft® .NET Framework is required. The version is dependent on the operating system.
.NET 4.5
.NET 4.0
Windows Vista SP2, Windows 7, Windows 8,
Windows Server 2008 (SP2 or earlier), Windows
Server 2008 R2, Windows Server 2012
Windows XP, Windows Vista (SP1 or earlier),
Windows Server 2003
Note: The .NET Framework 4 Client Profile is not supported.
Additional
Requirement s
Web Browser
Microsoft® Internet Explorer® 6.0 or later
Copy/Move Database Wizard
The SQL Server Backward Compatibility package is required to use the Copy/Move Database wizard.
Log Reader
The Log Reader requires version 8.0 DLL files in the Microsoft Visual
C++ 2005 SP1 Redistributable Package. If these files do not exist on the client, you will need to install them to use some functionality in the Log Reader.
http://www.microsoft.com/downloads/details.aspx?FamilyID=200B2FD
9-AE1A-4A14-984D-389C36F85647&displaylang=en
Server Requirements
Before installing Toad, ensure that your server meets the following minimum hardware and software requirements:
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
7
Toad for SQL Server Installation Guide
Installation
Cloud
Database
Service
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
Notes:
l
SQL Server Compact Edition is not supported.
l
Storage Management is not available on SQL Server Express.
SQL Azure
Note: To be able to utilize a majority of Toad functionality, please grant VIEW DEFINITION on the SQL Azure databases you want to work with.
Virtualization Support
Application
Virtualization
Limited testing has been performed for Citrix® XenApp™ 5.0 on
Windows Server 2003 and Citrix XenApp 6.5 on Windows Server
2008 R2.
Limited testing has been performed for Citrix support on Windows
Server 2003 Enterprise Server (Service Pack 2) using the MetaFrame
Presentation Server 5.0 and Citrix Presentation Server Clients 10.2.
See "Install Toad on Citrix® Systems" (page 19) for more information.
Desktop
Virtualization
(VDI)
Toad has been tested with vWorkspace™ 7.6 running on Windows
Server 2008 R2 64-bit.
Note: Toad may work in virtualization environments other than the ones in which it was tested.
User Requirements
User Requirements to Install Toad
Only Windows Administrators and Power Users can install Toad.
If an Administrator installs Toad, the Administrator can share the Toad shortcut icon on the desktop and menu items with any user—a Power User, Restricted User, Vista standard user— on the computer.
If a Power User installs Toad, a Restricted User cannot do the following: l
Associate file extensions.
8
Toad for SQL Server Installation Guide
Installation l
View the Toad shortcut icon on the desktop or the Toad menu options in the
Windows Start menu. As a workaround, Restricted Users can create a shortcut to Toad from the install directory and place the shortcut on their desktop.
User Requirements and Restrictions for Running Toad
The following describes the requirements and restrictions for users who launch and run Toad: l
To create or modify the QuestSoftware.ToadSecurity table to enable Toad Security, the user who maintains this table must have privileges to create, insert, update, and delete it. All other users need only the ability to read the QuestSoftware.ToadSecurity
table to use Toad Security features.
9
Toad for SQL Server Installation Guide
Installation
10
.
Install Toad
Note: Your Toad for SQL Server license key determines the edition and will enable Toad for
SQL Server functionality accordingly. In many cases, if functionality is disabled within Toad for SQL Server, 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.
To install Toad
1. Run the Installer.
2. Accept the License Agreement.
3. Select the products you want to install and click Install.
Caution! When installing Toad using Dell Software Installer on Windows 7 64bit, Program Compatibility Assistant may appear with “This program might not have installed correctly” message. Select This program installed correctly to continue installation.
Specify Application Data Directory Location
Toad for SQL Server 6.5 stores settings files in the user's Application Data directory. The default location cannot be modified from within the application. Toad provides two methods to change the default location: by using a Registry setting or by using a command switch in a Toad shortcut.
Use the Registry setting method to change the application data directory from Roaming to
Local. Use the command switch method to change the location to any new path.
To change Toad Application Data directory location from Roaming to Local
In the Registry under Toad for SQL Server (Computer\HKEY_CURRENT_
USER\Software\Quest Software\Toad for SQL Server\6.5), add LOCALSETTINGS with a value of 1.
See the following table for default (Roaming) and resulting (Local) directory path.
Caution: All current Toad settings will be lost after applying this Registry setting unless you manually 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.
Toad for SQL Server Installation Guide
Installation
11
Operating System
Windows XP
Windows Server 2003
Windows Vista
Windows Server 2008
Windows 7
Windows 8
Default Location
C:\Documents and
Settings\username\
Application Data\Quest
Software\Toad for SQL
Server 6.5
C:\Users\username\
AppData\Roaming\Quest
Software\Toad for SQL
Server 6.5
New Location when
LOCALSETTINGS = 1
C:\Documents and
Settings\username\ Local settings\Application
Data\Quest Software\Toad for SQL Server 6.5
C:\Users\username\
AppData\Local\Quest
Software\ Toad for SQL
Server 6.5
To change Toad Application Data directory location using a command-line switch
You can override the default Application Data directory by running Toad with the command switch:
Toad.exe --datadir="YourNewDirPath"
To instruct Toad to always use the new directory path, add the command switch and the new directory path to a Toad desktop shortcut. Then use the desktop shortcut when opening Toad.
1. To add the command switch, right-click the Toad shortcut and select Properties.
2. Enter the command switch and add the directory path in quotes (replace
"YourNewDirPath" with your directory path).
Install Toad 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.
Note: To perform a silent install, you can use either stand-alone installer or extract the .msi
from the Dell Software Installer, provided with Toad Suite.
Determine Which Installer to Use
Before performing a silent installation, review the following to determine which installer to use:
Installer
Executable file (.exe)
Advantages
Silent installation using the .exe
file has the following advantages:
Disadvantages
Silent installation using the .exe
file has the following disadvantages:
Toad for SQL Server Installation Guide
Installation
Installer
Microsoft
Installer file
(.msi)
Advantages
l
Verifies whether the prerequisite software is installed, and if not, redirects you to the download location.
l
Verifies whether a version of Toad already exists on the target computer. If so, the executable uninstalls the previous version and then installs the current version.
Supports deployment of Toad settings files and license keys.
Disadvantages
l
Cannot deploy custom
Toad settings files or license keys.
l
Installer automatically exits if the prerequisite software is not installed.
Silent installation using the .msi
file has the following disadvantages: l
Requires manual verification and download of any prerequisite software.
l
Requires a manual uninstall of the previous version of Toad using
Add/Remove Programs.
Silent Installation Prerequisites
Before you perform a silent installation, you must install the following software on every computer where you are installing Toad: l
Microsoft .NET Framework 4.0
Silent Installation Using the Executable
Use the executable file to perform a silent install to the default directory (or to a different directory) 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 the executable for Toad is located. (This file can be downloaded from the Dell Software
Web site or can be found on the Toad installation CD-ROM.)
2. For a standard installation with all features enabled, enter the following command:
12
Toad for SQL Server Installation Guide
Installation
13
“ToadInstaller.exe” /S
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.
Command-Line Options
The following MSIEXEC command-line options are used in this example:
Option
/L “C:\temp\
installLog.txt”
Description
(Optional) Write installation messages to the specified log.
You can append 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/enus/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.
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
INSTALLDIR
ALLUSERS
Description
(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\Quest Software\Toad for SQL Server 6.5.
(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.
Toad for SQL Server Installation Guide
Installation
Option Description
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.
Silent Installation Using the Microsoft Installer
For Toad purchased with the Suite you should extract the .msi from the Dell Software
Installer first.
14
Toad for SQL Server Installation Guide
Installation
15
Extract MSI file from Dell Software Installer
The Dell Software Installer can be launched in "extraction mode," which allows you to extract the Toad for SQL Server MSI installer.
Note: You do not need to install the Dell Software Installer on any of the computers where you are silently installing Toad products. The Dell Software Installer is only used to extract the required MSI files.
To launch the Dell Software Installer in extract mode
1. Run Toad from the command prompt and include the command-line switch "/extract".
"ToadInstaller.exe" /extract
2. The Dell Software Installer launches in extract mode. In the Extract Location page, specify a target location for the extracted files by entering or browsing to a directory.
3. In the Product Selection page, select the products that you want to extract.
4. Click Extract to extract the files.
The Finish page has a link to the directory into which the files were extracted and a link to the log file for the extraction process (Readme.txt). The extraction log contains verification of the files that have been extracted along with the command-line switches required for performing the default installation. You must run the installers in the order specified.
Perform Silent Installation Using MSI
To perform a silent install using msi
1. At a Windows command prompt, switch to the drive or directory where the msi installer for Toad is located.
2. For a standard installation with all features enabled, enter the following command:
“ToadInstaller.msi” /q
You can customize command-line options and overrides for your installation similar to the following: msiexec /i “ToadInstaller.msi” INSTALLDIR= “Drive:\your_install_
path” /q USERNAME=”some_user” COMPANYNAME=”your_company”
ApplicationUsers=”AllUsers”
Toad for SQL Server Installation Guide
Installation
Command-Line Options
The following MSIEXEC command-line options are used in this example:
Option
/i
Description
/q
Run the installation.
Specify the user interface (UI) that displays during installation.
You can append other options, such as n to hide the UI or b to hide the Cancel button during the installation.
Note: All command-line options are case-insensitive. See http://msdn2.microsoft.com/en-us/library/aa367988.aspx
for a complete list of command-line options.
Toad Default Installation Option Overrides
You can specify the following values to override Toad’s default installation options.
Enclose each value in double quotations.
Option
INSTALLDIR
ALLUSERS
USERNAME
Description
(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\Quest Software\Toad for SQL Server 6.5.
(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.
(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
16
Toad for SQL Server Installation Guide
Installation
17
Option Description
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.
Create Transform (MST) Files
You can create a Microsoft transform (.mst) file that deploys the license key, custom settings, and connections for users when performing a silent install using the .msi file. You can also use the .msi file to perform a basic silent install using the default directory (or install to a different directory) and to specify command-line options and default installation overrides.
See "Perform Silent Installation Using MSI" (page 15) for more information if you are not
creating a transform file.
Note: (MSI installs on Windows Vista and 7) If you are using MSI to install Toad on
Windows Vista or 7 with UAC enabled, you can install a file that adds a "Run as administrator" option when right-clicking the MSI file: http://www.symantec.com/connect/downloads/msi-run-administrator-context-menu-vista .
The following procedure uses the Wise Installer to create the transform file.
To create a transform file that includes custom Toad settings
1. Save and install the ToadInstaller.msi file on a computer where the Wise for Windows
Installer is installed. After customizing Toad settings, you will use the Wise Installer to create the transform file.
Toad for SQL Server Installation Guide
Installation
2. Open Notepad, and do the following: a. Enter the license key in the first line.
b. Enter the site message in the second line.
c. Save the file with license.key as the file name in the Toad install directory.
Make sure the file extension is .key not .txt.
3. Launch Toad. The application should open without prompting you to enter a license key.
4. Select Tools | Configuration Wizard from the Toad menu and complete the
Configuration wizard. 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. These options create a module settings folder and files.
7. Select View | Connection Manager from the menu in Toad to open the
Connection Manager.
8. Create any connections you want to deploy.
9. Exit Toad. Upon exiting, a Connections file is created.
10. Create the Microsoft Transform file, using any appropriate tool. The following steps describe how to use the Wise for Windows Installer to create the file. a. Select File | New.
b. Select Custom Templates under Categories, and then select the Transform template in the New Installation File window.
c. Select the ToadInstaller.msi file in the Select the .MSI file to base this transform on window.
d. Save the project.
e. Select Files from the Feature Details view.
f. Locate the following files and click Add to add them to the project:
File to Add Windows XP, Windows
Server 2003
Settings.xml
C:\Documents and
Settings\
username\Application
Data\Quest Software\
Toad for SQL Server
6.5.
Windows Vista,
Windows Server 2008,
Windows 7, Windows 8
C:\Users\
username
\AppData\Roaming\
Quest Software\Toad for
SQL Server 6.5.
18
Toad for SQL Server Installation Guide
Installation
19
File to Add Windows XP, Windows
Server 2003
ModuleSettings folder and files
C:\Documents and
Settings\
username\Application
Data\Quest Software\
Toad for SQL Server
6.5\ModuleSettings.
Connections.xml
C:\Documents and
Settings\
username\Application
Data\Quest
Software\Toad for SQL
Server 6.5.
Windows Vista,
Windows Server 2008,
Windows 7, Windows 8
C:\Users\
username
\AppData\Roaming\
Quest Software\Toad for
SQL Server
6.5\ModuleSettings.
C:\Users\
username
\AppData\Roaming\
Quest Software\Toad for
SQL Server 6.5.
g. Save the project and compile it to create the transform (MST) file.
Install Toad on Citrix
®
Systems
Toad must be installed on the Citrix server by the Citrix administrator. Users then connect to this instance through their Citrix login.
Note: Limited testing has been performed for Citrix XenApp™ 5.0 support on Windows
Server
®
2003 and for Citrix XenApp 6.5 on Windows Server 2008 R2.
To install Toad on a Citrix system
1. Connect to the Citrix Environment as an administrator.
2. Copy Toad to the Citrix server, if needed.
3. Start the Toad installation process.
4. During installation, select the Anyone who uses this computer checkbox when prompted.
5. Repeat steps 2 through 4 for each server in the Citrix farm.
Note: Although you must install Toad on every server in the Citrix farm, you only need to publish Toad once.
Toad for SQL Server Installation Guide
Installation
20
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.
Upgrade Automation Scripts and Scheduling
Tasks
If you upgrade to a newer version of Toad, Automation scripts created in a previous version must be upgraded before you can open them in the newer version. Toad prompts you to automatically upgrade a script when you attempt to open it in a newer version.
In addition, scheduled scripts are scheduled to run using the version of Toad in which they were created. After upgrading Toad, those previously-created, scheduled scripts will not execute in the newer version until you migrate each script's scheduling task. Toad prompts you to migrate scheduling tasks when you initially launch the application after installation.
Upgrade Automation Scripts to Newer Version of Toad
An automation script is compatible with the version of Toad in which the script was created.
If you want to open and/or modify a script using a newer version of Toad, you must upgrade the script. Toad automatically prompts you to upgrade the script the first time you open it in the newer version.
Toad for SQL Server Installation Guide
Installation
To upgrade an Automation script
1. Open the script in Toad. Toad prompts you to upgrade the script.
21
2. To upgrade the script, select Yes.
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.
Migrate Scheduling Tasks to Newer Version of Toad
Each scheduled Automation script uses a Windows scheduling task. The scheduling task specifies which version of Toad to use by specifying the version's application path. Toad provides you with two easy ways to migrate your scheduled scripts' scheduling tasks when you upgrade Toad. First, Toad prompts you to migrate scheduling tasks upon initial launch of the application after installation. Next, you can migrate scheduling tasks at any time using the Job Manager.
Notes:
l
If you upgrade a previously-created script by opening it in a newer version of Toad, you must also migrate the scheduling task to the newer version.
l
If you install the newer version of Toad side-by-side with the older version, previously-created, scheduled scripts will continue to execute using the older version, until you migrate the scheduling tasks (provided that you do not open the scripts in the newer version).
Toad for SQL Server Installation Guide
Installation
To migrate scheduling tasks upon initial launch
1. After upgrading Toad, and upon initial launch of the application, the Migrate
Scheduled Tasks dialog opens.
2. Select the scheduled tasks (scheduled Automation scripts) to migrate to the new version of Toad.
3. Click OK to close the dialog.
4. Toad immediately prompts you for your Windows password. Enter your password to migrate the scheduled tasks.
To migrate scheduling tasks using the Job Manager
1. Select Tools | Administer | Job Manager.
2. Click on the Job Manager toolbar.
3. Select the scheduled tasks to migrate and click OK.
Note: Only currently-scheduled tasks (enabled or disabled) are listed in the Migrate
Scheduled Tasks dialog.
4. Toad immediately prompts you for your Windows password. Enter your password to migrate the scheduled tasks.
Manually Edit Scheduling Tasks
On occasion you may need to modify the application path in a Windows scheduling task.
You can do this by manually editing the scheduling task using the following procedure.
To manually edit a scheduling task
1. In the Job Manager (Tools | Administer | Job Manager), right-click a task and select Edit Task.
2. To change the version of Toad used to run the script, in the Run and Start in fields, change the folder name in the toad.exe path.
Files Migrated During Upgrades
When upgrading to a new version of Toad, the following files can be migrated from the previous version's Application Data Directory (click the Application Data Directory link in
Help | About to open the directory).
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
22
Toad for SQL Server Installation Guide
Installation
Action.log
Connections.xml
ConnectionTrace.log
ExceptionTrace.log
FTPConnection.log
Tracks your usage within Toad. If you agree to share this data, the file is automatically sent to Dell on a periodic basis.
Contains all connections stored in the Connection
Manager or the New Connection window.
Contains the SQL Output connection trace log file if you select Tools | Execution Trace from the menu.
Contains a log of all exceptions encountered while running Toad.
Contains a log of exceptions encountered when attempting to connect to FTP servers.
FTPConnections.xml
Contains connections to FTP servers stored in the
FTP Connections window.
Quest.PersistentCache.xml
Contains the private object annotation cache options
(object notes, Lookup tables, and hidden columns). You can share these options with other Toad users in Tools
| Options | Database | Cache.
Settings.xml
Contains many of the global configuration settings.
SqlServerPlanPrefs.xml
ToadSupportBundle.zip
Used to generate SQL Server execution plans.
Contains the last support bundle you generated.
Folder
Automation (temporary folder)
Cache
Description
Used by automation when executing automation scripts.
Context
Used to spool cache database metadata to disk if enabled. The data is in binary format and can always be recreated by fetching it from the database.
Contains settings that depend on the context within
Toad including the following: l
Adapter—Custom data editing statements.
l
Filter—Unnamed filters defined in the Object
Explorer or Database Explorer.
l
Named Filter—Named filters defined in the
Object Explorer or Database Explorer.
l
TYPE—Tabs that display on the right when you select an object in the Object Explorer or
23
Toad for SQL Server Installation Guide
Installation
24
Document Recovery
Keyboard
Layouts
ModuleSettings
Plugins
Session
SQLFormatter
SQLRecall
Templates
Database Explorer.
Contains backup copies of Editor, Query Builder, and
Database Diagram files saved if you have enabled
Document Recovery in Tools | Options | Environment |
General.
Contains custom keyboard shortcut layouts.
Contains layouts for some areas in Toad, such as tool windows that automatically display in the Editor and column layouts for the Messages tab.
Contains general settings for various components in
Toad, such as whether the data grid defaults to readonly, displays not null indicators, etc.
Used by Toad plugin components.
Contains desktop configurations, including toolbar customizations and tool window locations.
Contains pre-set and user created templates for formatting SQL, and the SQL statement used to preview formatting changes in the Formatting Options page.
Contains the SQL statements saved by SQL Recall.
Contains the following templates: l
Code Templates—Templates used to define default values when creating new objects in the
Object Explorer or Database Browser.
l
Scripts—Startup scripts to run when connecting
(InitialSqlServer.Sql).
l
Snippets—Code Snippet entries.
l
Reports—Report entries.
Integration between Toad and Microsoft SQL
Server Management Studio
Toad provides a plug-in that integrates Toad features with Microsoft SQL Server
Management Studio. Enjoy the advantages of both products and ease of communication. The
Toad Plug-in is installed as a part of the Toad for SQL Server installation process and supports the following versions of Management Studio:
Toad for SQL Server Installation Guide
Installation
25 l
Microsoft SQL Server Management Studio 2014 l
Microsoft SQL Server Management Studio 2012 l
Microsoft SQL Server Management Studio 2008 R2 SP2 or later
The Toad Plug-in allows you to invoke key Toad features right from the Management Studio context menu and to send data directly into Toad. Connection information and security settings are transferred automatically and Toad functionality is already up and running.
Depending on the Toad Edition you are running, the following Toad features can be invoked from Management Studio: l
Group Execute l
Automation l
Log Reader l
Data Compare 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
Install and Uninstall Toad Plug-In
Launch SsmsInstallation.exe from the Windows command prompt as administrator.
1. Open SSMS Installation directory (
<Toad install directory>/ SSMS
Installation
) from the Windows command prompt.
2. Enter the following:
SsmsInstallation.exe [Type of Product/Mode] "[TSS Installation
Directory]"
Where:
[Type of Product/Mode] can be Uninstall, Freeware, Beta, Commercial, Trial
[TSS Installation Directory] resides.
is the directory where Toad for SQL Server
Example:
Toad for SQL Server Installation Guide
Installation
26
C:\Program Files (x86)\Quest Software\Toad for SQL Server 6.5\SSMS
Installation\SsmsInstallation.exe Commercial "C:\Program Files (x86)\Quest
Software\Toad for SQL Server 6.5"
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. (In Windows
XP, select Add/Remove Programs.)
2. Select the product that you want to uninstall.
3. Click Uninstall.
Note: The Diagnostic Server is uninstalled separate from Toad for SQL Server.
Licensing
To enter your license key
1. Select Help | Licensing from the menu (ALT+H+L).
2. Review the following for additional information:
Authorization key
Site message
Enter the license key for Toad.
Enter the site message included with the license key.
Note: Your license key determines the edition of Toad (Freeware, Base, 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://software.dell.com/ .
Toad for SQL Server Installation Guide
Installation
27
Notes for Toad for SQL Server Users
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.
To delete a trial key
1. Select Help | Licensing.
2. In the Toad Licensing dialog, find the License tab for the trial license key and click
Delete License to delete the trial key.
Create and Troubleshoot Connections
Understand Toad Connections
Review this topic to learn about open database connections in Toad.
Toad Open Connections
In Toad, an open connection in the Connection/Navigation Manager represents one or more actual connections to the database. When you open a database connection in Toad: l
Toad creates an initial database connection for general use.
l
Toad also creates a separate database connection for each Editor (the first time you execute a statement) and for each Data tab in the Database Explorer (the first time you select the tab and query data).
The connection associated with the window (or tab) remains open until you close the window. If a window has an associated connection, but a statement is not currently executing, the connection is in an inactive state.
To view information for an open connection
l
To view the number of actual database connections that exist for a Toad connection, including the number of active connections, place the cursor over the connection in the Connection/Navigation Manager pane or in the connection drop-down list.
To use the Background Processes pane
l
When a statement is executing, a progress bar displays in the Status bar located at the bottom of the Toad application window. Click the executing progress bar to open the
Background Processes pane.
l
To cancel statement execution, use the Background Processes pane.
Note: It is recommended that you cancel only your own processes, because terminating Toad activities could cause unexpected behavior.
Sharing a Connection Among Windows
You can instruct Toad to share an open connection among windows. In this way, the Editor windows and Data tabs can share the same connection when the connection is inactive.
To share a database connection among windows in Toad
1. Select Tools | Options | Editor | General.
2. Clear the checkbox for the Use individual connection for each open editor option.
Toad for SQL Server Installation Guide
Create and Troubleshoot Connections
29
3. When this option is not selected, Toad attempts to use a single connection for any new windows or query execution. For example, if you share a database connection, you can execute a query in the Editor, execute another query in a new Editor, and then select the Data tab from the same connection.
If the single connection is in use when Toad attempts to execute it, the following occurs: l
If your database does not support executing multiple queries on a shared connection, a dialog prompts you to either permanently associate the window with a new database connection, cancel the previous operation, or add the query to a queue until the current operation completes, and the execute it. If you place multiple queries in the queue, each one executes in the order that it was added to the queue.
Note: Although you can share a database connection, any commits apply to the selected window only.
Create SQL Server and SQL Azure Connections
You can create a new connection, or connect to an existing connection from the Create New
Connection window. See "Troubleshoot SQL Server® Issues" (page 31) for more information
about troubleshooting connection issues.
Note: For SQL Azure connections: l
To be able to utilize majority of Toad functionality please grant VIEW DEFINITION on the SQL Azure databases you want to work with.
l
You can login to Windows Azure Platform by selecting Tools | Cloud Computing |
SQL Azure Portal and providing your credentials.
l
Make sure that no Azure firewall rule restricts your IP address from having access to
Azure server. See "Create and Alter Azure Firewall Rules" in the online help for more information.
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
Server name
Description
Enter the name of the server to use when connecting.
Click to display any servers running SQL Server that are currently active on the network.
Toad for SQL Server Installation Guide
Create and Troubleshoot Connections
Password
Category
Encrypt connection
Advanced Tab
Network protocol
Parameter
Name/Value
Notes:
l
For SQL Azure connections, enter
InstanceName.database.windows.net in this field.
l
For named instances, enter the
MachineName\InstanceName in this field.
Enter the password to use when connecting.
Tip: After connecting, you can set a master password to further secure your connection in Tools
| Options| Environment | Security.
Select or create a category if you want to color code Editor tabs for a specific connection. This can help differentiate between development and production databases. You can also set an option to color code the Object Explorer pane and object editor windows (Create, Alter, Drop, etc.).
Click here to view a video of this feature.
Select this option to enable encryption for the current connection provided that the certificate has been already installed on the server.
Description
Select one of the following: l
Shared Memory l
TCP/IP l
Named Pipes
Note: When establishing Named Pipes connection
"Poll service status in connection list" option should be cleared.
You can add parameters to the connection. Toad includes the Application Name parameter with value Toad for SQL
Server by default.
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.
30
Toad for SQL Server Installation Guide
Create and Troubleshoot Connections
To import connections (including Central Management Server connections)
1. Click .
2. Specify the location where the connections currently reside.
Note: Review the following for additional information on CMS connections: l
To import CMS connections, select a server from the list where the CMS is registered. The connection to this SQL Server instance should be created beforehand.
l
CMS is available beginning with Microsoft SQL Server 2008.
l
User should have an appropriate login (Windows Authentication and grant to connect to selected server are required) created on the server to which he connects via CMS.
3. Select the connections to be imported.
Troubleshoot SQL Server
®
Issues
Installation Issues
The following table describes issues related to installing Toad.
Issue
When installing Toad on Windows 7 64-bit,
Program Compatibility
Assistant may appear with “This program might not have installed correctly” message.
Cause/Solution
Solution:
Select This program installed correctly to continue installation. For more information, see http://windows.microsoft.com/en-PH/windows7/Program-
Compatibility-Assistant-frequently-asked-questions
Toad Plug-in for Microsoft
®
Studio Issues
SQL Server Management
Issue
Toad Plug-in cannot be invoked from Microsoft
SQL Server
Management Studio after you uninstalled one of several editions
Cause/Solution
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.
Solution:
Select one of the following:
31
Toad for SQL Server Installation Guide
Create and Troubleshoot Connections
Issue
of Toad that resided on your machine side-byside.
Cause/Solution
l
Reinstall Toad for SQL Server. All current settings will be available after Toad reinstallation.
l
Launch SsmsInstallation.exe from the Windows command prompt as administrator.
1. Open SSMS Installation directory (
<Toad install directory>/ SSMS
Installation
) from the Windows command prompt.
2. Enter the following:
SsmsInstallation.exe [Type of
Product/Mode] "[TSS Installation
Directory]"
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.5\SSMS
Installation\SsmsInstallation.exe
Commercial "C:\Program Files (x86)\Quest
Software\Toad for SQL Server 6.5"
Connection Issues
Review the following solutions to help troubleshoot SQL Server connection issues in Toad.
Issue
Cannot specify a port number when connecting
Cause/Solution
Currently, Toad does not have a separate field for specifying a port number.
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
IPAddress,Port
For example:
10.1.29.129,1234 (where 1234 is the port number of the instance)
32
Toad for SQL Server Installation Guide
Create and Troubleshoot Connections
Issue
Cannot connect to a remote instance in SQL
Server 2005
"Path is not of a legal form" error message when connecting or
"Could not find a part of the path
C:\Program Files\Quest
Software
\Toad for SQL
Server\Template\Scripts\
InitialSqlServer.Sql" error message when connecting
Cannot establish
Named Pipes connection
Cause/Solution
Remote connections may not be enabled in SQL Server
2005. Also, named instances are configured to use dynamic ports and select an available port once the SQL Server
Service starts. If you are connecting to a named instance through a firewall, configure the Database Engine to listen on a specific port, so that the appropriate port is opened in the firewall.
Note: Remote connections are disabled by default in the
Express and Developer editions of SQL Server 2005.
Solution:
To enable remote connections, see "How to configure SQL
Server 2005 to allow remote connections" at: http://support.microsoft.com/kb/914277
You attempted to migrate settings from a previous install of
Toad to the current install, but the settings file
(InitialSqlServer.Sql) for the previous install was either removed, moved, or corrupt.
You may also receive this error if you installed Toad and migrated settings from a previous version, and later uninstalled the previous version.
Solution:
You must specify a valid location for the InitialSqlServer.Sql
file 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's
InitialSqlServer.Sql file in the Run Script on new
connection field.
By default, this file is located in the following directory:
C:\Program Files\Quest Software\Toad for SQL Server
version \Templates\Scripts
Note: Clicking may result in a "Path not found error". If you receive this error, manually enter the location in the field.
If you are trying to connect to the server using Named Pipes,
"Poll service status in connection list" option should be cleared.
Solution:
1. Open the options page under Tools | Options |
33
Toad for SQL Server Installation Guide
Create and Troubleshoot Connections
Issue
Cannot establish Azure connection
Cannot access some functionality when working with Azure connection.
Cause/Solution
Database | General.
2. Clear Poll service status in connection list checkbox.
Failing to establish Azure connection may indicate that your
IP address is restricted from having access to the Azure server.
Solutions:
1. Select Tools | Cloud Computing | SQL Azure Portal to login to Azure Portal.
2. Create a firewall rule on the master database, enabling access to current IP address or range. See
"Create and Alter Azure Firewall Rules" in the online help for more information.
To utilize majority of Toad functionality VIEW
DEFINITION grant is required for those databases you want to work with.
34
3
Configure Version Control
About Version Control
Toad integrates with your existing version control system so you can maintain multiple
Important: See "Troubleshoot Version Control" (page 42) for more information about issues
when upgrading version control from a previous version.
Notes:
l
Version Control can be configured for MS SQL Server 2005 and above.
l
If you want to place database objects under version control, you must configure version control for objects using the Object Explorer. Once configured, you can manage SQL scripts there. The main advantage of managing scripts in the Object
Explorer is that you can easily share them with team members who have version
control configured. See "Manage Objects under Version Control" (page 38) for more information.
l
If you rename a version controlled object, Toad drops the original object and its history from version control and prompts you to add the renamed object to version control. This newly renamed object does not have any history associated with it.
l
Currently, CLR objects are not supported by version control.
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.
Client Version Tested Supported
Provider
Apache
Subversion™
Server Version
Tested
Subversion 1.7.5
on Windows
Team
Foundation
Server (TFS)
TFS 2008, 2010,
2012
CollabNet Subversion Command-Line Client
1.7.5
Note: Any Subversion client must have svn.exe in its installation directory to use version control in
Toad.
Visual Studio
®
Client
(2008, 2010, 2012) Team Explorer
Toad for SQL Server Installation Guide
Configure Version Control
36
Supported
Provider
Server Version
Tested
Client Version Tested
File system based
Toad allows to utilize practically any version control system using the external client tool. In 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.
Note: Toad connects to your version control system based on login information included in the configuration. Your version control client does not need to run for Toad to connect.
The following objects can be added to Version Control:
TABLE
VIEW
STORED PROCEDURE
FUNCTION
SEQUENCE
UDDT
RULE
DEFAULT
SQL SCRIPT
Configure Version Control
To configure version control
1. Ensure that a supported version control client is installed on the computer where Toad
is installed. See "About Version Control" (page 35) for more information about tested
version control clients and supported versions.
2. Right-click one or more objects in the Object Explorer and select Version Control |
Version Control Wizard.
Note: Version control is configured for individual databases separately. You cannot configure version control on server level.
3. Review the following for additional information:
Version Control
System Page
Description
Toad for SQL Server Installation Guide
Configure Version Control
Type
Properties
Server
User name/
Password
Default Version
Control Settings
Page
Select the version control system name: l
Apache Subversion™
Note: The version number beside Subversion is an internal file definition used by Toad to check if an update for this file is available. It is not the actual version number for the version control provider.
l
Team Foundation Server
Note: If you select TFS, you must specify the workspace name for the provider in the Team
Foundation Server Properties window that displays.
l
File system based
(Subversion only) Click this button (beside the Type field) and complete the binary path. Enter the path where the Subversion client that contains svn.exe is installed.
For example, if you installed the CollabNet Subversion
Client, you would enter:
C:\Program Files\CollabNet Subversion Client
Note: Do not include svn.exe in the path.
Select one of the following: l
Subversion—Specify the existing working folder for the version control repository or specify the server string (for example: svn://MyServer).
l
TFS—Specify the server where your version control provider is installed and the port number
(default is 8080) to use in the following format: o http://MyServer:Port for TSF 2008 o http://MyServer:Port/TFS for TFS 2010,
2012 l
File System Based—Specify a directory at your local machine.
Enter your Subversion command-line user name and password and click Login.
Note: For TFS only, if you leave the user name and password fields blank, Toad uses your default Windows credentials.
Description
37
Toad for SQL Server Installation Guide
Configure Version Control
38
Version control folder
Working folder
Select the folder on the version control server where you want to check objects and scripts in.
If you already have objects or scripts under version control, select the folder on the server where these objects or scripts are located.
Note: Version control automatically checks out objects or scripts in this folder and any subfolders to the location you specify in the Working folder field.
Select the root repository folder on the client computer to use as the default working folder for checking objects and SQL scripts out. If you already have objects or
SQL scripts under version control, select the existing working folder for these.
4. Manage object and scripts using Version Control. See "Manage Objects under Version
Control" (page 38) for more information.
Manage Objects under Version Control
Note: Version Control should be configured in Toad before you start managing objects. See
"Configure Version Control" (page 36) for more information.
To add objects and scripts under version control
» Right-click an object or script and select Commit.
Tips:
l
The objects under version control are marked with sign at the top right corner of the object's icon.
l
If you rename a version controlled object, Toad drops the original object and its history from version control and prompts you to add the renamed object to version control This newly renamed object does not have any history associated with it.
l
You can create and version control SQL scripts for current database using the Scripts
Toad for SQL Server Installation Guide
Configure Version Control node in the Object Explorer. Click to create the new script.
39
To manage objects and scripts under version control
1. Determine object's version control status. Hover a mouse over the object in the Object
Explorer to see its status. Review the following for additional information:
Description Version Control status
Uninitialized
Untracked
Ignored
UpToDate
Modified
Merge
The object status is undetermined yet. This is a temporary status that is issued for all objects during version control status processing.
The object is not added to version control.
The object is added to ignore list and excluded from version control.
The object is under version control and is synchronized with version control repository. No changes are detected.
The object is under version control and has been modified by user. The changes are stored in local database only and need to be synchronized with version control repository.
The object is under version control and has been
Toad for SQL Server Installation Guide
Configure Version Control
Version Control status
Description
OutOfDate
Unknown
Deleted
NotInView modified in both local database and version control repository.
Note:: Toad's Version Control feature does not allow to merge object scripts.
The object is under version control and has been modified in version control repository.
The object is under version control but for some reason its status cannot be determined (for example, you created a script in your local database while the script with the same name already exists in version control repository, or you upgraded to a higher version of Toad and configured version control for the same repository while you have some uncommitted changes in the database).
Tip: If you are sure that the object is up to date but is listed as unknown, commit the object in version control system to resolve unknown status.
The object was under version control, but it was dropped or renamed in local database and exists only in version control repository.
Tip: You can see deleted objects in the Controlled objects pane only. To access it right-click any object and select Show perspective. Once you commit changes in Controlled objects pane, the object with all history will be deleted from version control repository.
The object is under version control and exists in version control repository only.
2. Right-click an object or script and select one of the following actions:
Use
Show perspective
Diff
To...
Select to review all controlled objects for current configuration.
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.
40
Toad for SQL Server Installation Guide
Configure Version Control
Use To...
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
Get latest revision
Commit
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.
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.
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
Update status
Add to ignore list
Remove from ignore list
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.
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.
Select to exclude object from the version control.
Ignored objects are not listed in Controlled Objects pane, Commit and Get latest revision are disabled.
Select to set object status as Untracked and add it to version control.
41
Toad for SQL Server Installation Guide
Configure Version Control
42
Use
Open in Windows
Explorer
To...
Select to navigate to the file in the Windows Explorer.
Tip: You can enable, disable, or delete a version control configuration under Tools |
Options | Version Control | Configurations.
Troubleshoot Version Control
Troubleshoot Upgrades
For this release, the back-end of version control has been rewritten. If you previously used version control in Toad, the following may occur: l
Version control settings are not migrated from the previous version of Toad, so you have to reconfigure version control in Toad.
l
In previous releases, the method Toad used to generate the script was different than the current method. After upgrading Toad and reconfiguring version control, the local revision of the objects differs from version control repository (The objects have
Unknown status). If the object in your database is current, you should commit it into version control.
Troubleshoot Other Issues
Review the following to help troubleshoot issues with version control:
Apache
Subversion™
Issues
System cannot find file
Command execution
Description
If a message stating that, “The system cannot find the file specified” displays, this usually means that the Subversion executable cannot be found in the path you specified in the BinaryPath field of the
Command Based Version Control Properties window. Verify that
svn.exe exists in the directory you specified in this field.
When executing Subversion commands, user input is not allowed.
This presents an issue when the user is using Subversion with the
SSH method and must enter a password to establish the Secure
Shell.
Workaround:
Generate identity keys that automatically authenticate between the client and the server when connecting with SSH.
OutOfMemory When adding a large number of objects, Subversion may encounter
Toad for SQL Server Installation Guide
Configure Version Control exception when adding a large number of objects
SVN is missing in the list of available providers
Object Issues
Adding multiple objects failed
Script Issues
Canceled check-in
OutOfMemory exception.
Workaround:
Commit objects in several steps.
If Subversion is missing in the list of available version control providers, it means that Subversion.xml was removed or corrupted.
Workaround:
Contact Support to get a new Subversion.xml and place it under
<Toad install path>/Templates/Version Control/
.
Description
When you add multiple objects to version control, the objects are grouped and added in batches (for example, all the tables for a particular schema are added at once). If an error (for example, failure to support Korean characters) causes this command to fail, none of the objects are added.
Description
SQL scripts remain checked out if a change was made to the text, but check-in was canceled during the prompt for a check-in comment. This behavior is by design—that is; the user can either undo the checkout or check in the script using the right-click menu in the Scripts node/folder/tab of the Object Explorer.
Note: If you alter the object again, you receive a prompt to use the
“locally changed” script. Click Yes to use the locally changed copy; click No to refresh the local copy from the source repository; click Cancel to cancel the prompt.
43
Configure SQL Server Debugging
Configure SQL Server Debugging
Debugging Prerequisites
Before configuring the Debugger, verify that the following prerequisites have been met: l
Disable all firewalls or open corresponding ports. Windows XP Service Pack 2 includes an embedded Windows firewall that should be disabled or ports opened as well. Specifically, the TCP 135 port must be opened and the Toad.exe must be added to the Exceptions list. The same is true for the remote (SQL Server) machine - TCP
135 port must be opened and sqlservr.exe must be added to the Exceptions list.
l
Stop any antivirus software that can lock the corresponding components, settings, etc.
l
Check your security policy because it may include an access lock to the remote server.
Notes:
l
The security policy can be applied to the domain or local computer.
l
Currently, you cannot debug CLR stored procedures.
Platforms Tested for Debugging Support
The following platforms have been tested for debugging support.
Note: The Service Pack on the client must match the Service Pack on the server unless specified otherwise.
2003
EE
(SP1)
XP
Pro
(SP3)
Vista
SQL Server 2012 and SQL Server 2014 Platforms Tested for Debugging
Client
Server
2003
EE
(SP2)
2000
(SP4)
2000
Pro
(SP4)
XP
Pro
(SP3)
Vista
Server
2008
7
Toad for SQL Server Installation Guide
Configure SQL Server Debugging
SQL Server 2012 and SQL Server 2014 Platforms Tested for Debugging
Client
Server
2003
EE
(SP2)
2000
(SP4)
2000
Pro
(SP4)
XP
Pro
(SP3)
Vista
Server
2008
Server
2008
7
7
2003
EE
(SP1)
XP
Pro
(SP3)
Vista
SQL Server 2008 Platforms Tested for Debugging
Client
Server
2003
EE
(SP2)
2000
(SP4)
2000
Pro
(SP4)
XP
Pro
(SP3)
Server
2008
7
Vista
Server
2008
7
45
Toad for SQL Server Installation Guide
Configure SQL Server Debugging
SQL Server 2005 Platforms Tested for Debugging
Client
Server
2003
EE
(SP1)
2000
(SP4)
2000
Pro
(SP4)
XP
Pro
(SP3)
2003
EE
(SP1)
XP
Pro
(SP3)
Vista
Server
2008
7
Vista Server
2008
7
2003
EE
(SP1)
XP
Pro
(SP2)
SQL Server 2000 (SP4) Platforms Tested for Debugging
Client
Server
2003
EE
(SP1)
2000
(SP4)
2000
Pro
(SP4)
XP
Pro
(SP2)
Vista
(Local server)
Vista
Server
2008
7
Server
2008
7
46
Toad for SQL Server Installation Guide
Configure SQL Server Debugging
47
Configure Debugging for SQL Server 2012 / SQL Server
2014
To debug locally, perform the following on the Toad client
1. Install the appropriate SQL Server Client Tools (2012 /2014) on the Toad client.
2. If autocommit is disabled, commit or rollback the connection in Toad before starting the debugging session.
To debug remotely, perform the following
1. Install the appropriate SQL Server Client Tools (2012 /2014) on the Toad client.
2. Set the following permission. 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' where Domain\Name is your Windows login.
3. If autocommit is disabled, commit or rollback the connection in Toad before starting the debugging session.
Configure Debugging for SQL Server 2008
To debug locally, perform the following on the Toad client
1. Install the SQL Server 2008 Client Tools on the Toad client.
2. If autocommit is disabled, commit or rollback the connection in Toad before starting the debugging session.
To debug remotely, perform the following
1. Install the SQL Server 2008 Client Tools on the Toad client.
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:
Toad for SQL Server Installation Guide
Configure SQL Server Debugging sp_addsrvrolemember 'Domain\Name', 'sysadmin' where Domain\Name is your Windows login.
3. If autocommit is disabled, commit or rollback the connection in Toad before starting the debugging session.
Configure Debugging for SQL Server 2005
To debug locally, perform the following on the Toad client
1. Install the SQL Server 2005 Workstation Component option of the SQL Server 2005 installation.
2. If autocommit is disabled, commit or rollback the connection in Toad before starting the debugging session.
To debug remotely, perform the following
1. Complete the following: a. Install the SQL Server 2005 Workstation Components option of the SQL
Server 2005 installation on the Toad client.
b. Copy and register the ssdebugps.dll (debugging host component) on both the client and server. This file is located by default in the following directory on the server where SQL Server 2005 is installed:
C:\Program Files\ Common Files\Microsoft Shared\SQL Debugging
To register this file, open a command prompt and enter the following command: regsvr32 ssdebugps.dll
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:
48
Toad for SQL Server Installation Guide
Configure SQL Server Debugging
49 sp_addsrvrolemember 'Domain\Name', 'sysadmin' where Domain\Name is your Windows login.
3. If autocommit is disabled, commit or rollback the connection in Toad before starting the debugging session.
Configure Debugging for SQL Server 2000
To debug locally, perform the following on the Toad client
1. Make sure that SQL Server 2000 with Service Pack 3 or Service Pack 4 is installed on the server.
2. Install the SQL Server Client Tools on the Toad client.
3. If autocommit is disabled, commit or rollback the connection in Toad before starting the debugging session.
To debug remotely, perform the following
1. Complete the following: a. Make sure that SQL Server 2000 with Service Pack 3 or Service Pack 4 is installed on the server.
b. Install the SQL Server Client Tools on the Toad client.
c. Copy and register the sqldbg.dll and sqldbreg2.exe (debugging host components) on both the Toad client and server. These files are located by default in the following directory on the server where SQL Server
2000 is installed:
C:\Program Files\Common Files\Microsoft Shared\SQL Debugging
To register these files, open a command prompt and enter the following commands: regsvr32 sqldbg.dlls
qldbreg2.exe /RegServer
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 user account (Windows authentication), or a SQL Server login (SQL Server authentication).
Toad for SQL Server Installation Guide
Configure SQL Server Debugging
50
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' where Domain\Name is your Windows login.
l
DCOM Access permissions must be granted for the system account and the group or user who needs access.To verify permissions: a. Open a command prompt and run dcomcnfg.exe. b. Expand Component Services, Computers.
c. Right-click My Computer and select Properties.
d. Select the COM Security tab.
e. Under Access Permissions, click Edit Default, and verify permissions.
Note: By default, Windows administrators on a computer running SQL
Server are SQL Server sysadmins on that computer.
3. If autocommit is disabled, commit or rollback the connection in Toad before starting the debugging session.
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
The wizard verifies the following on the client: l
Existence of the corresponding DLL files l
DLL version l
COM registration l
Availability of DLLs for this user l
Ability to connect to the server
Toad for SQL Server Installation Guide
Configure SQL Server Debugging l
Whether this user has administrator privileges for the server l
DCOM support
To run the Debugger Setup wizard
» Select Debug | Debugger Setup Wizard from the menu in an open Editor window.
51
About Dell
Contact Dell
Dell listens to customers and delivers worldwide innovative technology, business solutions and services they trust and value. For more information, visit www.software.dell.com
.
Technical Support:
Online support
Product Questions and Sales:
(800) 306-9329
Email:
Technical Support Resources
Technical support is available to customers who have purchased Dell software with a valid maintenance contract and to customers who have trial versions. To access the Support Portal, go to http://software.dell.com/support/ .
The Support Portal provides self-help tools you can use to solve problems quickly and independently, 24 hours a day, 365 days a year. In addition, the portal provides direct access to product support engineers through an online Service Request system.
The site enables you to: l
Create, update, and manage Service Requests (cases) l
View Knowledge Base articles l
Obtain product notifications l
Download software. For trial software, go to Trial Downloads .
l
View how-to videos l
Engage in community discussions l
Chat with a support engineer
Toad for SQL Server Installation Guide
Contacting Dell
53
Toad Community
Get the latest product information, find helpful resources, and join a discussion with the Toad for SQL Server team and other community members. Join the Toad for SQL Server community at http://www.toadforsqlserver.com
.
Index
A
automation
C
Citrix
connections
create SQL Azure 29 create SQL Server 29
share for all session windows 28
D
debugger
verify installed components 50
Dell
I
intergration with Management
L
M
manage objects under Version
R
requirements
S
SQL Azure
SQL Server
Toad for SQL Server Installation Guide
Index
T
Team Foundation Server, configure 36
troubleshoot
U
V
Version Control
configure Subversion 36 configure TFS 36
55
डाउनलोड
विज्ञापन