Toad

for Oracle

Getting Started Guide

Version 8.6
Copyright Quest Software, Inc. 2005. All rights reserved.
This guide contains proprietary information, which is 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.
WARRANTY
The information contained in this document is subject to change without notice. Quest
Software makes no warranty of any kind with respect to this information. QUEST
SOFTWARE SPECIFICALLY DISCLAIMS THE IMPLIED WARRANTY OF THE
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. Quest Software shall not
be liable for any direct, indirect, incidental, consequential, or other damage alleged in
connection with the furnishing or use of this information.
TRADEMARKS
Quest and Toad are registered trademarks of Quest Software, Inc. Oracle is a registered
trademark of Oracle Corporation and/or its affiliates. Other trademarks and registered
trademarks used in this guide are property of their respective owners.
World Headquarters
5 Polaris Way
Aliso Viejo, CA 92656
www.quest.com
email: info@quest.com
U.S. and Canada: 949.754.8000
Please refer to our Web site for regional and international office information.
Toad for Oracle Getting Started Guide
Updated - September 2005
Software Version - 8.6
i
CONTENTS
CHAPTER 1
INTRODUCTION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
TOAD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
ABOUT THIS GUIDE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
EDITIONS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
ABOUT QUEST SOFTWARE, INC. . . . . . . . . . . . . . . . . . . . . . . 6
CHAPTER 2
INSTALL, UNINSTALL, AND TOAD FILES . . . . . . . . . . . . . . . . . . . 7
OVERVIEW . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
SYSTEM REQUIREMENTS . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
WINDOWS PRIVILEGES AND TOAD . . . . . . . . . . . . . . . . . .10
INSTALL. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11
TOAD FILES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16
UNINSTALL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .23
HOW UNINSTALLING WORKS FOR EACH OF THE INSTALL TYPES .23
CHAPTER 3
SERVER SIDE INSTALLATION WIZARD . . . . . . . . . . . . . . . . . . . .25
OVERVIEW . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .26
FEATURES WITH SERVER SIDE OBJECTS . . . . . . . . . . . . . . . . . .26
INSTALL, UPGRADE, OR REMOVE OBJECTS FOR ALL USERS TO SHARE.28
INSTALL OR REMOVE SHARED OBJECTS IN THE TOAD SCHEMA. .28
DROP THE TOAD SCHEMA AND ALL PUBLIC SYNONYMS FOR ITS OBJECTS
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .29
INSTALL OR REMOVE SHARED OBJECTS IN A SCHEMA OTHER THAN TOAD
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .29
INSTALL OR REMOVE OBJECTS FOR AN INDIVIDUAL SCHEMA TO USE .30
CREATE SETUP SCRIPTS WITHOUT A DATABASE CONNECTION. . . . .30
SET UP WIZARD FINISHED . . . . . . . . . . . . . . . . . . . . . . . . .30
CHAPTER 4
REGISTRATION. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .31
TRIAL VERSION REGISTRATION. . . . . . . . . . . . . . . . . . . . . . .32
PURCHASE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .33
PRODUCT AUTHORIZATION ERRORS . . . . . . . . . . . . . . . . . . . .34
Toad for Oracle
ii
CHAPTER 5
FEATURES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .35
OVERVIEW . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .36
SQL EDITOR. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .36
SCHEMA BROWSER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .37
PROCEDURE EDITOR . . . . . . . . . . . . . . . . . . . . . . . . . . . . .38
OPTIONS MENU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .38
TOAD HELP. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .38
CHAPTER 6
TROUBLESHOOTING. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .39
OVERVIEW . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .40
CANNOT CONNECT TO PERSONAL ORACLE . . . . . . . . . . . . . . . .40
PATH ENVIRONMENT. . . . . . . . . . . . . . . . . . . . . . . . . . . . .40
SUPPORT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .41
Introduction
Toad
About this guide
Editions
About Quest Software, Inc.
1
Toad for Oracle
2
Toad
Toad is a powerful application development tool built around an advanced SQL
and PL/SQL editor. Using Toad, developers can build and test PL/SQL packages,
procedures, triggers, and functions. You can create and edit database tables,
views, indexes, constraints, and users.
Toad lets you view the Oracle Dictionary, tables, indexes, stored procedures, and
more.
Code can be created from shortcuts and code templates. You can also create
your own code templates.
With Toad you can:
Create, browse, or alter objects
Graphically build, execute, and tune queries
Edit PL/SQL and profile stored procedures
Manage your common DB tasks from one central window
Find and fix database problems with constraints, triggers, extents,
indexes, and grants
Control code access and development (with or without a third party
version control product) using Toad's cooperative source control
feature.
The PL/SQL Debugger (available in the Toad for Oracle Professional, Toad for
Oracle Xpert, and Toad for Oracle Suite editions) lets you step through the code
as it executes. With this feature you can run a debug session with or without
arguments, set breakpoints, watch variables, and more.
The optional Quest DBA Module adds database administration functionality to
Toad. With this module you can manage space, compare schemas, monitor
database performance, create new databases, maintain redo logs, perform
health checks, and more.
Introduction
3
About this guide
This guide introduces Toad. It helps you install and run Toad. It also introduces
you to some of the main Toad windows.
The guide covers the following major topics:
System requirements
Install/uninstall
Registration
Troubleshooting
Toad files
This is an introductory guide. Refer to Toad for Oracle Help for the latest
information. You can easily access Help while in Toad by pressing the F1 key.
The User's Guide contains details about the main Toad windows (SQL Editor,
Procedure Editor, Schema Browser, SQL Modeler) and additional windows and
feature information.
Releasenotes.htm contains the latest information about upgrades and changes.
This guide was prepared in September 2005. New or changed Toad features
since September 2005 are not reflected in this version of the Getting Started
Guide.
For details on Toad, including navigation and main windows, refer to the User's
Guide and Help.
Toad for Oracle
4
Editions
Toad for Oracle, Version 8.6 comes in four editions. So you can choose the
edition that is right for your environment.
You can enhance Toad's capabilities with optional add-on modules.
Quest DBA Module
Adds advanced database administrative functionality to Toad.
With this module you can manage space, compare schemas, monitor database
performance, create new databases, maintain redo logs, and more. Includes
Knowledge Xpert for Oracle Administration (launchable outside of Toad).
SQL Tuning Module
Identifies performance issues and provides Oracle database tuning so you can
resolve bottlenecks.
EDITION DESCRIPTION
Toad for Oracle Provides the foundation and basic tools for Oracle
professionals to create and execute queries and
build and manage database objects. This includes
XML editing, data browsing, data compare, SQL
recall, code snippets, and code formatting. This
edition also lets you plug into Toad's added utilities.
Toad for Oracle
Professional
(includes all features of Toad for Oracle plus
debugging functionality)
This edition includes PL/SQL Debugger, Script
Debugger for SQL*Plus scripts, CodeXpert, and
integrated PL/SQL Knowledge Xpert. It also includes
Data Pump for Oracle 10g.
Toad for Oracle
Xpert
(includes all features of Toad for Oracle Professional
with integrated SQL Tuning)
It includes the SQL Tuning Module and SQL
Scanning.
Toad for Oracle
Suite
(An entire application life cycle package. Includes all
features of Toad for Oracle Xpert plus a variety of
development tools)
It includes Quest DBA Module, Database
Administration Knowledge Xpert, DataFactory
Developer Edition, Benchmark Factory for Oracle,
and QDesigner PhysicalArchitect for creating and
reverse engineering accurate physical data models.
Introduction
5
eBiz Module
Lets you quickly find information in your Oracle e-Business Suite about
applications, concurrent programs, current and past activity, users,
responsibilities, workflows, flex fields, request sets, patches, profile options,
printers, menus, invalid objects, data groups, and more.
Toad for Oracle
6
About Quest Software, Inc.
Quest Software, Inc. delivers innovative products that help organizations get
more performance and productivity from their applications, databases and
infrastructure. Through a deep expertise in IT operations and a continued focus
on what works best, Quest helps more than 18,000 customers worldwide meet
higher expectations for enterprise IT. Quest Software can be found in offices
around the globe and at www.quest.com.
Install, Uninstall, and Toad
files
Overview
System Requirements
Install
Toad files
Uninstall
2
Toad for Oracle
8
Overview
This chapter covers the install process for Toad including an overview of the Toad
files that are installed. It explains the different types of installs. It also shows the
uninstall procedure.
You can install Toad from a CD-ROM or installation files you download from the
Quest Software Web site, www.quest.com.
Before installing Toad, make sure that your system meets the minimum
hardware and software requirements. Also check your SQL*Net or Net8 setup
with another application, such as Oracle's tnsping utility, to verify your
connection with the database.
If you also have the freeware version of Toad you should not install the
commercial version over the freeware version, because it will adversely affect
some functions. You should install the commercial version in a different
directory from the freeware version.
Install, Uninstall, and Toad files
9
System Requirements
Toad requires either NT 4.0, Windows 2000, Windows 2003, Windows XP, or
Windows XP SP2.
Minimum Hardware Requirements
IBM style PC
44 MB disk space required to run Toad
256 MB RAM required
CD-ROM drive (required for commercial version installation from
CD-ROM)
VGA monitor
1024 x 768 screen resolution
Mouse pointing device
Minimum Software Requirements
At least Oracle 7.3.4
The current release of Toad requires SQL*Net (32 bit) or Net8 for Oracle 8.
Toad will not run on Linux, Unix, OS2, or Macintosh.
FEATURES/MODULES
ADDITIONAL
REQUIREMENTS
Debugger Oracle Probe v2.0 or higher
(SYS.DBMS_DEBUG package)
Quest DBA module (Same as Toad Requirements)
Tuning modules 32 MB of RAM and an additional
25 MB of disk space
eBiz module Toad Requirements and
database with Oracle eBusiness
Suite installed
Toad for Oracle
10
Windows Privileges and Toad
At minimum, in order to install and run Toad, make a connection, and do basic
operations you have to be a power user and have read/write privileges on the Oracle
homes directories that you use for your connections.
USER/PRIVILEGE TOAD 8.6
Standard User Unable to install Toad 8.6.
Power User Installation is successful.
In order to connect with the 10g
client, you must have read
access to the 10g client folder.
Toad opens, but in order to
connect to any databases you
must have explicit privileges to
the Oracle home folder.
Power User with read & write
privileges granted to Oracle
directory
Installation is successful.
You can connect to the
databases.
Install, Uninstall, and Toad files
11
Install
To Install Toad
Run the Toad Installation program from the CD or downloaded file.
If another copy of Toad for Oracle is detected the Previous copy of Toad for
Oracle screen will display. This lets you Select your Installation Type. You can
choose New Install or Upgrade. If you choose Upgrade then Toad will
automatically set your install directory to the last place Toad for Oracle was
installed.
1. The first install dialog box is a Welcome screen. This ensures that
you want to install Toad. If you want to cancel, click Cancel.
As you progress through the following dialog boxes, you will have a
Back button to go back to the previous dialog box and a Cancel button
to cancel the installation. To progress through the installation, choose
your option for each dialog box and click Next.
The Toad Standard Edition - READ ONLY install is a read-only
executable designed to prevent its users from changing the database.
For this reason, it does not include Quest ScriptRunner (which lets a
user execute a script that can update database objects), SQLMonitor
(which logs SQL calls via the OCI layer), and Server Side Install
(which lets users make changes to Toad schemas).
2. The software license agreement displays in the next screen.
3. The next dialog asks you to select the type of installation you want.
The choices are:
Local Toad Install (FULL)
Network Install - Client (must run Server side install first)
Network Install - Server
Citrix/Terminal Server
You can only choose one. Toad always installs its files in a Toad folder.
No files will be placed in Windows folders or other miscellaneous
folders.
Local Toad Install (FULL)
This is the default choice. This installation is a full client and server
install. This installs all Toad files to your local hard drive. A Toad for
If you are installing Toad as a network installation the Toad license key is
written to the server. On the client side, Toad will prompt you for a license
key the first time it runs. The server should not be read-only when Toad is
run for the first time.
Toad for Oracle
12
Oracle folder is created on your local hard drive and the install puts
Toad.exe, Toad.chm, and other Toad files in your Toad for Oracle
folder. Toad for Oracle\User Files contains most of your personal
configuration files and the majority of the Toad files.
Is Network Installation the right choice for you?
An advantage of installing Toad to a network server is that as Toad is
updated, the network administrator only has to update the server
files. All users are updated when you update Toad on the server, as
opposed to having to update each workstation individually. This
makes periodic Toad updates easier.
The disadvantage of installing Toad to a server is whenever someone
starts Toad at their workstation they have to read the Toad.exe
application file (currently approximately 5 megabytes) across the
network. If you have a slow network or a network with a lot of traffic,
this type of installation might not be your best choice.
If you choose a Network Installation and you have installed
Microsoft security update 896358 then the Toad Help will not
work. This is because the security update restricts the use of
the ActiveX control that the Help needs. So, we recommend
that you install Toad locally if you want to be able to use Toad
Help.
Network Install - Client (must run Server side install first)
This option installs the personal configuration files to the PC, and
creates shortcuts to Toad.exe and Toad.chm on the server, which
already has Toad installed. All other Toad files, such as files that you
can customize, are installed on your workstation in your hard drive in
a Toad folder. So, if you choose this option you need to know where
on the server you want your Toad.exe and Toad.chm files to be read
from. This option is for individual workstations in situations where
Toad.chm and Toad.exe are already installed on the server.
Network Install - Server
This installs Toad.exe and Toad.chm on the network server so other
users can run the Network Install - Client installation to create
shortcuts to the served Toad. If Toad is installed to run on a server,
the network administrator should be the only one with write access to
Toad.
Citrix/Terminal Server
Citrix/Terminal Server support is offered for Toad 8.5 and higher and
enabled when you choose the Citrix/Terminal Server option. Toad
requires read access to the Toad Installation directory,
HKLM\Software\Quest Software\Toad in the registry, and the Oracle
Install, Uninstall, and Toad files
13
directory. Under Toad.exe properties | Compatibility tab | User
Account Privileges make sure the Allow non-administrators to run this
program box is checked. Write access is required to the Oracle
directory if any of the users want to edit the tnsnames.ora file by
using the TNSNames Editor.
When you choose a Citrix installation, all user files are stored in a
user_name directory. When a Citrix user opens Toad, Toad will copy
the contents of this folder to the users associated Application Data
folder for Toad.
4. The next dialog asks you to select your destination directory. The
default directory is C:\Program Files\Quest Software\Toad for Oracle,
but you can browse through your directories and select another one
if you want Toad installed in another directory or another hard drive
letter (D, E, F, etc.).
If in the previous step you chose to install some or all of Toad on a
server you will also be asked for the destination directory for the
server install.
5. The next dialog box asks if you want to backup replaced files. If you
choose Yes all copies of modified configuration files will be put in a
backup folder. Then, when Toad updates are performed, your
configuration files won't be overwritten. This only backs up Toad
install files. The default is Yes.
6. If you chose Yes in the previous dialog, the install will ask you to
select a backup directory. The default is the Toad\Backup folder. You
can browse through your directories if you want to choose another
location.
7. The next screen has a checkbox that lets you Install UNIX Job
Scheduler Scripts. The UNIX Job Scheduler is part of the Quest DBA
Module (version 7.4 and up). It lets a DBA use Toad to interface with
the UNIX Crontab facility to schedule scripts. If you do not install the
UNIX Job Scheduler Scripts, your UNIX Job Scheduler will be useless.
If you have the Quest DBA Module and want to use the UNIX Job
Scheduler, you should have the Install Unix Job Scheduler
Scripts checkbox checked. (It is checked by default.)
The screen also lets you select to back up several categories of
modifiable Toad files for local use. The checkboxes are:
Back up Code Snippets
Back up Script Manager Scripts
Back up Unix Job Scheduler Scripts
These files are seldom modified. The files you choose to backup will
be saved as file_name.DATE.SAV. (DATE is the date of the install.)
The files you do not choose to backup will be overwritten during the
install.
Toad for Oracle
14
8. Toad starts its installation process.
It asks you if you would like a Toad desktop shortcut icon. If you
choose Yes it creates a Toad shortcut and an icon on your desktop.
After Toad makes these checks, a progress bar displays which shows
the install program uncompressing the files and copying the files to
their destinations. At the same time, 2 log files are created in the Toad
folder: install.log and install.txt.
install.log and install.txt
Install.log is created by the install script. It contains verbose
commands of what the installation did. Do not edit install.log, because
it is needed by the uninstall engine. It is the file the uninstall engine
reads when removing files, icons, and other parts of Toad. This file is
also helpful when trying to diagnose an installation problem such as
low disk space, inadequate NT privileges, etc.
Install.txt is also created by the installation, but it has a different
format. Its user-friendly approach is easier to follow. It's basically an
outline of how the installation script went. If there is an installation
problem, such as a problem creating icons, the file can be helpful in
determining why that problem is occurring. Here is a section from an
install.txt file.
Copying down files...
File install complete
Creating icons...
Create a shortcut to Toad on the desktop...
Done creating icons!
So, Toad writes the files to the appropriate places.
9. Toad creates icons/shortcuts in the Start/Programs/Quest
Software/Toad for Oracle menu or Program Manager Group
including:
Toad Application
Toad Help
Uninstall Toad
Release Notes
Getting Started Guide
User's Guide
Toad also displays dialogs relevant to any add-on modules that you
have. It will ask you if you want to install Knowledge Xpert or SQL
Tuner. These are automatically included and you can install them, but
if you dont own the proper license key then you cant use them. They
will be enabled if you re-license Toad with the appropriate license key.
If you want to trial them or are planning to purchase these modules
in the future you might want to install them.
Install, Uninstall, and Toad files
15
10. The next screen asks if you want to run the Toad Server Side Objects
wizard. This wizard is discussed in detail in the next chapter.
11. The finish dialog displays indicating installation has been completed.
Checkboxes let you choose to View Release Notes and Start Toad.
Toad puts the selected notes into your default browser for you to
read.
Refer to the releasenotes.htm for the latest information about Toad
upgrades, changes, fixes, and issues.
Toad for Oracle
16
Toad files
When Toad is installed, files are copied into the appropriate directories. As you
work with Toad more files are created by you. This section is an overview of
some of the Toad files that are either in your Toad or Toad\User Files folder.
Toad.exe
This is the Toad application file.
Toad.chm
This is the Toad help file.
uninstall.exe
This is the uninstall engine. You select uninstall from the start menu or control
panel add/remove programs applet.
The uninstall engine reads and undoes everything that it finds in the install.log.
Toad.lic
This file must be in the Toad folder.
fullToad.lic
readonly.lic
Toad.exe only reads Toad.lic to determine if it is full Toad or read-only. The
default is fullToad.lic. So, the network administrator can copy readonly.lic over
the Toad.lic on an individual workstation to make Toad read-only at that
workstation.
savedsql.xml
Contains statements previously executed in the SQL Editor and Personal and
Named SQL statements. Personal and Named SQL statements can be saved via
the SQL Editor menu.
releasenotes.htm
Includes important information about upgrades, changes, fixes, and issues
revbase.dll
Interface from Toad to Oracle Knowledge Base
Install, Uninstall, and Toad files
17
Toad.ini
Initialization parameters file
connections.ini
Stores connection information such as passwords, usernames, and servers
Toadload.wav
Croak sound, plays when Toad.exe is invoked
schema.flt
Schema filters files. If you use browser filters, Toad creates schema.flt files.
Toadreports.exe
The executable that launches the Reports feature from within Toad. It can only
be launched from within Toad.
reportsparams.ini
Initialization files for the Reports feature
fmtplus.dll
Contains the code that Toad uses for code formatting, Profile Code, and Show
Inline Advice
fmtoptions.exe
Launched when you select View | Formatting Options.
fmtplus.opt
The settings for code formatting that the Formatting Options window configures
are saved in fmtplus.opt.
Toadserverside.exe
This is the Toad Server Side Objects wizard.
Toad for Oracle
18
Team Coding DLLs
scc.dll
vss.dll
pvcs.dll
cvs.dll
Templates for the Procedure Editor in the Procedure Editor window include:
newfunc.sql
newpackage.sql
newpackagebody.sql
newpkgfunc.sql
newpkgproc.sql
newproc.sql
newtrig.sql
newtype.sql
newtypebody.sql
newtypefunc.sql
newtypeproc.sql
Install, Uninstall, and Toad files
19
Three files are associated with syntax highlighting in the SQL Editor and
Procedure Editor.
plsqlscr.txt
Main file that is loaded at runtime
shortscr.txt
Contains only a basic list of keywords for Toad to highlight
Can copy shortscr.txt over plsqlscr.txt
longscr.txt
The default - plsqlscr.txt=longscr.txt
Contains a long list of keywords to highlight. It also contains commonly used
package functions and procedures from the SYS schema.
Syntax highlighting support also includes HTML, INI, JAVA, and TEXT files.
HTMLSCR.TXT
INISCR.TXT
JAVASCR.TXT
TEXTSCR.TXT
aliases.txt
List of user-defined table aliases
For example, Employee table can be set up as alias EMP.
Toad for Oracle
20
plsql.dci
Code completion templates activated in the SQL Edit or Procedure Edit window
by typing a couple of letters and <CTRL> + <SPACE> or to access the whole list
press <CTRL> + <SPACE>
The user can customize the file by:
Manually editing plsql.dci with notepad
OR
From the edit menu - Editor Options dialog tab for editing code
templates.
Code completion templates support also includes HTML, INI, Java (If you want
to use Java templates you'll have to create the files Javasub.txt and Java.dci),
and TEXT files.
html.dci
ini.dci
text.dci
plsqlsub.txt
List of AutoCorrect substitutions.
If you mistype and press <SPACE>, the word you incorrectly typed is
autoreplaced if it's in plsqlsub.txt.
Example; teh would be replaced with the
You can add words by accessing the editor options dialog or Notepad -
plsqlsub.txt.
Other sub.txt files are supported for HTML, INI, Java (If you want to use Java
templates you'll have to create the files Javasub.txt and Java.dci), and TEXT
files.
htmlsub.txt
inisub.txt
textsub.txt
Install, Uninstall, and Toad files
21
Schema_Database.lst
Lists of Oracle users for the selected schema/database.
You can use the View| Oracle Users List dialog to select which users'
schemas you want to see. This saves query time.
Toadstats.ini
Warning levels for server statistics window. You can set thresholds for when a
warning or error will display.
warning - pink
error - red
Script Manager Files
The files dba.sdf, schema objects.sdf (the category files for Script Manager),
and Oracle 8i Data Dictionary.sdf install into the Toad\User Files directory.
If you select server installation, the files Toad installs on the server include:
Toad.exe
Toad.chm
revbase.dll
Release Notes.htm
Toad Getting Started Guide.pdf
Toad Users Guide.pdf
QSR.exe
SQLMonitor.exe
Toadload.wav
Toad.lic
and
Code Snippet files
Toad for Oracle
22
New Procedure Templates
Code Completion Templates
in \User Files folder
Install, Uninstall, and Toad files
23
Uninstall
If you uninstall Toad, it might not totally uninstall. When you use Toad, you
create new Toad files such as SQL scripts, data output, or temp files. When you
run uninstall, Toad has no way of knowing what those files are. So it won't
remove new Toad files that you've created. You'll have to manually delete them.
To uninstall Toad
From the Start Menu
Click Start | Programs | Quest Software | Toad for Oracle|
Uninstall Toad
OR
Go to Add/Remove Programs in Windows and uninstall Toad.
If a network administrator installs server components they will not be
uninstalled. The network Toad components will have to be manually deleted.
How Uninstalling works for each of the
install types
Local Toad Install (FULL) - Uninstall uninstalls everything from your PC.
Network Install - Client (must run server side install first) - Uninstall only
deletes client files. With this type of install the Toad.exe and Toad.chm files were
installed on a server. The files on the server will have to be manually deleted.
Network Install - Server - This is run by a network administrator. Toad.exe
and Toad.chm files were installed on the server. An install log was not created
and it did not create an uninstall. This was intentional. If a network administrator
decided to uninstall Toad, this would affect all the workstations. So, network
Toad files must be manually deleted.
So, when network installation is involved, remember that any Toad components
that are installed on the server cannot be uninstalled. They will have to be
manually deleted. When Toad files are installed on the server they always
include Toad.exe and Toad.chm. Toad files on the client (workstation) can be
uninstalled.
Toad for Oracle
24
Server Side Installation
Wizard
Overview
Features with server side objects
Install, upgrade, or remove
objects for all users to share
Install or remove objects for an
individual schema to use
Create Setup scripts without a
Database Connection
Set up Wizard Finished
3
Toad for Oracle
26
Overview
During the installation you have the opportunity to install the server side objects
for Toad via the Server Side Installation wizard. After installation, you can access
the wizard from Toad via the Tools menu.
The Server Side Installation wizard lets you add, remove, or update the server
side objects for Toad features that require objects installed on the server side of
the Oracle instance.
Features with server side objects
The following are features with server side objects:
Explain Plan Tables - displays formatted plan info and saves plans
can install in the following schemas: Toad, Individual, Publicly Accessible
Toad Profiler interface to DBMS_PROFILER
can install in the following schemas: Toad, Individual, Publicly Accessible
Toad Security - lets you restrict users' access to specific Toad features
can install in the following schema: Toad
SQL Tuner - a SQL analyzer that lets you locate and tune SQL statements, see
the SQL Tuning topic in Toad Help for more information
can install in the following schema: Publicly Accessible
Team Coding - lets users check in and check out PL/SQL objects and optionally
associate those objects with a third party source control provider
can install in the following schemas: Toad, Publicly Accessible
Server Side Installation Wizard
27
Toad Space Manager - part of the Quest DBA Module, tracks space usage and
I/O over time
can install in the following schema: Toad
*The Space Manager wizard helps you set up the privileges for Toad, but the
View Tablespaces window will install and administer the objects.
The server side objects apply only to their corresponding features, and Toad's
other features will run successfully without the server side objects.
The Server Side Installation wizard simplifies installing and administering these
objects. In order to install server side objects, you will need to have access to
either the account for the Toad user, the account for the schema where you are
installing them, or an account with the DBA role.
FEATURES WITH
SERVER SIDE
OBJECTS
TOAD INDIVIDUAL
PUBLICLY
ACCESSIBLE
Explain Plan X X X
Profiler X X X
Security X
SQL Tuner X
Team Coding X X
Space Manager* X
Toad for Oracle
28
Radio buttons let you:
Install, upgrade, or remove objects for all users to share
Install or remove objects for an individual schema to use
Create setup scripts without a database connection.
Install, upgrade, or remove objects
for all users to share
If you choose the Install, upgrade, or remove objects for all users to share
radio button the next screen is a connection information window. It includes
three radio buttons:
Install or remove shared objects in the Toad schema
Drop the entire Toad schema and all public synonyms for its objects
Install or remove shared objects in a schema other than Toad.
Install or remove shared objects in the
Toad schema
Use this option to create and administer a repository schema called Toad. This
schema gives you a central location from which to maintain the tables needed to
run the above mentioned portions of Toad. You could create some of these
objects (Explain Plan and Profiler) in every schema in which you intend to use
them (every schema would have these same tables) but if you have a large
number of users, using the Toad schema is more efficient.
Checkboxes let you select which Toad features that include server side objects
you would like to Add, Remove, and depending on the situation Administer,
Recreate, Recompile, or Repair. Below each object title Toad lists the status by
checking the schema. The possible status messages are:
Found and OK
Not found
Error (An Error notice describes the problem.)
The window asks:
Which objects would you like to administer in the Toad schema?
Server Side Installation Wizard
29
The checkboxes and additional options are for:
Toad Security
SQL Tuner Privileges (The SQL Tuner admin pane lets you drag and drop
between the Granted and Ungranted lists.)
Explain Plan Tables
Toad Profiler
Team Coding
Toad Space Manager (part of Quest DBA Module, must be setup within Toad
while connected to the Toad schema)
Drop the Toad schema and all public
synonyms for its objects
This option lets you easily drop both the Toad schema and all the public
synonyms associated with it.
The next screen asks you to enter the connection information. DBA privileges
are required. Enter the database where you want the Toad schema dropped.
The Toad user and associated public synonyms are dropped. If you previously
used this client to set up Team Coding on your database, you will also get
prompted to drop any roles that you created for Team Coding.
Install or remove shared objects in a
schema other than Toad
You need to log in as the owner of the shared objects. (You cannot install Toad
Security outside of the Toad schema.) The window asks:
Which objects would you like to administer?
The checkboxes and options are for:
Explain Plan tables
Toad Profiler
Team Coding
Toad for Oracle
30
Install or remove objects for an
individual schema to use
Explain Plan support and Toad Profiler support can be provided on an
individual basis.
If you do not want to create the Toad user, you can create and administer some
of the objects in the schemas where you intend to use them. This might be more
efficient if you have a small number of users for these special features and you
do not want all of your users to have access.
If you choose this option, remember that each user who needs to use the
features will have to have setup done individually.
The next window is a connection information window and asks for the log on
information for the user account where you want to create the objects
Create Setup scripts without a
Database Connection
You can create the scripts to set up the Toad schema, etc. without access to the
database connection that you need. Then you can log in later and run the scripts.
The checkboxes let you select and save the desired setup scripts to disk.
Set up Wizard Finished
The last screen announces that the script has been run or saved and that set up
is complete.
If there were errors they are noted, and you are referred back to the log to
verify.
Toad runs other checks on your database and describes:
Status of SYS.DBMS_DEBUG (required for use of the Debugger
feature)
Status of SYS.DBMS_PROFILER (required to use Toad Profiler).
Registration
Trial Version Registration
Purchase
Product authorization errors
4
Toad for Oracle
32
Trial Version Registration
To Start Trial Toad
1. Start Toad.
2. The Product Authorization window displays.
3. Click in the Product Authorization textbox.
4. Enter the software registration key number
If you have previously used a Toad trial key you will get an "Invalid Key"
message. A trial key can only be used once, even between different versions of
Toad.
Registration Key
If your registration key has not been activated after a certain time period, it
expires. This is to ensure that you are not evaluating an old copy of Toad. We
want users to have the latest and greatest copy to evaluate. So, if your
unactivated key expires, download the latest trial copy and get your new
registration key, or call Quest Sales at 949-754-8000 for a trial extension.
If you are satisfied with the trial version and want to purchase the commercial
license key, refer to the next section. Remember, you'll need to update your
license key through Help | Register Toad.
Before you register the trial version of Toad you need your registration key.
The PL/SQL Debugger and the Quest DBA Module are activated in the trial
key.
Registration
33
Purchase
To purchase the latest version or place a large order you can either:
Contact Quest Sales at 949-754-8000 to discuss payment options
OR
Visit the Quest Software Web site at www.quest.com.
You'll receive a temporary key in the download.
After your order is processed, your permanent license key is sent to you. Then
go to the Help menu, click Register Toad, and enter your new authorization
key number, also known as the license or registration key number. Enter the Site
Message such as Company Name. In the future, when you download upgrades
from the Quest Web page you'll need the license key number. Select Help|
Register Toad, highlight your number from the authorization key number box,
Copy, and Paste the number.
You might need to restart Toad to reinitialize your options and enable all
functions.
Toad for Oracle
34
Product authorization errors
The following table shows steps that you can take when encountering an
authorization problem or error in Toad.
ERROR MESSAGE EXPLANATION AND POSSIBLE SOLUTION
Authorization string has expired. This occurs when the trial authorization for Toad
has expired.
If the trial date has not passed, check that the
date on your system is set correctly.
Invalid authorization string or
site message.
This indicates that the authorization string or the
site message has not been entered correctly.
Make sure that they have been entered exactly.
The site message is case sensitive.
If you try to use a trial key more than once you
will get an Invalid Key message because trial
keys can only be used once.
Features
Overview
SQL Editor
Schema Browser
Procedure Editor
Options Menu
Toad Help
5
Toad for Oracle
36
Overview
This chapter introduces you to a few of Toad's many features. To learn more
about these or other features refer to Toad Help and the Toad User's Guide.
SQL Editor
Ways to invoke the SQL Editor window include:
Click the button in Toad's main toolbar.
Select menu item Database | SQL Editor.
Set the SQL Editor to StartUp on new connection in the View|
Options |Windows dialog.
Right-click on the Connection toolbar and select New | SQL Editor.
The SQL Editor lets you type, edit, recall, execute, and tune. The editing window
is in the top panel and the results panel, the lower panel, displays fetched data.
The results panel contains tabs for Data, Explain Plan, Auto Trace, DBMS Output,
Script output, CodeXpert, and Query Viewer. A horizontal splitter between the
editor and results panel lets you size each component.
The SQL Editor window supports standard windows editing commands but
includes other functions such as a gutter for quick multi-line text selection,
programmer style double-click highlighting, and syntax highlighting of
categories, keywords, table names, and more.
The data grid can be edited. You can rearrange columns (drag and drop) without
having to re-execute your queries. Toad retains the column layout (order and
widths) from query to query as long as the column list in the query remains the
same. You can sort columns in the data grid in ascending or descending order.
If a column has a lot of text, the memo editor can be used. The memo editor is
invoked by double-clicking on a cell.
Features
37
Schema Browser
Ways to invoke the Schema Browser window include:
Click the button in Toad's main toolbar.
Select menu item Database | Schema Browser.
Set the Schema Browser to StartUp on new connection in the View
| Options|Windows dialog.
Right-click on the Connection toolbar and select New | Schema
Browser.

The Schema Browser separates database objects in a selected schema by type,
using tabs (or with a dropdown that you can select through the options menu).
The left panel lists the objects and the right panel displays the details. You can
hide, rearrange, or rename object tabs through the context menu.
Toad can create scripts (through the Create Script buttons on the object tabs),
for most objects that are displayed in the Schema Browser. You can copy object
names and column data from the Schema Browser panels to a clipboard or
another application.
Toad for Oracle
38
Procedure Editor
Ways to invoke the Procedure Editor window include:
Click the button on Toad's main toolbar.
Select menu item Database | Procedure Editor.
Set the Procedure Editor to StartUp on new connection in the View |
Options | Windows dialog.
Right-click on the Connection toolbar and select New | Procedure
Editor.
The Procedure Editor lets you create or modify procedures, functions, packages,
triggers, types, and type bodies. If you have the PL/SQL Debugger, the debugger
buttons will display enabled.
The left panel contains the Navigator List. The right panel contains the Procedure
Editor, which shows the code for the selected object. The tab interface allows
multiple objects in the window.
Options Menu
To access the Options Menu click the Configure Toad Options button on the main
toolbar or select the View | Options menu item. Click a topic from the left
panel and options for that topic appear in the right panel. Click in the boxes or
on the item text to check or uncheck the options. Keyboard users can press the
<Tab> key to move from the left panel to the right panel and press <SPACE>
to check or uncheck boxes.
More options are in the Edit|Editor Options window and the Formatter
Options window. Both windows can also be accessed from buttons on the main
View|Options window.
Toad Help
To access Toad Help while in Toad, simply press the F1 key. Toad Help includes
contents, a searchable index, and details on Toad's features.
Troubleshooting
Overview
Cannot connect to Personal Oracle
PATH Environment
Support
6
Toad for Oracle
40
Overview
This section discusses troubleshooting installation and connection problems. For
a comprehensive list of Frequently Asked Questions refer to the toadsoft.com
site and follow the links.
Cannot connect to Personal Oracle
If you are having trouble connecting to Personal Oracle or creating a SQL*Net
alias for PO7 or PO8, then for the database name on the Toad login window try
one of the following entries:
2:
BEQ-LOCAL
LOCAL
TCP-LOOPBACK
For Schema/Passwords try one of the following pairs:
DEMO/DEMO
SCOTT/TIGER
SYS/CHANGE_ON_INSTALL
SYSTEM/MANAGER
PATH Environment
The most frequent cause of problems is the resetting of the PATH environment
variable. To set your default Oracle home, you can use the Oracle Home selector
(provided with Oracle) to set it accurately. Refer to your Oracle documentation
for more information.
Troubleshooting
41
Support
If you have questions about using Toad, and you can't find the answers in this
guide, the user's guide or Toad Help please contact the customer support staff.
The Help | Support Bundle menu item window provides updated support
information and tools for contacting support.
The information it contains will be useful for support when resolving issues and
you should include this support information with emails to Quest Support. The
Support Bundle window is discussed in detail in the Toad User's Guide -
Frequently Asked Questions/Support chapter and in Toad Help.
Toad for Oracle
42
43
A
aliases.txt 19
C
connections.ini 17
D
DBA.sdf 21
Debugger Module 2, 9
disk space 9
E
error messages 34
F
fmtoptions.exe 17
fmtplus.dll 17
fmtplus.opt 17
fullToad.lic 16
H
Help 3, 14, 38
I
install 8, 11
local install 11
network installation 12
install.log 14
install.txt 14
Installation notes 15
L
longscr.txt 19
O
Options Menu 38
Oracle 8i Data Dictionary.sdf 21
P
plsql.dci 20
plsqlscr.txt 19
plsqlsub.txt 20
Procedure Editor 38
purchase 33
Q
Quest DBA Module 2, 9
Quest Software
Support 41
R
readonly.lic 16
release notes 14
releasenotes.htm 3, 15, 21
reportsparams.ini 17
requirements 9
revbase.dll 16
S
Schema Browser 37
schema objects.sdf 21
schema.flt 17
Script Manager Files 21
shortscr.txt 19
SQL Editor 36
T
Team Coding 26
Team Coding DLLs 18
Toad Getting Started Guide 3, 14, 21
TOAD Help 3
Toad Profiler interface to
DBMS_PROFILER 26
Toad Security 26
Toad Server Side Objects wizard 15,
17
Toad Space Manager 27
Toad Users Guide 3, 14, 21
Toad.chm 12, 16, 21
Toad.exe 12, 16, 21
Toad.ini 17
Toad.lic 16
Toadload.wav 17
Toadreports.exe 17
Toadserverside.exe 17
Toadstats.ini 21
troubleshooting 40
tuning modules 9, 10
U
uninstall 23
uninstall.exe 16
INDEX
Toad for Oracle
44