Quest Software 8.5 Toad for Oracle software User's Guide

PDF

Document

Toad

for Oracle

User’s Guide

Version 8.5

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 trademarks of Quest Software, Inc. Other trademarks and registered trademarks used in this guide are property of their respective owners.

World Headquarters

8001 Irvine Center Drive

Irvine, CA 92618 www.quest.com

email: [email protected]

U.S. and Canada: 949.754.8000

Please refer to our Web site for regional and international office information.

Toad for Oracle User’s Guide

Updated - April 2005

Software Version - 8.5

C ONTENTS

C

HAPTER

1 I

NTRODUCTION

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

T OAD O VERVIEW . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

L OGIN S CREEN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

C ONNECTING TO P ERSONAL O RACLE . . . . . . . . . . . . . . . . . . . .11

E ND C ONNECTION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11

C

HAPTER

3 S

CHEMA

P

REPARATION

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13

S ERVER S IDE I NSTALLATION WIZARD . . . . . . . . . . . . . . . . . . .14

E XPLAIN P LAN TABLE . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14

C

HAPTER

4 B

ASICS

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15

M OUSE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16

K EYBOARD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .18

H OTKEYS - ADDING / ALTERING . . . . . . . . . . . . . . . . . . . . . . .19

R IGHT CLICK MENUS . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20

W INDOW B AR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20

M AIN T OOLBAR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .21

C ONFIGURE T OAD O PTIONS . . . . . . . . . . . . . . . . . . . . . .21

S AVE T OAD O PTIONS . . . . . . . . . . . . . . . . . . . . . . . . .21

O FFLINE T EXT E DITOR . . . . . . . . . . . . . . . . . . . . . . . . .22

C ONFIGURE /E XECUTE E XTERNAL T OOLS . . . . . . . . . . . . . .23

P ROJECT M ANAGER . . . . . . . . . . . . . . . . . . . . . . . . . . .23

O BJECT P ALETTE . . . . . . . . . . . . . . . . . . . . . . . . . . . .25

C USTOMIZE ( TOOLBARS AND MENUS ) . . . . . . . . . . . . . . . . . . .26

T OOLBAR O PTIONS . . . . . . . . . . . . . . . . . . . . . . . . . . .27

M ENU S HORTCUT C USTOMIZATION WINDOW . . . . . . . . . . . . . . .29

D OCKABLE WINDOWS . . . . . . . . . . . . . . . . . . . . . . . . . . . . .29

C

HAPTER

5

Toad for Oracle

SQL E

DITOR

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .31

O VERVIEW . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .33

SQL E DITOR T OOLBAR . . . . . . . . . . . . . . . . . . . . . . . . . . .34

F ORMAT C ODE T OOLBAR . . . . . . . . . . . . . . . . . . . . . . . . . . .34

S OURCE C ONTROL T OOLBAR . . . . . . . . . . . . . . . . . . . . . . . .34

SQL R ECALL T OOLBAR . . . . . . . . . . . . . . . . . . . . . . . . . . . .34

C URRENT S CHEMA T OOLBAR . . . . . . . . . . . . . . . . . . . . . . . .34

S HORTCUT K EYS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .35

U SING THE SQL E DITOR . . . . . . . . . . . . . . . . . . . . . . . . . .39

S ELECTING A TABLE TO EDIT . . . . . . . . . . . . . . . . . . . . .39

N AVIGATOR P ANEL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .40

SQL R ESULTS P ANEL . . . . . . . . . . . . . . . . . . . . . . . . . . . .40

D ATA TAB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .40

E XPLAIN P LAN TAB . . . . . . . . . . . . . . . . . . . . . . . . . . .46

A UTO T RACE TAB . . . . . . . . . . . . . . . . . . . . . . . . . . . .47

DBMS O UTPUT TAB . . . . . . . . . . . . . . . . . . . . . . . . . .47

S CRIPT O UTPUT . . . . . . . . . . . . . . . . . . . . . . . . . . . . .47

Q UERY V IEWER . . . . . . . . . . . . . . . . . . . . . . . . . . . . .48

C ODE S NIPPETS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .49

M AKE C ODE S TATEMENT AND S TRIP C ODE S TATEMENT . . . . .49

E XPLAIN P LAN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .52

E XPLAIN P LAN T REEVIEW . . . . . . . . . . . . . . . . . . . . . . .54

R ECALL AND A DD SQL . . . . . . . . . . . . . . . . . . . . . . . .57

O PTIONS FOR THE SQL E DITOR . . . . . . . . . . . . . . . . . . . . . .61

SQL O PTIONS PAGE . . . . . . . . . . . . . . . . . . . . . . . . . .61

M AKE C ODE PAGE . . . . . . . . . . . . . . . . . . . . . . . . . . . .63

S CRIPT O PTIONS PAGE . . . . . . . . . . . . . . . . . . . . . . . . .63

E XECUTING S TATEMENTS . . . . . . . . . . . . . . . . . . . . . . . . . .65

E XECUTE SQL S CRIPTS . . . . . . . . . . . . . . . . . . . . . . . .67

T ABLE /V IEW A LIASES . . . . . . . . . . . . . . . . . . . . . . . . .73

C ONFIGURING THE E DITOR . . . . . . . . . . . . . . . . . . . . . . . . .75

U SER CONFIGURABLE S YNTAX C OLOR H IGHLIGHTING . . . . . . .75

B OOKMARKS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .78

Contents

U SER DEFINED KEYSTROKES FOR COMMON EDITING COMMANDS 78

A UTO R EPLACE S UBSTITUTIONS . . . . . . . . . . . . . . . . . . .79

C ODE C OMPLETION T EMPLATES . . . . . . . . . . . . . . . . . . . .80

U NDO /R EDO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .81

C OMMENT C ODE B LOCK . . . . . . . . . . . . . . . . . . . . . . . .81

U NCOMMENT C ODE B LOCK . . . . . . . . . . . . . . . . . . . . . .81

L OCATE C LOSING P ARENTHESIS (F IND C LOSING B LOCK ) . . . .82

F IND , F IND N EXT , F IND P REVIOUS , AND R EPLACE . . . . . . . .82

S HOW A LL FOLLOWING A SEARCH . . . . . . . . . . . . . . . . . .83

C ONFIGURABLE P RINT O PTIONS . . . . . . . . . . . . . . . . . . .83

E DITOR O PTIONS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .84

G ENERAL O PTIONS . . . . . . . . . . . . . . . . . . . . . . . . . . .85

H IGHLIGHTING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .91

K EY A SSIGNMENTS . . . . . . . . . . . . . . . . . . . . . . . . . . .94

A UTO R EPLACE . . . . . . . . . . . . . . . . . . . . . . . . . . . . .95

C ODE T EMPLATES . . . . . . . . . . . . . . . . . . . . . . . . . . . .98

R IGHT CLICK MENU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100

O PTIONS FOR THE E DITORS . . . . . . . . . . . . . . . . . . . . . 101

S CRIPT D EBUGGER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106

C ODE X PERT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106

SQL S CAN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106

C

HAPTER

6 D

ATA

G

RIDS

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107

O VERVIEW . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

R IGHT CLICK MENU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

S ORT O PTIONS W INDOW . . . . . . . . . . . . . . . . . . . . . . . . . 118

C ALCULATOR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119

D ATA G RIDS - D ATA O PTIONS . . . . . . . . . . . . . . . . . . . . . . 120

D ATA G RIDS - V ISUAL O PTIONS . . . . . . . . . . . . . . . . . . . . . 123

R EPORT L INK D ESIGNER . . . . . . . . . . . . . . . . . . . . . . . . . . 128

O PTIONS TAB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128

C OLORS TAB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129

F ONTS TAB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130

iii

Toad for Oracle

B EHAVIORS TAB . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130

M ISCELLANEOUS TAB . . . . . . . . . . . . . . . . . . . . . . . . . 130

C

HAPTER

7 P

ROCEDURE

E

DITOR

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131

O VERVIEW . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133

P ROCEDURE E DITOR T OOLBARS . . . . . . . . . . . . . . . . . . . . . 133

S HORTCUT K EYS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134

P ARAMETER H INTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136

U SING THE P ROCEDURE E DITOR . . . . . . . . . . . . . . . . . . . . . 136

N AVIGATOR T REE B UTTONS . . . . . . . . . . . . . . . . . . . . . . . . 140

O PTIONS FOR THE P ROCEDURE E DITOR . . . . . . . . . . . . . . . . . 141

R IGHT CLICK MENU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144

DBMS O UTPUT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145

S OURCE C ODE M ANAGEMENT . . . . . . . . . . . . . . . . . . . . . . . 147

T EAM C ODING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150

PL/SQL D EBUGGER . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152

T OOLTIP F EATURE FOR V ARIABLES . . . . . . . . . . . . . . . . . 154

T HE S TATUS P ANEL I NDICATORS . . . . . . . . . . . . . . . . . . 154

T HE D OCKABLE W INDOWS . . . . . . . . . . . . . . . . . . . . . 155

P REPARING PL/SQL C ODE FOR P RODUCTION . . . . . . . . . . 155

C

HAPTER

8 S

CHEMA

B

ROWSER

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157

O VERVIEW . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159

U SING THE S CHEMA B ROWSER . . . . . . . . . . . . . . . . . . . . . . 160

O PTIONS FOR THE S CHEMA B ROWSER . . . . . . . . . . . . . . . . . . 166

O BJECTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177

R EFRESH O PTIONS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178

C USTOM Q UERIES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179

F OREIGN K EY L OOKUP . . . . . . . . . . . . . . . . . . . . . . . . . . . 180

T ABLES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181

O BJECTS P ANEL . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183

D ETAILS P ANEL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190

V IEWS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197

S YNONYMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197

Contents

P ROCEDURES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198

T RIGGERS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199

I NDEXES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200

C ONSTRAINTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200

S EQUENCES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201

JAVA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201

DB L INKS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201

U SERS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202

J OBS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202

T YPES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202

Q UEUE T ABLES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203

Q UEUES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203

C LUSTERS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203

F AVORITES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203

C

HAPTER

9 O

THER

F

EATURES

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205

Q UEST S CRIPT R UNNER . . . . . . . . . . . . . . . . . . . . . . . . . . . 207

L AUNCHING Q UEST S CRIPT R UNNER FROM C OMMAND L INE . . 209

C OMMANDS S UPPORTED . . . . . . . . . . . . . . . . . . . . . . . 210

SQL M ODELER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211

SQL M ODELER O PTIONS . . . . . . . . . . . . . . . . . . . . . . 220

C ODE R OAD M AP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222

ER D IAGRAM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223

C REATE /A LTER T ABLE . . . . . . . . . . . . . . . . . . . . . . . . . . . 224

C REATE T ABLE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224

A LTER T ABLE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225

T OAD R EPORTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226

HTML S CHEMA D OC G ENERATOR . . . . . . . . . . . . . . . . . . . . 227

N ETWORK U TILITIES . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230

T OAD S ECURITY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234

S ESSION B ROWSER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236

J AVA FEATURES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237

O PTIONAL Q UEST DBA M ODULE . . . . . . . . . . . . . . . . . . . . . 238

DBA WINDOWS . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238

Toad for Oracle

S CHEMA B ROWSER AND C REATE M ENU . . . . . . . . . . . . . . 240

V IEW T ABLESPACES . . . . . . . . . . . . . . . . . . . . . . . . . 241

C ODE R OAD M AP AND ER D IAGRAM . . . . . . . . . . . . . . . 241

F LAT F ILE E XPORT WINDOW . . . . . . . . . . . . . . . . . . . . . 241

K NOWLEDGE X PERT ™ FOR O RACLE A DMINISTRATION . . . . . 241

C

HAPTER

10 Q

UESTIONS

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243

Q UESTIONS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244

T OAD H ELP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244

C USTOMER S UPPORT . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245

I NFORMATION D ISPLAYED . . . . . . . . . . . . . . . . . . . . . . 246

Introduction

• Toad Overview

Toad for Oracle

Toad Overview

Toad is a powerful low-overhead tool built around an advanced SQL and PL/SQL editor. It was designed from the developer's perspective, and the result is an easy to use, fast, and effective interface. The GUI browsers provide quick access to database objects.

You don't have to be a PL/SQL expert to access database objects when you're using Toad. You can view the Oracle Dictionary, tables, indexes, stored procedures, and more-- all through a multi-tabbed browser.

PL/SQL script writers can use the advanced editing features to save time and increase productivity. Code can be created from shortcuts and code templates.

You can even create your own code templates.

Use Toad to:

• Create, browse, or alter objects (tables, views, indexes, etc.) including Oracle8 TYPE objects

• Graphically build, execute, and tune queries

• Edit, debug, and profile "stored procedures" including procedures, functions, packages, and triggers

• Search for objects

• Find and fix database problems with constraints, triggers, extents, indexes, and grants

• Manage your most common DB tasks from one central window

• Create HTML docs for any schemas, complete with links and customizable for content and style

This guide is a how-to and reference for new users and users already familiar with Toad. The guide does not cover every Toad window, option, and function.

The guide covers the following major windows:

• SQL Editor

• Procedure Editor

• Schema Browser

Introduction

Once you are comfortable navigating around a few of these windows you'll discover that the other Toad windows have a similar design. The manual also covers the following major topics:

• Logon/logoff

• Navigation and shortcuts

The Toad for Oracle folder is referred to in this document as the Toad folder.

Note that this User's Guide was prepared in April 2005. New or changed Toad features since April 2005 are not reflected in this version of the guide. Refer to

Toad Help for the latest information.

Colors are presented in the PDF. The printed version of the User’s Guide is in black and white, so the color differences are not always distinguishable.

For details on installing and uninstalling Toad, refer to the Getting Started Guide

For details on the new features of Toad for Oracle 8.5, refer to Toad Help -

What’s New.

Toad for Oracle

Logon and Logoff

• Login Screen

• Connecting to Personal Oracle

• End Connection

Toad for Oracle

Login Screen

When you start Toad a Login screen displays. The screen lists your previous connections (user, server, and the date and time of the connection). Option boxes next to each connection let you check Auto Connect, Save Password, and

Favorite.

You can create a new connection to Oracle or select from a list of previous connections. All checked connections in the Autoconnect Column are automatically connected each time you start Toad.

The date format comes from the workstation setting in Settings | Control

Panel | Regional Settings | Date | Short date style option.

Server Login

You get to this dialog via the File | New Connection menu item or when Toad starts up.

You can create a new connection to Oracle or select from a list of previous connections. Toad will fill the database dropdown with the names of previous sessions and any aliases in TNSNAMES.ORA.

To create a new connection

Type the name of the database in the dropdown combo box labeled

Database. The server name you use must have an entry in the

TNSNAMES.ORA file.

Type the name of the USER in the textbox labeled User/Schema.

Type the PASSWORD for the user in the textbox labeled Password.

Asterisks will display instead of characters as you type.

Click OK

– OR –

Press <ENTER>.

To use a previous connection

If the View | Options| Oracle | Save passwords for Oracle Connections option is checked

THEN

You can double-click a previous connection from the list in the left panel to automatically logon.

Logon and Logoff

Otherwise, follow these steps.

Select a previous connection from the list in the left panel.

Type in the Password.

Click OK or press <ENTER>.

Toad saves the USER/DATABASE combinations between Toad sessions, but does not save the password.

DO NOT ENABLE THE Save passwords for Oracle connections OPTION

UNLESS YOU HAVE A SECURE ENVIRONMENT.

If the option is unchecked then the Save Pwd? column will display in the previously used connections grid. If you check the column the password is saved for the respective connection in the Login Grid.

To delete a previous connection

Select a connection from the Server, User, Last Connect list.

Press the <DELETE> key.

If you are having trouble running Toad with Personal Oracle 8.1.5

If you are using Toad with Personal Oracle 8.1.5 or later and receiving errors like

"No Listener" try the following:

Open a Command Prompt.

Type "lsnrctl" and <ENTER>

Type the command "start"

Toad for Oracle

Database dropdown

The database dropdown supports multiple aliases for tnsnames.ora entries.

The home that is selected by default in the dropdown at Toad startup is determined in the following order

If an Oracle client DLL is specified as a command line parameter when launching Toad (for example TOAD.exe

OCIDLL=C:\Oracle\Ora92\bin\oci.dll).

The Toad default home

The Oracle default home as determined by Oracle’s Home Selector

If the OCIDLL parameter is used then the Home dropdown is disabled, because every connection will be made with this home regardless of what selection is made in the dropdown

If LOCAL and ORACLE_SID are set for home, LOCAL is used first.

If you do not specify a database from the dropdown list of databases, then the

ORACLE_SID for the selected home is used. If there is no ORACLE_SID value and you do not specify a database in the dropdown, then no connection can take place.

Operating System Authentication

Toad can accept logins where the operating system validates the user and password. Select the database alias and leave the Username and Password textboxes empty. Oracle will prefix your workstation login and attempt a login.

To configure this on the server side, the init.ora initialization parameters file must have: remote_os_authent = true os_authent_prefix = "OPS$" or whatever prefix you select.

For example, Joe Smith logs onto the ORA805 database, enters "ORA805" in the

Database textbox, and leaves Username and Password empty. His NT login is

"JSMITH", which gets prefixed with "OPS$" giving a username of "OPS$JSMITH."

Oracle attempts a login and Toad starts up.

The next time you bring up the Server Login window, any previous logins that were O/S authentication logins will have username = "EXTERNAL". You don't need to type over the word EXTERNAL in the username textbox when reconnecting.

Logon and Logoff

You can use Oracle usernames without passwords in Toad. Whatever you enter in Database, Username, and Password boxes are passed to the database. If the database permits default passwords, you can connect.

Connect using dropdown drilldown button

This button opens the Oracle Home Editor window which shows all Oracle

Homes. It also lets you see which Oracle Homes are valid installs. The information can be copied to the clipboard and pasted into an email for technical support issues.

You can edit SID, NLS_LANG, and SQLPATH by double-clicking or via the right-click menu.

If a SQL*Net entry is not valid, you can click the Advice button for suggestions.

Make this the Toad default home

Check this check box to make the home selected in the dropdown the Toad default home. Uncheck the check box to remove that home as the Toad default home.

If you are upgrading to version 8.5 and you had your Toad default home previously set, you’ll have to reset it on the first execution of Toad 8.5. After that, the default home feature will work as expected.

SQLNet Editor link

This lets you set SQLNET.ORA parameters on the SQLNet editor screen. You can click View File and manually add/edit entries. A Make Settings Editable check box lets you make the screen editable. Clicking OK will save the changes to

SQLNET.ORA. Create Backup File and Restore Backup File buttons on the

SQLNET Editor screen let you create backups and restore backups from that screen.

A green check next to the SQLNet Editor link indicates that a SQLNET.ORA file has been found for that home. A red X indicates that the file cannot be found.

A red lock indicates the file (SQLNET.ORA) is read only.

TNSNames Editor link

This opens the TNSNames editor preloaded with the TNSNAMES.ORA file for the selected home.

Toad for Oracle

A green check next to the link indicates that the TNSNAMES.ORA file has been found for that home. A red X indicates that the file cannot be found.

A red lock indicates the TNSNAMES.ORA file is read only.

The TNSNames Editor supports multiple aliases. To add/edit entries that contain multiple aliases, type each alias separated by either a space or a comma in the

Name:edit box.

Refresh button

This refreshes the previously used connection info for the left pane of the login window, the list of databases from the tnsnames for the database dropdown, and all of the home information from the registry/hard disk for the home selection dropdown.

Save Passwords for Oracle Connections

One of the Toad options is Save Passwords for Oracle Connections. The default for this option is unchecked. When unchecked, Toad puts in the username for the password. When checked, the password is saved in CONNECTIONS.INI. All passwords are encrypted.

Before you check the Save passwords for Oracle Connections box, be sure you work in a secure environment where your CONNECTIONS.INI file will not fall

into the wrong hands.

To turn on the Save Passwords for Oracle Connections option

Go to View | Options | Oracle.

Click Save Passwords for Oracle Connections to check that option.

Either quit Toad and restart

– OR –

Click the Save All Options button in the main toolbar.

Logon and Logoff

Connecting to Personal Oracle

If you are having trouble connecting to Personal Oracle or creating a SQL*Net alias try one of the following four entries for the database name on the Toad login window:

BEQ-LOCAL

LOCAL

TCP-LOOPBACK

For Schema/Passwords try one of the following pairs:

• DEMO/DEMO

• SCOTT/TIGER

• SYS/CHANGE_ON_INSTALL

• SYSTEM/MANAGER

End Connection

You might want to close a connection without exiting Toad.

To close a specific connection without exiting Toad

Go to the File | End Connection menu.

A popup window lists one or more sessions.

Click the session you want to end.

Click OK.

All windows associated with that session are closed. If you have any Prompt to

save before close options on, you will be prompted to save the editor contents so that they are not discarded.

Toad also has an End All Connections option, accessed from the File menu, which will close all connections.

Toad for Oracle

Schema Preparation

• Server Side Installation wizard

• Explain Plan table

Toad for Oracle

Server Side Installation wizard

During the installation you had the opportunity to install the server side objects for Toad via the Server Side Installation wizard. The wizard also lets you remove or update the objects. You can access the wizard while in Toad from the Tools menu. 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.

The Server Side Installation wizard is discussed in detail in the Getting Started

Guide.

Explain Plan table

On the View | Options | Oracle page, you can specify the name of the

Explain Plan table that Toad should utilize. If you change the default setting from Toad_PLAN_TABLE to PLAN_TABLE, Toad will use your existing table, and you do not have to create the Toad table. On the other hand, if you still do not execute the Toad scripts, you will not be able to recall previous Explain

Plan results.

If you do not create the tables needed for storage and retrieval of Explain Plans which you can do automatically via the Server Side Installation wizard, Toad will not display previous Explain Plan results. Explain Plan will still function on the

SQL Edit window providing you specify PLAN_TABLE on the options window rather than Toad_PLAN_TABLE. If you decide NOT to store previous Explain Plan results, you should disable the option Save previous Explain Plan results on the View | Options | Oracle page.

By default, Toad uses the user name plus the date and time to generate a unique statement id for the Explain Plan. (You can change the user name Toad uses for

Explain Plan via the View | Options | Oracle |

User Name for Explain Plan textbox.) If the user has a longer than normal user name, you might need to expand the Statement_ID column of the Plan table.

Basics

• Mouse

• Keyboard

• Hotkeys - adding/altering

• Right-click menus

• Window Bar

• Main Toolbar

• Customize (toolbars and menus)

• Menu Shortcut Customization window

• Dockable windows

Toad for Oracle

Mouse

Toad is designed to be used with a mouse. In addition to left-clicking on items, the right-click button displays right-click menus. Right-click menus are discussed

in the Right-click menu section of this chapter.

Drill Down buttons

Drill down buttons indicate another level of information. Click the drill down button to drill down another layer, which is usually another window.

Check boxes

You will find check boxes throughout Toad. The program is designed to be flexible, and with check boxes you control how Toad looks and functions. You can check multiple items in a check box list. Options you've set in one check box might affect options in another check box.

To place a check in a check box or remove a check from a check box

Click in the check box area or label area

– OR –

Tab to the area with the check boxes and press the up and down arrow keys until your option is highlighted.

Press the space bar.

Basics

Dropdown lists

Dropdown lists are used throughout the Toad screens. The down arrow activates a dropdown menu from which you can choose an item.

Types of Message Boxes

Toad uses the industry standard symbols for its four types of message boxes.

This indicates an information box.

This indicates a question box that requires a decision from you.

This indicates a stop message

This indicates an exclamation (very important) message.

Toad for Oracle

Keyboard

You can use the keyboard for navigation and selection.

TAB

The TAB key lets you advance the cursor forward from one area of a window to another area. The first item in the area you tab to will highlight.

For textboxes, you can TAB to the textbox, and the text cursor displays ready for you to type.

UP/DOWN ARROWS

The UP ARROW and DOWN ARROW let you move your cursor up and down the items or list of whatever area your cursor is positioned in. In a dropdown list the

UP and DOWN ARROWS scroll through the choices in the list.

LEFT/RIGHT ARROWS

The LEFT ARROW and RIGHT ARROW let you move left and right across a list of radio button choices. Once you reach your choice, TAB to move out of the area

(or click outside of the area with your mouse), and your choice remains. You can also use the UP/DOWN arrow keys to move through the radio button choices.

For the Expand and Collapse buttons the LEFT ARROW collapses the list and the

RIGHT ARROW expands the list.

You can also activate Expand and Collapse buttons using the <+> and <-> keys on the numeric keypad. The plus sign "+" expands the list and the minus sign

"-" collapses the list. For hierarchy lists, the multiplication sign "*" expands to all levels.

SPACEBAR

The spacebar lets you check and uncheck check boxes or click buttons with focus.

ENTER

ENTER is similar to a mouse-click. It activates whatever button has focus. For example, if you <TAB> to a CANCEL button and press <ENTER>, you will cancel your choices and exit the window. Pressing <SPACEBAR> on buttons with focus also clicks the buttons.

ESC

ESC cancels most modal dialogs.

Basics

Not Accessible by Keyboard

Toad was designed for a mouse, and some areas of Toad can only be accessed by using the mouse.

For example, you cannot tab to a drill down button. You have to click the drill down button to bring up its associated window.

Hotkeys - adding/altering

The Editor Options Dialog list of key assignments contains a list of the basic editing functions. <CTRL><INSERT>, <SHIFT><INSERT>, and

<SHIFT><DELETE> are mapped to copy (<CTRL>C), paste (<CTRL>V), and cut

(<CTRL>X) automatically.

When you highlight a command, you can alter the key assigned to that command

OR add an additional key. All commands allow for two-part keystrokes; for example, Control-K, 0 for the command "set Bookmark 0."

To set the command for "Bookmark0" to "Control-K, 0"

Click the Edit | Editor Options | Key Assignment item.

Expand the Bookmarks list by clicking the expand "+" button.

Click Set Bookmark 0.

Click the Edit Sequence button.

In the Edit Key Pair step window press <CTRL>K. The key sequence displays in the window.

Click Next.

In the optional Step 2 window displays press 0.

Your second key, 0, displays in the window.

Click Finish.

10. Press OK in the Editor Options window to save the setting.

Note that keystrokes such as <CTRL>J or <SHIFT><INSERT> are ONE stroke keys.

DO NOT CLICK the buttons ADD or DELETE unless the keys you just entered are in addition to the default keystrokes OR you want to remove the displayed keystrokes entirely. If you click DELETE while looking at a command, the hotkey for that command is removed.

Toad for Oracle

Right-click menus

A right-click menu is specific to the window that you are in. Some items in the menu are shortcuts to commands or windows that can be found elsewhere, and some items are unique to the right-click menu and cannot be found anywhere else in Toad.

To access a right-click menu

• Press the right mouse button (right-click)

– OR –

For the Procedure Editor, SQL Editor, and SQL Modeler windows you can also press F10.

Window Bar

A window bar displays at the bottom of the main window screen to indicate what windows are open in Toad. Click a button on the bar to navigate to a window.

The tooltips on the bar display the full window caption.

Options for the window bar (Show connection string on buttons, Show window titles on buttons, and Highlight windows for current connection) appear under

Options |Toolbars.

If you want to undock the window bar from the bottom of the main window, check Options | Toolbars| Allow docking/hiding of read only toolbars.

To turn off/on the window bar, right-click over it and uncheck/check Window Bar.

If you are using a read-only toolbar configuration and you want the window bar to remain turned off, after unchecking Window Bar in the right-click menu, check

Options| Toolbars | Allow docking/hiding of read only toolbars.

Basics

Main Toolbar

The main toolbar buttons include buttons to open the major Toad windows such as the SQL Editor, Schema Browser, Procedure Editor, and SQL Modeler. Buttons also include Object Search, Run Script, Commit, Rollback, New connection,

Configure/Execute external tools, Configure options, and more. You can place the mouse pointer over a button to display its title.

Configure Toad Options

You access the multi-tabbed Toad Options window via the Configure Toad

Options button on the main toolbar or from the View | Options menu item.

Many of the options are discussed in later chapters and in Toad Help.

The Search button lets you search the options for specific text. This is useful, for example, if you can't remember which tab contains the option that you are trying to find. A table displays the list of options that contain the search text you type and the corresponding tab titles. Double-click the option, or click the option and press <Enter> to go to that page.

Save Toad Options

The Save Toad Options button saves external files, which are basically your current Toad settings and values.

This is useful if you are about to run a query that could crash or run for a long time. You might want to Save Toad Options before running such a query, just as a precaution. It saves all Toad options to files in your Toad and Toad\User Files folders including settings from the Toad Options dialog, Editor Options settings,

Recall Previous SQL lists, Lists of MRU (Most Recently Used) files, Table Name alias list, etc.

Toad for Oracle

Offline Text Editor

The Offline Text Editor button opens an Offline Text Editor window. So, you can edit scripts without being connected to an Oracle database.

For example, by modifying the script files that define how the Toad Editor should highlight keywords, you could edit HTML files and have Toad highlight the HTML markup tags in various colors.

The file language types supported are: PL/SQL, HTML, INI, JAVA , and TEXT. You can also open XML files (which will activate the XML Editor).

The View |Options | Parser Scripts dialog is where you set up the file associations for file name extension.

Configure the editor options by loading a file for a language into the offline editor and choosing Edit |Editor Options.

XML Editor

When you load an XML file into the offline text editor, a tree navigator for the

XML displays on the left hand side. You can edit the XML in the text or in the tree.

You can also open the XML Editor on CLOB datatypes that contain the XML page header. Save as works with XML data for some formats. Schema Browser files are stored as XML files.

Basics

Configure/Execute External Tools

This opens the Tool Options window which lets you add programs that can be launched from Toad. The Add button opens a Tool Properties window that lets you add programs, select icons, pass in parameters to the program, create shortcuts (click in the Shortcut box and enter the new keystroke), and add macros. After you've added programs to the Tool Options window, they are available from the Configure/Execute External Tools dropdown list. The icon of the last program you execute from the dropdown replaces the

Configure/Execute External Tools icon. You can then execute the last program by clicking its icon on the toolbar.

An Auto add button searches the registry for a set of preinstalled programs. You select the programs that you want to add. It finds the program file, an icon, and establishes the working directory as the same directory where the executable resides.

Project Manager

The Project Manager lets you manage your common DB tasks from one central window.

The Settings button opens the Configuration window where you can: specify the command Toad executes when you drag a file onto another file or onto a node, customize double-click operations, and customize the pop-up (right-click) menus. It also lets you configure the external associations and the DDL script inclusions.

Toad for Oracle

Project nodes let you store links to folders, connection links, and database objects.

To Add a Project Node

• Right-click and select Add| Project.

– OR –

From the Add Item dropdown select Project.

In order to add a folder to your project, it must exist on your hard drive.

To Add a Folder

• Right-click and select Add | Folder.

– OR –

From the Add Item dropdown select Folder.

When you add a folder, Project Manager maps the folder path. By default, double-clicking on the folder will open Windows Explorer to that folder. You can add items contained in the folder to the Project Manger window so that they can be accessed directly. FTP folders represent connections to a remote server and are located as sub-nodes to a project folder that you create. You can add a separate folder for each server directory that you want mapped.

A Copy feature lets you have more than one project open at once with links to the same files, FTP connections, or schemas. The feature applies to second-level nodes: Schemas, Folders, and FTP Folders.

Basics

To Copy Nodes

Select the node(s) you want to copy (multi-select via <Shift> or

<Ctrl>)

Right-click and select Copy from the menu.

The Destination Projects window displays.

Select the project(s) you want to copy to.

Click Ok.

Different project nodes can contain links to the same items. You can use different schemas or users in each project. Project Manager lets you access your connections, see if you are connected, and connect if the connection is not current. You can combine different Oracle connections and FTP connections into one project. You can configure Project Manger so that it will automatically run a

Schema Compare when you drag one schema node onto another schema node.

For more details about Project Manager refer to Toad Help.

Object Palette

The Object Palette is accessed from the View menu and docks to the main window. It replaces the Table Selector window that was in previous versions of

Toad. It can list tables, views, or synonyms. A toggle button lets you display columns for the selected object. You can also select an object from the list and press F4 to perform a Describe. The Object Palette is required for the SQL

Modeler and the ER Diagram.

Toad for Oracle

Customize (toolbars and menus)

You access the Customize window via the right-click menu Customize command on either the main toolbar or main menu. This window lets you customize the main toolbar and the menu bar. You can also add new menus and new toolbars.

You must have the Customize window open in order to customize toolbars or menus.

If you want your menu lists to automatically hide items that you seldom use, you can turn this option on via the Customize window| Options tab by checking the Menus show recently used commands first option. If checked, the menu lists configure themselves in response to how often you use each menu command, moving the most used commands to the top of the list, and hiding commands that you seldom use. If you check Show full menus after a short

delay, then after you select a menu and wait a few seconds, the remainder of the menu (the hidden menu items) displays. If the Show full menus after a short delay option is unchecked, you can still display the rest of the menu by clicking the down arrow at the bottom of the menu. The Reset my usage data button will reset the menu usage data.

The Customize | Options tab also lets you display large icons, show/hide tooltips, show/hide shortcuts on tooltips, and select menu animations.

If you want to make a lot of changes to the main toolbar, it might be easier to create your own custom toolbar via the Customize window| Toolbars tab.

Click New, name your new toolbar and click OK. Then click-and-drag commands from the Commands tab to your new toolbar. You can remove a command from the toolbar by clicking and dragging it off the toolbar. Notice the commands are categorized by their associated menus. If an icon is associated with the command the button will display the icon by default. You can right-click on an icon to change it to text display, icon and text, edit the displayed text, and other options. When editing text, if you want to define a hotkey (<Alt><key>) type an ampersand (&) before the letter you want underlined. You change a hotkey by changing the position of the ampersand. You can click-and-drag New Menu from the Commands tab to add a menu to your new toolbar.

While the Customize window is open, you can rearrange your customizable toolbar buttons and menus via click-and-drag. You can add a separator between groups of commands by clicking on a button and dragging it slightly left or right.

The customizable toolbars (which includes the main toolbar) can be docked (via click-and-drag) to any side of the screen, or left as floating toolbars which will remain on top of all Toad windows. The Customize window |Toolbars tab lets you show/hide toolbars via check boxes next to each toolbar. Restore the default settings of a customizable toolbar through the Customize window by selecting the toolbar from the list and clicking the Reset button.

Basics

Toolbar Options

View | Options|Toolbars lets you select or add a toolbar configuration. The preconfigured toolbars are read-only. Regardless of the configuration you choose, you will not receive items that you are not licensed to receive.

User Default - keeps your customized toolbar or gives you the Toad Default toolbar (all toolbar items). This is the only choice that is customizable.

Toad Default - all toolbar items that you are licensed to receive. Toad will have to be restarted.

The Add button adds a new toolbar using an existing template that you can later customize. Name is the name you want displayed in the options screen and INI

Filename is the filename for your new configuration.

Allow docking and hiding of read-only toolbars

Default - Unchecked

Unchecked, Toad shows all toolbars in their default location at restart, and you cannot hide or move and dock read-only toolbars (such as the main menu toolbar). Checked, you can move and hide the read-only toolbars.

Lock all toolbars

Default - Unchecked

If checked, this prevents the toolbars from being dragged from their current position and docked elsewhere. The toolbars can be locked in any position, docked or floating.

Use vertical text when toolbars are vertical

Default - Checked

If checked, vertically docked toolbar text will display vertically. If unchecked, vertically docked toolbar text will display horizontally, possibly resulting in a wider toolbar to accommodate the horizontal orientation of the text.

Toad for Oracle

Window Bar

Options let you

Show connection string on buttons (Default-Unchecked)

Show window title on buttons (Default-Checked)

Highlight window buttons for current connection (Default-Checked).

Visual Style dropdown

You can select a new style from the dropdown list.

If you are running on the Microsoft XP OS platform, you can use XP themes.

Standard

This is the original Toad style. Buttons are flat, but appear raised when the pointer is over them and depressed when selected.

Enhanced

This enhances the original Toad style with captions for docked windows and other visual enhancements.

Flat

This style gives a flat, two dimensional effect to the toolbars. Selected buttons are outlined with a hard border.

Office 2003

This style gives the menus and toolbars a blue-gradient Office 2003 style.

XP

This applies the XP style to the menus and toolbars.

Auto-save current desktop on shutdown

Default - Checked

If checked, this saves your desktop options when you shutdown.

Basics

Menu Shortcut Customization window

You can select Menu shortcuts from the right-click toolbar menu, to display the

Menu shortcut customization window. The intuitive window lets you change, create, and reset shortcuts.

Dockable windows

The following windows are dockable: Object Palette, Code Snippets, Project

Manager, Output.

Dockable windows can be pinned or unpinned using the push-pin button. Pinning a window locks it in place where it is docked. Unpinning a window adds a toolbar to the side of Toad where the window is docked and turns on the auto-hide mode.

Multiple windows can be docked on the left, right, or bottom of the main Toad window. Multiple docking configurations can be saved and restored with controls on the Desktop toolbar.

Toad for Oracle

SQL Editor

• Overview

• SQL Editor Toolbar

• Shortcut Keys

• Navigator Panel

• SQL Results Panel

• Code Snippets

• Explain Plan

• Options for the SQL Editor

• Executing Statements

• Configuring the Editor

• Editor Options

Toad for Oracle

• Right-click menu

• Script Debugger

• CodeXpert

SQL Editor

Overview

If you have never used Toad, the SQL Edit window is a good starting point. The window contains a multi-tabbed text editing window to compose SQL statements or scripts, a navigator panel, and a results tab to display the results from SELECT

SQL statements.

The SQL Editor lets you type, edit, 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, Code Statistics, and Query Viewer. A horizontal splitter between the editor and results panel lets you size each component accordingly.

The editing window support includes:

• Standard windows editing commands

• Multi-level undo

• Tabbed support for multiple scripts

• Support for files up to 4 gigabytes

• Double-click highlighting

• Popup menu for common editing functions

• Bookmarks for large files

Ways to invoke the SQL Edit window

• 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 Connection toolbar and select New | SQL Editor.

The SQL Edit window contains a main SQL Editor toolbar, an Edit toolbar (for common editing functions such as cut, copy, and paste), a Format Code toolbar, a Source Control toolbar, a SQL Recall toolbar, and a Current Schema toolbar, and a toolbar for the Script Debugger which is included with editions that have debugging functionality.

Toad for Oracle

SQL Editor Toolbar

The SQL Editor toolbar buttons let you Execute the complete or highlighted statement, Execute the statement at the cursor, Cancel the currently running script or statement, Specify a file to save the current editor contents, Save to file, Execute explain plan, Tune, and Change session.

Format Code Toolbar

The format code toolbar lets you access the code formatting functionality. It includes buttons that let you Format Code, Profile Code (display a code statistics summary), and Open CodeXpert (available in the SQL Editor) which opens by default as a docked window at the bottom of the screen.

Source Control Toolbar

The Source Control toolbar is always available. It covers basic source control and should not be confused with Team Coding.

SQL Recall Toolbar

The SQL Recall toolbar includes a named SQL dropdown that is a quick launch for named SQL. The SQL Recall window is discussed later in this chapter.

Current Schema Toolbar

This toolbar lets you work with a schema other than the one where you are connected. It includes a dropdown box listing schemas on that connection. To use the Current Schema feature, you must have the ALTER SESSION privilege.

This feature does not work with script execution or debugging commands.

It will issue the ALTER SESSION SET current_schema command before and after every statement to prevent problems in other windows.

SQL Editor

Shortcut Keys

A few keys to note

F1

You can press F1 to display the Help file.

<ALT><UP> and <ALT><DOWN> will scroll through the SQL history.

F4

Describes an object (table, view, procedure, function, or package) in a popup window. You access an Object Describe window by placing the cursor on the name of a table, procedure, function, package or view in a Procedure Editor or

SQL Editor and pressing F4. The Object Describe windows are similar to the

Schema Browser windows for the corresponding object types.

F10

Displays the right-click menu for the section (Editor or results panel) that the cursor is in

<CTRL>T

Columns Dropdown - You put the cursor on the table name, and a popup window lists the columns in that table.

<ALT><UP>

Goes to the previously executed statement that you've run

<ALT><DOWN>

Goes to the most recently executed statement

<HOME>

Goes to the beginning of the line

<CTRL><HOME>

Goes to the top of the editor. In the data grid, goes to the first row of the column the cursor is in

<END>

Goes to the end of the line

KEYSTROKE

<SHIFT>F2

<SHIFT>F3

<CTRL>F9

<SHIFT>F9

F10

Toad for Oracle

<CTRL><END>

Goes to the last row of the column you are in

You need to be careful when using <CTRL><END>. Toad shows queries quickly. Even in a table with a million rows the response to the initial query is almost immediate. This is because Toad only fetches and displays what it needs. But with <CTRL><END> Toad has to fetch EVERYTHING. This can be a long process. If a table has only a hundred rows, Toad can quickly fetch data when you press <CTRL><END>, but if a table has a million rows, the process could be time consuming.

If you need to examine rows at the end of a large recordset, refine your query with something like:

Select * from table

Where primary_key > value and re-execute it.

FUNCTION

Display SQL Editor section of Toad Help file

Toggle between full screen Editor and Editor/Results Panel display

Toggle full screen grid

Find next occurrence

Find previous occurrence

Describe Table, View, Procedure, Function, or Package in popup window

Execute as script (so does F11)

Toggle results grid

Clear all text

Recall previous SQL statement (invokes SQL Statement

Recall window)

Execute statement

Verify statement without execution (parse)

Execute current statement at cursor

Display right-click menu

SQL Editor

KEYSTROKE

F11

F12

<CTRL>A

<CTRL>C

<CTRL>D

<CTRL>E

<CTRL>F

<CTRL>G

<CTRL>L

<CTRL>M

<CTRL>N

<CTRL>O

<CTRL>P

<CTRL>R

<CTRL>S

<SHIFT><CTRL>S

<CTRL>T

<CTRL>U

<CTRL>V

<CTRL>X

<SHIFT><CTRL>Z

<CTRL><ALT><Pg

Up>

FUNCTION

Execute as script (so does F5)

Pass the editor contents to the specified External Editor

Select all text

Copy

Show Procedure Arguments

Execute Explain Plan on the current statement

Find text (invokes Find Text window)

Goto line (invokes Goto Line window)

Convert text to lowercase

Make Code Statement

Recall Named SQL Statement (invokes SQL Statement Recall window)

Open a text file

Strip Code Statement

Find and Replace (invokes Find and Replace Text window)

Save File

Save File As

Display Columns dropdown

Convert text to uppercase

Paste

Cut

Redo last Undo

Display Previous Statement

Display Next Statement (for use after <ALT><UP>)

Navigates to previous tab in the editor

Navigates to the next tab in the editor

Navigates to the previous results panel tab

Toad for Oracle

KEYSTROKE

<CTRL><ALT><Pg

Dn>

<CTRL>. (period)

FUNCTION

Navigates to the next results panel tab

In the data grids, go to the top of the recordset

In the results grid, go to the first row of the column the cursor is in

In the editors, go to the first row, first column of text.

In the Data Grid, go to the end of the recordset

In the editors, go to the last row, last column of text.

See caution note in this section.

Activate code completion template

Cycle through the collection of MDI Child windows

Execute current SQL statement at cursor

Auto complete tablenames

In version 8.5 the SQL Editor has been merged with the Script Debugger screen. (The Script

Debugger is available in editions with debugging functionality.) Prior to the merge, the Script

Editor and Script Debugger had common keyboard shortcuts. For example F5 in the Script Editor would Execute as Script and in the Script Debugger would Set a Breakpoint. If you are upgrading to 8.5, the merge requires you to resolve the shortcut conflicts by right-clicking on the main Toad toolbar, choosing Menu Shortcuts, and adjusting conflicts to best suit your environment.

SQL Editor

Using the SQL Editor

Selecting a table to edit

To edit a table’s data, you can't simply type Select and the tablename. Nothing will happen. You have to include a rowid in your select statement.

For example, if your tablename is DEPT and you type

Select dept.rowid, dept.* from dept and press <CTRL><ENTER> or F9 to execute, you can edit the data. You must

have Show ROWID in Data Grids checked in View|Options |

Data Grids - Data if you want ROWID to display in the results.

Alternatively, you can type the Toad EDIT command to translate the command into a SELECT SQL statement with ROWID column.

Edit dept and press <CTRL><ENTER> or F9 to execute. Then you can edit the data.

If you want to choose a table and can't remember the title or schema, open the

Object Palette from the View menu. With the Object Palette, you can click on a table name and drag and drop that name to the SQL Edit window.

Then type Edit before the name, and add a space.

Example: edit dept

Press F9.

Your selected table displays in the Results Grid.

Notice the status panel indicator at the bottom of the screen turns green. This indicates that the table data can be edited. When the indicator is red, the data cannot be edited, but it can still be selected and copied.

Toad for Oracle

Navigator Panel

The Navigator Panel displays an outline of the script in the active tab. Click on items listed to jump to that statement in the editor.

The navigator identifies SQL Plus statements, comments, DML statements, and

DDL statements.

If you have the pointer over an item in the navigator, the entire statement displays as a tooltip. Statements must be separated by ";" in order to appear. It must be valid SQL Plus syntax.

SQL Results Panel

The SQL Results Panel tabs include: Data, Explain Plan, Auto Trace, DBMS

Output, Script Output, Code Statistics, Query Viewer, Script Debugger (for editions with debugging functionality), and CodeXpert.

Data tab

The Data Grid is discussed in detail in the Data Grid chapter of this manual.

The SQL Results Data Grid lets you view output from select statements. The Grid lets you take the results of a query and perform a variety of functions and display options. It's more flexible than using SQL* Plus, because you can format the results visually or graphically.

If you type and execute

Select * from tablename in the SQL Editor, you can see all rows and columns of the given table in the results grid.

Editable Data Grid

The data grid that displays the results of the SQL queries is fully editable providing that the query returns an updateable resultset. Query statements

MUST return the ROWID to be updateable.

SQL Editor

For example: select * from employee would not be updateable whereas: select employee.*, rowid from employee would be updateable.

To overcome this obstacle, you can substitute EDIT Items which Toad will translate into the updateable version of the statement.

For example: edit employee

If the resultset is editable but remains read-only, make sure the

View | Options | Data Grid - Data | Default to Read-Only option is not checked.

A red or green box displays in the status panel indicating whether the recordset is editable (green) or not editable (red).

Cursors

You can view cursor data. When a query is run with a cursor, the cell with the cursor will display the word CURSOR. You'll need to right-click the cell and select

Pop-up Editor or double-click the cell to see the cursor data. (In order for the memo editor double-click feature to work the View | Options | Data Grids -

Data | Popup Memo Editor on double-click must be checked.) Data can only be displayed once per cell each time the query is run.

Toad for Oracle

Nested Table Data

You can view and edit nested data. A cell in the results grid that contains the nested data will display the word DATASET. Double-click (if the option is enabled) or right-click and select Pop-up Editor to view/edit the nested table data.

BFILE Data

You can view BFILE data. A cell with BFILE data will display the word BFILE. A column will be added to the grid to show the BFILE directory. Double-click on the cell (if option is enabled) or right-click and select Pop-up Editor to display the data. If it is an image or text file Toad will launch the program that is associated with the extension. Toad does not provide editing capability for BFILE data. If you run the file in an associated program you might or might not be able to edit the file, depending on your rights.

VARRAY Data

You can view and edit VARRAY data. A cell with VARRAY data will display the word VARRAY. Right-click the cell and select Pop-up Editor or double-click the cell (if the option is enabled). The memo editor will display the first 100 entries in the VARRAY.

Object Data

You can view and edit object data. A cell containing object type data will display the data in parenthesis delimited by commas. To view/edit, double-click on the cell (if the double-click option is enabled) or right click on the cell and select

Pop-up Editor.

LONG and LONG RAW

LONG is similar to CLOB, and LONG RAW is similar to BLOB. Toad can handle all four of these datatypes.

Toad does not display the data for LONG RAW columns in a SQL Edit Grid. LONG columns are columns that contain character data up to 2 gigabytes. You define them as "long" in your SQL script. LONG RAW columns contain binary data that cannot be displayed such as GIFs, Word docs, etc.

LONG columns display the first several characters, and LONG RAW columns display as (BLOB).

SQL Editor

LONG RAW columns display as (BLOB).

Double-click a LONG or

LONG RAW column to display the memo editor.

You edit these columns by double-clicking on the column and editing from the popup windows that display. For LONG columns, the Memo Editor window is displayed. For LONG RAW columns the Blob Edit window is displayed. If the popup window does not display, go to the View | Options | Data Grids tab and make sure the Popup memo editor on double-click option is checked. It must be checked for the above functionality to work.

The popup editor for LONG columns displays the column text. You can edit in the editor or load a file into the editor. The popup editor for LONG RAWS provides

Load From File or Save to File functionality.

Double-clicking on the LONG

COLUMN $define popups a memo editor that contains the column text.

Toad for Oracle

Load From File lets you select a file from your hard drive and place it into the

LONG RAW column in the Oracle database.

Save To File lets you take the data from the LONG RAW column from the database and save it to a file on your hard drive.

Note that the recordset has to be editable for the popup editors to edit the data.

You can still use the popup editors to have a read-only view of the data.

To Edit LONG and LONG RAW Columns

LONG Columns

The recordset has to be editable for the popup editors to edit the data.

Create a table: "create table long_test (id number, long_col long)"

Edit the table: "edit long_test"

Insert a row: enter "1" for ID, then double-click on the long col cell

Enter text.

Click the right arrow. "select * from long_test" should view all records, including (at least the first few chars) the long cols.

LONG RAW Columns

Create a table: "create table long_raw_test (id number, long_raw_col long raw)"

Edit the table: "edit long_raw_test"

Insert a row: enter "1" for ID then double-click on the long raw col cell

Pick a file to import.

Click the right arrow Next Record button. "select * from long_raw_test" should view only id, long_raw_col should display

(BLOB).

SQL Editor

Single Record View

The Single Record View button is present throughout Toad data windows and result grids. It is located on the top left of the table.

Click the Single Record View button, and the Single Record View window displays for the record of the item you've selected. The arrow buttons in the window let you move up and down the columns. You can also insert records, delete records, and post edits.

Here, the location for Department 30, Sales, was changed from Chicago to New York.

Toad for Oracle

Time Values

When displaying dates with times, Toad suppresses the time values if they are

12:00:00 AM (midnight). The time portion of the date fraction is zero, so Toad adds no value to the display of the date.

Oracle stores dates as a big fraction number offset from January 1, 4712 B.C. It is then converted to a complete date and time. Whether or not you use time, it's in there. It will also work accurately well past Y2K.

Performing a query:

SELECT SYSDATE FROM DUAL will display the time, and similarly, queries of DATE datatype columns will display the time if it is not midnight.

The time dropdown in the Toad Options | Data Grids - Data dialog (or right-click on the grid and select Grid Options) is for display purposes and does not affect the storage of time values.

Explain Plan tab

The Explain Plan tab displays the Explain Plan for the selected SQL statement including partition information for Oracle 8 and above. The interface has tabs for

Operation, Object name, Rows, Bytes, Cost, TQ (Object Node), In/Out, PStart

(Partition Start), and PStop (Partition Stop).

Explain Plan can be printed from the SQL Editor window via the right-click menu item.

Viewing previous Explain Plans via View | Explain Plan will not work unless you first create the tables needed for storage and retrieval of Explain Plans which you can do automatically via the Server Side Object wizard (see the

Getting Started Guide).

Explain Plan is discussed in more detail later in this chapter.

SQL Editor

Auto Trace tab

Auto Trace displays the results of every statement issued while in auto trace mode. It helps with tuning. When you run a query you can find out some performance statistics related to that query. Auto Trace is not recommended if a query is going to return a lot of rows, because it will force a read of all data from the results of a query.

DBMS Output tab

When you execute a DBMS Output statement, the DBMS Output will automatically display in the DBMS Output tab of the results grid.

Buttons let you Turn Output On/Off, Clear window, Set Output Buffer Size

(invokes the Set DBMS Output Buffer window where you can set the size), Save to file, Print, and Delete Screen.

Frequency of polling

You can set the frequency of polling (2 seconds to 15 seconds).

You can also open a new DBMS Output window by selecting the Open a new

DBMS Output window button.

DBMS Output is discussed in the Procedure Editor chapter.

Script Output

When you execute a script the results automatically display in this tab. When executing as script, you are not prompted to save changes because the script is not saved to a temp file. You can print from the Script Output tab via the right-click | Print menu item.

The script editor allows multiple editor tabs (like in the Procedure Editor) each with its own results sets in the lower part of the editor. You can run multiple queries and get multiple grids back (one for each data set returned) using the new execute button.

Toad for Oracle

Query Viewer

This tab displays currently running background queries, the database where they are running, their current execution time, and the SQL.

Toad’s main Query Viewer window (under the View menu) shows all the user queries that Toad has run.

The Error tab displays any error messages.

SQL Editor

Code Snippets

Code Snippets is a popup reference for Oracle SQL functions and expressions.

To access the Code Snippets window click View | Code Snippets.

In the Code Snippets window, an explanation of the item or function displays in the lower panel. Items can be dragged and dropped into your SQL script.

The code snippets templates are in the Toad directory in Templates.xml. You cannot directly edit the templates. You would need to make modifications via the

View | Options | Editors | Code Snippets page.

Make Code Statement and Strip Code

Statement

The SQL Edit window contains two functions that simplify copying SQL statements from Toad to code development tools such as Delphi, VB, C++, Java, or Perl, and from those code development tools back to Toad. The functions are called Strip Code Statement <CTRL>P and Make code Statement

<CTRL>M, available from the SQL Editor menu.

Make Code Statement

Adds the code development tool syntax to the SQL statement in the SQL Editor, and makes it ready to paste into the development tool code.

When making code statements, rather than changing the code in the SQL Edit window as the Strip Code Statement function does, the Make Code Statement function takes the currently highlighted SQL statement, translates it into the code development tool syntax, and copies it to the clipboard. You can now switch to the code development tool and paste in the results. A message displays in the status panel such as "VB statement copied to the clipboard."

If you have multiple SQL statements in the SQL Editor, highlight the statement you want to make before executing the Make Code Statement function.

Strip Code Statement

Strips off the code development tool syntax from the SQL statement, and places it on the clipboard ready to paste.

If you have multiple SQL statements in the SQL Editor, highlight the statement you want to strip before executing the Strip Code Statement function.

Toad for Oracle

Selecting the Code Development Tool

You select the code development tool from the View | Options | SQL Editor |

Make Code | Make Code Format dropdown menu. The Make Code Format dropdown menu lets you select a language syntax for Toad to convert a SQL statement into (Make Code Statement function) and out of (Strip Code

Statement function). Delphi, VB, C++, Java, and Perl are supported. The default selection is VB. You can also create your own language templates.

For information about Creating Make Code language templates, refer to Toad

Help.

The Make Code options page also includes two checkboxes.

Select SQL statement based on cursor position

Default - Unchecked

When this option is selected, Toad will look at the location of the cursor and determine which SQL statement to select.

Strip Code copies to clipboard

Default -Unchecked

When checked, if you choose to strip code, the code you strip is copied to the clipboard so that you can easily undo the operation. If you later strip additional statements, or perform other tasks that place data on the clipboard, the code is overwritten. Only the most recent action is saved.

SQL Editor

External Editor

You can use an external editor to edit the SQL Editor contents. To set up, go to the Toad Options | Editors | External Editor Command Line. Enter the drive letter, path, and executable name of the external editor you want, e.g.,

c:\winnt\notepad.exe %S. While in the SQL Editor or Procedure Editor, press

<CTRL><F12> to invoke the external editor, which will start and load up the current Toad Editor contents. Use the external editor, save the contents, quit the external editor.

• You will be prompted to reload the contents of the file only if the

View | Options | Procedure Editor | Reload files when

activating Toad if the file time stamp is changed option is checked.

Toad for Oracle

Explain Plan

Explain Plan (also called Execution Plan) displays steps that will occur in the selected SQL statement. This lets you visually see the steps. The purpose of

Explain Plan is to determine the execution plan Oracle follows to execute a specified SQL statement. The Explain Plan function inserts a row describing each step of the execution plan into a specified plan table. If you are using cost-based optimization, Explain Plan also determines the cost of executing the statement based on the statistics that have been stored for the table.

Viewing previous Explain Plans via View | Explain Plan will not work unless you first create the tables needed for storage and retrieval of Explain Plans which you do automatically via the Server Side Object wizard (see the

Getting Started Guide). <CTRL> E Explain Plans in the SQL Editor will work regardless, but it you have not created the tables needed you must set the

Previous Explain Plan Results option is checked.

To execute Explain Plan on a SQL Statement

In the SQL Editor, place the cursor on a SQL statement, go to SQL Window|

Explain Plan Current SQL (OR <CTRL>E).

If View| Options| Oracle| Save previous Explain Plan results is checked, then Explain Plans are stored in:

Toad_PLAN_SQL and

Toad_PLAN_TABLE

SQL Editor

To run Explain Plan

Load a SQL Script into the SQL Editor.

Click on a SQL statement such as Select, Insert, Update, or Delete.

Select SQL Editor| Explain Plan Current SQL menu item.

Explain Plan results display in the results grid.

Notice the Explain Plan results have expand and collapse buttons. They let you display the details that you need to see.

If you attempt to activate an Explain Plan and you have not created the needed

Toad temp tables (which you can do automatically via the Server Side Object wizard during the install or from the Tools menu (see the Getting Started Guide), you get an error message telling you the table or view does not exist.

You can copy the Explain Plan hierarchy to the Windows clipboard or send it to the printer with a right-click over the Explain Plan output and selecting either the

Copy to Clipboard or Print Results menu item

View Explain Plan

View Explain Plan displays a list of the previous Explain Plans that you've executed.

To Access View Explain Plan

Go to the View| Explain Plan menu item.

Click the Explain Plan item.

A list of previous Explain Plans displays.

You must have the View | Options | Oracle | Explain Plan Table Name menu item entered, or you will not be able to view previous plans. The default entry is Toad_PLAN_TABLE.

Toad for Oracle

Explain Plan Treeview

The Explain Plan treeview lists the contents of the Toad_PLAN_TABLE for the given statement id.

Operation

The concatenation of the OPERATION and OPTIONS columns of the plan table.

Object Name

The value of the OBJECT_NAME column of the plan table.

Rows

Number of rows accessed. This comes from the CARDINALITY column of the plan table. If appropriate, the number is converted to K (thousands), M

(millions), or G (1000 millions, or billions).

Bytes

Number of bytes accessed. This is the value of the BYTES column of the plan table. If appropriate, the number is displayed in Kilobytes, Megabytes, or

Gigabytes.

Cost

The value of the COST column of the plan table. If appropriate, the number is displayed in K (thousands), M (millions), or G (1000 millions, or billions). This column is not applicable to rule-based optimization.

Object Node

This column contains the contents of the OBJECT_NODE column used to keep track of the order in which operation's output is consumed for parallel queries.

SQL Editor

In/Out

The (abbreviated) value of the OTHER_TAG column in the plan table. It indicates how this step relates to the previous and subsequent steps with regard to parallel query execution.

ABBREVIATION

(blank)

P->S

P->P

PCWP

S->P

PCWC

MEANING

Serial execution

Parallel to Serial

Parallel to Parallel

Parallel combined with Parent

Parallel from Serial

Parallel Combined with Child

PStart

This column represents the DISTRIBUTION and PARTITION_START columns of the plan table.

ABBREVIATION FOR PSTART

ROWID

KEY

KEY(I) n n, m

MEANING

Row Location

KEY

KEY(INLIST)

Partition number for first partition in range

Partition and sub-partition number for first partition in range

Toad for Oracle

PStop

This column represents the PARTITION_STOP column of the plan table.

ABBREVIATION FOR PSTOP

ROW L

KEY n n, m

MEANING

Row Location

KEY

Partition number for first partition in range

Partition and sub-partition number for

last

partition in range

An operation's location in the treeview is determined by the values of LEVEL, ID,

PARENT_ID and POSITION for the row containing it.

Refer to Oracle documentation for more information on how to read and interpret an Explain Plan output.

SQL Editor

Recall and Add SQL

You access the Add and Recall SQL dialogs items through the SQL Editor menu.

The purpose of Add/Recall SQL is to create a list of previously executed SQL statements in order to recall them at a later date instead of having to retype them.

You can check the Save Only Statements that are Valid check box in the

View | Options | SQL Editor page. This check box item will only save those

SQL statements that execute successfully. This prevents the list from containing misspelled column names, etc.

SQL Recall Window

The SQL Recall window is dockable and can be pinned or hidden.

The SQL Recall window displays a list of the last X number of statements executed. The default number is 100, but you can change this in the options.

The maximum is 999.

Every statement executed in the SQL Editor is added to the statement recall list, unless you choose the option to only save valid ones. This list is organized with the most recent SQL at the top. You can select a statement from this list and run it, you can remove a statement from the list, and you can name your statements for easy recall. You can save a SQL statement as either a Personal SQL or Named

SQL.

All statements (to a maximum set in the SQL Options) are saved between sessions of Toad in the file Toad\User Files\savedsql.xml.

The SQL Recall window displays the Name of SQL (if any), SQL statement,

Connection information, and Date and time of last connection.

There are also tabs to display All SQL and Single SQL which show more detail of a long SQL statement.

You can search by clicking in the SQL Contains dropdown.

The SQL Recall window is dockable within Toad.

The SQL Recall Window toolbar is composed of two parts: the Main toolbar and the SQL Filter toolbar. You can hide or display each part.

Main SQL Statement Recall Toolbar

Toad for Oracle

The Main SQL Statement Recall toolbar includes commands for working with the

SQL statements that Toad has archived. You can save and copy SQL statements, remove selected SQL statements from the SQL list, Display connection information and the date last executed, edit via double-click in appropriate cell, and group by connection or SQL type.

SQL Filter Toolbar

The SQL Filter toolbar contains filtering options for your list of SQL statements.

The SQL Contains dropdown lets you filter the list by a character string contained within the SQL. The Database dropdown lets you filter by Database. The Show dropdown lets you display History, Named, or Personal SQL statements.

To recall a SQL command

• Press F8

– OR –

• Select SQL Command Recall from the View menu

Running a Recalled SQL Statement

After a SQL statement is recalled and placed in the SQL Editor, press

<CTRL><ENTER> or <SHIFT>F9. Toad will search backwards one line from the current cursor position to find a SQL statement to execute.

Add to Personal SQLs

Selecting this command from the SQL Editor menu adds the SQL statement that's in the SQL Editor to your Personal SQLs. You can later recall the statement by using the Recall Personal SQL command.

Toad saves all statements in this list between sessions of Toad in a file named savedsql.xml in the Toad\User Files folder.

To Add a SQL Statement to the Personal SQL List

Select the statement by highlighting it in the editor.

Click menu item SQL Editor| Add to Personal SQLs.

SQL Editor

Add to Named SQLs

This window lets you add a SQL statement to a user's Named list.

To Add a SQL Statement to the Named SQL List

Select the statement by highlighting it in the editor.

Click menu item SQL Editor| Add to Named SQLs.

Type the name you want to assign.

Click OK.

Recall Named SQL

Use this dialog to pick a SQL statement from your named list of SQLs, then copy it back to the SQL Edit window for execution. The Recall SQL window for Recall

Named SQL lists the names on the left panel and highlights the corresponding

SQL statement on the right panel.

The SQL statements are stored in the Toad\User Files\savedsql.xml file.

More about Recall

You can view recalled SQL statements in groups or individually and move them into editors.

To view all SQL statements

From the View menu select SQL Command Recall.

Click the All SQL tab.

To view Personal and Named SQL

From the View menu, select SQL Command Recall.

Click the All SQL tab.

Use the SQL Filtering toolbar to filter out everything but the

Personal or Named SQL from the grid.

To view individual SQL

From the View menu select SQL Command Recall.

Select one or more SQL statements.

Click the Single SQL tab.

In the single SQL tab, the operators F4, <CTRL> click, and right-click Describe are available.

You can open SQL statements in the SQL Editor or drag-and-drop them into the

Procedure Editor or Text Editor or by double-clicking them in the All SQL grid.

Toad for Oracle

To drag-and-drop SQL statements

Select one or more SQL statements from the SQL Recall window.

Drag the selection to one of the editors and drop the selection in the editing window.

If you want to open a SQL Statement in the SQL Editor, double-click on the desired SQL statement.

You can scroll through the previous statements directly within a SQL Editor edit panel by pressing <ALT> <UP> or <ALT> <DOWN>.

SQL Editor

Options for the SQL Editor

You access the Toad Options menu via the Configure Toad Options button on the main toolbar or by selecting the View| Options menu item.

SQL Editor Options are in three dialogs: Options | SQL Editor,

Options | Editors, and Edit | Editor Options.

The Options| SQL Editor contains numerous options on three pages.

SQL Options page

Only show one SQL Editor per database connection

Default - Unchecked

If checked, Toad will permit only one SQL Editor window to be opened per connection. This is similar to the one Schema Browser and one Procedure Editor per connection options.

Scan statements for bound variables before execution

Default - Checked

If checked, Toad will scan SQL statements for bound variables and ask you for the values before execution. If unchecked Toad sends the query as is to Oracle.

Default - Unchecked

If checked, Toad will show the statement execution time in the status panel. If unchecked, Toad will show the statement execution time until you perform further editing, then the status panel will show the row and col location of the cursor in the editor.

Toad for Oracle

Automatically poll for DBMS Output if Output detected

Default - Unchecked

If checked, Toad scans statements run in the SQL Editor, looking for a

DBMS_OUTPUT.PUT_LINE statement. If one is found, then Toad enables DBMS

Output, polls once, and then disables DBMS Output again. The default is unchecked.

Apply COMMIT and ROLLBACK to all tabs in the SQL Editor. This only

applies when threaded queries are used.

Default - Unchecked

Prompt to save contents when closing editor

Default - Checked

If checked, Toad will prompt you to save any text you typed in the editor.

If unchecked, you will still be prompted to save modified files loaded into the editor.

Close query (grid) when clearing the SQL Editor

Default - Checked

If checked, this clears the Data grid whenever you clear the SQL Editor.

Allow Clear All Text (buttons and F7 hotkey)

Default - Checked

If checked, you can press the F7 key to clear all text from the SQL Edit window without a confirmation dialog. If unchecked, F7 will not work, but you can still use the Edit | Clear All menu item.

Max # of SQL statements to save textbox

The default number is 100. The maximum is 999, but performance will be impacted.

This box lets you enter a custom number of SQL statements to save to your

Recall Previous SQL list. The list is saved to and retrieved from the savedsql.xml file. Only the most recently used SQL statements are saved.

SQL Editor

Save only statements that are valid

Default - Checked

If this option is checked, Toad will only save the SQL statements that ran successfully for recall via F8 SQL Statement Recall dialog.

Write saved SQL statements to disk prior to statement Execution

Default - Unchecked

If checked, then Toad writes the list of saved SQL (everything in the SQL Recall window) to the disk just prior to SQL execution. This ensures that if the query crashes Toad during the execution, your SQL history is not lost. Note that it will not save the current option if the option to only save valid SQL is checked, because validation occurs after the query executes.

Make Code page

Make Code and Strip Code, including the Make Code option page are discussed earlier in the Make Code Statement and Strip Code Statement section of this chapter.

Script Options page

Login Scripts frame

Glogin.sql (traditionally for group login settings) and login.sql (user’s personal login settings) are Oracle standards and used by SQL*Plus and other applications. Toad supports these for SQL Editor script executions. The boxes are read-only. Toad uses a SQL*Plus algorithm to find them.

Glogin.sql is executed first and then login.sql is executed. So any settings in login.sql will take precedence over any settings that coexist in glogin.sql.

glogin.sql

glogin.sql is usually located in the ORACLE_HOME\sqlplus\admin folder.

You can edit this file by clicking the Edit File button. The file will open in your selected text editor.

Toad for Oracle

login.sql

Toad finds login.sql by searching the initial working directory of Toad at startup.

It is usually the installation folder unless you have changed the start location.

If login.sql is not found there, Toad searches the SQLPATH for the active home.

SQLPATH can contain many directories each separated by a semicolon.

Execute login scripts

Default - Never

Radio buttons let you select Never, On SQL Editor startup, On reset settings.

Restore SET option defaults before each script execution

Default - Checked

When checked, the SQL Plus SET options will be restored to their default values each time a script is executed in the SQL Editor. If unchecked, changes remain for all executions that follow.

Script Output frame

Limit output from SELECT queries to X rows, 0 will fetch all rows

Entering a number in this box will limit your SELECT to that number of rows. Any results beyond that number of rows will be truncated. 0 shows all rows.

The default is 0.

Font button

This button lets you select the font for your script output.

Default - Courier

SQL Editor

Executing Statements

Press F9

Click the Execute Statement button on the toolbar.

If you only want to process a portion of the edit text

Highlight that portion AND :

Press F9

Click the Execute Statement button.

To execute a single statement among many statements (separated by at least one blank line)

Click or place the caret/cursor within the statement you want to execute AND:

Press <SHIFT> F9 OR <CTRL><ENTER>

Click the Run Current Statement button on the toolbar.

Toad supports query statements, DDL statements, blocks of procedure SQL, etc.

Toad recognizes substitution variables in quotes as follows:

If & is escaped, Toad will not prompt for a value.

If & is the last character in a string, it is not considered a substitution variable.

Toad for Oracle

Bind Variables

You can execute SQL statements in the SQL Editor using bind variables, where a colon leads the bind variable name, e.g.,

Select * from employee where last_name = :NAME and Toad will present the Variables popup window for you to input the value for the NAME bind variable. The values you enter are stored and retrieved for subsequent queries in the PARAMS.TXT file in the Toad\User Files folder.

Substitution Variables

You can also execute SQL statements with substitution variables where the ampersand leads the substitution variable name, e.g.,

SELECT * FROM &schema.EMPLOYEE

and Toad will present the same Variables popup window for you to enter the value for &schema. If you want to query DEMO.EMPLOYEE, enter DEMO. If you wanted to query SCOTT.EMPLOYEE, enter SCOTT.

SQL Editor

Execute SQL Scripts

The SQL Edit window can process SQL scripts that contain DDL statements,

Insert statements, and more. Some SQL*Plus commands are ignored as Toad processes a SQL script. For scripts that contain other SQL*Plus commands, you can still execute your script using the SQL Editor | Execute SQL Window via

SQL*Plus menu item.

A script that is opened in the SQL Editor, edited, and then executed via

SQL*Plus is AUTOMATICALLY SAVED TO DISK before Toad passes it to

SQL*Plus for execution.

SQL*Plus Script Execution statements that are supported include:

BREAK/BRE

BTITLE/BTI

CLEAR (CLEAR SCREEN, SQL, BUFFER not supported)

COLUMN/COL

COMPUTE/COMP (SUM, MIN, and MAX supported at one level of detail)

CONNECT/CON and DISCONNECT/DISC

DEFINE/DEF and UNDEFINE/UNDEF (CONNECT IDENTIFIER, SQLPLUS,

RELEASE, EDITOR not supported)

EXEC/EXECUTE

EXIT/QUIT

PAUSE/PAU

PASSWORD

Toad for Oracle

PROMPT/PRO

REM/REMARK

REPFOOTER

REPHEADER

SET APPINFO

SET AUTOTRACE/AUTOT (default OFF)

SET DEFINE/DEF (default ON)

SET ECHO (default ON)

SET ESCAPE/ESC

SET FEEDBACK/FEED

SET HEADING/HEA (default ON)

SET LINESIZE/LINES (default 80, maximum 2000)

SET SCAN (default ON)

SET SERVEROUTPUT/SERVEROUT (default OFF) - (ON and OFF supported, SIZE supported)

SET SHOW

SET TERMOUT/TERM (default ON)

SET TIMING

SET VERIFY

SET WRAP

SHOW

SPOOL Filename and SPOOL OFF (also SPO) - (In Toad, non-pathed files are created in the Toad directory. In Quest ScriptRunner, non-pathed files are created in the same directory as Quest ScriptRunner. It supports relative spool paths. It passes the SPOOL file to sub-scripts.)

SQL Editor

/ Slash (Required as a separator between certain commands (anonymous blocks, PL/SQL, and Create Type statements). This does not run the contents of the buffer, because Toad does not store a command buffer the same way

SQL*Plus does.)

START

STORE SET

TTITLE

VARIABLE

WHENEVER OSERROR

WHENEVER SQLERROR

SET ARRAYSIZE

SET AUTOCOMMIT

SET AUTOPRINT

SET AUTORECOVERY

SET BLOCKTERMINATOR

SET CMDSEP

SET COLSEP

SET COMPATIBILITY

SET CONCAT

SET COPYCOMMIT

SET COPYTYPECHECK

SET DESCRIBE

SET EDITFILE

Toad for Oracle

SET EMBEDDED

SET FLAGGER

SET FLUSH

SET HEADSEP

SET INSTANCE

SET LOBOFFSET

SET LOGSOURCE

SET LONG

SET LONGCHUNKSIZE

SET MARKUP

SET NEWPAGE

SET NULL

SET NUMFORMAT

SET NUMWIDTH

SET PAGESIZE

SET PAUSE

SET RECSEP

SET RECSEPCHAR

SET SHIFTINOUT

SET SQLBLANKLINES

SET SQLCASE

SET SQLCONTINUE

SET SQLNUMBER

SET SQLPREFIX

SET SQLPROMPT

SET SQLTERMINATOR

SET SUFFIX

SET TAB

SET TIME

SET TRIMOUT

SET TRIMSPOOL

SET UNDERLINE

DEL

EDIT

GET

HELP

HOST

INPUT

APPEND

ARCHIVE LOG

ATTRIBUTE

CHANGE

CLEAR SCREEN

CLEAR SQL

CLEAR BUFFER

COPY

SQL Editor

Toad for Oracle

LIST

RECOVER

RUN

SAVE

SHUTDOWN

STARTUP

SQL Editor

Table/View Aliases

Setting up table or view aliases permits a shortcut for entering columns of a query.

The ALIASES.TXT file is in the Toad\User Files directory. It should look like this: table_name=alias such as:

AAX_ACCESSGROUP_APPLICATION=aax

ACA_ACTIVITY_ACTION=aca

ACC_ACTIVITY_CATEGORY=acc

ACD_ACTION_DESCRIPTION=acd

ACP_ACTIVITY_CONTACT_PARTIC=acp

ACT_ANALYSIS_CATEGORY_TYPE=act

ADD_ADDENDUM=add

ADT_ADDRESS_TYPE=adt

AFP_ACTIVITY_FIRM_PARTIC=afp

AGX_APPLICATION_GROUP_ITEM=agx

DEPARTMENT=dept

To use, simply type something like: select dept.

and a column list will popup for the DEPARTMENT Oracle table.

If you set up these table aliases in ALIASES.TXT, they will be presented on the

SQL Modeler dialog when you select that table to build your query.

Toad for Oracle

To complete the SELECT SQL statement above, use Auto Replace Substitutions named similarly to the table aliases. These are accessible through the Edit|

Editor Options| Auto Replace tab. However, it would take you a long time to add a reasonably sized schema, so it is recommended that you edit \User

Files\PLSQLSUB.TXT. It should look like this: aax_ = AAX_ACCESSGROUP_APPLICATION aax aca_ = ACA_ACTIVITY_ACTION aca acc_ = ACC_ACTIVITY_CATEGORY acc acd_ = ACD_ACTION_DESCRIPTION acd acp_ = ACP_ACTIVITY_CONTACT_PARTIC acp act_ = ACT_ANALYSIS_CATEGORY_TYPE act add_ = ADD_ADDENDUM add adt_ = ADT_ADDRESS_TYPE adt afp_ = AFP_ACTIVITY_FIRM_PARTIC afp agx_ = AGX_APPLICATION_GROUP_ITEM agx dep_ = DEPARTMENT dept i.e., string = string to replace it with

You might want to use the underline _ because it is not as likely that a command will end with the underline _ symbol. Having the alias at the end keeps things tidy. If you type: select dept.

the popup should appear. Select your column name, then continue.

select dept.NAME

from dep_

Press the spacebar and it autocompletes...

select dept.NAME

from DEPARTMENT dept

If you edit ALIASES.TXT or PLSQLSUB.TXT, be sure to close and reopen Toad to re-read the list.

SQL Editor

Tablename Completion

An alternative to using AutoReplace for tablenames is tablename completion.

This works for the logon schema.

Type the first few letters of a table name in your schema, then press <CTRL>.

(period). Toad looks up the list of tables matching the letters. If only one matches, the table name is automatically completed in the editor. If there is more then one match, a popup list appears for you to select the desired table.

For example, if you type dep and press <CTRL>. (period), a list of all tables beginning with dep will popup.

Configuring the Editor

The editor in Toad is used on the SQL Editor and Procedure Editor windows to edit text. The same editor is used in read-only mode on many other windows throughout Toad. This section highlights some of the configurable features. The

Editor Options, which include some of the following options, are discussed in detail in the next section.

User configurable Syntax Color

Highlighting

The editors in the SQL Edit and Procedure Edit windows support flexible syntax highlighting. The highlighting is configurable in the Editor Options window, and the list of reserved words used in each window is also customizable by editing the parser script file. If during a Toad session you have used any window or function that retrieves the tablenames for the active Oracle session, tablenames will be colorized as well.

In order for the editor to support syntax highlighting, the following files distributed with Toad must be located in the Toad\User Files directory:

PLSQLSCR.TXT, for syntax parser scripts

PLSQL.DCI, for code templates

You must have the View | Options | Editors | Load view names from

database at time of first editor window option checked or the Object

Palette must be open.

The View | Options | Procedure Editor| Highlight names of stored

procedures option is checked by default.

Toad for Oracle

Editor Parser Scripts

The primary configuration for the editor comes from an editor parser script text file that is loaded at runtime. This file is editable but be VERY careful if you decide to edit this file because NO technical support for altered scripts will be provided.

The particular editor parser script is determined from the language of the object in the editor buffer. In the SQL Edit window editor, this language is always

PLSQL. In the offline text editor and in the Procedure Editor you can also have languages HTML, INI, JAVA, and TEXT. The language is determined from the file extension, e.g., HTML, and is configured in the View| Options | Parser

Scripts page| Language / File Extension Associations grid.

SQL Editor

The list of languages and editor parser scripts shipped with Toad is:

LANGUAGE

HTML

INI

JAVA

PL/SQL

TEXT

EDITOR PARSER SCRIPT FILE

HTMLSCR.TXT

INISCR.TXT

JAVASCR.TXT

PLSQLSCR.TXT

TEXTSCR.TXT

All editor parser script files are stored in the Toad\User Files folder.

Long and Short PL/SQL Editor Parser Scripts

Toad contains two flavors of editor parser scripts: SHORTSCR.TXT and

LONGSCR.TXT. During the install, it defaulted to SHORTSCR.TXT.

LONGSCR.TXT contains almost twice as many items for syntax highlighting and will give you access to over a thousand reserved words and keywords. The longer list might affect performance depending on your editor contents.

If you want to change to LONGSCR.TXT, you can copy LONGSCR.TXT over

PLSQLSCR.TXT. Another way to change your selection is via the View |

Options | Parser Scripts tab. Change the path for the PLSQL Parser Script

File (PLSQLSCR.TXT) to the desired file (LONGSCR.TXT or SHORTSCR.TXT).

If you want to add or remove Oracle SQL Reserved words, PL/SQL Reserved words, or Oracle Keywords from the lists that are syntax highlighted, then edit the PLSQLSCR.TXT file. If you edit the PLSQLSCR.TXT file be careful, because no support will be provided for altered scripts. If you want to add or remove words from the syntax highlighting of the other languages, edit the corresponding editor parser script for that language.

Toad for Oracle

Bookmarks

Bookmarks help you manage files. They are especially useful when you are trying to manage large files. Mark a position within the SQL Editor so that you can easily jump back to that line. You can set up to 10 separate bookmarks within one editor.

Bookmarks can be accessed from the right-click menu.

To set a bookmark

• Press <CTRL><SHIFT># where # is a number between 0 and 9. A small green box containing the bookmark number will appear in the editor gutter.

To jump back to a bookmark

• Press <CTRL># where # is a previously defined bookmark between

0 and 9.

Note that these keystrokes assume you have not altered the default editor keys.

User defined keystrokes for common editing commands

Click Edit | Editor Options | Key Assignments to access the Key

Assignments window.

Select the command from the left panel, and its associated Key Assignment displays in the right panel. The Add or Edit buttons display easy-to-follow steps so that you can add new key assignments or edit existing ones. The Delete button deletes the highlighted key assignment.

SQL Editor

Auto Replace Substitutions

A substitution is a text phrase that corresponds to replacement text. For example, if you specify a substitution pair of ACT = ACTIVITY_CENTERS, when you type ACT and press <SPACE> (or other configurable word delimiters), ACT is automatically replaced by ACTIVITY_CENTERS. If you specify a substitution pair of NDF = NO_DATA_FOUND and you type NDF and press a delimiter, NDF is automatically replaced by NO_DATA_FOUND.

To access Auto Replace, go to the Edit| Editor Options| Auto Replace tab.

Toad already has a list of Auto Replace Substitutions specified including: teh = the, ndf = NO_DATA_FOUND, (c) = ©.

The Toad parser scripts come with a handful of Substitution pairs, but you may edit and add to the list on the Editor Options window. Once saved from this window, the substitution pairs will be saved to an ASCII file named

[Language]SUB.TXT in the User Files directory.

The Auto Replace substitutions for each language type are stored in separate files in the Toad\User Files folder.

LANGUAGE

HTML

INI

JAVA

PL/SQL

TEXT

AUTO REPLACE

SUBSTITUTION FILE

HTMLSUB.TXT

INISUB.TXT

JAVASUB.TXT

PLSQLSUB.TXT

TEXTSUB.TXT

Thereafter, you can continue to alter the substitutions in the Editor Options window or directly in the [Language]SUB.TXT file.

Toad for Oracle

Code Completion Templates

Code templates expand upon the Auto Replace Substitution concept, but a manual keystroke (<CTRL><SPACE>) is required to perform the substitution.

Code templates are more than a single phrase and can contain line feeds. If a vertical pipe character is in the code template, the cursor will be placed at that point in the template. Code templates are loaded from the text file

[Language].DCI from the Toad\User Files folder, where [Language] can be

HTML, INI, JAVA, PLSQL, or TEXT.

Example: One of the code templates defined in PLSQL.DCI is:

[crbl | entire cursor block]

DECLARE

CURSOR c1 IS

SELECT | FROM WHERE;

c1rec IS c1%ROWTYPE;

BEGIN

OPEN c1;

LOOP

FETCH c1 INTO c1rec;

EXIT WHEN c1%NOTFOUND;

END LOOP;

CLOSE c1;

END;

Where:

"crbl" is the macro for the template (the text YOU type)

"entire cursor block" is the description of the template everything following until the next template is the body of the template

Do not leave spaces between the end of the template description and the final right bracket! NT4.0 API calls to manage profile strings have a bug which will cause reading of the templates file to fail.

SQL Editor

If you type "crbl" and press <CTRL><SPACE>, Toad will load the body of the template and place the cursor at the position of the vertical pipe char. If the word or phrase under the cursor does not match an existing macro verbatim, a dropdown list of all macros is displayed.

\User Files\PLSQL.DCI contains sample templates which you can alter to suit your needs.

You can edit the code completion templates directly in the Edit | Editor

Options dialog, Code Templates tab, or via text editor on the *.DCI files.

Undo/Redo

These basic editing commands are accessed from the Edit menu.

COMMAND

Undo

Redo

KEYBOARD SHORTCUT

<CTRL>Z

<SHIFT><CTRL>Z

Comment Code Block

This function comments the selected block of text by adding "--" before each line. This is available on the right-click menus of the editors and is also on the

Main Edit menu.

Uncomment Code Block

This function uncomments the selected block of text by removing "--" from the beginning of each line. This is available on the right-click menus of the editors and is also on the Main Edit menu.

Toad for Oracle

Locate Closing Parenthesis (Find Closing

Block)

Finds the closing parenthesis, "END" for matching "BEGIN", or "END IF" for matching "IF."

If you select/highlight a left parenthesis, "BEGIN", or "IF", this function will show the matching right parenthesis, "END" or "END IF."

Find Closing Block can only be accessed on the right-click menus of the SQL

Editor and Procedure Editor.

Find, Find Next, Find Previous, and Replace

You access the Find and Replace editing options from the Edit menu.

FUNCTION

Find

Find Next

Find Previous

Replace

KEYBOARD SHORTCUT

<CTRL>F

<SHIFT>F3

<CTRL>R

On the Find and the Find and Replace dialogs (Edit|Find, Edit | Replace), you can check the Regular expressions check box to use regular expression syntax for your search. Regular expressions specify text by its characteristics rather than its exact characters. For example, you can find and replace tabs with spaces. The following are some examples of regular expressions.

Carriage return

New line

Form feed

Tab character

Backspace

Space

SQL Editor

Show All following a search

To get to this function, click Edit| Show All.

Only to be used after a FIND. After you use FIND to search through your text for a word or phrase, you can click Show All from the Edit menu and Show All will display wavy red lines under every occurrence of the search phrase. The lines will be removed following any change to the text in the editor.

Configurable Print Options

The Edit | Editor Options| General Options tab provides printing options.

You can check/uncheck the Syntax Highlighting option from the View| Options

General page.

Use Syntax Highlighting when Printing Source Code

This option is checked by default, which means the report will print using the same colors that are displayed in the window. So, color printing is the default for printing SQL Edit text or Stored Procedure Edit code.

If you uncheck the View| Options| General| Use syntax highlighting

when printing source code option, then the SQL text or Stored Procedure Edit code will be printed in standard black and white.

If you get garbage characters on your color printout, turn off the Use syntax

highlighting when printing source code and then try to print again.

Toad for Oracle

Editor Options

Editor Options can be selected, deselected, and modified on the popup dialog window that is available either from the right-click menu of the editor (on the

SQL Edit or Procedure Edit windows) or from the Edit | Editor Options menu item.

The Editor Options lists categories in the left panel: General Options,

Highlighting, Key Assignments, Auto Replace, and Code Templates. Click any of these items to display its corresponding options in the right panel.

The editor options are stored in the [Language]KEYS.BIN and

[Language]OPTS.TXT files in the Toad\User Files folder, where [Language] is either HTML, INI, JAVA, PLSQL, or TEXT. When a change is made to the Editor

Options, the appropriate OPTS.TXT and KEYS.BIN files are written out. Do not attempt to edit these files with a text editor. Use the Editor Options dialog.

LANGUAGE

HTML

INI

JAVA

PL/SQL

TEXT

EDITOR OPTIONS FILES

HTMLKEYS.BIN HTMLOPTS.TXT

INIKEYS.BIN INIOPTS.TXT

JAVAKEYS.BIN JAVAOPTS.TXT

PLSQLKEYS.BIN PLSQLOPTS.TXT

TEXTKEYS.BIN TEXTOPTS.TXT

The Key Assignments, Auto Replace, and Code Templates items have Load

from File and Save to File buttons. Each of these buttons lets you set up two or more collections of keystrokes, auto replaces, and code templates. This is useful on multi-user machines. For example, one user might prefer to use one set of assigned keys, auto replaces, and code templates, and another user might have a different set for a preference.

General Options

General Options contains four categories:

• Printing Options

• Display Options

• Control Options

• General Options

SQL Editor

Click the "+" next to each option to expand its corresponding checklist.

If the checklist is expanded, click the "-" to close the corresponding checklist.

Printing Options

These options are used when you print the editor comments to paper. All are checked by default.

• Wrap lines when printing

• Print line numbers

• Print filename in header

• Print date in header

• Print page numbers

Toad for Oracle

Display Options

The display options let you control what is displayed in the editor.

Display line numbers in gutter

Default - Unchecked

When checked, this option will display line numbers in the gutter, which is a vertical region on the left of the editor used to display bookmarks, breakpoints, line numbers, and allow for multiple line selection with the mouse. If unchecked, line numbers will not display. You might want to increase the width of the gutter, in the Gutter Width textbox, to display large line numbers.

Show right margin

Default - Unchecked

When checked, this option displays a light gray vertical line indicating the right margin. When unchecked, no line to indicate the right margin will appear.

In the SQL Editor or Procedure Editor, you can also drag and drop the vertical right margin line left or right to change it.

No word-wrapping occurs at the right margin line. Word-wrapping is discussed later in this chapter in the Show Word-Wrap Column section.

Show gutter

Default - Checked

If checked, the gutter displays. If unchecked, the gutter does not display. If you have chosen to display line numbers, but you have the Show gutter option unchecked, your line numbers which would display in the gutter will not display.

SQL Editor

Show word-wrap column

Default - Checked

When checked, this displays the word-wrap column, which is basically a dashed vertical gray line on the right side. You have to enter a value in the word-wrap column value box in order for this to display. The default is 0, which means no word-wrap column will display. So, you need to check the Show word-wrap column check box AND enter a value in the word-wrap column box. For example, if you enter 20, a dashed vertical line displays in column 20, and any lines longer than 20 characters will wrap. The vertical word-wrap line can be dragged and dropped to the left or the right, so you don't have to drill down to the editor options dialog when you want to change the column settings. Word wrapping will not begin until you also check the General options | Word-wrap lines check box.

Block cursor on overwrite

Default - Checked

If this option is checked when you press the insert key to change to overwrite mode, the cursor is displayed as a block because it's in overwrite mode providing a visual reminder that it's in overwrite mode. If the option is unchecked, the cursor remains unchanged when you switch to overwrite mode as opposed to changing to a block.

Show wrapped lines with the |> (arrow) glyph

Default - Checked

If checked, this option displays an arrow in the gutter for wrapped lines.

Toad for Oracle

Show control characters

Default - Unchecked

If checked, the control characters (such as paragraph marks, end-of-line characters, spaces, and TABs) will display onscreen in your scripts.

Apply capitalization effects

Default - Unchecked

When checked, this option will apply the capitalization effects that you select from the Highlighting Options section.

Control Options

Allow TCustomSyntaxMemo to be an lDragSource

Default - Checked

When checked, this option lets you select and drag text from an editor to another

Windows application or another Toad window.

Title as Load/Save Filename parameter

Default - Checked

This option is not applicable and not activated.

Track columns in vertical movement

Default - Checked

If this is checked, the editor will attempt to restore the current column position as you key up or down through the lines of text. If the text is wide enough, the current column position is maintained, otherwise it places the cursor at the end of the line.

If this is unchecked, as you key up or down through the lines of text, the cursor column position decrements as the lines of text get shorter.

Respond to dropped files

Default - Checked

If checked, this lets files be dragged and dropped from Explorer to a Toad editor.

SQL Editor

Override word-wrap based on line start char

Default - Unchecked

You can specify a character or characters on the Editors Options dialog

Word-wrap override chars textbox that will override word-wrapping for that line only.

For example, if you want to specify that ">" will override word-wrapping for a line, enter it, set word-wrap to column 16, and you'll get:

This is over 16 chars and will word wrap

But when you begin the line with your specified character ">"

>This is over 16 chars and will not word wrap.

General Options

Auto indent

Default - Checked

If you have an indention already set when you type, it automatically indents the following lines.

Tab to next column

Default - Checked

When checked, the <TAB> key moves the cursor to the next column.

Auto select word on double-click

Default - Checked

When checked, if you double-click on a word in the editor it becomes selected.

Insert TABs into text for TAB chars

Default - Checked

Tabs are inserted into the text when the <TAB> key is pressed. Otherwise, an appropriate number of spaces are inserted.

Toad for Oracle

Insert mix of TAB/SPACE for optimal fill

Default - Checked

If checked, the editor will fill the required gap with a minimum number of characters composed of TABs and spaces.

Type this:

This line of code starts in column 5

So does this line

If the option is checked you get this:

This line of code starts in column 5

<TAB><SPACE>So does this line

Unchecked, you get this:

This line of code starts in column 5

<SPACE><SPACE><SPACE><SPACE>So does this line

Cursor beyond EOL

Default - Unchecked

When checked, you can type text or move the cursor past the right edge of each line of text.

Word-wrap lines

Default - Unchecked

When checked, text will automatically wrap at the Word-wrap Column margin.

If this option is selected, you cannot type beyond the right margin even if the

Cursor beyond EOL option is checked.

SQL Editor

Highlighting

The highlighting options let you select colors, fonts, and capitalization preferences for different items, names, etc. in the current schema. For example,

Reserved word refers to Oracle reserved words. You can change the foreground or background colors for Reserved words, the font, the type size, and even the capitalization. This lets you customize the way your code will appear for whatever is easiest for you to read. A preview pane is provided in the lower part of the window that shows you how the selections you make affect the preview example.

Here, the underline option is checked for datatypes. In the preview screen, the datatype is underlined.

Toad for Oracle

The following items can be syntax highlighted independently:

• Reserved Words

• SQL Functions

• Default Packages

• Exceptions

• Comments

• Identifiers

• Strings

• Numbers

• Symbols

• Datatypes

• Tablenames

• View Names

• SYS Views

• SQL Reserved Words

• PL/SQL Reserved Words

• Default Exceptions

• User Procedure Names

You can syntax highlight tablenames in your schema applying different colors and capitalization effects.

SQL Editor

Display Item

This lists the display items from which you can choose to modify how they will appear. The last three display items, Selected Text, Left Margin, and Gutter, do not refer to actual code content. They have only certain options enabled.

Selected Text

This is an item in the display items that refers to the colors that will display when you select text by either clicking and dragging the mouse over a section of text, or pressing <SHIFT> and one of the arrow keys to select a portion of text. You can change both the foreground and background colors that will display for the selected text. You can preview your new selected text colors before clicking OK, by selecting text in the preview window and seeing how the new colors affect the selected text. The other selection areas such as font are disabled when you click on the Selected Text item. Only the foreground and background color sections are enabled.

Left Margin

This item only enables the background color choice. If the background color default box is already checked, the dropdown menu will be disabled. In such a case, you must uncheck the default box to enable the dropdown menu. The dropdown menu displays a color palette from which you can choose the color for the left margin vertical bar.

Gutter

This item only enables the background color choice. If the Use Default box for the background color is checked, the dropdown button is disabled. In such a case, you need to uncheck the Use Default box so that the dropdown button is enabled.

Default

The default item lets you change the appearance of your default text if you want to use colors or fonts that are different from the defaults.

The editor supports only one font name for all display items.

Toad for Oracle

Capitalization Effect

This dropdown list lets you choose how your item will be capitalized. However, the Apply Capitalization Effects check box in General Options | Display

Options must be checked in order for your capitalization effects to display.

Your choices are:

• Unchanged - No special capitalization will be applied.

• Lowercase - The item will appear in all lowercase letters.

• Uppercase - The item will appear in all uppercase letters.

• Initial Caps - The item will appear with only the first letter of each word in caps.

For object names that contain the underscore character, the first letter after the underscore will also be capitalized, e.g., Table_Name.

Capitalization effects are only applied to your text after you change lines up or down in the editor. E.g., type:

select * from table_name and you will not get capitalization effects until you press <ENTER> or go up or down one or more lines then it is translated to:

SELECT * From Table_Name

Key Assignments

Clicking on the Key Assignments item displays the corresponding Key

Assignments options. The Key command categories listed are:

• Bookmarks

• Caret movement

• Clipboard operations

• Deletion operations

• Miscellaneous

Click the expand button to expand a category's list.

Select an item from the list, and that item's keyboard shortcut will display in the

Activation key sequences window.

SQL Editor

Add new sequence

This brings up a series of step boxes that let you add a new sequence by simply typing the sequence in the step boxes.

Edit sequence

This lets you edit the existing sequence through a series of step boxes.

Delete sequence

This deletes whatever sequence is currently highlighted in the Activation key sequences window. If a list of sequences is in the box, you can click a sequence from the list to highlight it and then click the delete sequence button to delete that highlighted sequence.

Auto Replace

Click on Auto Replace to display its corresponding options menu.

Toad already has Auto Replace items including the following.

IF TYPE THIS

(c)

(r)

(tm) ndf teh

REPLACES WITH THIS

No_Data_Found the

Add definition

This box is enabled after you click in the Current selection window and type a character. The first blank window is where you type the text that you want automatically replaced. The window to the right is where you type the replacement text. Then click the Add definition button to add this to the Auto

Replace list. Remember to Click OK before exiting the window. If you exit the window without clicking OK the new definition will not be added.

Replace definition

This button is enabled after you make a selection from the already defined Auto

Replace list, click in the With window (the window next to the current selection window), and type a character in the With window. After you type the new entry

Toad for Oracle that you want to replace the current selection with, click OK and the list will be updated.

Delete definition

This button is enabled after you select a definition from the existing Auto Replace list. Click the Delete definition button to delete the definition from the list. Click

OK and the definition will be deleted.

SQL Editor

Auto Replace activation keys

; , : = [ ] \n \t \s

These keys will separate one word from another and trigger the editor to check for and replace one word for another. "\n" is a carriage return, "\t" is a <TAB> character, and "\s" is a space.

For example, if you type "this;that" then "this" will be autoreplaced when the ";" key is pressed.

The autoreplace items are saved and recalled from the Toad\User

Files\[Language]SUB.TXT file, where [Language] could be HTML, INI, JAVA,

PL/SQL, or TEXT. You can directly edit the SUB.TXT file to add, delete, or change the autoreplace substitutions without having to go through the Editor Options dialog.

LANGUAGE

HTML

INI

JAVA

PL/SQL

TEXT

AUTOREPLACE FILE

HTMLSUB.TXT

INISUB.TXT

JAVASUB.TXT

PLSQLSUB.TXT

TEXTSUB.TXT

Toad for Oracle

Code Templates

Click the Code Templates item to display its associated options.

Shortcut/Description window

This window lists the code templates that are already defined.

Click on an item from this window and its template will display in the display window that is under the Shortcut/Description window.

Add definition

Click the Add definition button, and a new line with the word new appears in the shortcut templates window. You can then type in the shortcut name. Then tab and type in the description.

SQL Editor

Delete definition

The Delete definition button is enabled when you click on a line from the

Shortcut/Description window. To delete a definition, select the

Shortcut/Description you want to delete, click the Delete definition button, and then click OK.

Code template items are saved and recalled from the Toad\User

Files\[Language].DCI file, where [Language] could be HTML, INI, JAVA, PLSQL, or TEXT. You can directly edit the .dci file to add, delete, or change the code templates without having to go through the Editor Options dialog.

LANGUAGE

HTML

INI

JAVA

PL/SQL

TEXT

CODE TEMPLATES FILE

HTML.DCI

INI.DCI

JAVA.DCI

PLSQL.DCI

TEXT.DCI

Toad for Oracle

Right-click menu

Click the right mouse button while you are in the SQL Editor to access the corresponding right-click menu. This provides a shortcut to the functions listed in the menu. You can also press F10 to display the right-click menu.

The right-click menu includes the following:

Formatting Tools

Includes Profiler.

Find Closing Block

Finds the closing parenthesis, "END" for matching "BEGIN", or "END IF" for matching "IF"

Optimizer Mode

This changes the optimizer mode for the entire session. Options include Choose,

Default, Rule, First Rows, and All Rows. This option is not valid for Oracle 10g databases, so it is disabled for the 10g databases.

100

SQL Editor

Options for the Editors

You access this menu via View | Options | Editors menu item.

General

Tnsnames Editor

Reload last used tnsnames file

Default - Checked

If checked, this option automatically loads the last two tnsnames files that you edited into the TNSNames Editor panels.

Backup tnsnames file before saves

Default - Unchecked

If checked, this option will backup the tnsnames file prior to saving the file.

F4 Describe Windows

Use MDI Child Describe Popups

Default - Unchecked

If checked, the F4 popup Object Describe windows will use the Windows Stay on

Top feature. You access a Describe window by placing the cursor on a table, procedure, function, package or view in a SQL Editor or Procedure Editor and pressing F4. The Object Describe windows are similar to the Schema Browser windows for the corresponding object types.

Show Spec along with Body when describing a package

Default - Unchecked

If checked both the spec and body will be included in the Describe

Syntax Highlighting

Include when copying to/from clipboard (RTF format)

Default - Checked

If checked, Toad will copy color markups for pasting into email or other RTF enabled applications. If unchecked, the text will be copied to the clipboard as standard black text.

101

Toad for Oracle

Use syntax highlighting when printing

Default - Checked

If checked, printing will include color highlighting.

Highlight table names

Default - Checked

If checked, will show tablenames in the SQL Edit window and other editors using the syntax highlighting feature. If unchecked, tablenames will appear in black text.

Checkboxes in the option let you

Default - Unchecked

Toad caches tablenames and only queries tablenames the first time they are needed per Oracle session. If checked, this option will cause Toad to requery

Oracle for tablenames every time they are needed to fill a list of tablenames. If the table list is already cached, the list will override the global browser filter for tables when the Schema Browser window is opened.

and/or

Refresh table names list on every display in the Schema Browser

Default - Unchecked

Highlight view names

Default - Unchecked

If checked, view names will display using the syntax highlighting feature.

Highlight stored procedure names

Default - Checked

If checked, stored procedure names will display using the syntax highlighting feature.

102

SQL Editor

Misc.

External Editor Command Line textbox

Enter the drive letter, path, and executable name of the external editor you want, e.g., c:\winnt\notepad.exe %S. While in the SQL Editor or Procedure

Editor, press <F12> to invoke the external editor, which will start and load up the current Toad Editor contents.

Treat underscore character as part of object names

Default - Unchecked

If checked, when you double-click on a word any underbar to the immediate left or right of the word will be treated as part of the object name. If unchecked, when you double-click on a word only the word will be selected and treated as the object name. In the example EMP_BONUS_TAB, if the option is checked and you double-click on BONUS then EMP_BONUS_TAB will be selected. If the option is unchecked only BONUS will be selected.

Default - Unchecked

If checked, will return selected column names into the editors in lower case.

Otherwise they are returned in upper case. This option affects:

• Drag-drop of table names from the Table Name Select popup

• Drag-drop of column names from the Column Name Select popup

• The Clipboard button on the Column Name Select popup

• Drag-drop Code Snippets from the Code Snippets window

• The dropdown when you type in a table name and press "."

• Drag-drop of column names from the Details panel of the Schema

Browser

• Drag-drop of column names from the Describe popups for tables or views

When Find/Replace dialogs activate, default to the word under the cursor in the editor

Default - Checked

103

Toad for Oracle

If checked, when you open a Find and Replace dialog Toad will automatically look for the word currently under the cursor. If unchecked, Toad will default to the word that you most recently searched for.

Default - Unchecked

If checked, will load the .TXT files that populate the Code Snippets window from the network where Toad.EXE and Toad.CHM are read.

104

SQL Editor

Toad Insight

Display pick list after typing object name followed by a period

Default - Checked

If checked, will display the columns dropdown list. If unchecked, will not display the columns dropdown list.

Sort pick lists alphabetically

Default - Checked

If checked, items in the columns popup will display alphabetically.

Display parameter hints after typing open paren "("

Default - Checked

If checked, parameter hints will display automatically when you pause after typing the open parenthesis.

Delay for pop-ups ___ milliseconds spinner.

This lets you set the amount of time that will elapse between when you type a period in a statement that invokes the tables popup window and when the tables popup window automatically pops up. The spinner can be set from 50 to 2000

(2000 would be 2 seconds).

Ctrl-Click package/type procedure jumps to body

Default - Checked

If checked you can Ctrl-Click on a package procedure and jump to the body.

105

Toad for Oracle

Script Debugger

The Script Debugger is a Toad feature that is available with editions that include debugging functionality.

The Script Debugger is an extension of the SQL Editor that lets you debug short scripts. You can load multiple scripts, each in its own tab. It lets you set breakpoints, run to cursor, step over, trace into, trace out, and halt execution.

For more information about the Script Debugger refer to Toad Help.

CodeXpert

CodeXpert is available in the SQL Editor and the Procedure Editor in editions that include debugging functionality. It is a utility that analyzes PL/SQL against a set of best practices rules. The CodeXpert window opens as a tab in the output frame. The window consists of the CodeXpert toolbars, the Results tab, the

CodeXpert Report tab, and the Rules and statements totals.

SQL Scan

The SQL Scan function is included in the Xpert and Suite editions in the

CodeXpert tab via the Launch Rulesets button. Including a SQL scan within your ruleset lets you find additional ways to improve your code. You can attach a SQL scan to all rulesets, or you can attach it to a limited number.

For more information about CodeXpert or SQL Scanner refer to Toad Help.

106

Data Grids

• Overview

• Right-click menu

• Sort Options Window

• Calculator

• Data Grids - Data Options

• Data Grids - Visual Options

• Report Link Designer

Toad for Oracle

Overview

Each data grid includes context menu items and a print dialog. The data grid is used in the SQL Editor, Schema Browser (Tables | Data and Views | Data),

SQL Modeler, and Master/Detail Browser.

Right-click menu

The right-click menu for the Data Grid provides numerous display, printing, and exporting options.

Popup Editor

The Popup Editor is for nested tables, objects, reference columns, bfiles, cursors,

LONG, CLOB, CHAR, or VARCHAR data type columns. Blob Edit is for LONG

RAW/BLOB data type columns. For example, for columns that are long (200 characters or more), when you double-click, a text editor displays. For date columns, a date picker is displayed where you can select a date from a calendar presentation.

To view and/or edit the contents of a large column Memo Edit

If the View | Options | Data Grids | Popup Memo Editor on

Double-Click setting is checked,

Double-click a column to edit its value in the Memo Edit popup window.

– OR –

Right-click to display the right-click menu.

Click the Popup Editor menu item.

If you want to make changes to the data in the Memo Edit popup window, the resultset must be editable. Otherwise, the Memo Edit popup window is read-only.

Print Grid

This invokes the Print window.

108

Data Grids

Save Grid Contents

The Save As right-click menu item displays the Save Grid Contents window which contains format and file options.

Delimiters

Some programs require commas, which is a popular standard, to distinguish the data from one column to another column. The ASCII standard for dividing data is the <TAB> character.

Format radio buttons

Default - Tab Delimited

• ASCII, Comma Delimited - Divides data between columns with commas

• Tab Delimited - Divides data between columns with tabs

• Other Delim Char - You type the character you want to use as a delimiter

• HTML Table - Generates <TR></TR> and <TD></TD> HTML tags

(tags for table rows and columns) and puts the values between the tags

• Insert Statements - Saves the file with Insert statement. When exporting a data grid, it lets you supply the schema and table name.

If multiple tables were right-clicked from the Schema Browser, the schema and table names are filled in automatically.

• SQL Loader - Saves the file in SQL Loader format. The Output file contains both header and data information and is ready to be used by

SQL Loader.

• XLS File - Saves the file as an Excel file, supports "Include Nulls" option

• XLS Instance - Causes Toad to start up Excel if it is not running or connects to an instance of Excel if it is already running and copies the data to Excel. If Excel is already running when this feature is activated the data is created in a new sheet.

• XML Plain - Saves the file as an XML data file with no XSL style sheet

• XML (with XSL) - Saves the file in the old XML format

The options panel includes radio buttons for Insert, Truncate, Append, Replace, and text boxes for entering the Field Separator and the String Fields Enclosed by character.

109

Toad for Oracle

Other options include:

Double Quote Char (text) Columns

Default - Unchecked

If this option is checked, text will be enclosed in double quotes.

7369 "SMITH" "CLERK"7902

Include Column Headers

Default - Unchecked

If this option is checked, the column headers will be included in the text output.

Include NULL Text

Default - Unchecked

If this option is checked, the word NULL will be included for empty cells (cells that contain no information).

Zip resulting file(s)

Automatically zips the file.

You can save to File or Clipboard. If you save to file you can select to launch the file after it is created.

After you click OK, Toad will display a confirmation message that states the number of rows that were exported.

110

Data Grids

Select Columns - Row Numbers

Check or uncheck the columns you want to see. The Select Columns window includes a check box for Row Numbers. This lets you display or hide row numbers in the data grids.

To rearrange the order of the columns

Select the column you want to move by clicking on its header in the grid.

Drag the column(s) left or right as desired.

If after rearranging your columns, you copy the data to the clipboard, or save the data to a file, the data will be in the new column order.

To temporarily hide selected columns

Select the Select Columns item from the right-click menu.

Uncheck the columns you want to hide. They will NOT be included when you copy to clipboard or save to file.

This does NOT requery the data from the database. It just temporarily hides the columns.

111

Toad for Oracle

To set the column widths to a custom width setting

If you want to see more or less of a column,

• Move the mouse pointer to the grid headings, over the border between two columns, and drag it left or right.

If the columns of a query are the same from query to query, then Toad retains these custom column widths. You could add a WHERE clause, or an ORDER BY, etc., re-execute the query, and the column widths would remain the same.

If the columns of a query are different, then the grid columns will be sized according to the View | Options | Data Grids - Visual | Size columns to

the width of the headers, Size columns to the width of the data and Allow

columns to be less than the header width options.

Export to Flat File

When you Export to Flat File, you export data to an ASCII file without column delimiters. The spec file indicates start and end points for columns which you can edit.

On the Options tab select the table to export. You must set up the Specifications

File which will define the table name, table owner, how many lines in the output file will be covered by a single record of data, the columns of data, what line they will appear on, the starting column, and the length of each column of data.

Spec File tab

This is where you set up where your columns will begin and end.

Spec Filename

You can type in your filename or use the drill down to choose a target path.

Execute

This button exports the data to the file.

112

Data Grids

Save Spec File

This saves your specifications file and all your edits.

Generate Columns

This creates columns for your specifications file based on the DDL for the table, not the width of the actual table data.

Example of a specification file:

TABLENAME=EMPLOYEE

TABLEOWNER=DEMO

LINESPERRECORD=1

COL1=EMPLOYEE_ID,1,1,5

COL2=LAST_NAME,1,6,15

COL3=FIRST_NAME,1,21,15

COL4=MIDDLE_INITIAL,1,36,1

COL5=JOB_ID,1,37,4

COL6=MANAGER_ID,1,41,5

COL7=HIRE_DATE,1,46,22

COL8=SALARY,1,68,10

COL9=COMMISSION,1,78,10

COL10=DEPARTMENT_ID,1,88,3

The basic format for the column definition lines is:

COLx=COL_NAME,Output_row_num,Start Col,Num Columns

Flat File Export from Table window

You can also create a flat file from a table using the Database | Export |

Table as Flat File menu item. On the Options tab, you would select the schema and the table to export.

SQL Loader tab

This tab lets you set up the import parameters for the file that you are exporting so that you can later import it through Oracle SQL Loader.

113

Toad for Oracle

Find Data

The Grid Data Find window lets you search through selected columns for selected values or characters. You can specify whether you want the search case sensitive, and whether or not you want to have partial matches.

To find data

From the right-click menu or from the main Grid menu select Find

Data. The Grid Data Find window displays.

Select the Column you want to search.

Enter the keyword or Value to find.

Click the ADD button.

Select the desired case sensitive and partial match options.

Click OK.

Toad will search all records for the value and position the recordset to the first matching value. If the records are cached, the search is fast. If Toad needs to query ahead in the recordset, you'll have to wait for additional rows to be fetched from the database.

This dialog lets you enter a multiple column search criteria.

Example: ENAME = 'SMITH' AND JOB = 'CLERK'

You can press <F3> to find the next row with the specified value.

Duplicate Row

This item lets you copy an entire row.

114

Data Grids

To copy one row to create a new one

Edit the recordset.

Click in a cell of the row you want to copy.

Select the Grid | Copy Row menu item (also accessible from the right-click menu).

This copies the entire row to the bottom of the SQL Results grid ready for you to edit. NOTE: the recordset MUST be editable before

the Copy Row function will work.

After you edit the cell contents, move to the row above in order for the row to be sent to Oracle. If you want to cancel from adding this row, press the <ESC> key.

Record Count

This displays a message window that shows the count of the number of records in the recordset. Record count is cancelable in the SQL Editor, the Schema

Browser, the Master/Detail Browser, and the SQL Modeler.

Set Sequence Field

This invokes the Set Sequence Column window which lets you apply a previously created sequence to the selected column on the data grid. After the sequence is applied, if you add a new record in the table and leave the sequenced column blank, Toad will auto-generate the next number in the sequence applied to the column. Columns with assigned sequences are displayed in aqua.

The following example uses Set Sequence Field.

Run the following scripts in the SQL Editor. They will create a table called

SEQ_TABLE with columns titled FIRST_NME, LAST_NME, and ID_NMR. It creates a Sequence called SEQA that starts with 1, increments by 1, and has a maximum value of 4.

DROP TABLE SEQ_TABLE CASCADE CONSTRAINTS ;

CREATE TABLE SEQ_TABLE (

FIRST_NME CHAR (20),

LAST_NME CHAR (20),

ID_NMR NUMBER (4) NOT NULL,

CONSTRAINT UNIQUEID

UNIQUE (ID_NMR))

CREATE SEQUENCE SEQA START WITH 1 INCREMENT BY 1 MINVALUE 1 MAXVALUE

4 NOCACHE NOCYCLE NOORDER

115

Toad for Oracle

Next, you need to display the data grid for SEQ_TABLE. You can do this through the SQL Editor or the Schema Browser. For this example, use the Schema

Browser.

From the Schema Browser | Tables list select the SEQ_TABLE. In the details panel click the Data tab. The cells are currently empty of data.

Right-click in the data grid and select Set Sequence Field.

The Set Sequence Column window displays.

From the Sequence dropdown select SEQA. From the Column dropdown select ID_NMR.

Click OK.

Insert data in the record for FIRST_NME and LAST_NME.

When you click the Insert Record button 1 is automatically entered

Insert 3 more records of names.

The ID_NMR column populates with 2, 3, and 4.

Try to Insert data for a 5th record. An error message displays.

"ORA-8004: sequence SEQA.NEXTVAL exceeds MAXVALUE and cannot be instantiated." This is because you set the maximum records of the sequence to 4.

You can then delete the extra record.

116

Data Grids

Fix Current Column

You can select and fix columns. Click in a column, right-click, and select Fix

Column to fix the selected column. The column(s) you select will be anchored to the left. The fixed columns remain locked to the left in view during horizontal scrolling. Once a column is fixed, other columns can be dragged into the fixed area. To move a column out of the fixed area click and drag it to the right of the bold horizontal fixed column divider bar. When you display Row Numbers they automatically display as fixed columns.

Preview Current Column

This displays a full row below each data row to show the value of the selected column. This is useful for viewing long varchar columns.

Remove Preview Column

This removes the Preview Column.

Allow Multi-Select

When this is checked, you can select more than one row by pressing <CTRL> and the rows you want to select. If you accidentally select a row you want to deselect, press <CTRL> and click the row and it will be deselected.

When Multi-Select is not checked, you can only select one row at a time.

Grid Options

This invokes the Data Grids - Visual page which contains numerous display options including fonts and column sizing. This is discussed in detail later in this chapter. The Font option is on the Data Grids - Visual page.

Size Columns

You have a choice of

• Size Columns to Data

• Size Columns to Headers

About Row Height

You can easily adjust the height of your rows by moving your mouse to the gutter (the left of the first column) and over a row divider line until you get the double arrow, then click-and-drag the row up or down to increase or decrease its height. The new height adjustment automatically applies to all rows in the table. Row height adjustment is useful for viewing varchar columns.

117

Toad for Oracle

Sort Options Window

The Sort Options window lets you sort columns in ascending or descending order. It also lets you remove sorts. It is invoked when you click on a grid column header under specific conditions in the Schema Browser and SQL Editor.

In the Schema Browser, if a sort filter has not been applied via the filter button, you can click on a column header and invoke a Sort Options window that contains 3 radio buttons: Remove Sort, Sort Ascending, Sort Descending. You have to click the apply button for your sort choice to apply. You cannot sort row numbers. Once you apply a sort via the filter window (which you can do in the

Schema Browser), the column-click sorting is disabled until you clear the sort filter via the filter window.

In the SQL Editor, if the query does not contain an Order By, the grid is sortable via the Sort Options window.

The View | Options | Data Grids - Visual | Confirm sorts when clicking

on column header option is checked by default.

118

Data Grids

Calculator

You access the calculator by clicking on a number in an editable cell and pressing

<Enter>. A dropdown arrow displays. Click the arrow and a calculator will display. You can use the calculator to perform calculations in the cell. When you get your final result press <Enter> or click outside of the calculator area, and the new number remains displayed in the cell.

119

Toad for Oracle

Data Grids - Data Options

You access the Toad Options menu via the Configure Toad Options toolbar button on the main menu or by selecting the View | Options menu item. The Data

Grids Data options are on the Options | Data Grids - Data page.

Default to Read-Only Queries

Default - Unchecked

This option controls the ability to fetch updatable result sets in the data tab of the Schema Browser. If checked, you cannot edit data in the data tab of the

Schema Browser. If unchecked, you automatically get editable grids in the

Schema Browser and Master/Detail Browser. This option does not affect the result sets in the SQL Editor. Regardless of the option setting, grids in the SQL

Editor are editable only if you include ROWID in the query or run an EDIT statement.

Confirm data deletions from grids

Default - Unchecked

If checked, this will confirm each record deletion before deleting the record. This also affects the data grids on the Schema Browser Data tabs.

Check and warn of cascading constraints before deletions

Default - Unchecked

If checked, you will be warned of cascading constraints before deletion. This option only applies in the Schema Browser. If checked and you try to delete a row from a grid in the Schema Browser, Toad will check to see if there is an ON

CASCADE DELETE foreign key constraint that might cause rows from another table to get deleted.

Default - Checked

If this option is checked, Toad will not check for blank values during grid edits and will instead rely on Oracle for the constraint checking. If unchecked, Toad will stop editing if blank is entered in a NOT NULL required entry column.

120

Data Grids

Popup memo editor on double-click

Default - Unchecked

If checked, when you double-click on any text column, a popup window will display with the contents. This option is useful for LONG columns and other special datatypes. Even if the option is unchecked a popup editor is available in the cell of a grid via right-click.

Use older version of the Data Print Grid

Default - Unchecked

If checked, the old Toad print grid will be used when printing data grids. The old

Toad print grid lets you select columns that you wish to include/exclude from the printout.

The default is 12 MB.

Old grid print font button

If you check the Use older version of the Data Print Grid option, this lets you select the font.

Show ROWID in editable data grids

Default - Unchecked

If checked, the ROW IDs will display in the data grids.

Trim string data in CHAR and NCHAR fields

Default - Unchecked

If checked, For CHAR and NCHAR columns this option will trim off trailing spaces when they are retrieved from Oracle.

121

Toad for Oracle

Display large numbers in scientific notation

Default - Checked

If checked, numbers with more than 15digits are displayed in scientific notation in the data grids and numbers with decimal places are displayed rounded to the sixteenth place. If unchecked, all numbers are fully displayed. The calculator dropdown will be disabled in number cells if this option is unchecked.

If you change the option, you’ll need to log off and start a new connection in order to activate the new option.

Date format dropdown

Default - Your Windows Control Panel, Regional Settings, Short Date Style

Format

Normally, the data in Toad for date columns will display in the format selected in the Window Control Panel. Selecting a different format will override the

Windows Control Panel setting.

Time format dropdown list

Default - h:mm:ss AMPM

This lets you select a different time format, if desired.

Sliding window for entering two digit years

Default - 30

This is the number of years that will be subtracted from the current date (system date) to determine whether a two-digit year will be interpreted as a current century year or a previous century year. Click the Up and Down arrow to select the range. The range of choice is 0 to 49. Anything outside of the sliding window will be treated as a current century year, and any number that falls inside the sliding window will be treated as a previous century year.

For example, if your current system date is set for June 1, 2000 and you specify a 30 year window (which is the Toad default) and enter 1/1/87, the date produced will be Jan. 1, 1987. If you enter 1/1/57, the date is outside of the 30 year window, so the date produced will be Jan. 1, 2057.

122

Data Grids

Data Grids - Visual Options

The Data Grids - Visual Options are accessed via the View | Options (or the

Configure Options button)|Data Grids - Visual page.

Show

Focus Rectangle

Default - Unchecked

If checked, when you select an item in the data grid and then click outside of the grid, the item you selected is marked with a black rectangle.

Selection

Default - Checked

If checked, when you select an item in the data grid and then click outside of the grid, the item and cell remain highlighted. If unchecked, when you click outside the grid the item and cell are no longer highlighted.

Grid

Default - Checked

When checked, the grid displays around the data (lines appear between the rows and the columns).

Preview Column

Lines spinner

Default - 1

This lets you change the number of lines included in the preview column. You can select from 1 (the default) to 5. If you select 0 the preview is removed and you cannot preview columns.

Font button

Default - MS Sans Serif 8 point

This invokes the font selection window. Changing the font here only affects the font displayed in the preview column.

123

Toad for Oracle

Row lines

Width spinner

This controls the thickness of the lines between rows on the data grid. The measurement is in points.

Fonts

Grid button

Default - MS Sans Serif 8 point

This invokes the font selection dialog. Changing the font here affects the entire data grid, with the exception of the preview column and headers. All data grids will have the same font.

Header button

Default - MS Sans Serif 8 point

This invokes the font selection dialog. Changing the font here only affects the font displayed in the headers of the data grids.

Options

Column Sizing

Default - Checked

If checked, you can click-and-drag between columns to resize them.

Column Moving

Default - Checked

If checked, you can click-and-drag a column to another location in the grid.

124

Data Grids

Tabs

Default - Checked

If checked, lets you tab from column to column through one record. You cannot tab through multiple records unless Tab Through is also checked.

Tab Through

Default - Unchecked

If checked, you can tab through more than one record. In order to tab through the records, you must also have Tabs checked.

Row Select

Default - Unchecked

If checked, clicking in a cell in the data grid selects the entire row rather than only one cell.

Multi Select

Default - Unchecked

If checked, this automatically engages row select. Multi Select lets you select more than one row at a time by pressing either <SHIFT> or <CTRL> while clicking on the rows.

Cancel on Exit

Default - Checked

This applies to the Schema Browser | Data Grid for a table. If checked, if you click the Insert Record button and do not enter data...

then when you click back on the table name in the table list at the left...

125

Toad for Oracle the blank row will be deleted.

If the option is unchecked, the blank row will remain.

Immediate Edit

Default - Unchecked

If this option is checked, as soon as you click on a data cell in the grid, the grid will enter edit mode. If unchecked, you must select the cell twice to place the grid in edit mode or just begin typing in the cell. If the data grid is not editable, and the option is checked, it will still appear to enter edit mode but the data will not be editable.

Confirm sorts when clicking on column header

Default - Checked

If checked, the Sort Options window displays when you click on a column header.

Unchecked, when you click on the column it is sorted in either ascending or descending order (whichever is the opposite of its current state).

Allow Excel style filtering

Default - Unchecked

If checked, dropdown arrows display at the top of each column that let you access a Custom autofilter menu item. The autofilter lets you filter with a variety of dropdown choices such as Greater than, Less than, and Less than or Equal to.

For example, if you want to retrieve all rows in a column that start with M, select the dropdown in the column header, click Custom, and select Equals from the dropdown box. In the textbox to the right of Equals type M*. Click Ok. The filter will only display rows in the column that start with M.

You can also toggle the Custom autofilter dropdown arrows via the data grids right-click Excel Style Filtering menu item.

126

Data Grids

Null columns radio buttons: Display {null}/Yellow

If selected, any data cells that are null will either contain the words {null} or display in yellow depending on the radio button selection. If neither radio button is selected, the null data cells will display as empty cells.

Row numbers: Enabled

Default - Unchecked

If checked, a column containing row numbers displays. It is automatically fixed and the first column in the data grid.

Row numbers: Same color as grid border

Default - Unchecked

If checked, the row number background will be the same color as the border background. If unchecked, the row number background will be white.

Column Sizing

Size to header width radio button

Default - Not Selected

If selected, columns are sized to the width of the headings, and data wider than the heading is truncated.

Size to data width radio button

Default - Selected

If selected, columns are sized to the width of the data that they contain.

Allow resize column out of grid

Default - Unchecked

This option applies to the last column of the grid. If checked, you can resize the last column of the results grid.

Allow columns to be less than the header width

Default - Unchecked

If checked, you can make columns narrower than the width of the column header.

127

Toad for Oracle

Report Link Designer

When you issue a print command for a grid (Grid | Print Grid or right-click on the grid and select Print), you access the Print window. To access the Report Link

Designer you have to have the old print grid option unchecked, click Preview in the Print window, then click the Design Report icon. The printout will print in spreadsheet fashion, i.e., printing will not truncate the output at the page width; columns are printed on subsequent pages.

Options tab

Draw Mode dropdown

The choices are: Strict, Odd/Even Rows Mode, and Borrow from Source.

Show panel

Bands

Default - Checked

If checked, adds a blank band (bar) to the top of the grid.

Headers

Default - Checked

If checked, the column headers are included in the printout. If unchecked, column headers are not included.

• Footers - Not applicable to data grids

• Group Footers - Not applicable to data grids

Preview panel

Visible

Default - Checked

If checked, the preview columns will printout.

Autocalculate Preview Lines

Default - Checked

128

Data Grids

If checked, will autocalculate preview lines and the Preview Line Count spinner will be disabled.

Preview Line Count spinner

Default - Disabled

This is enabled if the Autocalculate Preview Lines option is unchecked.

Grid panel

Grid

Default - Checked

If checked, the grid lines (the lines between the rows and columns) will printout.

If unchecked, the grid lines will not printout.

Nodes Grid

Default - Checked

If checked, will print the column lines in a data grid. If unchecked, the column lines will not print in the data grid.

Group Footers Grid - Not applicable to data grids

Colors tab

Transparent - Not applicable

Fixed Transparent

Default - Unchecked

If checked, you can select band and header colors. If unchecked, band and header colors are transparent.

Group Node and Group Footers (and their color choices) are not applicable to data grids.

Grid Line Color dropdown

Default - Auto

You can select another color from the dropdown.

129

Toad for Oracle

Fonts tab

Fonts you can change include: band, font, header, and preview.

Behaviors tab

Choices here include Bands, Headers, Footers on every page; Auto nodes expand; and 3D effects. Graphics as text is not applicable.

Miscellaneous tab

The Expand button check box lets you give your printout a tree effect. If you uncheck the Flat check marks option the check marks will be 3 dimensional. You can also have your check marks display as text (True/False).

Title Properties button

This brings up the Report Title window that lets you type a title in the Text tab and select fonts and alignment from the Properties tab.

After you've made your selections, click OK and the Print window will display.

The Preview button lets you preview the printout. The Page Setup button invokes the Page Set up window, which can also be accessed via File | Print

Setup. This lets you set your paper size, source, orientation (portrait or landscape), and margins.

Remember, the screen width is wider than the portrait page width.

130

Procedure Editor

• Overview

• Procedure Editor Toolbars

• Shortcut Keys

• Parameter Hints

• Using the Procedure Editor

• Navigator Tree Buttons

• Options for the Procedure Editor

• Right-click menu

• DBMS Output

• Source Code Management

• Team Coding

Toad for Oracle

• PL/SQL Debugger

132

Procedure Editor

Overview

The Procedure Editor lets you create or modify procedures, functions, packages, triggers, types, and type bodies. It also has debugging functions in the Toad for

Oracle Professional, Toad for Oracle Xpert, and Toad for Oracle Suite editions .

It includes browser style back/forward buttons for code navigation. The results panel tabs are dockable. You can customize and save your layout with the

Desktop dropdown.

By clicking the right mouse button or pressing F10 you access a context menu with numerous options such as Set bookmark, Clear all bookmarks, and

Uncomment Block.

You cannot compile files that are not split (spec and body).

Ways to invoke the Procedure Editor window

• Click the button on Toad's main toolbar .

• Select menu item Database | Procedure Editor.

• Click the Procedure Editor button in the Schema Browser

Procedure Editor page.

• Set the Procedure Editor to StartUp on new connection in the

View | Options | Windows page.

Procedure Editor Toolbars

The Procedure Editor toolbar includes buttons that let you Compile the current statement, Load a SQL File (The dropdown arrow lists the most recent files used

while this editor window was open), Save to a new filename, Load source from existing object in the database, Reload the object from database or file, Create a new PL/SQL object, Compile dependent procedures, and Tune the current statement using SQLab Xpert.

If you have the PL/SQL Debugger, its toolbar will display to the right of the

Procedure Editor toolbar.

The Common Edit toolbar is a standard editing/formatting toolbar which is also used in the SQL Edit window.

133

Toad for Oracle

Shortcut Keys

SHORTCUT KEY

F10

F12

<CTRL>A

<CTRL>C

<CTRL><SHIFT>C

<CTRL>D

<CTRL>F

<CTRL>G

<CTRL>L

<CTRL>O

<CTRL>R

<CTRL>S

<CTRL><SHIFT> S

FUNCTION

Display Window Help File

Show/Hide error panel

Find Next Occurrence

Describe Table, View, Procedure, Function, or Package in popup window

Clear all text

Compile

Display Popup Menu

Pass the SQL or Stored Procedure Editor contents to the specified External Editor

Select all text

Copy

Perform code completion (on a package or object type), also sees what procedures are new in spec and creates stubs for the body

Display procedure arguments, for functions tells you the return datatype

Find Text

GoTo Line

Convert Text to Lowercase

Open a text file

Find and Replace

Save file

Save File As

134

Procedure Editor

SHORTCUT KEY FUNCTION

<CTRL>T

<CTRL>U

<CTRL>V

<CTRL>X

Display columns dropdown

Convert text to uppercase

Paste

Cut

<CTRL>Z

<CTRL><SHIFT>Z

Undo last change

Redo Last Undo

<CTRL><SHIFT><DOWN> Jump to the procedure implementation in the body

<CTRL><SHIFT><UP> Jump to the procedure declaration in the spec

<CTRL>. (period)

Go to col. 1, row 1 of the editor

Go to the last line of the buffer

Display code template (key combination + <CTRL>

<SPACE>) displays the applicable template

Cycle through the collection of MDI Child windows

Compile

Go to previous package procedure

Go to next package procedure

Autocomplete tablenames, includes incremental searching

<CTRL><ALT><PAGE

DOWN>

Navigate to the previous tab in the editor

Navigate to the next tab in the editor

Navigate to the previous results panel tab

Navigate to the next results panel tab

Hyperlink jump current word

Navigate back

Navigate forward

You can <CTRL>Click on a function or procedure and jump hyperlink-style to where it's declared.

135

Toad for Oracle

Parameter Hints

When you enter parameters for a procedure or function call, parameter help is available in a pop-up tooltip. The parameter hint automatically displays when you pause after typing the open parenthesis following the procedure call. It will display as long as the procedure reference can be resolved. When you enter in the parameter values, the current parameter will be highlighted in the tooltip.

The parameter hint pop-up will close when you do one of the following:

• Press <ESC>

• Type the closing parenthesis

• Move the cursor to the left of the open parenthesis

• Enter more parameters than expected

If the procedure is overloaded, you can cycle through the overloads by pressing

<UP> and <DOWN>.

Using the Procedure Editor

Navigating through the Procedure Edit window is similar to navigating through the SQL Edit window.

Main ways to get code into the Procedure Editor

• Read from file

• Load from existing object from database

• Create new Procedure Editor dialog

• Type/Paste from scratch

• Drag and Drop from File Explorer

• Select procedure or trigger in Schema Browser and click Load In

Procedure Editor button (the Procedure Editor window button on the objects panel).

The F9 key compiles and then stores the code in the database.

136

Procedure Editor

Java source can be loaded and compiled in the Procedure Editor.

If you have the PL/SQL Debugger and click in the gutter of the Procedure

Editor, a breakpoint is created. So, when selecting text with the mouse drag the selector within the text area.

To Open a Procedure Using File | Open

While in the Proc Edit window, Go to File | Open File.

The Load File window will display.

Select file(s) and click Open.

To Load Object from a database

Click the Load Object from database button.

The Load Database Object window will display.

Select the desired schema and object type from the dropdown lists.

You can filter using object types and a starts with, includes, ends with filter.

To preview the source for an object, select the object from the object list. Or, double-click on an object name to load it directly into the

Procedure Editor.

The selected object's SQL script is displayed in the SQL script area of the Load Database Object window. You can toggle the auto preview button that's at the top of the dialog to turn the auto preview on and off.

Click OK.

The script is opened in the Procedure Editor, and the Load Database Object window closes automatically.

The filter button on the Load Database Object window shows and hides the four widgets for filtering. If you hide the widgets, you have more area for the grid.

To Create an Object using the New PL/SQL Object button

Click the Create New PL/SQL object toolbar button.

The New PL/SQL Object Options window displays.

Select an object type from the dropdown list.

Click in the Object Name textbox and type in an object name.

Click OK.

The template script with your object name is pulled into the

Procedure Editor.

137

Toad for Oracle

The default templates are NewProc.sql for a procedure, NewFunc.sql for a function, NewPackage.sql, NewPackageBody.sql, NewPkgFunc.sql for a package function, NewPkgProc.sql for a package procedure, NewTypeFunc.sql for an object member function, NewTypeProc.sql for an object member procedure,

NewType.sql for an object type spec, NewTypeBody.sql for an object type body, and NewTrig.sql for triggers. You can edit the templates to create a common starting point for new stored procedures.

There is also an option in the View | Options | Editors page to load the templates from the network if you elected to install Toad to a network server share.

You configure templates on the View | Options | Procedure Editor | Proc

Templates page.

Toad will automatically substitute values for keywords in the templates. Toad will perform the following substitutions.

Object Name: %YourObjectName% or *YourObjectName*

Sysdate: %SYSDATE%

Date/Time: %DATETIME%

Date: %DATE%

Time: %TIME%

Username: %USERNAME% (set in Toad Options, Procedure Editor)

Trigger Options: %TriggerOpts%

For example, this template:

/* Object Name: %YourObjectName% */

/* Date:%DATE% */ is translated into:

/* Object Name: My_Proc_Name */

/* Date: 2/15/2005 */

138

Procedure Editor

Toad can substitute variables in the code completion templates. If you have substitution variables in your code completion templates, then after you enter the code completion keystroke, Toad prompts you for the substitution variable.

The left panel contains the navigator tree, a list of objects or package contents.

Each package is composed of a Specification (SPEC) and/or Body, which is displayed in the hierarchy on the list. You can right-click in the tree and select what you want to display. Functions are in indicated with an f ( ) and procedures are indicated with a p( ). The navigator tree represents nested procedures. It can also display the following declarations: constants, cursors, exceptions, parameters, PL/SQL tables, records, record fields, ref cursors, subtypes, system types, variables, and Varrays.

Click on an item and it goes to that item in the code.

The upper right panel in the Procedure Editor contains the code for the selected object. You can have several procedures open. Each procedure will open in a separate tab. When you open a package in the Procedure Editor the spec and body will open in separate tabs unless you choose for them to open in the same tab through the Options | Procedure Editor | File Splitting page.

Compiling will be disabled for files that are not split.

The Error panel lists errors on the left in a list box and details on the right.

Single-click on an error in the list to display the details and the error will highlight in the editor. Double-click on an error to invoke the Instant Messages screen for that Oracle error.

139

Toad for Oracle

The Status panel shows the Row number and Column number of the cursor position, whether or not the code has been Modified, VALID or INVALID status, and whether or not the code was compiled successfully or compiled with errors.

A vertical splitter between the navigator tree and the editor lets you resize the navigator tree and the editor. A horizontal splitter between the editor and the error panel can be sized up or down.

Run button

The Run button runs the selected procedure. If GIVE_RAISE is the selected procedure and you click the Run button, it will run the GIVE_RAISE procedure.

You can also right-click and select Execute without debugging, regardless of whether or not you have the debugger.

If you select the Load Object from Database button you get a filter window.

If your database contains many items, uncheck the

View | Options | Procedure Editor | Automatically show objects on

Select Database Object Window option and set up filters before clicking the

Run button. This populates the list of existing objects more efficiently.

Navigator Tree Buttons

Refresh Navigator

This button refreshes the navigator tree.

Sort Alphabetically

This button is used to sort the navigator tree alphabetically.

If the button is UP, the list appears in source code order.

If the button is DOWN (depressed), the items appear alphabetically

Right-click in the Navigator panel and a menu lets you refresh, sort, expand, collapse, and configure the Navigator panel.

140

Procedure Editor

Options for the Procedure Editor

You access the Toad Options window via the Configure Toad Options button or by selecting the View | Options menu item. The Options | Procedure

Editor page contains numerous options under General, Debugging, File

Splitting, and Proc Templates.

General

Reload files when activating Toad if the file time stamp is changed

Default - Unchecked

If checked, this allows editing in an external editor. When a Procedure Edit window containing a file is reactivated (gets focus), Toad will check the date stamp of the file to see if it was modified by the external program. If the file was modified, Toad will display a prompt dialog that will say that the file date/time has changed and ask you if you want to reload it. Select Yes, and the file will reload.

Include Owner when extracting source From database

Default - Unchecked

If checked, this basically puts owner name in the first line when loading from the database. When exporting source, if this option is checked, source will be prefixed with the owner.

Example: CREATE OR REPLACE PROCEDURE STHOMAS.PROCEDURENAME IS

If unchecked, source is not prefixed with the owner.

Default - Unchecked

If checked, an object type will be selected, and all objects that are not filtered will be shown. If unchecked, no object type is selected (just a blank grid), and you must select before any objects are shown.

141

Toad for Oracle

Only show one Procedure Editor per database connection

Default - Unchecked

If checked, permits only one Procedure Edit window per database connection to conserve Windows resources.

This is similar to the option that limits the number of SQL Edit windows and

Schema Browser windows, per connection.

Load Spec and Body as pair (Package or User Type)

Default - Checked

If checked when you load a package spec or type spec the corresponding body will be loaded, and when you load a package body or type body the corresponding spec will be loaded.

Use multi-line tabs in the editor

Default - Unchecked

If checked, once a line of tabs is full the editor tabs will display on multiple lines.

If unchecked, once a line of tabs is full, the tabs will display with a horizontal scroll bar.

Allow compiling when source loaded from database

Default - Checked

If checked, Toad will let you compile source that is loaded from a database.

Unchecking this option enforces the practice of loading and altering source files instead of storing the only copy of the code in the database.

Default - Unchecked

If this option is checked, the Create Procedure will not overwrite an existing object. When loading PL/SQL into the Procedure Editor, the Create clause will read, "Create Procedure/Function/Package ...". This is useful if when compiling a procedure, a different object of the same name already exists in the database, hence the compile will fail, instead of overwriting it.

If unchecked, the Create clause will read "Create or Replace Procedure/Function

Package" and overwrite any existing objects that have the same name.

142

Procedure Editor

Compile Spec and Body as Pair (Package or User Type)

Default - Unchecked

This option will compile the spec and body (in that order) whenever either of the objects is compiled in the Procedure Editor, as long as both objects are currently loaded. If only the spec is loaded, then only the spec will be compiled. If only the body is loaded, then only the body will be compiled.

Search for Dependent Objects following a compile

Default - Checked

If checked, Toad will search the database for dependent objects of the currently compiled PL/SQL object (those procedures that call this procedure), and if any are found, will enable the Compile Dependencies button.

If unchecked, the Compile Dependencies button is always enabled.

If PROC_A calls PROC_B and you are editing and recompiling PROC_B, Oracle flags PROC_A as INVALID, forcing a need to recompile PROC_A. Toad will check for this dependency, enable the Compile Dependencies button, which you can then click to compile PROC_A, and therefore not leave any INVALID objects out there as a result of your changing PROC_B.

Toggle Modified Flag after compiling source from database

Default - Unchecked

If checked, after you compile source from the database, the Modified flag in the status panel will toggle to "Modified".

Notification when compile process is complete

Default - Unchecked

When checked, this plays the ToadLOAD.WAV (croak sound) when the compile of a procedure has been completed.

The Debugging options are discussed in Toad Help.

The File Splitting options let you choose to automatically split files, be prompted to split files, choose to never split files (this disables compiling), use file splitting tags, and choose to save to separate files after splitting.

143

Toad for Oracle

Right-click menu

Right-click while you are in the Procedure Editor to access the right-click menu.

This provides a shortcut to the functions listed in the menu. You can also press

F10 to display the right-click menu.

Many of these items are the same as the items found in the SQL Edit window right-click menu. Some of the functions that the menu contains are:

Describe

Displays popup window that describes the selected object. If the item is a procedure, it displays the procedure popup window.

Close Tab

Closes the current tab

New Tab

Adds another tab and places the cursor on line 1 of your new tab

Comment Block

Adds dashes before the selected line or lines

Formatting Tools

Includes Profiler.

Find Closing Block

Finds closing parenthesis, "END" for matching "BEGIN" or "END IF" for matching

"IF"

Procedure Editor Desktop

Lets you show/hide the Navigator Panel, Debug Panel, and Status Toolbars and includes a Customize Toolbars menu item

Read Only

Toggles a File's Read-Only status

144

Procedure Editor

DBMS Output

You get to this dialog via the View | DBMS Output menu item.

Oracle provides a package, called DBMS_OUTPUT, which is specifically designed with functions for debugging PL/SQL code. It uses a buffer that your PL/SQL code writes into, and then a separate process queries the buffer out and displays the contents.

Output only comes out after the procedure has completed execution, not while you are single stepping through the code. In nested procedure calls, all procedures must have run to completion before any DBMS_OUTPUT content is displayed.

145

Toad for Oracle

The Procedure Editor right-click menu lists DBMS_OUTPUT specific commands.

You can edit DBMS_OUTPUT content, make comments, delete specific lines of output, etc. The standard copy, cut, and paste keys work in the DBMS_OUTPUT textbox.

To create a DBMS_OUTPUT statement

Highlight the desired selection from your SQL script.

Right-click to display the right-click menu for the Procedure Editor.

Select the Make Output Statement item.

Click the place in your script where you want to paste the

DBMS_OUTPUT statement.

Select Paste from the right-click menu OR the Edit menu.

Blank Output

You can also select Blank Output to get a DBMS_OUTPUT template, which you paste into your script and fill in the blank sections yourself.

To create a Blank DBMS_OUTPUT statement

Right-Click and select the Blank Output Statement item.

Click the place in your script where you want to paste the statement.

Select Paste from either the right-click menu or the Edit menu, and the blank DBMS_OUTPUT Statement is pasted into your script.

146

Procedure Editor

Source Code Management

Toad supports the Source Code Control (SCC), a Microsoft API. It defines a standard interface between development environments and source control products. The SCC API provides functions to perform the common source control operations such as Check-out, Check-in, and Add File.

Toad’s legacy source control feature provides check in and check out of files through the SCC API. This source control is only available in the Procedure Editor and the Project Manager, and it is not aware of database objects. Products tested with this feature include:

• Microsoft Visual SourceSafe 6.0

• PVCS VM 6.7

• Quma QVCS 3.5 and 3.6 (only allows one control group)

• ComponentSoftware CS-RCS 2.5.140, 3.0.192, 3.0.196

• Rational ClearCase 4.1

• Borland StarTeam 5.4 (requires the SCC Integration component from

Borland)

Earlier versions of these software products have not been tested with Toad, and we cannot guarantee their compatibility. Other vendors might conform to the API but have not been tested with Toad; therefore, integration cannot be guaranteed at this time.

Each SCC compliant product will create an entry in the registry identifying it as an SCC provider and identifying the location of the DLL used to invoke the SCC functions.

The client portion of the Source Control install must be run. You cannot run only the server piece of the Source Control install.

147

Toad for Oracle

Working Folder

You must have a working folder set in order to use the Toad Source Control interface. For example if you are using Microsoft Visual SourceSafe, to set your working folder you would open Microsoft Visual SourceSafe, right-click on a folder, and select the Set Working Folder option.

Source Control Options

You must also have the interface to the SCC configured by selecting the Source

Control options in the View | Options | Source Control page.

To set the Source Control Options

Select the Source Control Provider that you wish to use with Toad from the dropdown. The Source Control Provider dropdown lists the

SCC providers found in the registry. If you switch providers, you should restart Toad.

The Prompt for Comment check boxes let you determine whether or not a dialog will display that lets you store comments with the respective action.

Source Control is run through the Procedure Editor. The toolbar on the Procedure

Editor contains the check-in and check-out buttons.

All the other functions are on the right-click menu. The right-click menu contains a Source Control menu item that has the following submenu items:

Check-out File

When a file is checked-out, the file is reloaded from disk (it could be different than the file that was loaded), and it is made writeable.

Check-in File

When a file is checked-in, it is set to read-only again.

Undo-checkout

This command throws away any changes and reverts to the read-only, original version. This is useful, for example, if you do not want any changes stored to the database.

Get latest version

This refreshes the file from the source control and reloads the file (still read-only).

148

Procedure Editor

Add File

This adds the current file to source control and reloads it read-only.

Select project

This produces a dialog (provider-specific) to let you select a source control project to work with. The selected project is retained in the .ini file between Toad sessions.

A file that is not checked out should have a read-only status. Read-only files cannot be edited. All the SCC functions act upon the currently loaded file.

Source Control functionality does not work with database objects; it only works with files.

Steps for using Source Control from Toad for the first time

Install your client.

Confirm your client is configured to support SCC API. You confirm this by confirming that the client or the client install has created this registry key.

Go to View | Options | Source Control.

Select your SCC provider and check/uncheck options as desired.

Load the file that you want to work with into the Procedure Editor.

Remember, Source Control is run through the Procedure Editor.

Right-click in the Procedure Editor and choose Source Control |

Select Project.

Your SCC provider will display a dialog that will ask you to select a project. Depending on the provider and the configuration, it might also ask you to log in or browse for a database. It might provide a place for you to set a working folder. Refer to your provider's documentation if you need further details.

The working directory for the selected project must match the directory that you loaded the file from.

If the file is already stored in Source Control, you can check it in or check it out. Otherwise, you can right-click and select Source

Control | Add File to add it into Source Control. This assigns it a checked in status, and you will have to check it out to modify it

149

Toad for Oracle

Team Coding

Team Coding is a cooperative source control feature. You can use team coding alone or in conjunction with a third party version control system. Team Coding works with the Procedure Editor to control access and development of functions, procedures, packages, triggers, and more. It also works with the Schema

Browser | Favorites tab.

Team Coding does not have to replace Toad's version control. It provides more features in a more integrated environment.

Team Coding lets PL/SQL developers develop stored programs without concurrently modifying the same objects. It includes a built-in version control browser with a check in/check out system that does not require a third party version control product.

With a third party version control product Team Coding allows a revision history to be kept for your code, lets you launch the third-party provider's browser, lets multiple Oracle users work on a Team Coding controlled project in their own schemas, and places script files under code control.

Team Coding directly supports the following third party products:

• Microsoft Visual SourceSafe 5.0, 6.0

• PVCS VM 6.6, 6.7, 6.8.1, 7.5.0

• PVCS VM 5.2, 5.3, 6.0

PVCS 6.6.1 and 6.8.0 are not supported with Team Coding.

150

Procedure Editor

Team Coding also operates with products providing Microsoft’s SCC API. The products tested with Toad’s Team Coding include:

• Rational Clearcase 5.0 (2002)

• ComponentSoftware CS-RCS 2.5.140, 3.0.192, 3.0.196 workgroup mode only

• Quma QVCS 3.5, 3.6 (only allows one control group)

• Borland StarTeam 5.2, 5.4 (requires the SCC integration component from Borland)

• Microsoft Visual SourceSafe 6.0

• PVCS VM 6.7.00

Team Coding includes Flexible Code Control Groups that help you control objects from one or more schemas, using customizable groupings.

For more information about Team Coding refer to Toad Help.

151

Toad for Oracle

PL/SQL Debugger

The Toad for Oracle Professional, Toad for Oracle Xpert, and Toad for Oracle

Suite editions include debugging functionality (PL/SQL Debugger, Script

Debugger).

The PL/SQL Debugger, which is run in the Procedure Editor window, lets you step through the code as it executes, line-by-line, statement-by-statement. The

Debug menu is only enabled in a Procedure Edit window. You can run a debug session with or without argument values. With the click of the toolbar button, debugging begins and stops on breakpoints, as appropriate, or it runs to the end.

If you have the Debugger installed, the Debug toolbar displays to the right of the

Procedure Edit toolbar in the Procedure Edit window. You can also access the

Debug menu using the keyboard by pressing <ALT>U.

Unless you specify parameter values in the Set Parameters dialog, they will default to NULL values. So, for functions that depend on the argument values, you can still check the branching, logic, etc. You can also set argument values in the Set Parameters dialog, and it will use those values.

You can add, edit, and delete breakpoints. You can also set conditional breakpoints and apply pass counts.

After the procedure has executed, you can view the DBMS_OUTPUT from the server.

For all databases, you must have the Oracle Probe API installed in order to debug

PL/SQL using Toad.

Objects you can Debug

• Top-level Functions

• Top-level Procedures

• Package Functions

• Package Procedures

• Triggers

Objects you cannot debug

• Java classes

• Anonymous PL/SQL blocks

Right-click over the editor, select Debug from the menu, and several Debug functions will appear on the submenu.

152

Procedure Editor

To start the Debugger

Open the Procedure Edit window from either the

Database | Procedure Editor menu item

– OR –

Click the Open a New Procedure Edit window button on the main toolbar.

Load a PL/SQL procedure into the editor or write a new procedure.

You can

Load a procedure from a file on disk

– OR –

Load a procedure from an existing object in the database

– OR –

Type a procedure from scratch

– OR –

Click the New Procedure button.

Compile the procedure by

Pressing F9

– OR –

Clicking the Compile button on the Procedure Editor toolbar.

Press F7 (Trace Into) to start stepping through the code. Toad generates the symbol table required to obtain debug information for this procedure.

If you want to step into other procedures and view debug information, you'll need to click the Compile Dependencies with Debug toolbar button before beginning the debug process.

153

Toad for Oracle

When you begin debugging, you can set Toad to

• Always compile dependent procedures

• Never compile dependent procedures

• Prompt you whether or not to compile dependent procedures

To set any of these options go to View | Options | Debugging tab.

Otherwise, watched variable values in the dependent procedures will have "no debug information" displayed in the watches window.

The View | Options | Debugging | Show executable line indicators in

gutter option (available for Oracle 8.1.7 and later) will display a small blue dot in the editor gutter for an executable line of code. This indicates where breakpoints may be set in the code.

When debugging a procedure, if no breakpoints have been set and no errors occur, the procedure will execute to completion, and it appears to have "done nothing." This is a common cause of confusion when people first start using the

Debugger. To avoid this confusion, if you haven't set any breakpoints you might want to use the Step function <F8> instead of the Execute function <F11>.

Tooltip Feature for Variables

The Debugger has a handy tooltip feature. When you are running the Debugger if you move the pointer over a variable, a tooltip pops up that tells you what the value of that variable is at that point in the code.

The Status Panel Indicators

When debugging PL/SQL code, the word "Running" displays in a segment of the

Procedure Edit window status panel at the bottom of the window. If you are not debugging a procedure, "Valid" or "Invalid" displays.

154

Procedure Editor

The Dockable Windows

There are four stay-on-top windows in the Debug menu: Breakpoints, Call Stack,

Watches, and DBMS Output. Any of these windows can be docked together into one window (or combinations of multiple docked windows) by dragging the window title bar of one window and dropping it on another window. This creates a tabbed interface to the separate panels. A right-click menu item lets you Dock

to Procedure Editor which groups and docks all four windows.

You can display all the windows at once. To return the windows to their docked as one position, drag them by their tabs and place them on top of each other.

You can double-click on a floating debug window's title bar to dock it.

DBMS Output

DBMS Output is also discussed in the Procedure Editor chapter.

To view the DBMS_OUTPUT

Select Debug | DBMS Output.

The DBMS Output dockable window displays with the variable value listed, after execution of the procedure has completed.

Preparing PL/SQL Code for Production

Once you have finished debugging your PL/SQL code, compile your procedure and any called procedures one last time with the debugger toggled off. This recompiles it without the debug symbol tables. This will make your code smaller; so it will run faster.

For more information about the PL/SQL Debugger and the other debug features

refer to Toad Help.

155

Toad for Oracle

156

Schema Browser

• Overview

• Using the Schema Browser

• Options for the Schema Browser

• Objects

• Refresh Options

• Custom Queries

• Foreign Key Lookup

• Tables

• Details Panel

• Views

• Synonyms

Toad

• Procedures

• Triggers

• Indexes

• Constraints

• Sequences

• JAVA

• DB Links

• Users

• Jobs

• Types

• Queue Tables

• Queues

• Clusters

• Favorites

158

Schema Browser

Overview

The Schema Browser separates database objects by type. Details for the objects are separated by tabs. For example, all tables appear in the left panel when the

Tables type is selected, all views appear in the left panel when the Views type is selected, etc. When you select an object, details or the DDL structures for that object are displayed in the right panel. This eliminates having to drill down through hierarchical mountains to find the desired data. It also lets you compare details between objects of the same type with one click. Keyboard users can easily use the scroll keys to perform the same tasks.

For performance, Toad delays fetching some schema lists until the dropdown or tab that requires that list is activated.

You can cancel certain long running list populating queries in the Schema

Browser. The Statement Processing popup will display which lets you cancel.

Ways to invoke the Schema Browser window

• Click the button in Toad's main toolbar.

• Select menu item Database | Schema Browser.

• Set the Schema Browser to open automatically when a new connection is made in the View | Options | Windows dialog.

159

Toad

Using the Schema Browser

The object types that display in the left panel depend upon the database version.

All the tabs that show in the details panel are details for the selected object.

The vertical splitter between the objects panel and the details panel can be moved left or right via click and drag.

Any Schema Browser Object can be dragged and dropped into the SQL Editor.

You can also drag and drop multiple objects using multi-select (<CTRL> Click).

Schema Browser options let you control how the object types will be displayed.

You can choose a tabbed interface, an alphabetized dropdown, or a tree view.

The default is a tabbed interface. You can always show or hide tabs (for the tabbed view) or nodes (for the tree view) through the right-click menu.

When viewing Packages and Procedures, you might see "wrapped" rather than the code of the object. This means that the procedure was compiled using the

Oracle wrap utility and is not stored in readable format.

Object Lists

Right-click in the tab area of the objects panel (the left-hand side of the window) to display a menu that lets you show/hide individual tabs. You can show/hide individual tabs. However, you cannot hide the Tables tab. If you only want Views and Synonyms, deselect the rest for a cleaner interface. When you exit, Toad saves your options.

All the left-hand side Object lists (except Favorites) are multi-select enabled.

Icons are also displayed on the left panel tabs and dropdown items. If you don’t want to display the icons, you can turn them off with the Browser Style dropdown on the right panel (Show LHS Images).

In the non-tree view all the Object lists (left-hand side) can be sorted without requerying the database by clicking the column header.

In the non-tree view, all the objects in the list (left-hand side) have micro-help.

For example, hover the mouse over a table and it will display the tablename and the tablespace.

You can double-click an object in the left-hand side list to get to the alter screen for the selected object.

You can press <F4> in the left-hand side lists to get describes for objects that have describes.

160

Schema Browser

In the left-hand side you can select an item and show the popup menu in one action, a right-click.

In the tabbed and tree view modes, you can right-click on the column header and choose more than one column to display. You can sort by any column.

Autosize is configured separately for each Schema Browser tab. Autosize and the column selections and widths are remembered.

161

Toad

Configure Browser Tabs window

The right-click menu in the tab area also includes a Configure menu item which invokes the Configure Browser Tabs window that lets you show, hide, rename and rearrange tabs. This does not affect the alphabetized dropdown list which displays if you have chosen to display the categories in a dropdown by unchecking the Tabbed Schema Browser option.

The Configure Browser Tabs window has a Tab column that lists the actual category names and an editable Caption column that lists the captions Toad is currently displaying for the tabs. You can rename these captions by simply clicking in a caption cell and typing.

In addition, you can rearrange the order of the tabs by clicking in the gray box on the far left of the row of the item you wish to move and dragging the row to its new position on the list. Or you can select a tab or caption cell and click the

Up Arrow or Down Arrow in the window to move the whole row up or down in the list.

The right-click menu in the tree view display lets you configure which nodes of the tree view to show or hide.

Panels Right-Click Menus

The Schema Browser panels contain right-click menus. Many of the pages, such as Tables and Views, have enhanced right-click menus that contain menu items for all the buttons on the objects panel and details panel of the page.

Compare with another object

The Compare with another object right click menu item opens a new Single

Schema object Compare window whenever one or two objects are selected. The menu item is available on all tabs except Constraints, Synonyms, System

Privileges, and Types.

162

Schema Browser

Navigation

When you first open the Schema Browser, the Tables tab is selected by default, and a list of all the tables in the selected schema displays.

The dropdown box above the Object tabs lets you select the desired schema.

If you want to narrow the list of schemas in the schema dropdown list you have two choices, Only show users that own objects in dropdown lists and

Oracle Users List. For details about "Show only schemas that own objects" see the Schema Browser options. To set up a specific list of Oracle users (schemas) that you want to see, select menu item View | Oracle Users List. This opens the Configure User Lists dialog where you can multi-select any combination of users you want to see. This list is saved and restored in a file named schema_databasealias.lst, e.g., SCOTT_ORA8I.LST, in the Toad\User Files folder. From that point forward, any dialog in Toad that presents a schema dropdown list will be restricted to the schemas you select, e.g., the "Table Name

Select" dialog or the "Column Name Select" dialog.

If an Object tab doesn't contain any objects, the Object tab window will be empty for that tab.

The Item History button has a dropdown that contains a list of the most recent object list items that you selected. The history is remembered by connection and can be restored between sessions if the corresponding option is checked on. You can select one of the items to return to it. The number of items the history retains can be set in the Schema Browser options.

The Change Active Session button has a dropdown button next to it. Its dropdown list displays all active sessions. You can click on a session from the list to change the active session. If you want to create another session, click the change active session button. It will bring up the "Select Session" dialog where you can then click the NEW button to create the new session.

The status panel shows what session you're in. The CNT on the status panel shows how many objects are in the object list for the object tab you've selected.

Refresh All

The Refresh All button refreshes everything in the Schema Browser. If you create a table and you don't see it in your table list, click Refresh All which will requery, and the table name should display in the list, subject to any active table filters.

Refresh Current List

The Refresh current list button refreshes the objects panel (left panel) list.

163

Toad

Refresh Detail

The Refresh Detail button refreshes, or requeries, only the details panel. If you dropped a column, you can click on the Refresh Detail button to see the refreshed list.

Clear all data grid filters

A button also lets you clear all data grid filters.

Filter

• When the filter is red it's ON.

• When the filter funnel is gray it's OFF.

• When there are no filters, the filter is gray and it's OFF.

On the Schema Browser page Tables | Data tab and Views | Data tab, a four-way filter button displays a dialog where you can sort and/or filter. The filter can display four states: empty, filtered, ascending/descending filtered, ascending/descending empty.

Here, the data is sorted ascending/descending but not filtered.

Schema Browser Icon Legend

This button opens the Icon Legend for the Schema Browser. It initially opens with the node expanded for the active Schema Browser page. You can expand and collapse individual nodes or all nodes.

Browser Style dropdown

Menu items let you choose from the following styles: Dropdown, Tabbed

(multi-line), Tabbed (single row), and Treeview. You can also check to show left hand side images and/or left hand side hints. The Configure Object Types item displays the Configure Browser Tabs window.

Object name and Date created/altered

The object name (and the date created/altered if available) displays on the top of the details panel for all object types.

Quickfilter

164

Schema Browser

The Quickfilter edit box (below the schema dropdown for the tabbed and dropdown views) is a client-side filter that filters all Schema Browser object lists without requerying the database. It works in conjunction with existing browser filters. Wildcards such as *, ?, and % are accepted. It will not work in the

Favorites tab or the treeview. It keeps a history of the last 25 items, with the most recent one first. You can right-click on the Quickfilter to see the history, clear the history, or clear the filter.

165

Toad

Options for the Schema Browser

You get to the Schema Browser Options menu through the View | Options (or the Configure Options button ) | Schema Browser item. The options are on 2 pages accessed via the Data and Visual tabs.

Data tab

Only show one Schema Browser per database connection

Default - Unchecked

If checked, Toad will only permit one Schema Browser window to be opened per

Oracle connection. This conserves operating system resources, because the

Schema Browser is loaded with widgets, buttons, and bitmaps. If the user tries to create another Schema Browser window, and one is already open, Toad will just switch to the existing Schema Browser window.

This option is similar to limiting the number of SQL Edit windows in the SQL

Editor option (Only show one SQL Editor per database connection) and

Procedure Edit windows in the Procedure Editor options menu.

Use same schema after changing sessions

Default - Unchecked

If checked, when you change sessions within the Schema Browser the selected schema will be the same.

Omit SYS objects from the Procedure Dependencies List

Default - Checked

If checked, Toad will omit SYS owned objects from the Procedure Dependencies lists (Deps tabs on the Procedure detail panel and the trees in the View

Dependencies window), such as standard packages, DBMS_STANDARD,

DBMS_UTILITY, etc.

Automatically show filter dialog for filtered lists on Browser

Default - Unchecked

If checked before the Schema Browser window is opened, a Filter Dialog will display for the user to enter filter criteria for tables; then the Schema Browser will open with only those objects matching the filter.

166

Schema Browser

Save filters for LHS lists

Default - Checked

If checked, Toad will save the objects panel browser filters to disk in files named

SCHEMA.FLT in the \Toad\User Files folder.

If you want to reset your Schema Browser filters each time you close and open

Toad, uncheck this option.

Auto refresh details after selecting object on left hand side

Default - Checked

If checked, when you select an object from the objects panel Toad will auto refresh the details panel.

Milliseconds for List Search Timer on LHS Lists

You can select how many milliseconds for the list search timer. The spinner range is 500 to 20000 milliseconds.

Refresh Browser

After an object is created

Default - Unchecked

If checked, when you create a new object from the Schema Browser window,

Toad will refresh the window after the object has been created. The object will be listed in the Object Panel list.

After an object is altered

Default - Unchecked

If checked, when you create a new object from the Schema Browser window,

Toad will refresh the window after the object has been created. The object will be listed in the Object Panel list with its changes.

167

Toad

User/Schema Lists

Default - Show all users

Radio buttons let you choose Show all users, Only show users that own objects,

Only show users that own objects excluding Synonyms, or Only show users that own objects excluding synonyms and temporary tables.

This filter makes the schema dropdown list more manageable. This option affects all windows in Toad with Schema dropdown lists, e.g. "Table Name Select",

"Column Name Select", etc.

LHS Copy Mode

You can select multiple objects on the left hand side, and press <CTRL><C>.

The list is copied to the clipboard and you can paste it into your SQL Editor,

Procedure Editor, and so on.

Items separated by commas

When this option is selected, the list of objects will be pasted all on one line, separated by commas.

One item per line

When this option is selected, the list of objects will be pasted on multiple lines, one object to a line. This is the default behavior.

168

Schema Browser

Data and Info Grids

Data Grids

Save data grid layouts

Default - Unchecked

When checked, Toad will automatically save the Data tab grid layouts with respect to column order and custom column widths.

Sorting and Filtering are a function of the data filters and are automatically saved, whether or not this option is checked.

Set focus to data grid after selecting table, view, or snapshot

Default - Unchecked

If checked, after you first pull up the Schema Browser page and select a table, view, or snapshot on the objects panel and Data on the details panel if you start typing you'll be automatically editing in the data grid section. Otherwise, the focus will remain on the objects list.

Use NOPARALLEL hint in data grids

Default - Unchecked

On tables that have parallelism (degree or instances <>1), Oracle runs multiple processes when you query them. In this case, processes are not removed until the cursor is closed which you accomplish by either closing the Schema Browser or moving to a different table. Since the Schema Browser Tables Data page does not perform any heavy processing, these processes can be performed better elsewhere.

When checked, Toad will use the NOPARALLEL hint in the data grids, causing the queries to consume less of Oracle’s resources.

Enable Foreign Key (FK) lookup in data grids

Default - Checked

When checked, you can look up foreign keys in the data grids.

169

Toad

Include disabled FK constraints

Default - Checked

If checked, disabled function key constraints will be included in the data grid lookup window. If unchecked, only enabled constraints will display.

Don't select BLOB/CLOB fields in data grids

Default - Unchecked

If checked, BLOB, CLOB, and NCLOB type columns will be excluded from the query for the Data tab in Tables and Views pages. BLOB and CLOB data types can be large and can take a long time to load.

Limit grid fetch ___ fetches (25 records)

Default - Unchecked

If a value is entered, the SQL results grids on the Tables | Data tab and the

Views | Data tab are limited to that number of rows. It will fetch that number

(n) of rows, then a prompt will ask you if you want to keep fetching rows. If you respond yes, it fetches n more rows and then prompts again. This option does not affect the SQL results grid on the SQL Edit window.

Wrap INSERT statements when exporting table data

Default - Checked

Info Grids

Allow extra lines for column comments

Default - Checked

If checked, the comments are shown in the grid and are wrapped so that you can see the full text of the comments. The rows of the grid are resized so that the full column comments are shown.

If unchecked, each column occupies one row and only what fits on one line is shown.

170

Schema Browser

Default - Unchecked

When unchecked, the entire hierarchy of dependencies is displayed for all grants regardless of level.

If checked, only the top level grants (grants that have been directly granted to the user) are shown on the Users, Roles, Sys Privs, and Resource Group tabs.

This can improve the loading time for the tabs.

Auto-size info grid columns

Default - Unchecked

If checked, Toad will automatically size the width of the columns list in the details panel to the width of the text.

Show Column Length Info with Column Data Type

Default - Checked

If checked, columns will show in the columns tab in the format "VARCHAR2(20)" including max length, scale, and precision (if applicable). If unchecked, length, scale, and precision will display in separate columns in the grid.

Show Table Stats (on the Tables > Stats/Size tab)

Default - Checked

If checked, Toad will show the table stats information. You can also check this

ON or OFF via check boxes on the Stats/Size tab.

171

Toad

Visual tab

Show

Left hand side

You can select any of the following. All are checked by default.

Toolbars above object lists- toolbar of commands displays above object lists

Tab/Dropdown Icons- object icon displays on the object tab or next to the name in the dropdown list

Item Hints -hovering the pointer over an object on the LHS displays a pop up hint describing the object

Right hand side

You can select any of the following. All are checked by default.

Object Create/Alter dates - will display on the details panel above the tabs

Primary Key columns for tables - will display the list of Primary key columns on the Tables/Columns tab to the right of the show comments dropdown list. For some tables with long column names and/or compound primary keys, this label might not be long enough. Toad places a black triangle next to each column in the columns list that is a Primary Key column.

Sort package procedures alphabetically

Default - Unchecked

If checked, when you expand the hierarchical view of packages, procedures and functions in the specification and body display in alphabetical order. If unchecked, they display in the same order that they appear in the code.

Enable DROP ALL buttons

Default - Unchecked

If checked the Schema Browser Drop All buttons will be enabled for the current session. Drop All buttons in the Schema Browser are in the details panel of the

Schema Browser | Tables - Constraints, Triggers, and Indexes tabs and the Schema Browser | Snapshots - Indexes tab.

172

Schema Browser

Compile mode button

The Select Compile Mode window lets you select to Refresh items one by one or Refresh the entire LHS when complete. If Don’t ask before compiling

in the Schema Browser is checked, Toad will not ask you if you want to compile when you are in the Schema Browser.

Default schema for connections to: current connection

Default - no schema selected

You can enter a default schema in this box. When a connection is made to this database, the Schema Browser will open to this default schema. If the default schema does not exist on the connected database, the Schema Browser will open to the connected schema.

This option can also be changed via the Schema Browser popup menu items Set

current schema as default and Clear default schema.

Default schema for connections to: current schema@current connection

You can enter a default schema in this box. When a connection is made to the database, the Schema Browser will open to the default schema. If the schema does not exist on the connected database, the Schema Browser will open to the connected schema.

This option can also be changed via the Schema Browser popup menu items Set

current schema as default and Clear default schema.

Browser Style radio buttons

Radio buttons let you choose Tabbed Object Type Selection (Schema Browser object types will display in a tabbed interface), Dropdown Object Type

Selection (the object types will display in an alphabetized dropdown list), or

Tree View (a tree view style display). If you choose Tabbed Object Type

Selection you can also choose to Use Multi-line tabs on the left side. If checked, once a line of object tabs is full the schema browser tabs will display on multiple lines. If unchecked, once a line of object tabs is full, the tabs will display with a horizontal scroll bar.

LHS Font

Click the LHS Font button to set a font for the left hand side of the Schema

Browser. A sample of the chosen font displays to the right of the button.

173

Toad

Browser History

Limit to nn Items

Default - 25 items

Use this box to select the number of items the Browser history will remember.

The History button keeps track of every item selected in object lists on the left panel.

Restore History on connection

Default - unchecked

If this option is checked, if you disconnect and reconnect Toad will remember your Browser history. If unchecked, when you end the connection the Browser history will be lost.

174

Schema Browser

Types tab

Capitalize keywords during code generation

Default - Checked

If checked, when code is generated to create the objects, keywords will be capitalized.

Autoload Tables Based on Object

Default - Unchecked

If checked, will automatically load and display the tables based on the selected object and display them on the Properties tab.

Autoload Columns Implementing Object

Default - Unchecked

If checked, will automatically load and display the columns implementing the selected object on the Properties tab.

Autoload Dependencies

Default - Unchecked

If checked, will automatically load and display the objects that the selected object is dependent upon.

Name new objects, Name new attributes, Name new methods,

Name new collections

This is the name that will be given to a new object, new attribute, new method, or new collection, until you rename it to something more meaningful. For each successive object, attribute, method, collection a number will be appended to this name.

Default Method Restrictions

This lets you select the method restrictions: WNDS, WNPS, RNDS, and/or RNPS

175

Toad

Default attribute type

Default - VARCHAR2

This is the default data type for a new attribute.

Default method Type

Default - Procedure

This is the default method type for a new method when the New Method button is clicked. Alternate method types can be selected from the dropdown.

Default function type

Default - INTEGER

This is the default function type for a new function.

176

Schema Browser

Objects

Object Scripts

Toad can create DDL Scripts -- Oracle Statements to recreate the object -- for most of the objects displayed on the Schema Browser. The Create Script button on the objects panel is used to generate a script. The scripts are always copied to the clipboard by default.

Dropping Objects

Many objects can be dropped directly from the Schema Browser. When an object has a drop button, the button is enabled whenever an object is selected in the list.

The drop all buttons are disabled by default. They will only be enabled if you check the Enable drop all option in the Schema Browser options. The drop all button is on the Tables page - Constraints, Triggers, and Indexes panels; and on the Snapshots page - Indexes panel.

Copying From the Browser

Any of the Object Names shown in the Object Lists on the left of the Browser can be copied to the clipboard by pressing <CTRL>C for the highlighted object name.

Any column of data shown in the detail grids on the right of the Browser can be copied to the clipboard by pressing <CTRL>C for the highlighted grid cell.

Note that the listview displays for Table Information work differently. The grids that display Table Detail Information support multi-row selection and always copy the first column to the clipboard. For example, if you are viewing a grid display of a list of columns for a table, you can <CTRL> Click to select more than one column and then press <CTRL>C. This will copy your selected columns to the clipboard, with commas in-between (a comma-delimited list). Then you can paste the list into a SQL Editor or another application.

Filters

All Object tabs in the Schema Browser have a filter. They can be filtered to show a subset of all the like objects in the schema. For example, you might have hundreds of tables in a schema but only want to see those where the table name begins with "GEO".

Schema Browser filters are specific to a schema/owner name. This means you can define a filter for the schema DEMO and a different filter for PRODUCTION,

177

Toad and the appropriate filters will be loaded when you view that schema in the

Schema Browser.

Table Filters allow filtering on table names as well as column names. For example, you can find all tables that have columns with FND_NO anywhere in the column name. The table name may also be searched.

Constraints can be searched by constraint name or constraint column name.

Synonyms can be filtered by Synonym scope: owned by schema only, owned by schema plus Public synonyms, exclude SYS and SYSTEM synonyms, etc.

The browser filter, although primarily intended to filter the Schema Browser window, also affects the table lists throughout Toad. For example, if your filter is set to display only tables that begin with GEO, every table list will display a filtered list until the filter is changed.

The filters not only reduce the amount of data displayed, they also modify the query used to fetch the data. Not only is the display refreshed faster, the query fetches fewer rows for faster response from the database.

If no filters are defined default filters include:

• Constraints show primary keys only

• Synonyms exclude those for objects owned by SYS & SYSTEM

The filters for all Schema Browser objects can be viewed in a single window under the View | Browser Filters menu.

To apply the filters, you must click the Filter toolbar button on the desired object tab, e.g., Constraints, to bring up the Schema Browser Filters dialog where you can select the filter options, click the OK button, and the browser filters are applied.

If you click View/Edit Query Before Executing, Toad will show you the query which is about to populate the browser. You can change the Where or Order by clauses. You should not change the select list.

Refresh Options

If the refresh options that you have set interfere with the action you want to take, you can alter the options without opening the Options page via the right-click menu in the data grid from the Tables, Views, or Snapshots page. The

Refresh Options menu item will let you select and deselect your refresh options.

178

Schema Browser

Custom Queries

The Schema Browser lets you create custom queries. The query is built with your selected objects and placed into the SQL Editor for editing or running.

To create a custom query

In the objects panel (left hand side) of the Schema Browser, select the objects that you want to use for the query.

Right-click and select Custom Queries from the right-click menu.

Select from a list of default queries. The query is created and loaded into the SQL Editor.

Edit Custom Queries window

The right-click menu also lets you edit custom queries via the Custom

Queries | Edit Custom Queries menu item. The window lets you rename a query, select/deselect Oracle versions, and select/add variables while you create your query.

To create a new query template

From the Edit Custom Queries window click the Add Query button. A new blank query will display.

Enter your new query name and the query.

Click the Post Edits button to create the query and add it to the selection list.

You can now use your new query the same way you would use one of the standard provided queries.

179

Toad

Foreign Key Lookup

The Schema Browser data grids has a List of Value (LOV) feature which adds a drill down button next to cells that have foreign keys on them. This lets you see and choose values.

To lookup foreign keys

In the Schema Browser, click the Tables tab.

Select the table that you want to edit and in the details panel click the Data tab.

Click in a column that has foreign keys.

Click again to activate Editing mode. A drill down button displays.

Click the drill down button and it will bring up the rows in the referential table.

When you select a row and click OK, the data will be entered in the appropriate columns in the data grid.

The Foreign Key Lookup window includes all foreign key constraints. (You can exclude disabled constraints via the Options | Schema Browser | Data window).

The filter by box lets you filter by typing. (If the box is checked and you type

EMP it will filter out rows that do not begin with EMP).

To filter rows by editing the query

Click Edit Query.

Edit the query within the editing window. Specify variables by clicking the Variable button and entering variable information.

Check syntax accuracy via the Check button.

Click OK to run your new query and filter the lookup grid.

180

Schema Browser

Tables

This chapter discusses the Tables tab in detail and then summarizes some of the other tabs. Most of the tabs and functions in the Schema Browser operate in a similar way.

The Tables page right-click menu includes an Incrementally Drop Table menu item which is only accessed via this menu.

Incrementally drop table

This lets you drop a large table in steps over a selected number of days so that server performance is not hindered. You can only incrementally drop tables with greater than 200 MB and greater than 1000 extents. If the table is not large enough to drop incrementally, a warning dialog displays.

The steps include a job to truncate the table, jobs to deallocate the unused extents in increments over a number of days, and a job to drop the empty table on the last day.

The Incrementally drop table menu item invokes the Deallocate Table Extents window.

181

Toad

To incrementally drop a table

In the Schema Browser | Tables page, right-click on the table you want to drop.

Select the Incrementally Drop Table menu item.

A confirmation dialog displays. Click Yes. (If the table is not large enough to drop incrementally, a warning dialog will display.)

The Deallocate Table Extents window displays. Select the Begin the

decollation/drop process on date from the calendar dropdown.

The Long date format check box is checked by default. If you prefer the short date format, uncheck the box.

Use the At this time spinner to set the time of day that you want to start the deallocation process.

Use the Over this many days spinner to set the number of days you want the deallocation process to take. The spinner lets you select from 5 to 14 days.

Click Execute. The process is scheduled.

To confirm that the procedure has been scheduled, or to delete the procedure, check the Jobs tab. The last several jobs on the jobs list will be deallocating and dropping the selected table. You can delete the incremental drop by deleting all related jobs in the list.

182

Schema Browser

Objects Panel

Create Script

The Create Script button displays a Table Script Creation window with the

Options tab selected by default.

When you select the Execute button, a script is created for your table that you can then paste into the SQL Editor or elsewhere. NOTE: Most but not all Oracle clauses are not supported for object DDL scripts.

For creating multiple table scripts, see the Database | Export | Table

Scripts menu item.

The Options tab contains many options including Include Schema name,

Include Drop Statement, Sort for Creation, and Script Comments. An Inclusions pane lets you include Table Comments, Private Synonyms, Public Synonyms,

Grants, and more. A Constraints panel lets you include the different types of constraints and has the following radio buttons: List constraints following table columns, Individual 'Alter Table' Commands, and One big 'Alter Table'

Command.

The Output tab lets you output the table script to Clipboard, File(s), or Screen.

Click the Execute button to generate the table script, or click the Cancel button to close the Table Script Creation dialog.

The options selected in the Table Script Creation dialog are saved and restored the next time you create a table script.

Create Table

The Create Table button invokes the Create Table window. You can also access this window from the Create| Table menu item.

This window lets you create a new Oracle table.

Use the dialog to enter the table information, then click the Execute button to create the Table. This is easier than remembering the Oracle syntax for this command.

183

Toad

Alter Table

The Alter Table button invokes the Tables window which lets you drop, modify, and add columns; change storage parameters and data type sizes; add not null constraints; and set unused columns. It is the same window as the Create |

Table window, but you are using it to make modifications. To alter a table, select a table from the objects list and click the Alter Table button. The Table window will automatically display the Schema and the Name for the table you selected.

Export Data

The Export Data function creates "INSERT INTO" SQL statements for the data in the selected table. The Export Data button displays the Data Export window for whatever table is selected from the left panel of the Tables page.

Here, the User Profile object was selected, the Export Data button was clicked, and this was the resulting Data Export window.

The Data Export window supports NUMBER, FLOAT, CHAR, DATE, and

VARCHAR2 object types.

184

Schema Browser

Columns Tab

You can check/uncheck columns you wish to include/exclude. Toad checks all the columns by default.

Exclude Null Columns

If checked, Toad will exclude null columns from the columns clause and the values clause of the "INSERT INTO" SQL statement.

E.g.,

INSERT INTO Foo ( ID ) VALUES (5);

INSERT INTO Foo ( ID, NULL_COL_TEST2 ) VALUES (6, 2);

INSERT INTO Foo ( ID, NULL_COL_TEST ) VALUES (7, 1);

INSERT INTO Foo ( ID ) VALUES (8);

INSERT INTO Foo ( ID ) VALUES (9);

Exclude Primary Key Columns

If checked, your primary key columns will be unchecked. If you then check a primary key column, this box gets unchecked. If you do not have any primary key columns, this choice will not be enabled.

Select All /Unselect All

The Select All and Unselect All buttons let you quickly Select or Unselect all the columns. You can then selectively check/uncheck the columns you want to include/exclude.

Options Tab

Where... clause

The Where clause is optional. You do not have to include a Where clause.

If you include a Where clause, you must include the word "Where" in your statement. Example:

WHERE INVENTORY_NUMBER = 943

Destination

Default - To File

The Destination radio buttons let you choose between To Clipboard or To File.

185

Toad

Filename

The filename area has a drill down button where you can drill down to the desired file. You must supply a file name.

Include Schema/Owner Name in Insert Statements

When this radio button is selected, the Schema or Owner Name will be included in insert statements.

E.g.,

INSERT INTO Schema.Foo ( ID ) VALUES (5);

Insert COMMIT statements every __ rows spinner

This spinner lets you designate how many insert statements to generate before generating a commit statement.

Show Table in ER Diagram

This shows the selected table in an ER Diagram.

Table Privileges

The Table Privileges button activates the Privileges window.

This window lets you view, grant, and revoke privileges for the selected table.

You can view all users and their privileges. If you are not the object owner, you cannot grant privileges that you don't have the grant option for. If you do not have sufficient privileges to alter an object, you will get a warning message, but you will still be able to view everyone's privileges for that object and you will also be able to rearrange columns.

The Revoke All button will revoke all privileges from everyone but you.

You can multi-select users using the <CTRL> key. This is useful when applying changes to multiple users. You can multi-select the users, right-click in the column, and grant or revoke from the right-click menu.

The Show SQL button lets you preview the SQL before applying changes.

You can rearrange columns by clicking and dragging on the column headers.

Grants will be highlighted in blue and admin grants will be highlighted in yellow.

If you only want to see the rows of users who have grants you can check the

Show only users who have grants assigned check box.

186

Schema Browser

Create Constraint

The Create Constraint button activates the Create Constraint window.

Use this dialog to create additional table constraints.

You can also get to this dialog via the Create | Constraint menu item.

You can create:

• Primary Key constraints

• Check constraints

• Unique constraints

• Foreign Key constraints

Analyze Table

Click the Analyze Table button to display the Analyze Tables window.

Use this dialog to analyze the selected table from the tables object list. This collects statistics so that COST based query optimization can be used. So, the optimizer can run better queries.

You can either estimate statistics (faster than compute), compute statistics, or delete current statistics.

To analyze all tables in the current schema or other selected schema, go to the

Tools | Analyze All Tables menu item. This displays a schema dropdown so that you can select which schema tables to analyze all at once.

Add Public Synonym for Table

Click the Add Public Synonym for this Table button, and a confirmation window will appear asking if you want to create a public synonym for the table.

Click Yes to create the synonym or No to Cancel.

187

Toad

Table Filter

The Table Filter button displays the Browser Filters window for the Tables.

The Browser Filters button can be found on the tabs for Tables, Procedures,

Triggers, Views, Synonyms, and Constraints. All the Browser Filter windows have a similar interface.

Browser filters are helpful for schemas that contain a lot of objects- the fewer objects that Toad needs to load, the faster it will execute. For example, you can narrow the focus to only tables whose names begin with EMP and temporarily ignore all other objects in the schema.

After you set your filters, select OK and the browser displays the resulting objects.

To view all the objects again, simply select the filter button, clear the filters by selecting Clear where you have filters, and select OK.

The filter is stored in a file named SCHEMA.FLT in the Toad\User Files folder where SCHEMA is the schema name. Do NOT attempt to edit this file!

You can also use this dialog to set up the default filter which is in force for every new schema.

To set up a default filter, go to View | Browser Filters, and click the Show

Default Filter button. Set up your default filters and press OK to close the window. These filters will be set up by default each time the Schema Browser window is opened.

If you select multiple filters, e.g., table name and tablespace name, then they are joined together with an AND statement in the SQL as opposed to an OR statement in SQL.

Not Like sets up the tablename query like this: [not like KEYWORD%].

188

Schema Browser

Rebuild Table

This button invokes the Rebuild Table window.

Compile Dependencies

If your table is called by a Procedure or View this button will compile those dependencies.

Drop Table

The Drop Table button lets you drop the selected table directly from the Schema

Browser. A confirmation window will ask you if you are sure you want to drop the table. Once you select Yes the table is dropped and cannot be retrieved.

Truncate Table

This lets you truncate a table (delete all the data but maintain the table structure) and either reuse the storage or drop it. The following dialog will display when you select the button.

Once you click the Execute button you can't rollback or undo your choice.

189

Toad

Details Panel

The Tables details panel has tabs for displaying different details about the selected table.

Table - Columns

The Columns tab lists all the columns for the selected table. It also displays each column Data Type whether or not the column accepts Null values, column attributes (such as length, precision, scale), Default value, and column comments, if any. You can change the length, precision, scale display to

"NUMBER(10,5)" through the Toad Option | Schema Browser | Show

Column Length Info with Column Data Type setting.

The dropdown default is Show no comments. The other choices in the dropdown are Column Comments and Table Comments which show the comments in an overlay panel at the bottom of the details panel. You can type directly into this panel to edit the various comments. To save the comment edits, just select a different column or table.

Primary Key columns are indicated by PK column numbers in the PK column. A label to the right of the Add and Drop column buttons in the details panel displays the Primary Key column name(s).

You can multi-select columns, press <CTRL>C to create a comma-delimited list of columns to the windows clipboard and paste the selection into an editor.

190

Schema Browser

Table - Columns Details Panel Buttons

Click the Add Column button to display the Column Definition window. This dialog lets you add a column to the selected table. You must enter the Column

Name, the Type, and the Size. The Nullable radio button is selected by default.

If you want to see the resulting SQL script of your command, select the SQL tab.

To Add a Column

Enter the column name, data type, and other appropriate information.

Click the Execute button to add the column.

Character Default Values have to be wrapped within single quotes in order to make a valid "ALTER TABLE..." statement.

Additional columns are always appended to the end of the table definition.

The Drop Column button and the Drop Column from Table right-click menu item are enabled only if you have Oracle 8.1.5 or later.

The panel also contains a Clear Filter button. If it is red, a filter is active for the data grid, and you can click the Clear Filter button to clear the filter.

Table - Indexes

The Indexes tab lists the indexes for the selected table. The list includes the

Index Name, whether or not the index is Unique, the Column(s), and the

Position. It also lists the Parameters and Values for each index.

The Indexes details panel buttons include a Create script for selected index button and buttons that let you create, modify, rebuild, analyze, and drop indexes.

191

Toad

Table - Constraints

The Constraints tab lists any constraints for the selected table. It lists the

Constraint Name, the Constraint Type, the corresponding Column, and the

Position.

For foreign key referential integrity constraints, the panel at the bottom lists the owner, table, and column names that the foreign key constraint is pointing to.

The Table-Constraints details panel buttons let you enable/disable, rename, and drop constraints.

Table - Triggers

The Triggers tab lists any triggers for the selected table. It includes the Type,

Status, whether or not it's Enabled, the Trigger Event, the Trigger Owner, and the When Clause.

The editor at the bottom of the details panel lists the source code for the selected trigger.

The Table - Triggers details panel buttons let you enable/disable triggers, drop triggers, open a Procedure Editor window for the selected trigger, and compile.

Table - Data

The Data tab displays the selected table with data in grid format. This is similar to the SQL Results Grid on the SQL Edit window. The data in this grid is directly editable, because the query to populate the grid includes the ROWID column.

Grid configurations on this data tab are saved and restored from the Toad\User

Files folder structure.

You can easily rearrange columns by clicking and dragging on the column titles.

Double-click any data item to bring up a memo editor for that item.

Click on the book in the top left corner of the table to show single record views of the selected row.

192

Schema Browser

Table - Data Details Panel Buttons include:

The Filter Data toolbar button opens the Table Sort dialog where you can select the columns to sort and/or filter.

The View/Edit query button opens the View/Edit Schema Browser query window which lets you edit the query, check it to see if it parses ok, and implement it via the OK button.

Table Sort window

Sort Tab

To Sort, select the column(s) you want to sort and click on the pointing hand.

You can sort in ascending or descending order. You can move items up and down the list. If you want to clear the sort column(s) for this table, click the Clear Sort button. If you want to clear the entire filter for this table, click the Clear Filter button on the Table Sort dialog.

View/Edit Query button

Lets you change the query.

Filter Tab

You enter the filter criteria in the lower text panel.

The filter tab provides dropdowns with additional filter choices. On the filter tab, select the Column, Operator, and Value to filter upon. You can further edit the resulting SQL right in the memo editor widget.

When finished, click OK and the data in the grid will be sorted and/or filtered as specified.

The sort and filter criteria are saved in temporary files in the Toad\User Files folder hierarchy.

If a table filter is in effect, the funnel icon on the Data tab will be red.

The Clear Filters toolbar button clears the filter criteria and the sort criteria.

193

Toad

Data Details Panel buttons Continued

The forward and backward buttons let you quickly move around from row to row in the recordset. The First Record button takes you to the top of the grid (the first record in the recordset). The Next Record button takes you to the next record in the recordset, and so on.

See the Data Grids chapter for information on the Data Grids right-click menu.

Table - Scripts

The scripts tab displays the SQL script for the table you've selected. The scripts tab buttons include Copy Text to Clipboard and Select All Text.

The Copy Script to SQL Edit window opens a SQL Edit window and pastes a copy of the script into the window.

The tab includes options. When you change an option by either checking or unchecking it, the GO button turns red. This indicates that a change has taken place but is not yet reflected in the SQL script. The GO (Refresh the Table Script) button refreshes the script, updating any changes. Once you click GO the script refreshes implementing the options you've changed and GO returns to its original gray color.

Table - Grants

The Grants tab lets you view existing table grants and assign or replace existing privileges.

The Grants details buttons include Revoke Privilege, and Privileges which opens the Privileges window.

If you cannot see any roles, have your DBA Grant select on dba_roles to

schema.

To Add or Replace Privileges

Select the table from the object list.

Click the Privileges button. The privileges window for the selected table displays.

Click in the cell of the privilege you wish to change. A dropdown displays.

Select an item from the dropdown.

Click Apply.

A confirmation dialog will appear. Confirm by clicking OK.

194

Schema Browser

Table - Partitions

This lets you see partitioned columns and partitions for the selected table. The

Drop Partition button lets you drop partitions. The Truncate Partition button lets you truncate a selected partition.

Table - Subpartitions

This lists the subpartitioned columns. The display includes Subpartition Name,

Partition Name, Tablespace, Rows, and Blocks.

Table - Stats/Size

The Stats/Size tab displays numerous statistics and size information about the selected table.

The two display options Show Stats and Show Size/Extents are checked by default.

The Stats, such as TABLESPACE NAME and NUM ROWS, are displayed in the upper window of the details panel, and the Size/Extents information, such as

SIZE IN BYTES and INITIAL EXTENTS, are displayed in the lower window of the details panel.

The panel window columns are click and drag resizable, and a horizontal splitter is between them.

195

Toad

Table - Referential

The Referential tab displays a hierarchy of tables and how the selected table is referenced by other tables and references other tables. This display is based on the existing foreign key constraints from table to table.

Remember, "+" on the keyboard expands one branch of the hierarchy, and

<CTRL><SPACE> expands the whole tree. Pressing the asterisk key, "*" will fully expand the current node.

On each node of the hierarchy, there is a chain symbol for standard referential and a scissors symbol if the reference is Cascade on Delete.

Circular references, such as EMPLOYEE.MANAGER_ID referencing

EMPLOYEE.EMPLOYEE_ID, are captured; so you cannot drill down in the hierarchy endlessly (for example, emp_id is referenced by manager_id, which references emp_id, which references manager_id, and so on).

You can select an item in the list, press <F4> and get a popup window describing the object in detail.

Table -Used by

The Used By tab shows the objects that reference the selected table such as views, triggers, functions, procedures, and packages.

Here, the CUSTOMER table is selected in the objects panel. The Used By tab in the

details panel shows that the CUSTOMER table is used by the Demo.Sales view.

196

Schema Browser

Views

In addition to the basic create, edit, save, compile, filter, and drop buttons, the objects panel includes buttons that let you create the view script syntax, open the SQL script of the selected view in a SQL Editor, display the privileges window for the selected view, create a public synonym for the selected view, and compile dependencies.

The details panel includes tabs for Columns, Script, Data, Grants, Deps (uses),

Deps (Used by), and Triggers. The Dependencies tabs display the dependencies.

If there is a hierarchy of dependencies, the dependencies tree will display. The

Deps right-click menu lets you compile, describe, and copy the outline of a selected object. You can also get a popup describe window by selecting an object in the Deps list and pressing <F4>.

Synonyms

You can create synonyms for the following objects: tables, procedures, packages, functions, sequences, views and synonyms. Synonyms basically point to the original object.

The symbol indicates a public synonym.

In addition to the basic create and drop buttons, the panel includes a Filters button which lets you filter out different types of synonyms. Because the

SYS/SYSTEM schemas contain a lot of synonyms, users like to filter them out for easier navigation. So, the Show Public synonyms except those for objects

owned by SYS/SYSTEM is selected by default.

The details panel displays details of the object the selected synonym is pointing to. You can see details about synonyms pointing to tables, views, and stored procedures. Unknown Objects are listed as UNKNOWN.

The details panel also displays tabs and details associated with the object. For example, if the object is a view, the details panel will contain the same tabs the

Object View tab displays in the details panel and the same associated details.

197

Toad

Procedures

In the left panel list of PL/SQL Procedures, Functions, and Packages, a pink X is for a Package that contains one or more invalid (red X) functions or procedures.

A circle with a slash through it in the left panel list indicates a package body that has no package spec. A package body cannot function without a spec. Refer to the icon legend (click the icon legend button) for more icon information.

In addition to the basic save and drop buttons, the panel includes the following.

• The Proc Edit button is enabled after you select a procedure. It opens a Procedure Edit window for the procedure that you've selected in the objects panel. A dropdown lets you select to Load, Load Spec Only, or

Load Body Only.

• The Compile button compiles the selected procedure, function, or package. A dropdown lets you Compile, Compile Spec Only, or

Compile Body Only.

• The Compile All button compiles all procedures, functions, packages, and triggers for the current schema. On databases prior to 8.1.7, it compiles only INVALID objects.

• The Procs Filter button displays a Browser Filter dialog for procedures.

• The Compile Dependencies button will compile dependencies for the selected procedure. For example, if procedure A calls your procedure B, select procedure B, click the Compile Dependencies button, and Toad will recompile procedure A. A dialog asks if you want to compile the dependencies on the selected procedure. Select Yes or

No.

• The Execute Procedure button brings up the Set Parameters window where you can enter your arguments, and click OK to execute the procedure.

• Use this Privileges button to view or modify the privileges of the selected procedure to other user schema accounts or roles.

198

Schema Browser

• The Public Synonym button lets you create a public synonym for the selected procedure, function, or package.

• The details panel includes tabs for Code, Arguments, Deps (Uses),

Deps (Used by), Errors, and Grants.

• The Dependencies tabs (Uses and Used By) displays the dependencies in the upper part of the panel. If there is a hierarchy of dependencies, the dependencies tree will display. The Deps right-click menu lets you compile, load in the Procedure Editor, describe, and copy the outline of a selected object.

You can select an item in the Deps list, press <F4> and get a popup window describing the object in detail.

The Errors tab displays the last errors that occurred when you tried to compile the selected procedure. If you click on an error, its location is highlighted in the script displayed in the lower part of the details panel.

Triggers

The Objects panel includes save, compile, filter, and drop buttons. It also includes a Proc Edit (Trigger to Proc Editor) button that places the selected trigger in a Procedure Editor ready for editing.

The details panel displays information about the selected trigger. The Columns tab displays the column, table, table owner, and usage. The Source tab displays the SQL script for the selected trigger.

The trigger text is selectable via <CTRL>A and can be copied to the clipboard via <CTRL>C.

199

Toad

Indexes

In the list of indexes, "101" icons are BITMAP indexes, Yellow Square + Red

Triangle + Blue Circle icons indicate UNIQUE indexes (vs. non unique), and

"f ( )" indicates function-based indexes.

Remember, the icon legend button displays what each icon represents.

In addition to the basic create, modify, and drop buttons, the panel includes the following.

The Create Script button copies the Create Index script of the selected index to the clipboard.

The Rebuild Index button lets you rebuild a table index. Indexes need to be periodically rebuilt in order to improve query performance.

Refer to Toad Help for more information about the Rebuild Index window.

The Analyze Index button lets you collect statistics on the selected index so that COST based query optimization can be used. So, the optimizer can run better queries.

The Filters Indexes List button invokes the Browser Filters window that lets you filter Index Names and Table Names.

The details panel tabs include Column, Partitions, and Script.

Constraints

The Constraints tab displays the constraints in the objects panel.

You can enable/disable constraints. When you disable constraints, if any of the constraints you have selected to disable have dependencies, an Oracle error message will display stating that you cannot disable constraints that have dependencies. A red X displays next to disabled constraints in the objects list.

The Constraints Filter button invokes a Browser Filter dialog window for constraints.

The details panel provides information about the selected constraint including its type, status, table and owner.

200

Schema Browser

Sequences

Sequences are basically counters that Oracle maintains.

In addition to the basic create, alter, and drop buttons, the objects panel includes a button that opens the privileges window for the selected sequence and a button that creates a public synonym for the selected sequence.

The buttons on the Grants tab in the details panel let you revoke privileges for the selected sequence or all sequences.

JAVA

Toad includes a JAVA tab for Oracle 8i and up databases. It lets you view the list of Java objects. The right-click menu includes a Publish Java to PL/SQL menu item. The details panel has a Code tab.

DB Links

DB Links lists all possible links from the database you are using. Links can be public (used by all schemas) or private (used only by the schema that created it). DB Links are used in queries at the end of each table or view name.

Public links in the list have the symbol next to them.

In addition to the basic drop button, the panel includes a Copy script to

clipboard button that copies a Create Public DB link script to the clipboard and a Create new database link button that invokes the Create Database Link window.

The details panel lists the owner, host, user name, and the date and time the link was created for the selected DB link from the object list.

201

Toad

Users

You can create, modify, and drop users. You can also create and copy the SQL script to the clipboard. You can view details for roles and privileges. You can copy

(and then rename) users. You can lock and unlock accounts. Locked accounts display in the objects list with a lock icon to the left of the name. The objects list right-click menu includes an Expire Account feature.

The details panel contains tabs for Info, Roles, and Privileges, Resource

Groups, and more.

The Roles and Privileges tabs contain Revoke buttons which revokes the selected role or privilege.

Jobs

You can create, alter, execute, and drop jobs. You can also place jobs online or offline and view job details.

The details panel shows various parameters for the selected job, such as LOG

USER, NEXT DATE, and INTERVALS. Source for the selected job displays in the lower pane of the details panel.

Types

This page lets you create, browse, and edit user-defined datatypes.

This feature is only available for Oracle 8 and higher databases.

You can set options via the View | Options | Types Tab page.

The objects panel lists user-defined datatypes in a hierarchical display.

The Edit User Type button invokes either the Edit Object Type window or Edit

Collection Type window, depending on the item you select.

Remember, you can click on the icon legend button to display a chart that shows what each icon represents.

202

Schema Browser

Queue Tables

This page lets you create, alter, and drop queue tables using Oracle's built-in

DBMS_AQADM package.

This feature is only available for Oracle 8 and higher databases. Alter queue table is not supported in Oracle 8.0.

Queues

This page lets you create, alter, and drop queues and enable or disable enqueuing or dequeuing on those queues, using Oracle's built-in DBMS_AQADM package.

This feature is only available for Oracle 8 and higher databases.

Clusters

This tab lets you quickly see all of the clusters in the database. It displays the clusters' columns and the tables and indexes involved. A script tab gives you the script to recreate the cluster and optionally the tables and index. The

Create/Alter Clusters screen can be launched from the Clusters tab.

Favorites

The Favorites tab is a configurable tab that lets you add different objects from other Schema Browser tabs into one tab. The objects can be grouped into one or many folders. The folders are specific to an instance. The Details Panel displays the appropriate details, toolbars, tabs, and right-click menu (which includes menu items that perform actions on the objects) for the object type.

Many of the Schema Browser tabs include a right-click Add to Favorites list menu item.

Some of the other Schema Browser tabs that display offer limited DBA features for base Toad, including feature limited Roles and System Privileges.

Their full functionality is available with the optional Quest DBA Module. The

DBA module also includes tabs for Oracle 10g scheduler functions such as

Programs, Jobs, Job Classes, Schedules, Windows, and Window Groups.

Please refer to Toad Help for more information about the DBA Schema

Browser tabs.

203

Toad

204

Other Features

• Quest ScriptRunner

• SQL Modeler

• Code Road Map

• ER Diagram

• Create/Alter Table

• Toad Reports

• HTML Schema Doc Generator

• Network Utilities

• Toad Security

• Session Browser

Toad for Oracle

• Java features

• Optional Quest DBA Module

206

Other Features

Quest ScriptRunner

Quest ScriptRunner is a small script execution utility included in your Toad directory that lets you execute DDL and DML scripts. Because of its small size, several instances of Quest ScriptRunner can be running at one time. You can run it from the executable or from the command line. It includes automatic formatting. It is not 100 percent SQL*Plus compatible, but most of the DDL and

DML scripts should be supported.

If Quest ScriptRunner is not in your Toad directory, it will not include syntax highlighting, hot keys, code templates, and all the other editor features found in the Toad Editor Options window.

The File menu contains the basic file commands.

The Edit menu contains the basic text editing commands including Find and

Replace. It lets you toggle between a full screen and split screen editor.

Edit | Options Menu

Application Options

Editor Font button

This option lets you set the editor font (top panel). The default is 10 point

Courier.

Output Font button

This option lets you set the output font (bottom panel). The default is 10 point

Courier.

Output background color dropdown

You can change the background color of the output.

207

Toad for Oracle

Default - Checked

When this option is checked, if Quest ScriptRunner is located in the Toad directory, or if the Toad editor option files have been copied to the directory where Quest ScriptRunner resides, Quest ScriptRunner will load and use them.

So your Toad options will override the fonts selections that are on this options page. This option gives you access to: autoreplace, syntax highlighting, templates, hotkeys, and the ability to schedule scripts to run. Quest

ScriptRunner first looks for Toad editor options in a User Files directory below the application, and if not found, looks in its local directory for the files.

Show Login window at startup

Default - Unchecked

If checked, the login window will be invoked when you start Quest ScriptRunner.

Default - Unchecked

If checked, when you run Quest ScriptRunner from the command line, Quest

ScriptRunner will close if you have not entered connection information on the command line, or there is no automatic logon connection information saved.

Start in Full Screen edit mode until script is executed

Default - Unchecked

If checked, will open Quest ScriptRunner in full screen mode until you execute a script. When a script is executed, the screen splits to display the results grid in the lower pane.

208

Other Features

Always exit after execution from Toad or command line

Default - Unchecked

If checked, will exit after it executes from either Toad or the command line.

The other option pages include Printing, Script (default script options), and

Toolbars (also includes toolbar buttons options).

Run Menu

The Run menu includes the following commands for running the script: Execute entire/highlighted Script, Run from Cursor, Run to Cursor, Run Current

Statement (runs only statement where cursor is positioned), Execute Script step-by-step, Step through Script from Cursor, and Connect (opens a new connection to an Oracle database).

Right-Click Menus

The editor panel and results panel right-click menus contain some of the common main menu items. The results panel right-click menu also includes commands that let you use any results your script returns.

Launching Quest ScriptRunner from

Command Line

To Launch Quest ScriptRunner from the command line

Type QSR at the command prompt.

Press <Enter>

Quest ScriptRunner will launch and prompt for a connection.

To Launch Quest ScriptRunner and specify a connection from the command line use one of the following formats

QSR <username>/<password>@<databasename>

QSR demo/demo@mydatabase

209

Toad for Oracle

To Launch Quest ScriptRunner and connect using a blank/default database name from the command line

• QSR demo/demo

To get Quest ScriptRunner to attempt to connect using an OPS$ login

• QSR/

To Specify a file to load when Quest ScriptRunner is launched from command line

Use the following format, and Quest ScriptRunner will connect using the specified connection. It will load the file into the editor panel.

• QSR demo/demo@mydatabase c:\temp\mysql.sql

If the filename or path contains spaces, the entire path must be enclosed in

double quotes:

• QSR demo/demo@mydatabase "c:\temp\my sqlfiles\mysql.sql"

To pass the name of a script to load but not run use the following format

• qsr.exe jsmith/jsmith@mydatabase c:\parentscript.sql

To save output to a destination file after running the script designated in the command line use the following format

• qsr.exe jsmith/jsmith@mydatabase @c:\quest scriptrunner\sga.sql

>c:\quest scriptrunner\sgaoutput.txt

Commands Supported

Quest ScriptRunner supports many of the SQL*Plus commands such as

REM/REMARK, PROMPT/PRO, SET ECHO, SET ESCAPE/ESC, SETHEADING/HEA, and SET LINESIZE/LINES.

Refer to Toad Help for more details.

210

Other Features

SQL Modeler

The SQL Modeler lets you quickly create the framework of a Select, Insert,

Update, or Delete statement. You can select Tables, Views, or Synonyms, join columns, select columns, and create the desired type of statement.

Ways to invoke the SQL Modeler

• Click the Database | SQL Modeler menu item.

• Click the Open a new SQL Modeler button toolbar.

on the main

The SQL Modeler uses floating list boxes for tables which include check boxes for selecting column(s) and allow for scrollbars and resizing.

The modeler allows for keyboard interaction with the tables. Press the Up Arrow and Down Arrow keys to move up and down, and press the Space Bar to check or uncheck a box.

211

Toad for Oracle

Table Model Area

The Table Model Area lets you graphically lay out a query. You can drag-and-drop tables from the Schema Browser, Project Manager, Object Search window, and Object Palette. The floating list boxes for the tables include check boxes that let you select columns.

To maximize the model viewing area, press F2 or right-click in the model and select Full Screen Model from the right-click menu.

You can visually join or manipulate the Tables, Views, or Synonyms. You can establish your own joins by dragging and dropping a column from one table to another table column. Once the line is drawn, you can double-click the line to adjust its properties, such as Inner Join vs. Outer Join, or Join Test, e.g., equal

(=), less than (<), greater than (>), etc. The selected column information will appear in the Criteria grid below.

Model Area right-click menu

Right-clicking over the model area displays the following menu items.

Copy Model Image to Clipboard

Copies a bitmap image of the model to the Windows Clipboard

212

Other Features

Tables | Visibility

Displays a Tables Visibility window with check boxes next to a list of tables that are in the model. Check/uncheck the individual tables to show/hide them.

Tables | Calculated Fields

Adds calculated fields based on other table columns

Show | Join Text

Displays the column names that comprise the joins

Show | Primary Key

Shows or hides the Table Primary Keys as "(PK)" next to each PK col

Show | Indexes

Shows or hides Indexes as "(IDX)"

Show | Show Field Type

Shows or hides the data type of each table column

SQL | Run Query in Thread

Lets you cancel a query while it is running, if necessary

SQL | Global Where Clauses

Adds a WHERE clause to the query in addition to the column conditions from the

Criteria tab

SQL | Global Having Clauses

Adds a HAVING clause to the query in addition to the columns conditions from the Criteria tab

SQL | Query Variables

Displays the Variables window where you can add and edit variables

Auto Join All Objects

Automatically joins all tables based on existing DDL Foreign Key Constraints

213

Toad for Oracle

Hide Fields

Only shows the table names and the joins between the tables resulting in more layout space

Zoom to table

Automatically shifts the model area so that the table you want to zoom to is in view

Toggle full screen mode

Hides the bottom tabs of the modeler so that the model area is the whole screen allowing you to see more tables.

Auto Trace

Displays results of statements issued while in auto trace mode, helps with tuning.

Close open cursor

Closes the cursor which closes the query and frees resources. Closing the cursor clears the data in the grid.

The right-click menu also includes Optimize All Table Sizes, Adjust Model

Origin, Auto Arrange Tables, Cascade Tables, Arrange Tables

Horizontally, and Arrange Tables Vertically.

Object right-click menu

Right-clicking over a Table object in the model displays the following menu items.

Set Table Alias

Sets the Table alias

Alias Field Names

Sets logical column names

214

Other Features

Auto Join

Automatically joins this table to others based on existing DDL Foreign Key

Constraints

Describe

Performs a describe.

Show Schema Name in SQL

Shows or hides the schema name before each table in the generated query

Include ROWID

Includes the ROWIDs.

Remove Table

Permanently removes this table from the model

Select All

Selects all columns in the table

Unselect All

Unselects all columns in the table

Invert Selection

Selects columns that were unselected and vice versa

Optimize Size

Sets size to the (data) fields listed in the box

Hide

Temporarily hides this table from the model. To unhide the table, right-click over the empty model space and select the Tables | Visibility menu item

215

Toad for Oracle

Results Grid

After you lay out your query, click the Generated Query tab, and the resulting query will display. Other tabs in the window are Criteria, Query Results, and

Explain Plan.

The alias comes from ALIASES.TXT. If the selected table does not have an entry in ALIASES.TXT, the first three characters of the table name are used to generate the alias, which might not always be unique. For example, the aliases for ALL_OBJECTS and ALL_TABLES are both going to be ALL. You can edit the alias as desired to make it unique or change it to something more meaningful.

If the table name is eight characters or less in length, the entire table name is used as the table alias.

The Results Grid contains four tabs: Criteria, Generated Query, Query Results, and Explain Plan.

Criteria tab

If individual columns are selected, they will be displayed in the Criteria grid.

You can edit many of the column properties in the Criteria grid. "Table" and

"Schema" are not editable here. Double-clicking on the following Criteria columns has the following effects:

Double-click on:

• Sort in a column to select Ascending, Descending, or No sort for that column.

• Condition to bring up the Input the WHERE Definition dialog where you can set a column equal to a constant value or another column value. To remove the WHERE definition, bring up the dialog and click the Remove Condition button. To clear the form click the

Clear Form button.

• Or to enter another WHERE criteria, which will be OR'd together with the above WHERE criteria. If you want to AND multiple column criteria together, go to the expert mode from the Input the WHERE

Definition dialog.

216

Other Features

• Aggregate Function to select an aggregate column function such as

Average, Count, Max, Min, Sum, Standard Deviation, or Variance.

• Field Name to enter a different logical column name.

• Visible to toggle whether or not this column is returned in the query

(Show or Not Show).

• Group to select this as a GROUP BY column. A number within parentheses indicates the order of the columns in the GROUP BY clause.

• Group Condition to bring up the "GROUP BY Definition" window to enter a GROUP BY condition.

If you want to change the table alias, right-click over the table in the model and select the Set Alias menu item.

To rearrange the order of the columns, click the column headers and drag and drop them left or right.

Criteria Tab right-click menu

Right-clicking over the Criteria grid will display the following menu items.

Suppress Current Column

Removes this column from the query, which also removes the plus "+" from the column in the model

Best Fit (All Columns)

Sets the column width of the Criteria grid to show all text

Default Width (All Columns)

Sets the column width of the Criteria grid to the default width

Copy Query Grid Image to Clipboard

Copies the Criteria grid to the clipboard. A dialog gives you the options of rotating the image 90 degrees and/or a gray shaded image.

**Execute as SQL*Plus Report**

Opens the Query Report Format window which lets you format query results in a report style format

217

Toad for Oracle

Generated Query tab

This tab lists the automatically generated SQL statement. Any changes made to the model or column criteria will automatically regenerate this SQL statement.

You can copy the query to the clipboard by selecting it and pressing <CTRL>C or right-clicking and selecting Copy from the popup menu.

You can also copy the query directly to the SQL Edit window by clicking the SQL button in the SQL Modeler toolbar or via the right-click option.

You cannot directly edit the SQL on the Generated Query tab dialog.

The query is syntax highlighted using the same editor settings from the SQL Edit or Stored Procedure Edit window.

218

Other Features

Query Results tab

This grid displays the results of executing the generated query. Insert, Update, and Delete queries can only be executed in the SQL Edit window.

Query Results right-click menu

The Right-click Query Results grid menu includes the following menu items.

Print Grid

Invokes the Print window so that you can print hardcopy of the data. (To access the Report Link Designer click Preview from the Print window and then click the

Design Report button.)

Save As

Invokes the Save Grid Contents window which lets you save data to Clipboard or File.

Export to Flat File

Invokes the Flat File Export from Query window which lets you save the data as a Flat File.

Find Data

Invokes the Grid Data Find window.

Record Count

Displays the number of records in the grid.

The menu also lets you resize columns.

219

Toad for Oracle

Explain Plan tab

If you click the Explain Plan button for a generated SQL statement in the modeler, the Explain Plan output will display on the Explain Plan tab.

Explain Plan tab right-click menu

Right-clicking over the Explain Plan window displays the following menu items.

Copy to Clipboard

Copies the Explain Plan statement (in text mode) to the Clipboard

Optimizer Mode

Lets you select the query optimizer mode for subsequent statements from

Choose, Default, Rule, First Rows, or All Rows

SQL Modeler Options

SQL Modeler options can be set via View | Options | SQL Modeler.

A Modeler Table Text Font drilldown lets you change the font for the table.

A selection list includes Inner Joins, Outer Joins, and Auto Joins.

Click over a color box to select a color for the element. Right-click over the color box to select a background color for the selected item. A preview of the Table object with its new colors displays in the preview window below.

Automatic AutoJoin

Default - Checked

When checked, this feature will automatically check foreign key constraints and join tables that are dropped into a model with other tables. If the option is unchecked, then you can manually join tables with the table popup menu.

Use Schema Name in Generated SQL

Default - Unchecked

If checked, the schema name will be included in the tablename (i.e., myschema.mytable) in the generated SQL. Regardless of whether or not this option is checked, schema names are automatically included if the table belongs to a schema that is different than your login schema.

220

Other Features

Automatically Select All Columns

Default - Unchecked

When checked, all columns are automatically selected when you add a table to the SQL Modeler. If unchecked, no columns are selected.

Allow Cartesian Joins

Default - Unchecked

If checked, the modeler will allow Cartesian products.

Warn on Cartesian Joins

This check box is only enabled if the Allow Cartesian Joins check box is checked.

If checked, you will be prompted each time a Cartesian Join is going to execute.

Default - Unchecked

If checked, when you are in the Schema Browser - Tables page and open a table in the SQL Modeler via either the Tables page | SQL Modeler toolbar button or the Tables page | Model Table right-click item, the Modeler will open in full screen mode. If checked, when you are in the Schema Browser - Views page and open a view in the SQL Modeler via the Views page | Model View right-click item the Modeler will open in full screen mode.

Default - Unchecked/5

This lets you limit the number of visible columns on the table in the model area.

For example, if the spinner is set to 5, the box is checked and you add a table with 10 columns, only 5 columns will display and a scrollbox will let you view the rest of the columns.

Restore All Defaults button

Click this button to discard your customized options and restore the default settings for the options.

221

Toad for Oracle

Code Road Map

You get to this window via the main menu button, the Tools | Code Road

Map menu item or from the Schema Browser - Procedures page |

Right-click menu.

The Code Road Map displays a diagram illustrating with arrows which object references which object. The object at the arrow end of the line is referenced by the object at the black dot end of the line.

The toolbar buttons include Create new code road map, Clear the map, Open an existing .crm (code road map) file, Information (lets you type comments which will be saved with the file), and Toggle expand/collapsed package view. The

Save file as... button will save the map as a .crm file. For larger maps you might find that the Save the diagram as a text file button creates a text file that is easier to read. You can also Save the map as a bitmap. The Auto layout

design buttons are designed to improve the map layout. Set colors for DB

Objects lets you change the colors for all objects of a type on the screen.

Note: The Create the scripts for the objects in the map button requires the

DBA module.

The left side contains the object browser treeview list. Click on an item in the list, and the respective object in the map is brought into focus.

Right-clicking on either the objects in the map or the objects in the object browser treeview list will display the associated Schema Browser right-click menu for that object.

F2 in the map toggles full screen.

F4 or double-clicking on an object performs a describe for objects that are supported by the describe feature in Toad.

222

Other Features

ER Diagram

You access this window via the main menu button, the Tools | ER Diagram menu item or from the Schema Browser - Tables page | Right-click menu.

The ER (entity relationship) Diagram works in a similar way to the Code Road

Map. It shows dependencies and selected details. Objects on the arrow end of the line are referenced by objects on the black dot end of the line. The left side contains the treeview object browser list. Right-clicking in the diagram will display the associated Schema Browser right-click menu for that object.

When you create a new diagram you can select what to display: primary keys, foreign keys, unique keys, data type, not nullable, and indexes.

Using the Object Palette window (from the View menu) you can list tables.

Objects can be added to the diagram via drag and drop or double-click.

After you add new objects (tables, views, synonyms) press the Find

dependencies button on the toolbar to find dependencies between the newly added objects and the existing objects.

The Save as... button saves the file as a .erd file. The toolbar includes a button that lets you Load the objects into the SQL Modeler.

Each object in the ER Diagram includes an "X" on the caption bar that lets you remove the object from the diagram.

F2 will toggle full screen.

F4 or double-clicking on an object performs a describe for objects that are supported by the Toad describe feature.

The Create the scripts for the objects in the map button requires the DBA module.

223

Toad for Oracle

Create/Alter Table

Create Table

You get to this dialog via the Create | Table menu item or from the Schema

Browser window | Tables page | Create Table button.

This window lets you create a new Oracle table. Use this dialog to enter the table information; then click the Execute button to create the Table. This is easier than remembering the Oracle syntax for this command.

Standard Table

Select Standard Table if you want a normal relational table.

Global Temporary Table

Select this if you want a table whose data is only visible for the current session.

Index-Organized Table

Select this if you want a table whose data rows are stored in the primary key index.

Clustered Table

Select this if you want a table that is part of a cluster.

Advanced Queuing

Select this if you want to create an advanced queuing table.

External Tables

When you are connected to Oracle 9i or later, you can create external tables.

Access parameters can be created by one of three methods: create with a GUI by sampling data, create manually with a GUI, or manual edit of an existing SQL

Loader control file.

224

Other Features

Alter Table

You get to this window from the Schema Browser | Tables page | Alter

Table button. This window lets you drop, modify, and add columns; change storage parameters; change data type; add not null constraints; and set unused columns. It is the same window as the Create Table window, but you are using it to make modifications to an existing table.

To alter a table, select a table from the objects list and click the Alter Table button. The Table window will automatically display the Schema and the Name for the table you selected.

The Table Type radio buttons are disabled, because you can't alter the table type.

Data Types Options

The Data Types Options page is accessed through the View | Options | Data

Types item. The options that are checked will appear as items in the Data Types dropdown in the Create Table and Alter Table windows.

Types are listed in the Native Oracle Types panel and the ANSI Types panel.

Select All and Select None buttons are in each panel. You can check and uncheck the individual types. The types checked are the only ones that will be included in the Table Data Types dropdown.

Refer to Toad Help for more information about Create Table/Alter Table.

225

Toad for Oracle

Toad Reports

Toad Reports lets you print out various preformatted reports. You access the window from the View | Reports menu item. Or you can click on the Reports button on the toolbar.

The reports list is displayed in the Reports panel in tree views that are divided by major categories. You select a report from the list.

The Report Description panel displays a description of the selected report.

The right panel contains a dropdown of Parameters that you need to set. The parameters that are displayed depend upon the type of report you select. The wildcard symbol "%" is a choice in each parameters list.

The Run button will run the report and invoke a Print Preview window where you can select your printer settings.

To run a report

Select the report.

Enter the parameters.

Click the Run button. The Print Preview window displays the preformatted report and lets you set your printer options.

The Close button closes the window. The window does not close automatically when you close Toad.

Toad Reports runs as a separate program. If you have a long running report process you can close Toad and leave the reports program open. Toad Reports enhances Toad performance, because it can run in the background without tying up Toad.

226

Other Features

HTML Schema Doc Generator

You access this window from the Tools | HTML Schema Doc Generator menu item.

This window lets you select one or more schemas from the Sources tab and create HTML documentation describing the schema(s) via the Begin HTML

Schema Doc Generation button at the top of the screen. Hyperlinks throughout the HTML document let you jump between sections of the documentation.

The HTML Schema Doc Generator includes command line support. Refer to

Toad Help for more information.

All options are saved to and loaded from the Toad.INI file. Schema selections are saved and loaded on a per-database basis. The following options require further explanation.

Content tab

This tab contains check boxes that let you select what to include in your HTML document.

Counts of All Objects

If checked, the document will list each object type owned by the schema and the number of objects of that type in the schema.

227

Toad for Oracle

Object Summary

Each Object Summary check box (Tables Summary, Snapshots Summary, etc.) when checked, creates a list of characteristics of the object. For most object types, the object name is a hyperlink to a more complete description of the object.

Object Descriptions

Each Object Description check box enables additional check boxes that let you specify what to include in the description. The Table Descriptions includes a

Default Values check box. If checked, a Default Value column will be added to the table descriptions and display the default value for each column in a table.

Format tab

File Options radio buttons

One file per schema

If selected, each schema is written to its own file. If more than one schema is selected, an additional HTML page will be created that is a link between the schema documents.

A few files per schema

If selected, schemas are broken into a few files, one file for each major section.

One file per object

If selected, each object is written to its own file, and each summary section is written to its own file.

Background

Use Existing CSS file

Most of the style options are written to a CSS file. If you want to use your own customized version of the CSS file, select this option and specify the file name or URL (The default will be the same name as the HTML file but with the css extension.). When this option is selected, the options that are written to the CSS file are disabled.

228

Other Features

Indent HTML files

When checked, the HTML code in the files will be indented with spaces so it can be more easily read. When the option is unchecked, no indentations will be made in the HTML code, so the resulting files are smaller and can be read faster by computers. This option does not change the way the HTML documents are displayed when viewed through a browser.

In/Exclusions tab

This tab lets you create and select inclusion and exclusion files.

The filter button lets you select either the Tables or Views button. The Create a file button generates an inclusion/exclusion text file for the schema that lists all your tables or views. You can then view and edit the file. If you use it as an inclusion file then only the tables or views listed will be included. If you use it as an exclusion file then only the tables or views listed will be excluded. You can also add STARTSWITH: ENDSWITH: CONTAINS: filters.

A radio button also lets you select to specify object sets. This lets you specify the objects using the GUI instead of editing a text file. This is the fastest way to create HTML schema documentation for large schemas when you are interested in creating documentation for only a small percentage of the schema objects.

The inclusion/exclusion files are suited for specifying a large percentage of schema objects.

Headers/Footers tab

This lets you add headers and footers and select the fonts for each header/footer.

Aliases for Schema Names tab

This lets you add aliases for the generated HTML for individual schemas.

229

Toad for Oracle

Network Utilities

You access the Network Utilities window via the File | Network Utilities menu item.

You access the Network Utilities options via the View | Options | Network

Utilities page.

Telnet

Telnet (Telecommunications Network) is a protocol for connecting to another computer and establishing a session there where you can issue commands. The protocol is specified in Internet RFC 854.

The Telnet tab is used to communicate with servers implementing the Telnet protocol. It provides Telnet capability through a simple interface. It functions like a terminal emulator, although at this time only displayable characters and the

<Enter> key are supported (i.e., control characters, including backspace, are not currently supported).

Type in the Host Name/IP (Host Name or the IP address) in the dropdown box.

Type in the Port number.

Click the Connect button.

In the window your cursor will appear after "login:"

Type in your login name, press <Enter>, type in your password, and press

<Enter>.

The top panel is a console that displays messages from the server and the commands that you type in. The lower panel shows the Telnet commands sent and received as part of the protocol.

Right-click in the terminal window to access the context menu. The menu lets you Clear the screen or copy information to the Clipboard.

The Save Output button lets you save through the Save As window.

230

Other Features

RExec

The RExec tab lets you execute a Unix command. The server must be running

Rexecd in order for this function to work. It provides controls for specifying the host, user name, and password for the connection. It also provides a location to enter the command to be executed and an Execute button to submit the command. For more information about the RExec command, consult your Unix administrator or refer to your Unix documentation.

The output of the command is displayed in the panel below the connection information. If it is a command to run a program (such as "bc"), then you can enter the information to send, press <Enter>, and see the results of the program. The connection continues until you exit the remote program.

Type in the Host Name/IP (Host Name or the IP address).

In the User box type in the User name.

In the Password box type in the password.

In the Command box type in a Unix command such as "who" or "ls". You can double-click in the Command box to display a command editor that will accommodate long strings.

Press the Execute button to execute the command.

The right-click menu lets you Clear or copy to Clipboard.

Ping

This uses ICMP to contact other machines on the network and let you know whether it was successful or not.

Type in the Host name/IP (Host name or IP address) that you want to ping.

You can set a different Interval (which is in milliseconds), if desired.

Click Start.

Toad will ping the selected host and display the results in the bottom panel. The sending bytes and received bytes results will display in the window. It will continue to ping the host at the interval selected until you click Stop.

You can right-click in the results panel to access the context menu which lets you copy the results to Clipboard or Clear the results window.

Ping is configured under View | Options | Executables.

231

Toad for Oracle

TNS Ping

TNS Ping is an Oracle utility that tries to determine whether a TNS Listener is running for one of the connection strings in the TNSNAMES.ORA file. Given a connection string, TNS Ping looks in the TNSNAMES.ORA file to determine the name or IP address of the machine running Oracle. TNS Ping then connects to that machine to determine whether a TNS Listener is running.

The TNS Ping tab has a Server dropdown with the connection strings from the

TNSNAMES.ORA file and a TNS Ping button to submit the TNS Ping request. The results of TNS Ping display in the panel at the bottom of the window.

TNS Ping is configured under View | Options | Executables.

Select a Server from the dropdown.

Click TNS Ping.

An "Attempting..." message and "Ok..." message will display indicating that the server was successfully pinged.

If there is no listener a "No Listener" message will display.

The right-click menu lets you Clear or copy to Clipboard

IP Addresses

The IP Addresses tab lets you enter a Host name or URL and get the IP address, or enter an IP address and get the Host name or URL.

The top of the window displays the local Host and the local IP address.

In the Host/IP/URL box, type in the Host or URL.

Press the Find button or press <Enter>.

Both the Host/URL and its IP address will display.

This also works in the other direction. Type in an IP address, Press the Find button or press <Enter>, and both the Host/URL and the IP address will display.

The results panel displays all of the results since you opened the window.

The right-click menu in the results panel lets you Clear or Copy to Clipboard.

The Save button lets you save the results to a comma-delimited file via the Save

As window.

232

Other Features

SSH

Secure Shell lets you log into another computer over a network, execute commands in a remote machine, and move files from one machine to another utilizing password/id and data encryption. It provides secure connections over unsecured channels and is a secure replacement for Telnet, Rlogin, RSH, and

RCP.

In addition to the setup area, the screen contains three panels. The top panel displays messages (not SSH commands) from the server. The second panel displays the command that you type in and a Send button for the command. The bottom panel displays the SSH commands sent and received as part of the protocol.

The two versions of Secure Shell are SSH version 1 and SSH version 2. They are different protocols and encrypt at different parts of the packet. They are not compatible. SSH version 2 is more secure and the current development standard.

To connect with SSH

From the File | Network Utilities | SSH tab

In the Connection properties area enter the:

Host name

Port (default 22)

Check either SSHv1 (version 1) or SSHv2 (version 2)

In the Authentication properties area enter the user name, password, private key file for PUBLICKEY authentication type

Click Connect

233

Toad for Oracle

Toad Security

Toad includes a security feature. You can restrict Toad users from having access to specific Toad features.

NOTE: Due to a redesigned architecture for Toad Security, if you are upgrading to Toad 7.3 or later and have already set up your security features in a version of Toad prior to 7.3, you will need to recreate the security tables and assign restrictions based on the new format.

During the installation you had the opportunity to set up Toad Security from the

Server Side Installation wizard. You can also access the Server Side Installation wizard from the tools menu. See the Getting Started Guide for more details.

To Run Toad Security

Run Toad, log in as the DBA user and select the Tools | Toad

Security menu item to bring up the Toad Features Security window. Select the user or role, then select the features you want to deny to that user or role.

All other Toad Security features will be granted to this user. Since other non-DBA users only have SELECT privileges to the

Toad_RESTRICTIONS table, they cannot make changes to the security.

Click the Grant SELECT button so the user or role can see the

Toad.Toad_RESTRICTIONS table.

If the user cannot see the Toad_RESTRICTIONS table (i.e., they do not have SELECT access granted to them), they have FULL access to all Toad features.

If the user has SELECT privileges on the Toad_RESTRICTIONS table, then the security is in effect.

Move any commands you do not want the user to have from the

Features list to the Restricted Features list.

Not all buttons, menus, or functions in Toad are contained within this security scheme. If you need to restrict other functionality, please let us know.

When you have completed restricting features, click OK to save your changes.

You can also create collections of Toad features using existing Oracle roles. Grant the features to a role, e.g., DEVELOPER_ROLE, grant the role to the end user(s), then those Toad users will get the collections of Toad functionality without having to set up the same list of Toad features for multiple users.

234

Other Features

Disable saving Oracle passwords by Toad

This option is in the Features | Non-Menu list as No save passwords. It lets you disable the ability to save passwords. When this feature is activated, it applies to the entire Toad session, even if other users on the same session have the rights to save passwords.

Read-only

You can make Toad read-only to a selected user or role. This is useful, for example, if you have someone who needs to view scripts and roles but does not have the authority to change them.

To make Toad read-only move the Read only Override function from the

Features | Non-menu list to the Restricted features list. This makes Toad read-only to the selected user.

Toad security is not enforced if the user has the DBA role.

For more information about Toad Security refer to Toad Help.

235

Toad for Oracle

Session Browser

The Toad Session Browser lets you easily view and work with sessions.

You can:

• Organize session views

• View detailed information

• Kill sessions

• Trace sessions

• View locks being held or acquired by sessions

• View transaction information for online rollback segments

• Filter sessions

For more information about the Session Browser refer to Toad Help.

236

Other Features

Java features

Java features in Toad include:

• Load/Drop of Java classes via the Java Manager

• Publish Java classes to PL/SQL packages via the Java to PL/SQL wizard

• Browse Java sources/classes/resources in the Schema Browser

• Create Java Sources in the SQL Editor

237

Toad for Oracle

Optional Quest DBA Module

The optional Quest DBA Module is a configuration of Toad features designed for the use of the Database Administrator. The module adds extended functionality to the DBA menu, the Schema Browser, the Create Menu, and the View

Tablespaces area. The Quest DBA Module windows are discussed in Toad Help.

DBA windows

DBA windows include the following:

• Audit Objects - Displays the audit monitoring options for selected database objects. You can enter and modify monitoring levels for individual objects or groups of objects.

• Audit SQL/Sys Privs - Displays the audit monitoring options for SQL

Statement objects, reserved words, and system privileges in the database

• Compare Schemas - The DBA version of this function loads def files and save or copy the migration/synchronization report to a script file

• Compare Databases - Lets you compare two databases

• Control Files - Displays control file information about the associated database required for the database to be accessed by an instance

• Database Monitor - Lets you monitor database performance with charts

• Database Browser - Lets you browse information related to the databases in either your TNS names file or the list of active connections

• Database Health Check - Performs a series of checks on a selected database and displays the results

• Database Probe - A real-time monitoring window that offers a large collection of alerts, lets you create your own alerts

• DataPump Import/Export wizards - An import/export utility added in Oracle 10g. It is faster and more efficient than the standard import/export utilities. Toad’s Data Pump import/export wizards make using it even easier. Toad has a Data Pump job manager to help you manage import/export tasks.

• Export File Browser - Window to browse contents of export files and view data and DDL without having to import them

238

Other Features

• Export Utility Wizard - Exports a schema script using Virtual DBA routines

• Generate Schema Script - Takes the selected schema or definition file and builds DDL and/or definition files for all selected objects

• Generate Database Script - Creates a new database that is based on an existing one

• Identify Space Deficits - Displays tables that do not have enough free disk space to allocate their next extent

• Import Utility Wizard - Imports a schema script using Virtual DBA routines

• Index Monitoring - Monitors indexes to determine whether or not they are being used. You can drop unused indexes.

• Instance Manager - Checks on the status of the databases you can access

• Log Switch Frequency Map - Shows when your database performs a log switch

• LogMiner - Analyzes a database for which system change number

(SCN) caused a corruption problem so that you can recover to the transaction exactly before the corruption

• New Database Wizard - Provides a rapid way to create new Oracle databases

• NLS (National Language Support) Parameters - Displays session, instance, and database parameter settings, and changes session and/or instance parameters

• Operating System Utilities include:

Unix Monitor - Lets you monitor database performance with charts and a grid, displays the top 20 CPU usage processes

Unix Job Scheduler - Lets you schedule jobs to a Unix machine

Windows Registry Parms - Lets you set Windows Registry parameters to make Toad and Oracle run more efficiently

Unix Kernel Parms - Lets you set Unix Kernel parameters to make

Toad and Oracle run more efficiently

• Oracle Parameters - Lets you alters parameters

• Pinned Code - Pins code into the memory buffer so that it is always accessible and not overwritten by new data

• Redo Log Manager - Maintains the redo logs for a database

• Resource Plan Scheduling - Lets you schedule and change schedules for resource plans.

239

Toad for Oracle

• Segment Advisor - Lets you examine tables, indexes, and partitions to determine if and how much space can be reclaimed with the

SHRINK command.

• Tablespace Map - Provides a graphical view of tablespaces in your database

• Top Session Finder - Finds the sessions in the database that are consuming the most resources

• Undo Advisor - Provides advice and helps automate the establishment of the database undo environment.

Schema Browser and Create Menu

The Quest DBA module adds the following functionality to the Schema Browser and the Create menu:

• Dimensions - You can create and alter dimensions.

• Directories - You can create and alter directories.

• Libraries - You can create, alter, and drop libraries.

• Oracle Scheduler - Support for the Oracle Scheduler functionality that includes: Sched.Programs, Sched.Schedules, Sched.Jobs,

Sched.Job Classes, Sched.Windows, and Sched.Window Groups.

• Policies - You can create, enable, disable, edit, and drop policies.

• Policy Groups - You can create and drop policy groups.

• Profiles - You can create, modify, and drop profiles.

• Roles - You can create, alter, and drop roles.

• Rollback Segments - You can create, alter, and drop rollback segments.

• Refresh Groups - You can add and remove materialized views to and from the group and drop the group.

• Resource Plans - You can create, alter, and drop resource plans. You can view details and schedule plans.

• Resource Consumer Groups - You can create, alter, and drop resource consumer groups.

• System Privs - You can configure grantees to system privileges.

• Tablespaces - You can create, alter, and drop tablespaces. You can place tablespaces online or offline.

240

Other Features

View Tablespaces

The Space, Space History, and IO History tabs are only available in Toad with the optional Quest DBA module.

Code Road Map and ER Diagram

The Create Object Scripts buttons on both of these windows are only available in Toad with the Quest DBA Module.

Flat File Export window

The SQL*Loader tab is only available in Toad with the Quest DBA module.

Knowledge Xpert™ for Oracle

Administration

Knowledge Xpert™ for Oracle Administration, which is included with the Quest

DBA Module, is a comprehensive technical resource that anticipates the daily responsibilities of DBAs. Thousands of topics provide insights, database analysis information, and working examples for DBAs.

241

Toad for Oracle

242

Questions

• Questions

• Toad Help

• Customer Support

Toad for Oracle

Questions

What is the current version of Toad?

See www.quest.com for the latest version information.

**Can Toad connect using 16 bit Oracle SQL*Net?**

Toad is a 32 bit application and therefore requires 32 bit SQL*Net.

If Toad hangs during the splash screen, there could be a problem with the sound card or sound devices. Edit Toad.INI, set "PLAY_WAVE=0", and try to run Toad again. You can also rename ToadLOAD.WAV to something else, so that Toad will not find it or attempt to play it.

Where can I get upgrades?

Upgrades can be obtained from the Quest web site, www.quest.com.

Toad Help

To access Toad Help while in Toad, press the F1 key. Toad Help includes contents, a searchable index, and details on Toad's features. It also contains details for troubleshooting problems.

244

Questions

Customer Support

If you have questions about using Toad, and you can't find the answers in the

User's Guide, the Getting Started Guide or Help please contact the customer support staff. The Help | Support Bundle menu item window provides updated support information.

The information it contains will be useful for support when resolving issues and you should include this support information with emails to Quest Support.

Including the Toad.INI file is optional, but it might help the support staff because it includes options settings and other Toad information. Toad.INI does not include any connection information (passwords, servers, usernames). That information is stored in CONNECTIONS.INI. So, when you submit the Toad.INI file to Quest Support or share it with other Toad users, your credentials

(passwords etc.) are not included.

The toolbar includes Copy the support bundle text to the clipboard, Save the support bundle text to a file, Send a message to the Toad mailing list

([email protected]), Send a message to Quest Support

([email protected]), Launch default web browser and go to Quest support on the web (http://www.quest.com/support/), Attach Toad.INI to emails (When checked, Toad.INI is included with your email to Quest Support or the Toad mailing list as an attachment), Include this information in the body of your emails (When checked, the support bundle text is included as the body of your email).

245

Toad for Oracle

Information Displayed

Application Information

• Toad Version

• Toad Registration Information

• Toad Options (Debugger, DBA, Xpert, etc.)

• Installation Type (Network or Local)

• EXE and Client Directories (Client directory only applies to network installations)

• Knowledge Xpert Version and Location

• Team Coding and SP Server status and information

Oracle Client Information

• Client Version

• Client Location

• TNSNAMES.ORA Location

Oracle Server Information (for each connection)

• Server Version

• Server NLS_CHARACTERSET

• Server NLS_NCHAR_CHARACTERSET

• Connected User and Connect As (Normal, SYSDBA, SYSOPER)

246

Questions

System Information

• Operating System Version

• Total and Available Memory (Physical, Virtual, and Swap)

• PATH Environment Variable

• TNS_ADMIN Environment Variable

Oracle Homes Registry Data

• All registry information for each installed home is displayed. (Located under HKEY_LOCAL_MACHINE\Software\Oracle.)

This information helps the customer support staff. You can type in information about your question or problem in the body of the letter. If your question is about an error message, include the error text as well.

The Help | About window displays customer support contact information including telephone numbers and your version number. When you contact customer support they will need to know what version of Toad you are using.

You can create your own support calls online at www.quest.com/support

If you create support calls online, you will also be able to check the status and update your own calls online.

247

Toad for Oracle

248