TOAD

USER’S GUIDE

®

Version 7.6

© Copyright Quest Software, Inc. 2000-2003. All Rights Reserved. This guide contains proprietary information, which is protected by copyright. The software described in this guide is furnished under a software license or nondisclosure agreement. This software may be used or copied only in accordance with the terms of the applicable agreement. No part of this guide may be reproduced or transmitted in any form or by any means, electronic or mechanical, including photocopying and recording, for any purpose other than the purchaser’s personal use without the written permission of Quest Software, Inc. Warranty The information contained in this document is subject to change without notice. Quest Software makes no warranty of any kind with respect to this information. QUEST SOFTWARE SPECIFICALLY DISCLAIMS THE IMPLIED WARRANTY OF THE MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. Quest Software shall not be liable for any direct, indirect, incidental, consequential, or other damage alleged in connection with the furnishing or use of this information. Trademarks Quest® and TOAD® are registered trademarks of Quest Software, Inc. Other trademarks and registered trademarks used in this guide are the property of their respective owners.

Quest Software, Inc. World Headquarters 8001 Irvine Center Drive Irvine, CA 92618 www.quest.com U.S. and Canada 949.754.8000 email: info@quest.com

TOAD User's Guide Updated November 2003 Software Version 7.6

Contents

C O N T E N T S

TOAD

User’s Guide

1 INTRODUCTION........................................................................................................................... 7 2 LOGON/LOGOFF.......................................................................................................................... 9 LOGON OPTIONS ............................................................................................................................. 11 CONNECTING TO PERSONAL ORACLE.............................................................................................. 15 END CONNECTION .......................................................................................................................... 15 3 SCHEMA PREPARATION......................................................................................................... 17 4 BASICS .......................................................................................................................................... 19 MOUSE............................................................................................................................................ 19 KEYBOARD ..................................................................................................................................... 21 HOTKEYS – ADDING/ALTERING ....................................................................................................... 23 RIGHT-CLICK MENUS ...................................................................................................................... 24 WINDOW BAR ................................................................................................................................. 24 MAIN TOOLBAR .............................................................................................................................. 25 Configure TOAD Options .......................................................................................................... 26 Save TOAD Options ................................................................................................................... 26 Offline Text Editor ..................................................................................................................... 27 Configure/Execute External Tools ............................................................................................. 27 Project Manager ........................................................................................................................ 28 Customize (toolbars and menus)................................................................................................ 30 Menu Shortcut Customization window....................................................................................... 32 5 SQL EDITOR................................................................................................................................ 33 SQL EDITOR TOOLBAR................................................................................................................... 34 SHORTCUT KEYS............................................................................................................................. 34 USING THE SQL EDITOR ................................................................................................................. 39 Selecting a table to edit.............................................................................................................. 39 Commit....................................................................................................................................... 42 Explain Plan............................................................................................................................... 44 Recall and Add SQL................................................................................................................... 49 OPTIONS FOR THE SQL EDITOR ...................................................................................................... 55 EXECUTING STATEMENTS ............................................................................................................... 60

4

Execute SQL Scripts................................................................................................................... 61 Table/View Aliases ..................................................................................................................... 63 CONFIGURING THE EDITOR ............................................................................................................. 66 EDITOR OPTIONS ............................................................................................................................. 76 General Options ......................................................................................................................... 77 Highlighting ............................................................................................................................... 85 Key Assignments......................................................................................................................... 89 Auto Replace .............................................................................................................................. 91 Code Templates.......................................................................................................................... 93 RIGHT-CLICK MENU ........................................................................................................................ 95 SQL RESULTS PANEL ..................................................................................................................... 96 Data tab ..................................................................................................................................... 96 Explain Plan tab....................................................................................................................... 101 Auto Trace tab.......................................................................................................................... 102 DBMS Output tab..................................................................................................................... 103 Script Output ............................................................................................................................ 103 SQL TEMPLATES .......................................................................................................................... 104 MAKE CODE STATEMENT AND STRIP CODE STATEMENT .............................................................. 106 OPTIONS FOR THE EDITORS ........................................................................................................... 109 SQL EDITOR TASKS...................................................................................................................... 114 6 DATA GRIDS.............................................................................................................................. 123 RIGHT-CLICK MENU ...................................................................................................................... 123 SORT OPTIONS WINDOW ............................................................................................................... 135 CALCULATOR ................................................................................................................................ 136 DATA GRIDS – DATA OPTIONS ..................................................................................................... 137 DATA GRIDS – VISUAL OPTIONS................................................................................................... 141 REPORT LINK DESIGNER ............................................................................................................... 147 7 PROCEDURE EDITOR............................................................................................................. 151 PROCEDURE EDITOR TOOLBARS ................................................................................................... 152 SHORTCUT KEYS ........................................................................................................................... 153 PARAMETER HINTS ....................................................................................................................... 155 USING THE PROCEDURE EDITOR ................................................................................................... 156 NAVIGATOR TREE BUTTONS ......................................................................................................... 162 OPTIONS FOR THE PROCEDURE EDITOR......................................................................................... 163 RIGHT-CLICK MENU ...................................................................................................................... 167 DBMS OUTPUT ............................................................................................................................ 169 UTPLSQL ..................................................................................................................................... 171 SOURCE CODE MANAGEMENT ...................................................................................................... 173 TEAM CODING .............................................................................................................................. 177 OPTIONAL PL/SQL DEBUGGER .................................................................................................... 178 Tooltip Feature for Variables .................................................................................................. 180

Contents

5

The Status Panel Indicators ..................................................................................................... 181 The Dockable Windows............................................................................................................ 181 Preparing PL/SQL Code for Production ................................................................................. 182 PROCEDURE EDITOR TASKS .......................................................................................................... 183 8 SCHEMA BROWSER................................................................................................................ 189 USING THE SCHEMA BROWSER ..................................................................................................... 190 OPTIONS FOR THE SCHEMA BROWSER .......................................................................................... 194 CUSTOM QUERIES ......................................................................................................................... 204 FOREIGN KEY LOOKUP ................................................................................................................. 205 TABLES ......................................................................................................................................... 206 VIEWS ........................................................................................................................................... 225 SYNONYMS ................................................................................................................................... 225 PROCEDURES ................................................................................................................................ 226 TRIGGERS ..................................................................................................................................... 227 INDEXES........................................................................................................................................ 228 CONSTRAINTS ............................................................................................................................... 229 SEQUENCES................................................................................................................................... 229 JAVA ........................................................................................................................................... 229 DB LINKS ..................................................................................................................................... 230 USERS ........................................................................................................................................... 230 JOBS.............................................................................................................................................. 231 TYPES ........................................................................................................................................... 231 QUEUE TABLES ............................................................................................................................. 231 QUEUES ........................................................................................................................................ 231 CLUSTERS ..................................................................................................................................... 232 FAVORITES.................................................................................................................................... 232 SCHEMA BROWSER TASKS ............................................................................................................ 233 9 OTHER TOAD OPTIONS AN D FEATURES ........................................................................ 237 QUEST SCRIPTRUNNER ................................................................................................................. 238 SQL MODELER ............................................................................................................................. 243 CODE ROAD MAP.......................................................................................................................... 257 ER DIAGRAM................................................................................................................................ 258 CREATE/ALTER TABLE ................................................................................................................. 259 TOAD REPORTS ........................................................................................................................... 261 HTML SCHEMA DOC GENERATOR ............................................................................................... 262 NETWORK UTILITIES..................................................................................................................... 265 TOAD SECURITY ......................................................................................................................... 269 SESSION BROWSER ....................................................................................................................... 271 JAVA FEATURES ............................................................................................................................ 272 OPTIONAL QUEST DBA MODULE ................................................................................................. 273 10 FREQUENTLY ASKED QU ESTIONS/SUPPORT ............................................................. 275

...................................................................................6 TOAD HELP ........................................................................... 276 INDEX...................................................................................................................... 279 ........................ 276 CUSTOMER SUPPORT........................................................................................

debug. tables. You can even create your own code templates. packages. functions. and the result is an easy to use. Use TOAD to § § § § § § § Create. You can view the Oracle Dictionary. The GUI browsers provide quick access to database objects.1 Introduction TOAD TOAD is a powerful low-overhead tool built around an advanced SQL and PL/SQL editor.all through a multi-tabbed browser. Code can be created from shortcuts and code templates. browse. and more-. extents. and effective interface. PL/SQL script writers can use the advanced editing features to save time and increase productivity. and grants Manage your most common DB tasks from one central window Create HTML docs for any schemas. indexes. and triggers Search for objects Find and fix database problems with constraints.) including Oracle8 TYPE objects Graphically build. execute. stored procedures. complete with links and customizable for content and style . views. triggers. fast. indexes. indexes. You don’t have to be a PL/SQL expert to access database objects when you’re using TOAD. and profile “stored procedures” including procedures. It was designed from the developer’s perspective. and tune queries Edit. or alter objects (tables. etc.

and function. Colors are presented in the . The guide covers the following major windows and topics: § § § SQL Editor Procedure Editor Schema Browser Once you are comfortable navigating around a few of these windows you’ll discover that the other TOAD windows have a similar design. option. The guide does not cover every TOAD window. refer to the TOAD Getting Started Guide. For details on installing and uninstalling TOAD. Refer to TOAD Help for the latest information.8 This guide is a how-to and reference for new users and users already familiar with TOAD. You can always access TOAD Help while you are in TOAD by pressing the F1 Key. The printed version of the TOAD User’s Guide is in black and white. New or changed TOAD features since November 2003 are not reflected in this version of the guide. .PDF. The manual also covers the following major topics: § § Logon/logoff Navigation and shortcuts Note that this User’s Guide was prepared in November 2003. so the color differences are not always distinguishable.

The screen lists your previous connections (server. TOAD will fill the database dropdown with the names of previous sessions and any aliases in TNSNAMES. You can create a new connection to Oracle or select from a list of previous connections.ORA. user. All checked connections in the Autoconnect Column are automatically connected each time you start TOAD. and the date and time of the connection). Otherwise. You can create a new connection to Oracle or select from a list of previous connections. . or when TOAD starts up. 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. the default password will be the same as the username. If you have a TOAD home set. the home that is set via Oracle's Home Selector application is loaded. When you double-click to select a previous logon from the list of previous logons.2 Logon/Logoff When you start TOAD a Login screen displays. then it is loaded into the Home Selection dropdown.

DO NOT ENABLE THE Save passwords for Oracle connections OPTION UNLESS YOU HAVE A SECURE ENVIRONMENT. Asterisks will display instead of characters as you type. TOAD saves the USER/DATABASE combinations between TOAD sessions. Click OK or press <ENTER>. .ORA file. follow these steps. If the option is unchecked then the Save Pwd? column will display in the previously used connections grid. but does not save the password. Otherwise. Click OK OR Press <ENTER>. 2 3 4 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. Type the name of the USER in the textbox labeled User/Schema. If you check the column the password is saved for the respective connection in the Login Grid. Type in the Password.10 To create a new connection 1 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. 1 2 3 Select a previous connection from the list in the left panel. Type the PASSWORD for the user in the textbox labeled Password.

User. This option does not apply to Oracle 8i because Oracle restored the error position function. TOAD ignores the Net8 DLLs on your system and attempts to connect to Oracle via the SQL*Net DLLs. you get the row and character position from bad queries. Type “lsnrctl” and <ENTER> Type the command “start” Logon Options Force SQL*Net (ignore Net8) checkbox When checked. If Force SQL*Net is chosen. The DLL is loaded according to the above. This also means that a client install with just Net8 will result in a failure. Last Connect list. but the new Net8 functions are ignored. you do not get the error row or column position. The downside is that no Oracle 8 functions are supported. . but you do get the Oracle 8 functions. Net8 DLLs are skipped.5 If you are using TOAD with Personal Oracle 8. and the cursor is positioned to the point of error.1. the DLL with the HIGHEST revision number is loaded. SQL*Net Compatible Net8 checkbox This option only applies to Oracle 8. It assumes that Net8 is installed. When unchecked (OFF).x databases.5 or later and receiving errors like “No Listener” try the following: 1 2 3 Open a Command Prompt.0.1.Chapter 2 Logon/Logoff 11 To delete a previous connection 1 2 Select a connection from the Server. If you are having trouble running TOAD with Personal Oracle 8. When checked (ON). Press the <DELETE> key. When the Oracle Home has been found.

It also lets you see which Oracle Homes are valid installs. and SQLPATH by double-clicking or via the right-click menu. you can click the Advice button for suggestions. Whatever you enter in Database. any previous logins that were O/S authentication logins will have username = “EXTERNAL”. NLS_LANG. you can connect. Connect using dropdown drilldown button This button opens the Oracle Home Editor window which shows all Oracle Homes. Username.ora initialization parameters file must have: remote_os_authent = true os_authent_prefix = "OPS$" or whatever prefix you select. . If the database permits default passwords. the init. Joe Smith logs onto the ORA805 database. enters “ORA805” in the Database textbox. and leaves Username and Password empty. To configure this on the server side. You can edit SID. For example. His NT login is “JSMITH”.” Oracle attempts a login and TOAD starts up. which gets prefixed with “OPS$” giving a username of “OPS$JSMITH. The next time you bring up the Server Login window. If a SQL*Net entry is not valid.12 Operating System Authentication TOAD can accept logins where the operating system validates the user and password. The information can be copied to the clipboard and pasted into an email for technical support issues. You can use Oracle usernames without passwords in TOAD. and Password boxes are passed to the database. Oracle will prefix your workstation login and attempt a login. You don’t need to type over the word EXTERNAL in the username textbox when reconnecting. Select the database alias and leave the Username and Password textboxes empty.

A red X indicates that the file cannot be found. and all of the home information from the registry/hard disk for the home selection dropdown.ORA parameters on the SQLNet editor screen. the list of databases from the tnsnames for the database dropdown.ORA file has been found for that home. A red lock indicates the file (SQLNET.ORA file is read only. 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.ORA) is read only.Chapter 2 Logon/Logoff 13 Make this the TOAD default home checkbox Check this checkbox to make the home selected in the dropdown the TOAD default home. You can click View File and manually add/edit entries. the modified one will be used for your connection and your original will be backed up once the connection is established. TNSNames Editor link This opens the TNSNames editor preloaded with the TNSNAMES. Uncheck the checkbox to remove that home as the TOAD default home. A green check next to the link indicates that the TNSNAMES. Unchecked.ORA file will be overwritten with the modified one. A red lock indicates the TNSNAMES. If checked your SQLNET. A checkbox lets you make the changes permanent to your SQLNET. Refresh button This refreshes the previously used connection info for the left pane of the login window.ORA file for the selected home.ORA. SQLNet Editor link This lets you set SQLNET. .

Before you check the Save passwords for Oracle Connections box. So. Click Save Passwords for Oracle Connections to check that option. To turn on the Save Passwords for Oracle Connections option 1 2 3 Go to View > Options > Oracle.14 Save Passwords for Oracle Connections One of the TOAD options is Save Passwords for Oracle Connections. Either quit TOAD and restart OR Click the Save All Options button in the main toolbar. The default for this option is unchecked.INI file will not fall into the wrong hands. If you do not check the Save Passwords for Oracle Connections checkbox. the password is saved in CONNECTIONS. When checked. during login. .INI. When unchecked. then the username is copied to the password box because most development schemas are created as user/user. the password = Username. be sure you work in a secure environment where your CONNECTIONS. All passwords are encrypted. TOAD puts in the username for the password.

. Click OK. which will close all connections. you will be prompted to save the editor contents so that they are not discarded. try one of the following four entries for the database name on the TOAD login window: 2: BEQ-LOCAL LOCAL TCP-LOOPBACK For Schema/Passwords try one of the following pairs: DEMO/DEMO SCOTT/TIGER SYS/CHANGE_ON_INSTALL SYSTEM/MANAGER End Connection You might want to close a connection without exiting TOAD. Click the session you want to end. If you have any Prompt to save before close options on. TOAD also has an End All Connections option. A popup window lists one or more sessions. accessed from the File menu. To close a specific connection without exiting TOAD 1 2 3 4 Go to the File > End Connection menu. All windows associated with that session are closed.Chapter 2 Logon/Logoff 15 Connecting to Personal Oracle If you are having trouble connecting to Personal Oracle or creating a SQL*Net alias for PO7 or PO8.

.

TOAD uses the user name plus the date and time to generate a unique statement id for the Explain Plan. you can specify the name of the Explain Plan table that TOAD should utilize. By default. the account for the schema where you are installing them. (You can change the user name TOAD uses for Explain Plan via the View > Options > Oracle > User Name for Explain Plan textbox.3 Schema Preparation During the installation you had the opportunity to install the server side objects for TOAD via the Server Side Installation wizard. and you do not have to create the TOAD table. If you change the default setting from TOAD_PLAN_TABLE to PLAN_TABLE. If you decide NOT to store previous Explain Plan results. . On the other hand. TOAD will use your existing table. The Server Side Installation wizard is discussed in detail in the Getting Started Guide. 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 still do not execute the TOAD scripts.) If the user has a longer than normal user name. The wizard also lets you remove or update the objects. 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. you might need to expand the Statement_ID column of the Plan table. NOTE: On the View > Options > Oracle page. In order to install server side objects. or an account with the DBA role. you should disable the option Save previous Explain Plan results on the View > Options > Oracle page. you will not be able to recall previous Explain Plan results. TOAD will not display previous Explain Plan results. You can access the wizard while in TOAD from the Tools menu. you will need to have access to either the account for the TOAD user.

.

The program is designed to be flexible. . Checkboxes You will find checkboxes throughout TOAD. Drill Down buttons The drill down button Drill down buttons indicate another level of information. Click the drill down button to drill down another layer. buttons. which is usually another window. In addition to left-clicking on items. You can check multiple items in a checkbox list.4 Basics This section contains basic information about TOAD navigation. and with checkboxes you control how TOAD looks and functions. Right-click menus are discussed in the Right-click menu section of this chapter. and the main menu. Options you’ve set in one checkbox might affect options in another checkbox. the right-click button displays right-click menus. hotkeys. right-click menus. Mouse TOAD is designed to be used with a mouse.

This indicates an exclamation (very important) message. The down arrow activates a dropdown menu from which you can choose an item.20 To place a check in a checkbox or remove a check from a checkbox Click in the checkbox area or label area OR Tab to the area with the checkboxes and press the up and down arrow keys until your option is highlighted. Types of Message Boxes TOAD uses the industry standard symbols for its four types of message boxes. Press the space bar. This indicates a question box that requires a decision from you. This indicates a stop message. . i ? X ! This indicates an information box. Dropdown lists Dropdown lists are used throughout the TOAD screens.

The plus sign “+” expands the list and the minus sign “-” collapses the list. LEFT/RIGHT ARROWS The LEFT ARROW and RIGHT ARROW let you move left and right across a list of radio button choices. The UP and DOWN ARROWS are referred to as the UP and DOWN keys. For textboxes. You can also activate Expand and Collapse buttons using the <+> and <-> keys on the numeric keypad. For hierarchy lists. For the Expand and Collapse buttons the LEFT ARROW collapses the list and the RIGHT ARROW expands the list. The first item in the area you tab to will highlight. TAB to move out of the area (or click outside of the area with your mouse). TAB The TAB key lets you advance the cursor forward from one area of a window to another area. Once you reach your choice. the multiplication sign “*” expands to all levels. and your choice remains. 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.Chapter 4 Basics 21 Keyboard You can use the keyboard for navigation and selection. You can also use the UP/DOWN arrow keys to move through the radio button choices. . and the text cursor displays ready for you to type. In a dropdown list the UP and DOWN ARROWS scroll through the choices in the list. you can TAB to the textbox.

It activates whatever button has focus. if you <TAB> to a CANCEL button and press <ENTER>.22 SPACEBAR The spacebar lets you check and uncheck checkboxes or click buttons with focus. For example. For example. Pressing <SPACEBAR> on buttons with focus also clicks the buttons. Not Accessible by Keyboard TOAD was designed for a mouse. ENTER ENTER is similar to a mouse-click. ESC ESC cancels most modal dialogs. . you will cancel your choices and exit the window. and some areas of TOAD can only be accessed by using the mouse. you cannot tab to a drill down button. You have to click the drill down button to bring up its associated window.

Press <CTRL>K. Expand the Bookmarks list by clicking the expand “+” button. for example. The optional Step 2 window displays. Click Next. <SHIFT><INSERT>.Chapter 4 Basics 23 Hotkeys – adding/altering The Editor Options Dialog list of key assignments contains a list of the basic editing functions. Click the Edit Sequence button. the hotkey for that command is removed. 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. . displays in the window. All commands allow for two-part keystrokes. Click Set Bookmark 0. 12 Press OK in the Editor Options window to save the setting. The key sequence displays in the window. Note that keystrokes such as <CTRL>J or <SHIFT><INSERT> are ONE stroke keys. you can alter the key assigned to that command OR add an additional key. and cut (<CTRL>X) automatically. 0 for the command "set Bookmark 0. The Edit Key Pair step window displays. Control-K. Press 0. If you click DELETE while looking at a command. 0" 1 2 3 4 5 6 7 8 9 Click the Edit > Editor Options > Key Assignment item." To set the command for "Bookmark0" to "Control-K. When you highlight a command. paste (<CTRL>V). 11 Click Finish. 0. <CTRL><INSERT>. 10 Your second key. and <SHIFT><DELETE> are mapped to copy (<CTRL>C).

right-click over it and uncheck/check Window Bar. and some items are unique to the right-click menu and cannot be found anywhere else in TOAD. Click a button on the bar to navigate to a window. Some items in the menu are shortcuts to commands or windows that can be found elsewhere. The tooltips on the bar display the full window caption. Window Bar A window bar displays at the bottom of the main window screen to indicate what windows are open in TOAD. and SQL Modeler windows you can also press F10. . check Options > Toolbars > Allow docking/hiding of read only toolbars To turn off/on the window bar. Options for the window bar (Show connection string on buttons and Highlight windows for current connection) appear under Options > Toolbars. To access a right-click menu Press the right mouse button (right-click) OR For the Procedure Editor. SQL Editor. If you are using a read-only toolbar configuration and you want the window bar to remain turned off. check Options > Toolbars > Allow docking/hiding of read only toolbars. If you want to undock the window bar from the bottom of the main window.24 Right-click menus A right-click menu is specific to the window that you are in. after unchecking Window Bar in the right-click menu.

Configure/Execute external tools. Procedure Editor. You can place the mouse pointer over a button to display its title. and more. Run Script. New connection. and SQL Modeler.Chapter 4 Basics 25 Main Toolbar The main toolbar buttons include buttons to open the major TOAD windows such as the SQL Editor. . Buttons also include Object Search. Rollback. Configure options. Schema Browser. Commit.

26 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. You might want to Save TOAD Options before running such a query. for example. . or click the option and press <Enter> to go to that page. Many of the options are discussed in later chapters and in TOAD Help. The Search button lets you search the options for specific text. just as a precaution. Recall Previous SQL lists. which are basically your current TOAD settings and values. Editor Options settings. if you can't remember which tab contains the option that you are trying to find. It saves all TOAD options to files in your TOAD and TOAD\TEMPS folders including settings from the TOAD Options dialog. This is useful if you are about to run a query that could crash or run for a long time. Double-click the option. Save TOAD Options The Save TOAD Options button saves external files. This is useful. Lists of MRU (Most Recently Used) files. A table displays the list of options that contain the search text you type and the corresponding tab titles. Table Name alias list. etc.

An Auto add button searches the registry for a set of preinstalled programs. HTML. an icon. The icon of the last program you execute from the dropdown replaces the Configure/Execute External Tools icon. The Add button opens a Tool Properties window that lets you add programs.Chapter 4 Basics 27 Offline Text Editor The Offline Text Editor button opens an Offline Text Editor window. The file language types supported are: PL/SQL. So. Configure the editor options by loading a file for a language into the offline editor and choosing Edit > Editor Options. You select the programs that you want to add. JAVA . and add macros. It finds the program file. Configure/Execute External Tools This opens the Tool Options window which lets you add programs that can be launched from TOAD. you can edit scripts without being connected to an Oracle database. you could edit HTML files and have TOAD highlight the HTML markup tags in various colors. The View > Options > Parser Scripts dialog is where you set up the file associations for file name extension. INI. create shortcuts (click in the Shortcut box and enter the new keystroke). . and TEXT. select icons. by modifying the script files that define how the TOAD Editor should highlight keywords. pass in parameters to the program. and establishes the working directory as the same directory where the executable resides. For example. After you’ve added programs to the Tool Options window. they are available from the Configure/Execute External Tools dropdown list. You can then execute the last program by clicking its icon on the toolbar.

It also lets you configure the external associations and the DDL script inclusions. By default. connection links. . and customize the pop-up (right-click) menus. To Add a Folder Right-click and select Add > Folder OR from the Add Item dropdown select Folder When you add a folder. 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. Project nodes let you store links to folders. customize double-click operations. You can add items contained in the folder to the Project Manger window so that they can be accessed directly. Project Manager maps the folder path. FTP folders represent connections to a remote server and are located as sub-nodes to a project folder that you create. and database objects. double-clicking on the folder will open Windows Explorer to that folder. 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. You can add a separate folder for each server directory that you want mapped. it must exist on your hard drive.28 Project Manager The Project Manager lets you manage your common DB tasks from one central window.

Different project nodes can contain links to the same items. Select the project(s) you want to copy to. The Destination Projects window displays. For more details about Project Manager refer to TOAD Help. and connect if the connection is not current. Folders. and FTP Folders. see if you are connected. Click Ok. You can combine different Oracle connections and FTP connections into one project. The feature applies to second-level nodes: Schemas. You can use different schemas or users in each project. . FTP connections. You can configure Project Manger so that it will automatically run a Schema Compare when you drag one schema node onto another schema node.Chapter 4 Basics 29 A Copy feature lets you have more than one project open at once with links to the same files. Project Manager lets you access your connections. To Copy Nodes 1 2 3 4 Select the node(s) you want to copy (multi-select via <Shift> or <Ctrl>) Right-click and select Copy from the menu. or schemas.

You change a hotkey by changing the position of the ampersand. the menu lists configure themselves in response to how often you use each menu command. and hiding commands that you seldom use. When editing text. and select menu animations. moving the most used commands to the top of the list. You must have the Customize window open in order to customize toolbars or menus. If you want to make a lot of changes to the main toolbar. If you want your menu lists to automatically hide items that you seldom use. if you want to define a hotkey (<Alt><key>) type an ampersand (&) before the letter you want underlined. You can right-click on an icon to change it to text display. You can click-and-drag New Menu from the Commands tab to add a menu to your new toolbar. you can still display the rest of the menu by clicking the down arrow at the bottom of the menu. You can remove a command from the toolbar by clicking and dragging it off the toolbar. If the Show full menus after a short delay option is unchecked. Notice the commands are categorized by their associated menus. it might be easier to create your own custom toolbar via the Customize window > Toolbars tab. This window lets you customize the main toolbar and the menu bar. icon and text. and other options. If an icon is associated with the command the button will display the icon by default.30 Customize (toolbars and menus) You access the Customize window via the right-click menu Customize command on either the main toolbar or main menu. edit the displayed text. the remainder of the menu (the hidden menu items) displays. then after you select a menu and wait a few seconds. You can also add new menus and new toolbars. show/hide shortcuts on tooltips. . Then click-and-drag commands from the Commands tab to your new toolbar. Click New. show/hide tooltips. If checked. name your new toolbar and click OK. If you check Show full menus after a short delay. you can turn this option on via the Customize window > Options tab by checking the Menus show recently used commands first option. The Customize > Options tab also lets you display large icons. The Reset my usage data button will reset the menu usage data.

Unchecked Unchecked. you can move and hide the read-only toolbars. Regardless of the configuration you choose. The preconfigured toolbars are read-only.keeps your customized toolbar or gives you the TOAD Default toolbar (all toolbar items).Chapter 4 Basics 31 While the Customize window is open. Restore the default settings of a customizable toolbar through the Customize window by selecting the toolbar from the list and clicking the Reset button. Name is the name you want displayed in the options screen and INI Filename is the filename for your new configuration.excludes most of the DBA functions from the toolbar Business Analyst . Checked.all toolbar items that you are licensed to receive.designed for a user whose main priority is running queries and reports DBA (full menus) . You can add a separator between groups of commands by clicking on a button and dragging it slightly left or right. or left as floating toolbars which will remain on top of all TOAD windows. User Default . you will not receive items that you are not licensed to receive. . The Customize window > Toolbars tab lets you show/hide toolbars via checkboxes next to each toolbar. you can rearrange your customizable toolbar buttons and menus via click-and-drag. TOAD shows all toolbars in their default location at restart. Developer . TOAD will have to be restarted. The customizable toolbars (which includes the main toolbar) can be docked (via click-and-drag) to any side of the screen. TOAD Default . and you cannot hide or move and dock read-only toolbars (such as the main menu toolbar). Allow docking and hiding of read-only toolbars checkbox Default .all toolbar items The Add button adds a new toolbar using an existing template that you can later customize. This is the only choice that is customizable. Toolbar Options View > Options > Toolbars lets you select or add a toolbar configuration.

32 Lock all toolbars Default . vertically docked toolbar text will display horizontally. If unchecked. The toolbars can be locked in any position.Checked If checked. docked or floating. Menu Shortcut Customization window You can select Menu shortcuts from the right-click toolbar menu. to display the Menu shortcut customization window. vertically docked toolbar text will display vertically. Use vertical text when toolbars are vertical Default . possibly resulting in a wider toolbar to accommodate the horizontal orientation of the text. this prevents the toolbars from being dragged from their current position and docked elsewhere. create. and reset shortcuts. The intuitive window lets you change. .Unchecked If checked.

Select menu item Database > SQL Editor.5 SQL Editor If you have never used TOAD. At the end of the chapter. A horizontal splitter between the editor and results panel lets you size each component accordingly. The window contains an editor to compose SQL statements or scripts and a results grid to display the results from SELECT SQL statements. displays fetched data. Auto Trace. execute. is for common editing functions such as copy. When you first start TOAD you are in a SQL Edit window. DBMS Output. 3 ways to invoke the SQL Edit window § § § Click the button in TOAD’s main toolbar. The results panel contains tabs for Data. If you have the optional PL/Formatter. The SQL Edit window has two toolbars. The SQL Edit window has two panels. step-by-step examples are provided for various SQL Edit procedures. The SQL Editor is the top panel and the results panel. The edit toolbar is also on the Procedure Edit window. Explain Plan. The top toolbar is for SQL Edit specific functions. cut. The bottom toolbar. and Script Output. edit. the SQL Edit window is a good starting point. or edit toolbar. Set the SQL Editor to StartUp on new connection in the View > Options > Windows dialog. the lower panel. The SQL Editor lets you type. and paste. . a tab for Code Statistics is also on the panel. and tune.

Execute explain plan. Update SQL Results Grid editors to database (not a commit). or package) in a popup window. Strip out Oracle SQL statement. Recall previous SQL statement. package or view in a Procedure Editor or SQL Editor and pressing F4. Create development tool code statement. function. F4 Describes an object (table. Recall personal SQL statement. procedure. Delete current row. procedure. Execute window as script. function. Insert row into editable results grid. Shortcut Keys A few keys to note F1 You can press F1 to display the help file.34 SQL Editor Toolbar The SQL Editor toolbar buttons let you Execute the complete or highlighted statement. Load a file. . Tune. Reverse changes to the current query not yet posted. <ALT><UP> and <ALT><DOWN> will scroll through the SQL history. and Change session. view. Save. The Object Describe windows are similar to the Schema Browser windows for the corresponding object types. Execute the statement at the cursor. You access an Object Describe window by placing the cursor on the name of a table.

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. goes to the first row of the column the cursor is in <END> Goes to the end of the line . In the data grid.Chapter 5 SQL Editor 35 F6 Toggles the cursor between the SQL Editor and the results panel 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.

but if a table has a million rows. This can be a long process. If you need to examine rows at the end of a large recordset. TOAD shows queries quickly. Even in a table with a million rows the response to the initial query is almost immediate. TOAD can quickly fetch data when you press <CTRL><END>. . the process could be time consuming. If a table has only a hundred rows. This is because TOAD only fetches and displays what it needs. refine your query with something like: Select * from table Where primary_key > value and re-execute it.36 <CTRL><END> Goes to the last row of the column you are in CAUTION: You need to be careful when using <CTRL><END>. But with <CTRL><END> TOAD has to fetch EVERYTHING.

Function.Chapter 5 SQL Editor 37 KEYSTROKE F1 F2 <SHIFT>F2 F3 <SHIFT>F3 F4 F5 F6 F7 F8 F9 <CTRL>F9 <SHIFT>F9 F10 F12 <CTRL>A <CTRL>C <CTRL>D <CTRL>E <CTRL>F <CTRL>G <CTRL>L <CTRL>M <CTRL>N 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. Procedure. or Package in popup window Execute as script Toggle cursor between Editor and Results Panel 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 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) . View.

38 <CTRL>O <CTRL>P <CTRL>R <CTRL>S <SHIFT><CTRL>S <CTRL>T <CTRL>U <CTRL>V <CTRL>X <SHIFT><CTRL>Z <ALT><UP> <ALT><DOWN> <CTRL><HOME> 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>) In the data grids. go to the first row. In the Data Grid. See CAUTION NOTE in this section. go to the first row of the column the cursor is in In the editors. Activate code completion template Cycle through the collection of MDI Child windows Execute current SQL statement at cursor Auto complete tablenames <CTRL><END> <CTRL><SPACE> <CTRL><TAB> <CTRL><ENTER> <CTRL>. last column of text. first column of text. go to the top of the recordset In the results grid. (period) . go to the last row. go to the end of the recordset In the editors. page 36.

For example. if your tablename is DEPT and you type Select dept. You have to include a rowid in your select statement.rowid. Edit dept and press <CTRL><ENTER> or F9 to execute. Alternatively. Then you can edit the data. you can type the TOAD EDIT command to translate the command into a SELECT SQL statement with ROWID column. you can’t simply type Select and the tablename. Nothing will happen. Table Name Select Show Tables window button . you can edit the data.Chapter 5 SQL Editor 39 Using the SQL Editor Selecting a table to edit To edit a table.* from dept and press <CTRL><ENTER> or F9 to execute. dept. You must have Show ROWID in Data Grids checked in View > Options > Data Grids – Data in order for ROWID to display in the results.

click the Show Tables window button and the Table Names Select window displays from which you can choose the owner and the table. You can even click on a table name and drag and drop that name to the SQL Edit window. Then type Edit before the name. Example: edit dept Press F9. Status Panel Indicator: green=editable red=not editable . and add a space. This indicates that the table data can be edited. the data cannot be edited. Notice the status panel indicator at the bottom of the screen turns green. When the indicator is red. Your selected table displays in the Results Grid.40 If you want to choose a table and can’t remember the title or schema. but it can still be selected and copied.

was changed from Chicago to New York. Sales.Chapter 5 SQL Editor 41 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. delete records. You can also insert records. Click the Single Record View button. Here. The arrow buttons in the window let you move up and down the columns. the location for Department 30. and post edits. . and the Single Record View window displays for the record of the item you’ve selected.

Commit can be ON or OFF. Check or Uncheck Commit automatically after every statement. Other users can only see the old data until you commit. The status panel on the bottom of the window shows you the status of Commit. . To Turn Commit ON or OFF Go to View > Options > Oracle. If Commit automatically after every statement is unchecked. So. Commit writes the transaction to the database. and Prompt for Commit when closing connection is checked.42 Commit Commit The Commit command executes an Oracle Commit. The status panel shows the status of Commit Notice a related option on the next line is Prompt for Commit when closing connection. You can choose Commit from the Database > Commit menu item or click the Commit button from the main toolbar. This performs a commit for all windows that are open in the current session. TOAD will ask you whether or not you want to perform a commit to the changes before you close a session. Data is not available to other users until you choose Commit. Rollback cancels that transaction. with Commit OFF you can make changes without affecting other users.

the data is available to other users. For example. the changes are not sent to the Oracle transaction buffer until you change rows (click in another row). and the data is sent to the Oracle transaction buffer. You can edit in the row and then. without changing rows. If autocommit is OFF. you can make changes. typing in col 2. click the Update Grid Edits button. if you only have one row. . it stays in the buffer. When you edit data in a row. then clicking the Reverse Changes button will reset col 1 and col 2 to their previous values. This lets you reverse the changes you’ve made that have not yet been posted to the database. However. the data is committed. typing in col 1. If autocommit is ON.Chapter 5 SQL Editor 43 Update Grid Edits As soon as you start editing a table. but other users will see the old data until you choose Commit. With Commit OFF. If autocommit is OFF. The Update Grid Edits command sends the latest edits (or data) to the database. Reverse Changes Next to the Update Grid Edits button is the Reverse Changes button. pressing <TAB>. the Update Grid Edits button is enabled. If Commit is ON and you type in a row and then change rows. the data will be committed. you can’t change rows. pressing <TAB>. the data is buffered in the transaction. That’s where the Update Grid Edits command is useful. If autocommit is ON at the time the Update Grid Edits is activated.

To execute Explain Plan on a SQL Statement In the SQL Editor. If View > Options > Oracle > Save previous Explain Plan results is checked. Click on a SQL statement such as Select. . then Explain Plans are stored in: TOAD_PLAN_SQL and TOAD_PLAN_TABLE To run Explain Plan 1 2 3 4 Load a SQL Script into the SQL Editor. This lets you visually see the steps. <CTRL> E Explain Plans in the SQL Editor will work regardless. go to SQL Window > Explain Plan Current SQL (OR <CTRL>E). Explain Plan results display in the results grid. NOTE: 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 Installation wizard (see the Getting Started Guide). Insert. The Explain Plan function inserts a row describing each step of the execution plan into a specified plan table. Select SQL-Window > Explain Plan Current SQL menu item. The purpose of Explain Plan is to determine the execution plan Oracle follows to execute a specified SQL statement. but if you have not created the tables needed you must set the View > Options > Oracle > Explain Plan Table name option to point to your own plan table (Plan_Table). Explain Plan also determines the cost of executing the statement based on the statistics that have been stored for the table. Update. or Delete. If you are using costbased optimization. Make sure the View > Options > Oracle > Save Previous Explain Plan Results option is checked.44 Explain Plan Explain Plan (also called Execution Plan) displays steps that will occur in the selected SQL statement. place the cursor on a SQL statement.

Click the Explain Plan item. 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 Installation wizard during the install or from the Tools menu (see the Getting Started Guide). A list of previous Explain Plans displays. you get an error message telling you the table or view does not exist. The default entry is TOAD_PLAN_TABLE. They let you display the details that you need to see.Chapter 5 SQL Editor 45 Notice the Explain Plan results have expand and collapse buttons. . 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. or you will not be able to view previous plans. NOTE: You must have the View > Options > Oracle > Explain Plan Table Name menu item entered. To Access View Explain Plan 1 2 3 Go to the View > Explain Plan menu item.

This is the value of the BYTES column of the plan table. the number is displayed in Kilobytes. This comes from the CARDINALITY column of the plan table. If appropriate. . Object Name The value of the OBJECT_NAME column of the plan table. or G (1000 millions. or billions). Bytes Number of bytes accessed. the number is displayed in K (thousands). If appropriate. M (millions). Operation The concatenation of the OPERATION and OPTIONS columns of the plan table. If appropriate. Rows Number of rows accessed.46 Explain Plan Treeview The Explain Plan treeview lists the contents of the TOAD_PLAN_TABLE for the given statement id. M (millions). This column is not applicable to rule-based optimization. or billions). or Gigabytes. the number is converted to K (thousands). Megabytes. or G (1000 millions. Cost The value of the COST column of the plan table. 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.

Abbreviation for PStart ROWID KEY KEY(I) n n.Chapter 5 SQL Editor 47 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. m Meaning Row Location KEY KEY(INLIST) Partition number for first partition in range Partition and sub-partition number for first partition in range . 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.

.48 PStop This column represents the PARTITION_STOP column of the plan table. Refer to Oracle documentation for more information on how to read and interpret an Explain Plan output. PARENT_ID and POSITION for the row containing it. Abbreviation for PStop ROW L KEY n n. m Meaning Row Location KEY Partition number for last 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.

You can even search by clicking in the SQL Contains textbox. Cancel closes the window and returns you to the Editor.Chapter 5 SQL Editor 49 Recall and Add SQL You access the Add and Recall SQL dialogs items through the SQL-Window menu. Move the mouse over the record selector and drag up or down. There are also tabs to display All SQLs and Single SQL which show more detail of a long SQL statement. The Remove button lets you remove selected statements from your list. which means add the statement to your current SQL script. On the All SQLs tab. the grid row height is vertically adjustable on a row-by-row basis. There are three different types of Add/Recall SQL statements: § § § Recall Previously Executed Recall Personal SQL Recall Named SQL SQL Recall Window The SQL Recall window has buttons that let you move to the Next or Previous statement. . typing the text you want to search for. or Replace which would replace your current script with whatever SQL statement you select. The list will filter for statements that contain your search item. You can copy statements to the clipboard by clicking the Clipboard button. and clicking GO. 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. It also has buttons to Append.

Add to Personal SQLs Selecting this command from the SQL-Window menu adds the SQL statement that’s in the SQL Editor to your personal SQLs. The list of SQL statements is written to and read from the SQLS. . You can later recall the statement by using the Recall Personal SQL command. The Recall window displays a list of the last X number of statements executed. page 55. press <CTRL><ENTER> or <SHIFT>F9.DAT file from the TOAD folder. The SQL Statement Recall window displays. TOAD saves all statements in this list between sessions of TOAD in a file named PERSSQLS.50 SQL Command Recall or Recall Previous SQL To Recall a SQL command Click the Recall Previous SQL button in the SQL Edit window toolbar OR Press F8 OR Select SQL Command Recall from the SQL – Window. deleting SQL statements. The default number is 100. See the Options for the SQL Editor topic. Running a Recalled SQL Statement After a SQL statement is recalled and placed in the SQL Editor.DAT in the TOAD folder. It includes options for searching in SQL statements. and displaying all or selected SQL statements. for more details. TOAD will search backwards one line from the current cursor position to find a SQL statement to execute. but you can change this in the options.

You have to add a Personal SQL Statement before you can Recall a Personal SQL Statement. Add to Named SQLs This window lets you add a SQL statement to a user’s named favorite list. Type the name you want to assign. . Click menu item SQL –Window > Add to Personal SQLs.Chapter 5 SQL Editor 51 To Add a SQL Statement to the Personal SQL List 1 2 Select the statement by highlighting it in the editor. Recall Named SQL You get to this dialog via the SQL Window > Recall Named SQL menu item (or press <CTRL>N). Click OK. To Add a SQL Statement to the Named SQL List 1 2 3 4 Select the statement by highlighting it in the editor. Recall Personal SQL only lists the ones that you’ve added to the list. This window functions identically to SQL Statement Recall. Recall Personal SQL You access the window by clicking the Recall Personal SQL button in the SQL Edit toolbar or via the SQL-Window > Recall Personal SQL menu item. except that the list and order of statements is controlled by the TOAD user. Click menu item SQL – Window > Add to Named SQLs.

You can select/recall a statement from this list on the Statement Recall window.DAT in the TOAD folder. and Recall Named SQL. This prevents the list from containing misspelled column names. All statements (to a maximum set in User Options) are saved between sessions of TOAD in the file SQLS. Recall Personal SQLs.52 The SQL Statement Recall window for Recall Named SQL Use this dialog to pick a SQL statement from your named list of SQLs. This checkbox item will only save those SQL statements that execute successfully.DAT file in the TOAD\TEMPS folder. You can also remove statements from this list. . You can check the Save Only Statements that are Valid checkbox in the View > Options > SQL Editor page. This window is a combination of SQL Command Recall. More about Recall Every statement executed in a SQL Edit window is added to a most-recent-first list. You can scroll through the previous statements directly within a SQL Editor edit panel by pressing <ALT> <UP> or <ALT> <DOWN>. 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. then copy it back to the SQL Edit window for execution. The SQL statements are stored in the NAMEDSQL. etc.

but you can still select the Replace button. Bind Variables You can execute SQL statements in the SQL Editor using bind variables.Chapter 5 SQL Editor 53 Append versus Replace The View > Options > SQL Editor page > SQL window button on SQL Recall window Appends rather than replaces option changes the default button to be set to Append rather than Replace for the SQL Recall window. If you select a statement in the grid and press <ENTER> it also activates the default button.g. if Append rather than Replace was checked. When you press F8 to recall a statement (or recall a statement via a menu item). .TXT file in the TOAD\TEMPS folder. The values you enter are stored and retrieved for subsequent queries in the PARAMS.. where a colon leads the bind variable name. e. 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 Append button will be the default button. If you double-click in the grid it activates the default button.

. enter DEMO.EMPLOYEE and TOAD will present the same Variables popup window for you to enter the value for &schema. e. If you want to query DEMO. SELECT * FROM &schema. If you wanted to query SCOTT..54 Substitution Variables You can also execute SQL statements with substitution variables where the ampersand leads the substitution variable name. enter SCOTT.g.EMPLOYEE.EMPLOYEE.

so data retrieval is slower. TOAD will issue each query in a separate thread. Insert. . as well as your machine. and DELETE statements will be processed in the background. See page 76 for more information on the Edit > Editor Options Menu. Processing lengthy statements in the background frees up TOAD. and Delete statements in background Default – Unchecked If this option is checked. The Options > SQL Editor page contains numerous options. The disadvantage to having this option checked is that more processing must occur. The background window contains Commit and Rollback buttons. When executed. for other tasks. Process statements in threads/allow queries to be cancelled Default – Unchecked If checked. SQL Editor Options are in three dialogs: Options > SQL Editor. the statements are actually copied to a separate background process window to provide a visual indication that the statement is running. Process Update. Options > Editors. The Cancel button will display on the SQL Edit window toolbar to the right of the Change Active Session button enabling you to cancel a long running query before any data is returned. and Edit > Editor Options. UPDATE. INSERT.Chapter 5 SQL Editor 55 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.

the background process window will display showing the execution. If checked.56 Process PL/SQL statements in background Default – Unchecked If checked. When executed. Save only statements that are valid Default – Unchecked If this option is checked. # of SQL statements to save textbox The default number is 100. The list is saved to and retrieved from the SQLS. . Save SQL statement before statement Execution Default – Unchecked If checked. TOAD will only save the SQL statements that ran successfully for recall via F8 SQL Statement Recall dialog. PL/SQL statements will be processed in the background. then for the statement recall TOAD saves the SQL statement before executing it in case something happens during the execution. the Save only statements that are valid option will not apply.DAT file. The background window contains Commit and Rollback buttons. This box lets you enter a custom number of SQL statements to save to your Recall Previous SQL list. Only the most recently used SQL statements are saved.

TOAD will tell you that the variables are not bound. TOAD will scan SQL statements for bound variables and ask you for the values before execution. Scan statements for bound variables before execution Default – Checked If checked. Java. VB. but you can still use the Edit > Clear All menu item. Currently. Prompt to save contents when closing editor Default – Unchecked If checked.Chapter 5 SQL Editor 57 Allow Clear All Text (buttons and F7 hotkey) Default – Checked If checked. Make Code Variable name textbox Default – SQL This lets you enter the variable name. TOAD will prompt you to save any text you typed in the editor. C++. Make Code Format dropdown list Default . Delphi. If unchecked. .VB This dropdown list lets you select the language syntax for TOAD to convert a SQL statement into (Make Code Statement function) and out of (Strip Code Statement function). If unchecked. F7 will not work. you can press the F7 key to clear all text from the SQL Edit window without a confirmation dialog. and Perl are supported.

Only show one SQL Editor per database connection Default – Unchecked If checked. the default button and behavior will append the selected SQL to the current contents of the SQL Edit window.58 “SQL Window” button on SQL Recall window appends rather than replaces Default – Unchecked If checked. If unchecked. this clears the query grid to Explain Plan tab whenever you clear the SQL Editor. This is similar to the one Schema Browser and one Procedure Editor per connection options. TOAD will permit only one SQL Editor window to be opened per connection. then the status panel will show the row and col location of the cursor in the editor. Close query (grid) when clearing the SQL Editor Default – Checked If checked. If unchecked. Always show statement execution time (overrides ROW:COL display) Default – Unchecked If checked. TOAD will show the statement execution time until you perform further editing. . TOAD will show the statement execution time in the status panel. the default button and behavior will REPLACE the current contents of the SQL Edit window.

TOAD scans statements run in the SQL Editor. looking for a DBMS_OUTPUT. and then disables DBMS Output again. Script output font button This button invokes the font window where you can select the font for your script output. . polls once.Chapter 5 SQL Editor 59 Automatically poll for DBMS Output if Output detected Default . If one is found.PUT_LINE statement. then TOAD enables DBMS Output.Unchecked If checked. The default is unchecked.

DDL statements. it is not considered a substitution variable. 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> OR Click the Run Current Statement button on the toolbar. blocks of procedure SQL. If & is the last character in a string. etc. TOAD will not prompt for a value. . TOAD supports query statements. If you only want to process a portion of the edit text Highlight that portion AND : Press F9 OR Click the Execute Statement button.60 Executing Statements If the SQL Edit window has a single statement that you wish to execute Press F9 OR Click the Execute Statement button on the toolbar. TOAD recognizes substitution variables in quotes as follows: If & is escaped.

For scripts that contain other SQL*Plus commands.sql insert into table values (2). 3. As TOAD processes a SQL script. edited. If a full path is not provided. TOAD uses the following priority to search for non-pathed files: 1. Insert statements. and then executed via SQL*Plus is AUTOMATICALLY SAVED TO DISK before TOAD passes it to SQL*Plus for execution. . 4. 2. and more. @c:\scripts\doscript. insert into table values (1). Some SQL*Plus commands are ignored as TOAD processes a SQL script. Current directory in use by the editor Same path of parent script if present \TEMPS\ SQLPATH environment variable NOTE: A script that is opened in the SQL Editor. etc.Chapter 5 SQL Editor 61 Execute SQL Scripts The SQL Edit window can process SQL scripts that contain DDL statements. For example. REM This is the start of my script. you can also embed one script within another via the @ sign. you can still execute your script using the SQL-Window > Execute SQL Window via SQL*Plus menu item.

The following SQL*Plus Script Execution statements are ignored: SET TAB VERIFY PAGESIZE . and the headings are not included. SET ECHO (ON/OFF) – defaults to ON SET ESCAPE/ESC (ON/OFF) – defaults to ON SET ESCAPE/ESC ‘\’ (\ is any character) – defaults to \ SET HEADING/HEA (ON/OFF) – defaults to ON SET FEEDBACK (ON/OFF) – defaults to ON Note: Set Feedback N (N = a number) is not supported SET SERVEROUTPUT/SERVEROUT (ON/OFF) SET TERM (ON/OFF) – defaults to ON DEFINE/DEF and UNDEFINE/UNDEF PAUSE EXIT/QUIT (without parameters) PROMPT/PRO CONNECT/CON and DISCONNECT/DISC. REM/REMARK / Slash DESCRIBE SHOW (show errors) Embedded script files are now supported using @ or RUN. Non-pathed files are created in the \TEMPS\directory.62 SQL*Plus Script Execution statements that are supported include: SPOOL Filename and SPOOL OFF (also SPO). TOAD only outputs data. Following a CONNECT in a script. the original session is reconnected after the script terminates. SPOOL works differently in TOAD than in SQL*Plus.

Chapter 5 SQL Editor 63 Table/View Aliases Setting up table or view aliases permits a shortcut for entering columns of a query.TXT. so it is recommended that you edit \TEMPS\PLSQLSUB. To complete the SELECT SQL statement above.TXT file is in the TOAD\TEMPS directory. they will be presented on the SQL Modeler dialog when you select that table to build your query. These are accessible through the Edit > Editor Options > Auto Replace tab. It should look like this: . 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. The ALIASES. However.TXT. use Auto Replace Substitutions named similarly to the table aliases. If you set up these table aliases in ALIASES. it would take you a long time to add a reasonably sized schema.

. Having the alias at the end keeps things tidy. If you type: select dept.TXT or PLSQLSUB. 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.NAME from dep_ Press the spacebar and it autocompletes. .. Select your column name. then continue. the popup should appear.64 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. be sure to close and reopen TOAD to re-read the list.e.NAME from DEPARTMENT dept If you edit ALIASES.TXT. select dept.. select dept.

then press <CTRL>.Chapter 5 SQL Editor 65 Tablename Completion An alternative to using AutoReplace for tablenames is tablename completion. (period). the table name is automatically completed in the editor. (period). a popup list appears for you to select the desired table. If only one matches. For example. a list of all tables beginning with dep will popup. . if you type dep and press <CTRL>. TOAD looks up the list of tables matching the letters. If there is more then one match. Type the first few letters of a table name in your schema.

The same editor is used in read-only mode on many other windows throughout TOAD.DCI. If during a TOAD session you have used any window or function that retrieves the tablenames for the active Oracle session. § User configurable Syntax Color Highlighting The editors in the SQL Edit and Procedure Edit windows support flexible syntax highlighting. the following files distributed with TOAD must be located in the TOAD\TEMPS directory: PLSQLSCR. The View > Options > Procedure Editor > Highlight names of stored procedures option is checked by default. This section highlights some of the configurable features. tablenames will be colorized as well. which include some of the following options. The Editor Options. and the list of reserved words used in each window is also customizable by editing the parser script file.66 Configuring the Editor The editor in TOAD is used on the SQL Editor and Procedure Editor windows to edit SQL text. for syntax parser scripts PLSQL. The highlighting is configurable in the Editor Options window. . for code templates You must have the View > Options > Editors > Load view names from database at time of first editor window option checked. are discussed in detail in the next section.TXT. In order for the editor to support syntax highlighting.

the default color of green for comment is being changed to light blue and italics has been unchecked. .Chapter 5 SQL Editor 67 Here.

68 Editor Parser Scripts The primary configuration for the editor comes from an editor parser script text file that is loaded at runtime.. . In the offline text editor and in the Procedure Editor you can also have languages HTML. JAVA. The language is determined from the file extension.TXT JAVASCR.TXT All editor parser script files are stored in the TOAD\TEMPS folder. INI.TXT TEXTSCR.g.TXT PLSQLSCR. e. and TEXT. this language is always PLSQL. In the SQL Edit window editor. 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. HTML. and is configured in the View > Options > Parser Scripts page > Language / File Extension Associations grid.TXT INISCR. 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) to the desired file (LONGSCR. because no support will be provided for altered scripts. . Change the path for the PLSQL Parser Script File (PLSQLSCR. § Bookmarks Bookmarks help you manage files. Mark a position within the SQL Editor so that you can easily jump back to that line. PL/SQL Reserved words. LONGSCR.TXT.TXT contains almost twice as many items for syntax highlighting and will give you access to over a thousand reserved words and keywords. A small green box containing the bookmark number will appear in the editor gutter.TXT or SHORTSCR.Chapter 5 SQL Editor 69 Long and Short PL/SQL Editor Parser Scripts During the install process you were able to select from two flavors of the PL/SQL editor parser script: SHORTSCR. Bookmarks can be accessed from the right-click menu.TXT).TXT and LONGSCR. See the TOAD GETTING STARTED GUIDE for more details.TXT over PLSQLSCR. then edit the PLSQLSCR.TXT file be careful. or Oracle Keywords from the lists that are syntax highlighted. You can set up to 10 separate bookmarks within one editor. If you want to change your earlier choice. you can copy LONGSCR. If you edit the PLSQLSCR. edit the corresponding editor parser script for that language. If you want to add or remove Oracle SQL Reserved words. Another way to change your selection is via the View > Options > Parser Scripts tab. They are especially useful when you are trying to manage large files.TXT or SHORTSCR. The longer list might affect performance depending on your editor contents. To set a bookmark Press <CTRL><SHIFT># where # is a number between 0 and 9.TXT.TXT file. If you want to add or remove words from the syntax highlighting of the other languages.

The Delete button deletes the highlighted key assignment.TXT in the TEMPS directory. page 89. for more information. The TOAD parser scripts come with a handful of Substitution pairs. . Once saved from this window.70 To jump back to a bookmark Press <CTRL># where # is a previously defined bookmark between 0 and 9. but you may edit and add to the list on the Editor Options window. For example. ACT is automatically replaced by ACTIVITY_CENTERS. § Auto Replace Substitutions A substitution is a text phrase that corresponds to replacement text. NDF is automatically replaced by NO_DATA_FOUND. To access Auto Replace. (c) = ©. ndf = NO_DATA_FOUND. the bookmarks are reset. The Auto Replace substitutions for each language type are stored in separate files in the TOAD\TEMPS folder. Once a file is closed. TOAD already has a few Auto Replace Substitutions specified: teh = the. the substitution pairs will be saved to an ASCII file named [Language]SUB. Select the command from the left panel. § User defined keystrokes for common editing commands Click Edit > Editor Options > Key Assignments to access the Key Assignments window. Note that these keystrokes assume you have not altered the default editor keys. See the Key Assignments topic. 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. go to the Edit > Editor Options > Auto Replace tab. If you specify a substitution pair of NDF = NO_DATA_FOUND and you type NDF and press a delimiter. if you specify a substitution pair of ACT = ACTIVITY_CENTERS. when you type ACT and press <SPACE> (or other configurable word delimiters).

Chapter 5 SQL Editor 71 Language HTML INI JAVA PL/SQL TEXT Auto Replace Substitution File HTMLSUB. JAVA. .TXT INISUB. INI.TXT JAVASUB.TXT TEXTSUB. you can continue to alter the substitutions in the Editor Options window or directly in the [Language]SUB. Code templates are loaded from the text file [Language]. If a vertical pipe character is in the code template. Code templates are more than a single phrase and can contain line feeds.TXT file. PLSQL. where [Language] can be HTML. or TEXT. § Code Completion Templates Code templates expand upon the Auto Replace Substitution concept.DCI from the TOAD\TEMPS folder.TXT PLSQLSUB. the cursor will be placed at that point in the template.TXT Thereafter. but a manual keystroke (<CTRL><SPACE>) is required to perform the substitution.

You can edit the code completion templates directly in the Edit > Editor Options dialog.0 API calls to manage profile strings have a bug which will cause reading of the templates file to fail. or via text editor on the *. Code Templates tab.DCI is: [crbl | entire cursor block] DECLARE CURSOR c1 IS SELECT | FROM BEGIN OPEN c1. . \TEMPS\PLSQL. LOOP FETCH c1 INTO c1rec. EXIT WHEN c1%NOTFOUND. a dropdown list of all macros is displayed. TOAD will load the body of the template and place the cursor at the position of the vertical pipe char. CLOSE c1. END LOOP. c1rec IS c1%ROWTYPE. If the word or phrase under the cursor does not match an existing macro verbatim.72 Example: One of the code templates defined in PLSQL. 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 NOTE: Do not leave spaces between the end of the template description and the final right bracket! NT4. END. If you type "crbl" and press <CTRL><SPACE>.DCI contains sample templates which you can alter to suit your needs. WHERE.DCI files.

§ Uncomment Code Block This function uncomments the selected block of text by removing "--" from the beginning of each line. . "BEGIN". § Locate Closing Parenthesis (Find Closing Block) Finds the closing parenthesis. 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.” If you select/highlight a left parenthesis. "END" or "END IF. This is available on the right-click menus of the editors and is also on the Main Edit menu. "END" for matching "BEGIN". this function will show the matching right parenthesis. or "IF". This is available on the right-click menus of the editors and is also on the Main Edit menu. or "END IF" for matching "IF." Find Closing Block can only be accessed on the right-click menus of the SQL Editor and Procedure Editor.Chapter 5 SQL Editor 73 § Undo/Redo These basic editing commands are accessed from the Edit menu.

After you use FIND to search through your text for a word or phrase. . The following are some examples of regular expressions. For example. Edit > Replace). you can check the Regular expressions checkbox to use regular expression syntax for your search. Find Previous. The lines will be removed following any change to the text in the editor. \r Carriage return \n New line \f Form feed \t Tab character \b Backspace \s Space § Show All following a search To get to this function. Only to be used after a FIND. Regular expressions specify text by its characteristics rather than its exact characters. Find Next. you can find and replace tabs with spaces.74 § Find. you can click Show All from the Edit menu and Show All will display wavy red lines under every occurrence of the search phrase. click Edit > Show All. 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 F3 <SHIFT>F3 <CTRL>R On the Find and the Find and Replace dialogs (Edit > Find.

Chapter 5 SQL Editor 75 § Configurable Print Options The Edit > Editor Options > General Options tab provides printing options. then the SQL text or Stored Procedure Edit code will be printed in standard black and white. which means the report will print using the same colors that are displayed in the window. Use Syntax Highlighting when Printing Source Code This option is checked by default. If you get garbage characters on your color printout. color printing is the default for printing SQL Edit text or Stored Procedure Edit code. turn off the Use syntax highlighting when printing source code and then try to print again. So. If you uncheck the View > Options > General > Use syntax highlighting when printing source code option. You can check/uncheck the Syntax Highlighting option from the View > Options > General page. .

BIN TEXTKEYS. Language HTML INI JAVA PL/SQL TEXT Editor Options Files HTMLKEYS. Auto Replace. PLSQL. JAVA. INI.BIN JAVAKEYS.BIN HTMLOPTS.BIN PLSQLKEYS. and Code Templates items have Load from File and Save to File buttons. Auto Replace.BIN INIKEYS. where [Language] is either HTML. auto replaces.TXT files in the TOAD\TEMPS folder. and Code Templates. one user might prefer to use one set of assigned keys.BIN files are written out. For example. auto replaces.TXT TEXTOPTS. The editor options are stored in the [Language]KEYS.76 Editor Options Editor Options can be selected. the appropriate OPTS. and another user might have a different set for a preference. Each of these buttons lets you set up two or more collections of keystrokes.TXT INIOPTS.TXT PLSQLOPTS.TXT and KEYS. Click any of these items to display its corresponding options in the right panel.TXT NOTE: The Key Assignments. Highlighting. and code templates. Use the Editor Options dialog. The Editor Options lists categories in the left panel: General Options. Do not attempt to edit these files with a text editor.TXT JAVAOPTS. or TEXT. Key Assignments. 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.BIN and [Language]OPTS. deselected. This is useful on multi-user machines. . When a change is made to the Editor Options. and code templates.

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 .Chapter 5 SQL Editor 77 General Options General Options contains four categories: Printing Options Display Options Control Options General Options Click the “+” next to each option to expand its corresponding checklist.

but you have the Show gutter option unchecked. Show gutter Default – Checked If checked. Display line numbers in gutter Default – Unchecked When checked. the gutter displays. You might want to increase the width of the gutter. this option will display line numbers in the gutter. in the Gutter Width textbox. no line to indicate the right margin will appear. NOTE: No word-wrapping occurs at the right margin line. line numbers. breakpoints. to display large line numbers. If you have chosen to display line numbers.78 Display Options The display options let you control what is displayed in the editor. your line numbers which would display in the gutter will not display. If unchecked. Show right margin Default – Unchecked When checked. and allow for multiple line selection with the mouse. When unchecked. In the SQL Editor or Procedure Editor. line numbers will not display. this option displays a light gray vertical line indicating the right margin. . you can also drag and drop the vertical right margin line left or right to change it. which is a vertical region on the left of the editor used to display bookmarks. Word-wrapping is discussed later in this chapter in the Show Word-Wrap Column section. If unchecked. the gutter does not display.

you need to check the Show word-wrap column checkbox AND enter a value in the word-wrap column box. The vertical word-wrap line can be dragged and dropped to the left or the right. which means no word-wrap column will display. the cursor is displayed as a block because it’s in overwrite mode providing a visual reminder that it’s in overwrite mode. For example.Chapter 5 SQL Editor 79 Show word-wrap column Default – Checked When checked. a dashed vertical line displays in column 20. Word wrapping will not begin until you also check the General options > Word-wrap lines checkbox. if you enter 20. 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 displays the word-wrap column. so you don’t have to drill down to the editor options dialog when you want to change the column settings. and any lines longer than 20 characters will wrap. . If the option is unchecked. this option displays an arrow in the gutter for wrapped lines. 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. So. The default is 0. Block cursor on overwrite Default – Checked If this option is checked when you press the insert key to change to overwrite mode.

80 Show control characters Default – Unchecked If checked. end-of-line characters. the control characters (such as paragraph marks. this option will apply the capitalization effects that you select from the Highlighting Options section. spaces. . and TABs) will display onscreen in your scripts. Apply capitalization effects Default – Unchecked When checked.

as you key up or down through the lines of text. the cursor column position decrements as the lines of text get shorter. Title as Load/Save Filename parameter Default – Checked This option is not applicable and not activated. Respond to dropped files Default – Checked If checked. 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.Chapter 5 SQL Editor 81 Control Options Allow TCustomSyntaxMemo to be an lDragSource Default – Checked When checked. otherwise it places the cursor at the end of the line. If this is unchecked. this option lets you select and drag text from an editor to another Windows application or another TOAD window. this lets files be dragged and dropped from Explorer to a TOAD editor. . the current column position is maintained. If the text is wide enough.

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. enter it. set word-wrap to column 16. if you want to specify that “>” will override word-wrapping for a line. .82 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 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. Tab to next column Default – Checked When checked. it automatically indents the following lines. the <TAB> key moves the cursor to the next column. Type this: This line of code starts in column 5 So does this line . the editor will fill the required gap with a minimum number of characters composed of TABs and spaces.Chapter 5 SQL Editor 83 General Options Auto indent Default – Checked If you have an indention already set when you type. Insert mix of TAB/SPACE for optimal fill Default – Checked If checked. an appropriate number of spaces are inserted. Auto select word on double-click Default – Checked When checked. Otherwise.

.84 If the option is checked you get this: this line of code starts in column 5 <TAB><SPACE>so does this line Unchecked. text will automatically wrap at the Word-wrap Column margin. you can type text or move the cursor past the right edge of each line of text. 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 cannot type beyond the right margin even if the Cursor beyond EOL option is checked. If this option is selected. Word-wrap lines Default – Unchecked When checked.

Reserved word refers to Oracle reserved words. in the current schema.Chapter 5 SQL Editor 85 Highlighting The highlighting options let you select colors. and even the capitalization. the type size. For example. In the preview screen. You can change the foreground or background colors for Reserved words. . the font. etc. A preview pane is provided in the lower part of the window that shows you how the selections you make affect the preview example. fonts. This lets you customize the way your code will appear for whatever is easiest for you to read. the underline option is checked for datatypes. names. Here. and capitalization preferences for different items. the datatype is underlined.

. you could syntax highlight SYS view names like this: And the result would be “Table_Privileges” in light red.86 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 For example. initial caps.

You can preview your new selected text colors before clicking OK. If the background color default box is already checked. the dropdown menu will be disabled. The dropdown menu displays a color palette from which you can choose the color for the left margin vertical bar. and Gutter. do not refer to actual code content. or pressing <SHIFT> and one of the arrow keys to select a portion of text. Display Item This lists the display items from which you can choose to modify how they will appear. Selected Text. 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. In such a case.Chapter 5 SQL Editor 87 You can syntax highlight tablenames in your schema applying different colors and capitalization effects. . Left Margin This item only enables the background color choice. Left Margin. The last three display items. The other selection areas such as font are disabled when you click on the Selected Text item. You can change both the foreground and background colors that will display for the selected text. by selecting text in the preview window and seeing how the new colors affect the selected text. They have only certain options enabled. you must uncheck the default box to enable the dropdown menu. Only the foreground and background color sections are enabled.

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 . 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. For object names that contain the underscore character.g. the dropdown button is disabled. you need to uncheck the Use Default box so that the dropdown button is enabled. Capitalization effects are only applied to your text after you change lines up or down in the editor.. Uppercase – The item will appear in all uppercase letters. In such a case. Capitalization Effect This dropdown list lets you choose how your item will be capitalized. E. the first letter after the underscore will also be capitalized. Initial Caps – The item will appear with only the first letter of each word in caps.88 Gutter This item only enables the background color choice. Table_Name. If the Use Default box for the background color is checked. Lowercase – The item will appear in all lowercase letters. The editor supports only one font name for all display items. the Apply Capitalization Effects checkbox in General Options > Display Options must be checked in order for your capitalization effects to display.. However. Your choices are: Unchanged – No special capitalization will be applied.

and that item’s keyboard shortcut will display in the Activation key sequences window. The Key command categories listed are: Bookmarks Caret movement Clipboard operations Deletion operations Miscellaneous Click the expand button to expand a category’s list. .Chapter 5 SQL Editor 89 Key Assignments Clicking on the Key Assignments item displays the corresponding Key Assignments options. Select an item from the list.

Delete sequence This deletes whatever sequence is currently highlighted in the Activation key sequences window.90 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. . If a list of sequences is in the box. Edit sequence This lets you edit the existing sequence through a series of step boxes. you can click a sequence from the list to highlight it and then click the delete sequence button to delete that highlighted sequence.

TOAD already has 5 Auto Replace items. If type this (c) (r) (tm) ndf teh Replaces with this © ® TM No_Data_Found the .Chapter 5 SQL Editor 91 Auto Replace Click on Auto Replace to display its corresponding options menu.

. Click the Delete definition button to delete the definition from the list. “\t” is a <TAB> character.TXT file. : = [ ] \n \t \s These keys will separate one word from another and trigger the editor to check for and replace one word for another. if you type “this. The autoreplace items are saved and recalled from the TOAD\TEMPS\[Language]SUB. JAVA. and “\s” is a space. “\n” is a carriage return. Delete definition This button is enabled after you select a definition from the existing Auto Replace list. Then click the Add definition button to add this to the Auto Replace list. or TEXT. The window to the right is where you type the replacement text. You can directly edit the SUB. Click OK and the definition will be deleted. If you exit the window without clicking OK the new definition will not be added. and type a character in the With window. Auto Replace activation keys . The first blank window is where you type the text that you want automatically replaced. PL/SQL. where [Language] could be HTML. or change the autoreplace substitutions without having to go through the Editor Options dialog.92 Add definition This box is enabled after you click in the Current selection window and type a character. INI. click in the With window (the window next to the current selection window). .TXT file to add. Replace definition This button is enabled after you make a selection from the already defined Auto Replace list. click OK and the list will be updated.that” then “this” will be autoreplaced when the “. Remember to Click OK before exiting the window. For example.” key is pressed. After you type the new entry that you want to replace the current selection with. delete.

TXT JAVASUB. .TXT Code Templates Click the Code Templates item to display its associated options.TXT PLSQLSUB.TXT TEXTSUB.TXT INISUB.Chapter 5 SQL Editor 93 Language HTML INI JAVA PL/SQL TEXT AutoReplace File HTMLSUB.

Add definition Click the Add definition button. JAVA. or TEXT. or change the code templates without having to go through the Editor Options dialog. To delete a definition.DCI TEXT.dci file to add. Click on an item from this window and its template will display in the display window that is under the Shortcut/Description window. PLSQL. You can then type in the shortcut name. click the Delete definition button.DCI PLSQL. Delete definition The Delete definition button is enabled when you click on a line from the Shortcut/Description window. where [Language] could be HTML.DCI . You can directly edit the . delete. INI.94 Shortcut/Description window This window lists the code templates that are already defined.DCI INI. and then click OK. Code template items are saved and recalled from the TOAD\TEMPS\[Language]. Then tab and type in the description.DCI file. Language HTML INI JAVA PL/SQL TEXT Code Templates File HTML. select the Shortcut/Description you want to delete. and a new line with the word new appears in the shortcut templates window.DCI JAVA.

rightclick and select Format SQL. First Rows. Rule. If you use the internal formatter on anything other than Select statements you will get errors. To format a DML statement. Formatting Tools will display in the menu instead of Format SQL. This provides a shortcut to the functions listed in the menu. You can also press F10 to display the right-click menu. Options include Choose. highlight the statement you want formatted. "END" for matching "BEGIN".Chapter 5 SQL Editor 95 Right-click menu Click the right mouse button while you are in the SQL Editor to access the corresponding right-click menu. The right-click menu includes the following: Format SQL TOAD’s internal formatting mechanism only supports Select statements. Find Closing Block Finds the closing parenthesis. Default. . and All Rows. or "END IF" for matching "IF" Optimizer Mode This changes the optimizer mode for the entire session. If you have PL/Formatter or Formatter Plus installed.

DBMS Output. The Grid lets you take the results of a query and perform a variety of functions and display options. Auto Trace. It’s more flexible than using SQL* Plus.96 SQL Results Panel The SQL Results Panel tabs include: Data. and Script Output. 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. Data tab The Data Grid is discussed in detail in the Data Grids chapter of this manual. rowid from employee would be updateable. Explain Plan. The SQL Results Data Grid lets you view output from select statements. . because you can format the results visually or graphically. For example: select * from employee would not be updateable whereas: select employee. you can see all rows and columns of the given table in the results grid. If you have the optional PL/Formatter. a tab for Code Statistics is also on the panel. Query statements MUST return the ROWID to be updateable.*. If you type and execute Select * from tablename in the SQL Editor.

A red or green box displays in the status panel indicating whether the recordset is editable (green) or not editable (red). A cell in the results grid that contains the nested data will display the word DATASET. If it is an image or text file TOAD will launch the program that is associated with the extension. For example: edit employee If the resultset is editable but remains read-only. Double-click (if the option is enabled) or right-click and select Pop-up Editor to view/edit the nested table data. Nested Table Data You can view and edit nested data. If you run the file in an associated program you might or might not be able to edit the file. When a query is run with a cursor. . depending on your rights. 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. BFILE Data You can view BFILE data. You'll need to right-click the cell and select Pop-up Editor or double-click the cell to see the cursor data. make sure the View > Options > Data Grid – Data > Default to Read-Only option is not checked.) Data can only be displayed once per cell each time the query is run. you can substitute EDIT Items which TOAD will translate into the updateable version of the statement. the cell with the cursor will display the word CURSOR. (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. A cell with BFILE data will display the word BFILE. TOAD does not provide editing capability for BFILE data. Cursors You can view cursor data.Chapter 5 SQL Editor 97 To overcome this obstacle.

To view/edit. TOAD does not display the data for LONG RAW columns in a SQL Edit Grid. . double-click on the cell (if the double-click option is enabled) or right click on the cell and select Pop-up Editor. Double-click a LONG or LONG_RAW column to display the popup memo editor. LONG RAW columns display as (BLOB). and LONG RAW is similar to BLOB. LONG columns are columns that contain character data up to 2 gigabytes. LONG RAW columns contain binary data that cannot be displayed such as GIFs. Right-click the cell and select Pop-up Editor or double-click the cell (if the option is enabled). TOAD can handle all four of these datatypes. LONG and LONG RAW NOTE: LONG is similar to CLOB. Object Data You can view and edit object data. Word docs. A cell containing object type data will display the data in parenthesis delimited by commas. A cell with VARRAY data will display the word VARRAY. The memo editor will display the first 100 entries in the VARRAY. etc. and LONG RAW columns display as (BLOB). You define them as “long” in your SQL script. LONG columns display the first several characters.98 VARRAY Data You can view and edit VARRAY data.

For LONG columns. Double-clicking on the LONG COLUMN $define popups a memo editor that contains the column text. go to the View > Options > Data Grids tab and make sure the Popup memo editor on double-click option is checked. 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. the Memo Editor window is displayed. Load From File lets you select a file from your hard drive and place it into the LONG RAW column in the Oracle database.Chapter 5 SQL Editor 99 You edit these columns by double-clicking on the column and editing from the popup windows that display. The popup editor for LONG RAWS provides Load From File or Save to File functionality. If the popup window does not display. You can edit in the editor or load a file into the editor. . It must be checked for the above functionality to work. For LONG RAW columns the Blob Edit window is displayed. You can still use the popup editors to have a read-only view of the data. Note that the recordset has to be editable for the popup editors to edit the data. The popup editor for LONG columns displays the column text.

LONG RAW Columns 1 2 3 4 5 Create a table: "create table long_raw_test (id number. Click the right arrow Next Record button. "select * from long_test" should view all records. long_raw_col should display (BLOB). long_col long)" Edit the table: "edit long_test" Insert a row: enter “1” for ID. . 1 2 3 4 5 Create a table: "create table long_test (id number. "select * from long_raw_test" should view only id.100 To Edit LONG and LONG RAW Columns LONG Columns The recordset has to be editable for the popup editors to edit the data. Click the right arrow. then double-click on the long col cell Enter text. 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. including (at least the first few chars) the long cols.

Cost. it's in there. TOAD suppresses the time values if they are 12:00:00 AM (midnight). NOTE: 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 Installation wizard (see the Getting Started Guide). TQ (Object Node).C. Performing a query: SELECT SYSDATE FROM DUAL will display the time. Explain Plan tab The Explain Plan tab displays the Explain Plan for the selected SQL statement. The Explain Plan also displays additional information. PStart (Partition Start). and PStop (Partition Stop). so TOAD adds no value to the display of the date. Explain Plan can be printed from the SQL Editor and the Kill/Trace window via the right-click menu item. Rows. 4712 B. and similarly. including partition information for Oracle 8 and above. The time dropdown in the TOAD Options > Data Grids . Bytes. Oracle stores dates as a big fraction number offset from January 1. In/Out.Chapter 5 SQL Editor 101 Time Values When displaying times with dates. Object name. The time portion of the date fraction is zero. It is then converted to a complete date and time. queries of DATE datatype columns will display the time if it is not midnight. . Whether or not you use time. The interface has tabs for Operation. It will also work accurately well past Y2K. Explain Plan is explained in detail in the Explain Plan section on page 44.Data dialog is for display purposes and does not affect the storage of time values.

102 Auto Trace tab Auto Trace displays the results of every statement issued while in auto trace mode. Auto Trace is not recommended if a query is going to return a lot of rows. it will be enabled . It helps with tuning. You can enable/disable Auto Trace through the SQL Edit right-click menu. TOAD will ask you if you want to enable Auto Trace. If you select Yes. When you run a query you can find out some performance statistics related to that query. because it will force a read of all data from the results of a query. If Auto Trace is disabled and you select the Auto Trace tab.

You can also open a new DBMS Output window by selecting the Open a new DBMS Output window button. Set Output Buffer Size (invokes the Set DBMS Output Buffer window where you can set the size).Chapter 5 SQL Editor 103 DBMS Output tab When you execute a DBMS Output statement. Open a new DBMS Output window DBMS Output is discussed in the Procedure Editor chapter. Frequency of polling You can set the frequency of polling (2 seconds to 15 seconds). Print. the DBMS Output will automatically display in the DBMS Output tab of the results grid. and Delete Screen. You can print from the Script Output tab via the rightclick > Print menu item. Clear window. Buttons let you Turn Output On/Off. you are not prompted to save changes because the script is not saved to a temp file. Script Output When you execute a script the results automatically display in this tab. . When executing as script. Save to file.

To access the SQL Help Templates.TXT USRFUNCS.TXT NMBRFMTS. an explanation of the item or function displays in the lower panel. The items’ associated text files are located in the TOAD directory in the TEMPS folder.TXT DATEFMTS.TXT ASSOCIATED TEMPLATE Single Row Character Functions Single Row Number Functions Group Functions Date Functions Date Format Options Data Conversion Functions Other Misc. You can modify the files. This is especially useful for configuring PREDFXCP.TXT PREDFXCP. .TXT PSEUDO.TXT CNVFUNCS.TXT NUMFUNCS.TXT and USRFUNCS.TXT GRPFUNCS.TXT OPTHINTS. You can also access SQL Templates from the Procedure Editor window. Items can be dragged and dropped into your SQL script. Functions Number Format Options Oracle Pseudo Columns SQL Optimizer Hints Defined Exceptions User Provided Function List These templates are user configurable by editing the text file.TXT.104 SQL Templates SQL Templates (Help) is a popup reference for Oracle SQL functions and expressions.TXT MSCFUNCS. FILE NAME STRFUNCS. In the SQL Templates window. go to the common edit toolbar in the SQL Edit window and select Show SQL Help.TXT DATFUNCS.

. OR You can click the Clipboard button to copy the item to the clipboard. OR You can click the Direct button to automatically copy and paste the item into your SQL script. Select an item from the dropdown list. An explanation of the item or function will display in the lower panel.Chapter 5 SQL Editor 105 Show SQL Help To Access and Use SQL Help Templates 1 2 3 4 Click the Show SQL Help button that is located on the common edit toolbar. You can drag and drop the item to your SQL Editor.

highlight the statement you want to make before executing the Make Code Statement function. C++. The functions are called Make Code Statement <CTRL>M and Strip Code Statement <CTRL>P. and makes it ready to paste into the development tool code. A message displays in the status panel such as “VB statement copied to the clipboard.106 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. rather than changing the code in the SQL Edit window as the Strip Code Statement function does. or Perl. You can now switch to the code development tool and paste in the results. and from those code development tools back to TOAD. taking this code and running Make Code Statement for VB code changes the SQL statement from this: select count(*) as cnt from all_tables where owner = 'DEMO' and table_name = 'EMPLOYEE' to this: Sql = " select count(*) as cnt" Sql = Sql & Sql = Sql & Sql = Sql & " from all_tables" " where owner = 'DEMO'" " and table_name = 'EMPLOYEE'" . Make Code Statement Adds the code development tool syntax to the SQL statement in the SQL Editor. translates it into the code development tool syntax. Java. and copies it to the clipboard. For example. When making code statements. VB.” If you have multiple SQL statements in the SQL Editor. the Make Code Statement function takes the currently highlighted SQL statement.

The Make Code Format dropdown list 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). If you have multiple SQL statements in the SQL Editor. highlight the statement you want to strip before executing the Strip Code Statement function. copying it. taking this VB code from the VB development tool. and Perl are supported. Delphi. Java.Chapter 5 SQL Editor 107 Strip Code Statement Strips off the code development tool syntax from the SQL statement. . pasting it into TOAD. ready to execute in TOAD. The default selection is VB. C++. changes the SQL statement from this: Sql = " select count(*) as cnt" Sql = Sql & Sql = Sql & Sql = Sql & " from all_tables" " where owner = 'DEMO'" " and table_name = 'EMPLOYEE'" to this: select count(*) as cnt from all_tables where owner = 'DEMO' and table_name = 'EMPLOYEE' Now the SQL is ready to execute in TOAD. and running Strip Code Statement. Currently. For example. VB. Selecting the Code Development Tool You select the code development tool in the View > Options > SQL Editor tab > Make Code Format dropdown list.

SQL is used if the editor contents are not associated with a file. and executable name of the external editor you want. e. To set up. Enter the drive letter. SQLPLS. quit the external editor. press <CTRL><F12> to invoke the external editor.108 External Editor You can use an external editor to edit the SQL Editor contents.SQL file. Otherwise. which will start and load up the current TOAD Editor contents. which might ask you if you want to reload the contents of the SQLPLS. and click back on TOAD.. § 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. go to the TOAD Options > Editors > External Editor Command Line. Select Yes. While in the SQL Editor or Procedure Editor.g. Use the external editor. save the contents back to the SQLPLS.SQL file in the TOAD folder. § . c:\winnt\notepad. the actual file is used. path.exe %S.

and Views are on a separate tab. Reload last used tnsnames file Default . and synonyms are listed on separate tabs. Tables.Unchecked If checked. this option automatically loads the last two tnsnames files that you edited into the TNSNames Editor panels.Chapter 5 SQL Editor 109 Options for the Editors You access this menu via View > Options > Editors menu item. views. will show views along with tables on the Table Select window. this option will backup the tnsnames file prior to saving the file. Backup tnsnames file before saves Default . General Show Views on Table Selector Default – Unchecked If checked. . along with tables and optionally views on the Table Select window. Tables are listed on one tab.Checked If checked. Show Synonyms on Table Selector Default – Unchecked If checked. will show synonyms.

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." 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 . tablenames will appear in black text. will return selected column names into the editors in lower case. Return table and column names in lower case from selection windows and drag-drop Default – Unchecked If checked.110 Use syntax highlighting on tablenames Default – Checked If checked. 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. Otherwise they are returned in upper case. If unchecked. Treat underbar character as part of object names Default – Unchecked If checked. will show tablenames in the SQL Edit window and other editors using the syntax highlighting feature. 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 SQL Templates from the SQL Templates popup The dropdown when you type in a table name and press ". If the option is unchecked only BONUS will be selected. if the option is checked and you double-click on BONUS then EMP_BONUS_TAB will be selected. If unchecked.

EXE\TEMPS.EXE\TEMPS location Default .CHM are read will load from TOAD.Checked If checked. the F4 popup Object Describe windows will use the Windows Stay on Top feature.Chapter 5 SQL Editor 111 Allow RTF when copying to/from clipboard Default .EXE and TOAD. If unchecked. You access a Describe window by placing the cursor on a table. TOAD will copy color markups for pasting into email or other RTF enabled applications. Load Source for the SQL Templates window from TOAD. package or view in a SQL Editor or Procedure Editor and pressing F4.Checked If checked. Use StayOnTop Describe Popups Default – Checked If checked.Checked If checked. will load the . . the text will be copied to the clipboard as standard black text. If unchecked.TXT files that populate the SQL Templates window from the network or local workstation where TOAD. Find word under the cursor Default . when you open a Find and Replace dialog TOAD will automatically look for the word currently under the cursor. procedure. The Object Describe windows are similar to the Schema Browser windows for the corresponding object types. TOAD will default to the word that you most recently searched for. function.

While in the SQL Editor or Procedure Editor. Load View names from database at time of first editor window Default .exe %S..Unchecked If checked both the spec and body will be included in the Describe. this option will cause TOAD to requery Oracle for tablenames every time they are needed to fill a list of tablenames. the list will override the global browser filter for tables when the Schema Browser window is opened. which will start and load up the current TOAD Editor contents. and executable name of the external editor you want. If checked.Unchecked If checked. press <F12> to invoke the external editor. This allows syntax highlighting for view names. . view names will automatically load when you open an editor. e. If the table list is already cached.g. path. Show Spec along with Body when describing a package Default .112 External Editor Command Line textbox Enter the drive letter. Load table names from database at time of Login for each connection Default – Unchecked TOAD caches tablenames and only queries tablenames the first time they are needed per Oracle session. c:\winnt\notepad.

If unchecked. Delay for pop-ups ___ milliseconds spinner. Display parameter hints after typing open paren "(" Default . Sort pick lists alphabetically Default .Chapter 5 SQL Editor 113 TOAD Insight Display pick list after typing object name followed by a period Default – Checked If checked. will display the columns dropdown list. will not display the columns dropdown list.Checked If checked. .Checked If checked. parameter hints will display automatically when you pause after typing the open parenthesis. items in the columns popup will display alphabetically. 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).

. To select more than one item. etc.114 SQL Editor Tasks This section will take you step-by-step through various tasks that you might want to perform with the SQL Editor. To look up table columns while you construct a query This applies to any table or view that you can access. 3 Click the item you wish to select. 1 2 After you type the table name (or view name) and the period. press <CTRL>T (or wait a few seconds) A list of columns displays. hold down the <CTRL> key and click the items you wish to select. SYS. including objects from other schemas. SYSTEM.

Chapter 5 SQL Editor 115 4 5 Press <ENTER> OR Press <TAB> TOAD places the selected column or columns into the SQL Editor to build your query. you can press <CTRL>T to display a list of the columns from the SQL Results Grid.INSERT_PRIV After a query populates the SQL Results Grid. .SELECT_PRIV. TABLE_PRIVILEGES. select table_privileges. TABLE_PRIVILEGES.TABLE_NAME.

pulls up the Table Name Select window. The Table Name Select window displays. Click the item you wish to select. in the common edit toolbar. or Synonym names from the Table Name Select dialog to the SQL Editor. 1 2 3 4 From a SQL Edit window or a Procedure Edit window. To select more than one item.116 To copy Table Names into the SQL Editor You can copy the Table. hold down the <CTRL> key and click the items you want to select. You can drag and drop the item(s). The Show Tables window button. on the common edit toolbar select the Show Tables window button. View. or copy <CTRL>C and paste <CTRL>V. .

Chapter 5 SQL Editor 117 To copy Table Column Names into the SQL Editor The Show Columns button. hold down the <CTRL> key and click the items you want to select. The Column Name Select window displays. select the Show Columns window button. To select more than one item. or copy <CTRL>C and paste <CTRL>V. pulls up the Column Name Select window. in the second SQL Editor and Procedure Editor toolbar. Click the item you wish to select. . You can drag and drop the item(s). 1 2 3 4 From the SQL Edit window or Procedure Edit window on the common edit toolbar.

Check the Include Column Headers checkbox that is listed in the Save Grid Contents dialog. [select * from employee]. Switch to the target Windows application. e. Functions. and Packages. To use TOAD to copy Oracle data to another Windows application You can query some data and process it further in another Windows application. Uncheck the undesired columns until the columns you want are the only ones checked. Press F4. A popup window displays that describes the object. Procedures. The Select Columns window displays. Views. 1 2 3 4 5 6 7 8 9 Execute a query. like Excel. .g. Paste in the results.118 To get a description of an object while you are typing in the SQL Editor This applies to Tables. Select the Save As menu item from the right-click menu. Right-click over the SQL results grid to display the right-click menu. Select the Select Columns menu item. This saves the results to the Windows Clipboard. 1 2 3 Place the cursor on the object you want described.

The file loads into the SQL Editor. You can click the triangle to display a dropdown list of the last 10 files you opened while you were in the SQL Edit window. Drag and drop a file from Windows Explorer to the SQL Editor. Type in some SQL code. 1 2 3 4 5 OR Click the Load a file into the editor button on the SQL Editor toolbar. Refine it. Typing 1 2 3 4 5 Start with a blank window in the SQL Editor. Click the Open button. the list is reset. Loading a file The Load a file into the editor button. Save it to disk.Chapter 5 SQL Editor 119 Ways to get code into the SQL Editor This section shows you the various ways you can enter or bring code into the SQL Editor. A Select File for Edit window displays. Click the desired file. Execute it. . Once the window is closed.

The list of previous SQL statements is stored to and retrieved from SQLS.DAT.TXT in the TOAD\TEMPS folder.120 File > Reopen File You can also open a file into the SQL Editor. SQL Editor node. via the File > Reopen File menu. This list is saved and restored to the file SQLFILES. for more information. See the Recall and Add SQL topic. It is copied to the SQL Editor. Select a query from the list. The SQL Statement Recall window displays. page 49. Recall previous SQL The Recall Previous SQL button 1 Select the SQL-Window > SQL Command Recall menu item OR Press F8 OR Press the Recall Previous SQL button. 2 3 4 On the TOAD Options dialog View > Options menu item. select items from dept select item from dept (invalid) (invalid) (valid) select item from department Another option lets you enter the number of previous SQL statements that you want to save and recall. The default is 100. It lists the last 100 queries that you executed in the SQL Edit window. you can choose to save only the SQL commands that executed without errors. . check the Save only statements that are valid checkbox. To do this. This is a useful filter because otherwise the recall list will fill with queries until you get it right. There is a list of the last 10 files opened. or Procedure Editor.

Select menu item SQL-Window > Add to Named SQLs. The SQL Statement Recall dialog displays.DAT. OR Press <CTRL>N. 3 4 The list of personal SQL statements is stored to and retrieved from PERSSQLS. The queries are organized by the names that you select. OR Select the Recall Personal SQL button from the SQL Editor toolbar. e.g.. . Enter a name. Select menu item SQL-Window > Recall Personal SQL. Select the desired SQL. The SQL Statement Recall window displays.Chapter 5 SQL Editor 121 Recall a Personal SQL that you created The Recall Personal SQL button 1 2 Enter a query. Create and Recall a Named SQL statement 1 2 3 4 Enter a query. 5 6 The list of named SQL statements is stored to and retrieved from NAMEDSQL. Select the query to return to the SQL Editor. “Salary Query” Select menu item SQL-Window > Recall Named SQL.DAT.

INI. In the SQL Editor. type in the shortcut keys. “crbl” Press <CTRL><SPACE>. Enter the shortcut keys for the code snippet. page 93.DCI file. or TEXT. and the code in the same format as the samples already in the . for more information. 2 3 4 5 . See the Code Templates topic. the complete name.g. e. For the SQL Editor the language would be PLSQL. PLSQL.122 Recall a Code Completion template that you previously set up 1 Edit [Language].DCI in the TOAD\TEMPS folder.. where [Language] could be HTML. JAVA. TOAD looks up the code completion template and plugs it into the SQL Editor.

. or VARCHAR data type columns. printing. reference columns. Popup Editor The Popup Editor is for nested tables. bfiles.6 Data Grids Each data grid includes context menu items and a print dialog. CHAR. CLOB. when you double-click. a text editor displays. a date picker is displayed where you can select a date from a calendar presentation. Right-click menu The right-click menu for the Data Grid provides numerous display. and exporting options. SQL Modeler. Blob Edit is for LONG RAW/BLOB data type columns. objects. For example. The data grid is used in the SQL Editor. LONG. for columns that are long (200 characters or more). For date columns. Schema Browser (Tables > Data and Views > Data). and Master/Detail Browser. cursors.

which is a popular standard. the resultset must be editable. 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 . Print Grid This invokes the Report Link Designer which is discussed later in this chapter. Delimiters Some programs require commas. Format radio buttons Default – Tab Delimited § § § ASCII.124 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. to distinguish the data from one column to another column. the Memo Edit popup window is read-only. If you want to make changes to the data in the Memo Edit popup window. 1 Double-click a column to edit its value in the Memo Edit popup window. The ASCII standard for dividing data is the <TAB> character. Otherwise. Otherwise. Save Grid Contents The Save As right-click menu item displays the Save Grid Contents window which contains format and file options. 1 2 3 Right-click to display the right-click menu. Click the Popup Editor menu item.

and text boxes for entering the Field Separator and the String Fields Enclosed by character. supports "Include Nulls" option XLS Instance . Truncate. 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. SQL Loader .Chapter 6 Data Grids 125 § § 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 . XLS File – Saves the file as an Excel file. Replace.Saves the file in SQL Loader format. text will be enclosed in double quotes. If multiple tables were right-clicked from the Schema Browser. Example: 7369 "SMITH" "CLERK" 7902 12/17/1999 . it lets you supply the schema and table name. Append.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. When exporting a data grid. The Output file contains both header and data information and is ready to be used by SQL Loader. the schema and table names are filled in automatically. Other options include: Double Quote Char (text) Columns Default – Unchecked If this option is checked.Saves the file with Insert statement.

If you save to file you can select to launch the file after it is created. the column headers will be included in the text output. Example: 7698 BLAKE MANAGER 7839 05/01/1988 NULL 30 Zip resulting file(s) Automatically zips the file. . the word NULL will be included for empty cells (cells that contain no information). TOAD will display a confirmation message that states the number of rows that were exported. You can save to File or Clipboard. Example: EMPNO 7369 ENAME SMITH JOB CLERK MGR 7902 HIREDATE 12/17/1980 SAL 800 Include NULL Text Default – Unchecked If this option is checked.126 Include Column Headers Default – Unchecked If this option is checked. After you click OK.

Drag the column(s) left or right as desired. If after rearranging your columns. This does NOT requery the data from the database. or save the data to a file. Uncheck the columns you want to hide. The Select Columns window includes a checkbox for Row Numbers. To temporarily hide selected columns 1 2 Select the Select Columns item from the right-click menu. They will NOT be included when you copy to clipboard or save to file. you copy the data to the clipboard. This lets you display or hide row numbers in the data grids. the data will be in the new column order. It just temporarily hides the columns. .Chapter 6 Data Grids 127 Select Columns – Row Numbers Check or uncheck the columns you want to see. To rearrange the order of the columns 1 2 Select the column you want to move by clicking on its header in the grid.

how many lines in the output file will be covered by a single record of data. table owner. § Move the mouse pointer to the grid headings. . the starting column. etc.. what line they will appear on. Execute This button exports the data to the file. re-execute the query. Export to Flat File When you Export to Flat File. If the columns of a query are different. and drag it left or right. You must set up the Specifications File which will define the table name. The spec file indicates start and end points for columns which you can edit. then the grid columns will be sized according to the View > Options > Data Grids . then TOAD retains these custom column widths. or an ORDER BY. and the column widths would remain the same. You could add a WHERE clause. over the border between two columns.128 To set the column widths to a custom width setting If you want to see more or less of a column. and the length of each column of data. you export data to an ASCII file without column delimiters. Spec Filename You can type in your filename or use the drill down to choose a target path. On the Options tab select the table to export. Spec File tab This is where you set up where your columns will begin and end.Visual > Size columns to the width of the headers. If the columns of a query are the same from query to query. Size columns to the width of the data and Allow columns to be less than the header width options. the columns of data.

6.3 The basic format for the column definition lines is: COLx=COL_NAME.1.1.21.5 COL2=LAST_NAME.1.68.1.1. not the width of the actual table data.1.1.22 COL8=SALARY.1.1.Num Columns A sample flat file as exported will look like this: 7369 7499 7505 7506 SMITH ALLEN DOYLE DENNIS JOHN KEVIN JEAN LYNN Q J K S 667 670 671 671 7902 7698 7839 7839 12/17/1984 2/20/1985 4/4/1985 5/15/1985 800 1600 2850 2750 300 20 30 13 23 .1 COL5=JOB_ID.15 COL4=MIDDLE_INITIAL.10 COL10=DEPARTMENT_ID.1.4 COL6=MANAGER_ID.5 COL7=HIRE_DATE.Start Col.Output_row_num.46. Example of a specification file: TABLENAME=EMPLOYEE TABLEOWNER=DEMO LINESPERRECORD=1 COL1=EMPLOYEE_ID.36.Chapter 6 Data Grids 129 Save Spec File This saves your specifications file and all your edits.88.78.10 COL9=COMMISSION.1. Generate Columns This creates columns for your specifications file based on the DDL for the table.41.37.15 COL3=FIRST_NAME.

. If TOAD needs to query ahead in the recordset.130 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. Example: ENAME = ‘SMITH’ AND JOB = ‘CLERK’ You can press <F3> to find the next row with the specified value. This dialog lets you enter a multiple column search criteria. 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. the search is fast. On the Options tab. you would select the schema and the table to export. You can specify whether you want the search case sensitive. Select the desired case sensitive and partial match options. Enter the keyword or Value to find. The Grid Data Find window displays. Find Data The Grid Data Find window lets you search through selected columns for selected values or characters. Select the Column you want to search. To find data 1 2 3 4 5 6 From the right-click menu or from the main Grid menu select Find Data. and whether or not you want to have partial matches. If the records are cached. Click the ADD button. TOAD will search all records for the value and position the recordset to the first matching value. you’ll have to wait for additional rows to be fetched from the database. Click OK.

They will create a table called SEQ_TABLE with columns titled FIRST_NME. and the SQL Modeler. if you add a new record in the table and leave the sequenced column blank. After you edit the cell contents. To copy one row to create a new one 1 2 3 4 Edit the recordset. the Master/Detail Browser. 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. NOTE: the recordset MUST be editable before the Copy Row function will work. and ID_NMR.Chapter 6 Data Grids 131 Duplicate Row This item lets you copy an entire row. It creates a Sequence called SEQA that starts with 1. LAST_NME. After the sequence is applied. increments by 1. Click in a cell of the row you want to copy. . Record count is cancelable in the SQL Editor. If you want to cancel from adding this row. The following example uses Set Sequence Field. Run the following scripts in the SQL Editor. This copies the entire row to the bottom of the SQL Results grid ready for you to edit. move to the row above in order for the row to be sent to Oracle. 5 Record Count This displays a message window that shows the count of the number of records in the recordset. and has a maximum value of 4. press the <ESC> key. Select the Grid > Copy Row menu item (also accessible from the rightclick menu). TOAD will auto-generate the next number in the sequence applied to the column. Columns with assigned sequences are displayed in aqua. the Schema Browser.

Right-click in the data grid and select Set Sequence Field.132 DROP TABLE SEQ_TABLE CASCADE CONSTRAINTS . use the Schema Browser. CHAR (20). NUMBER (4) NOT NULL. 1 2 From the Schema Browser > Tables list select the SEQ_TABLE. In the details panel click the Data tab. CREATE TABLE SEQ_TABLE ( FIRST_NME LAST_NME ID_NMR CHAR (20). From the Column dropdown select ID_NMR. CONSTRAINT UNIQUEID UNIQUE (ID_NMR)) CREATE SEQUENCE SEQA START WITH 1 INCREMENT BY 1 MINVALUE 1 MAXVALUE 4 NOCACHE NOCYCLE NOORDER Next. you need to display the data grid for SEQ_TABLE. You can do this through the SQL Editor or the Schema Browser. From the Sequence dropdown select SEQA. For this example. . The cells are currently empty of data. 3 4 The Set Sequence Column window displays.

and 4. “ORA-8004: sequence SEQA.Chapter 6 Data Grids 133 5 6 7 8 Click OK. Click in a column. The fixed columns remain locked to the left in view during horizontal scrolling. To move a column out of the fixed area click and drag it to the right of the bold horizontal fixed column divider bar. Fix Current Column You can select and fix columns. 9 Try to Insert data for a 5th record. The column(s) you select will be anchored to the left. other columns can be dragged into the fixed area. 3. right-click. When you display Row Numbers they automatically display as fixed columns. Remove Preview Column This removes the Preview Column. and select Fix Column to fix the selected column. Insert data in the record for FIRST_NME and LAST_NME. . You can then delete the extra record. The ID_NMR column populates with 2. This is useful for viewing long varchar columns. An error message displays.NEXTVAL exceeds MAXVALUE and cannot be instantiated. Once a column is fixed. Preview Current Column This displays a full row below each data row to show the value of the selected column. When you click the Insert Record button 1 is automatically entered Insert 3 more records of names.” This is because you set the maximum records of the sequence to 4.

you can only select one row at a time.Visual page which contains numerous display options including fonts and column sizing. 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. The new height adjustment automatically applies to all rows in the table. then click-and-drag the row up or down to increase or decrease its height. If you accidentally select a row you want to deselect.Visual page.134 Allow Multi-Select When this is checked. This is discussed in detail later in this chapter. When Multi-Select is not checked. press <CTRL> and click the row and it will be deselected. The Font option is on the Data Grids . . Row height adjustment is useful for viewing varchar columns. Grid Options This invokes the Data Grids . you can select more than one row by pressing <CTRL> and the rows you want to select.

Sort Ascending.Chapter 6 Data Grids 135 Sort Options Window The Sort Options window lets you sort columns in ascending or descending order. In the Schema Browser. It is invoked when you click on a grid column header under specific conditions in the Schema Browser and SQL Editor. It also lets you remove sorts. the column-click sorting is disabled until you clear the sort filter via the filter window. The View > Options > Data Grids – Visual > Confirm sorts when clicking on column header option is checked by default. Once you apply a sort via the filter window (which you can do in the Schema Browser). if a sort filter has not been applied via the filter button. You cannot sort row numbers. . you can click on a column header and invoke a Sort Options window that contains 3 radio buttons: Remove Sort. the grid is sortable via the Sort Options window. Sort Descending. In the SQL Editor. You have to click the apply button for your sort choice to apply. if the query does not contain an Order By.

You can use the calculator to perform calculations in the cell. . Click the arrow and a calculator will display.136 Calculator You access the calculator by clicking on a number in an editable cell and pressing <Enter>. and the new number remains displayed in the cell. When you get your final result press <Enter> or click outside of the calculator area. A dropdown arrow displays.

Date format dropdown Default – Your Windows Control Panel.Chapter 6 Data Grids 137 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. if desired. Regional Settings. a popup window will display with the contents. Selecting a different format will override the Windows Control Panel setting. 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. the data in TOAD for date columns will display in the format selected in the Window Control Panel. when you double-click on any text column. The Data Grids Data options are on the Options > Data Grids . Short Date Style Format Normally. Even if the option is unchecked a popup editor is available in the cell of a grid via right-click. Time format dropdown list Default – h:mm:ss AMPM This lets you select a different time format. This option is useful for LONG columns and other special datatypes. If checked. Popup memo editor on double-click Default – Unchecked If checked.Data page. . you cannot edit data in the data tab of the Schema Browser.

Check and warn of cascading constraints before deletions Default . This also affects the data grids on the Schema Browser Data tabs. TOAD will stop editing if blank is entered in a NOT NULL required entry column. Show Row ID in data grids Default – Unchecked If checked. you will be warned of cascading constraints before deletion. TOAD will not check for blank values during grid edits and will instead rely on Oracle for the constraint checking. This lets you post a single column with just spaces. If unchecked. . Confirm data deletions from grids Default – Unchecked If checked. the ROW IDs will display in the data grids. Trim string data before posting to Oracle Default – Unchecked If checked.138 Do not require NOT NULL columns in data grid entry (allow Oracle to enforce constraints) Default – Checked If this option is checked.Unchecked If checked. this will trim off trailing spaces from data before posting it to the database. this will confirm each record deletion before deleting the record.

If you attempt to continue scrolling a message box will appear asking “Do you want to cancel the Data Scroll?” If you click “Yes” you cannot scroll any further down and no more data will be fetched. If you click “No” you can continue scrolling. 1987. Anything outside of the sliding window will be treated as a current century year. if your current system date is set for June 1. and any number that falls inside the sliding window will be treated as a previous century year. numbers with more than 15 places and floating point numbers with more than 15 decimal point places will display in scientific notation. . Pressing <Alt> <Tab> doesn't count as a key-stroke or mouse-click that will stop the fetch. Display large numbers in scientific notation Default . The range of choice is 0 to 49. If you enter 1/1/57. For example. 1.Chapter 6 Data Grids 139 Sliding window for entering two digit years Default . Allow key-stroke/mouse-click (Alt + Tab excluded) to cancel data fetches (grid scrolls) Default – Unchecked When checked.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. 2057. the date is outside of the 30 year window. it lets you disable scrolling in a large data set. 1. 2000 and you specify a 30 year window (which is the TOAD default) and enter 1/1/87. Click the Up and Down arrow to select the range. so the date produced will be Jan. No more data is fetched beyond the point where you stopped scrolling.Checked If checked. the date produced will be Jan.

Old grid print font button If you check the Use older version of the Data Print Grid option.Unchecked If checked. The old TOAD print grid lets you select columns that you wish to include/exclude from the printout.140 Use older version of the Data Print Grid Default . this lets you select the font. the old TOAD print grid will be used when printing data grids. .

when you select an item in the data grid and then click outside of the grid. the item and cell remain highlighted. Preview Column Lines spinner Default . .Checked If checked. If unchecked.Checked If checked.Chapter 6 Data Grids 141 Data Grids – Visual Options The Data Grids – Visual Options are accessed via the View > Options (or the Configure Options button) > Data Grids – Visual page. If you select 0 the preview is removed and you cannot preview columns. Grid Default – Checked When checked. when you click outside the grid the item and cell are no longer highlighted. when you select an item in the data grid and then click outside of the grid. Show Focus Rectangle Default .1 This lets you change the number of lines included in the preview column. the item you selected is marked with a black rectangle. the grid displays around the data (lines appear between the rows and the columns). You can select from 1 (the default) to 5. Selection Default .

Changing the font here only affects the font displayed in the preview column. with the exception of the preview column and headers. The measurement is in points. . Changing the font here affects the entire data grid. Row lines Width spinner This controls the thickness of the lines between rows on the data grid. you can click-and-drag between columns to resize them. Header button Default – MS Sans Serif 8 point This invokes the font selection dialog. Options Column Sizing Default – Checked If checked.142 Font button Default – MS Sans Serif 8 point This invokes the font selection window. Fonts Grid button Default – MS Sans Serif 8 point This invokes the font selection dialog. All data grids will have the same font. Changing the font here only affects the font displayed in the headers of the data grids.

Multi Select Default – Unchecked If checked. You cannot tab through multiple records unless Tab Through is also checked. In order to tab through the records. you can click-and-drag a column to another location in the grid. clicking in a cell in the data grid selects the entire row rather than only one cell.Chapter 6 Data Grids 143 Column Moving Default – Checked If checked. Multi Select lets you select more than one row at a time by pressing either <SHIFT> or <CTRL> while clicking on the rows. Tab Through Default – Unchecked If checked. this automatically engages row select. Tabs Default – Checked If checked. . lets you tab from column to column through one record. you can tab through more than one record. you must also have Tabs checked. Row Select Default – Unchecked If checked.

it will still appear to enter edit mode but the data will not be editable. If the data grid is not editable. the blank row will be deleted...144 Cancel on Exit Default – Checked This applies to the Schema Browser > Data Grid for a table.. If checked. the grid will enter edit mode.. the blank row will remain. and the option is 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. as soon as you click on a data cell in the grid. you must select the cell twice to place the grid in edit mode or just begin typing in the cell. If the option is unchecked. . Immediate Edit Default – Unchecked If this option is checked. If unchecked.

a column containing row numbers displays. any data cells that are null will contain the words {null}. Allow columns to be less than the header width Default – Unchecked If checked. and data wider than the heading is truncated. Confirm sorts when clicking on column header Default – Checked . Show row numbers Default – Unchecked If checked. Size columns to the width of the data radio button Default – Selected If selected. columns are sized to the width of the headings. you can make columns narrower than the width of the column header. Display {null} for null columns Default – Unchecked If checked. columns are sized to the width of the data that they contain. It is automatically fixed and the first column in the data grid. Unchecked.Chapter 6 Data Grids 145 Column Sizing Size columns to the width of the headers radio button Default – Not Selected If selected. the null data cells will display as empty cells.

You can also toggle the Custom autofilter dropdown arrows via the data grids right-click Excel Style Filtering menu item. Allow resize column out of grid Default . Allow Excel Style Filtering Default . and Less than or Equal to. In the textbox to the right of Equals type M*. if you want to retrieve all rows in a column that start with M.Unchecked This option applies to the last column of the grid. Less than. dropdown arrows display at the top of each column that let you access a Custom autofilter menu item. when you click on the column it is sorted in either ascending or descending order (whichever is the opposite of its current state). and select Equals from the dropdown box. The filter will only display rows in the column that start with M.146 If checked. the row number background will be the same color as the border background.Unchecked If checked. If unchecked. click Custom. Color row numbers same as grid border Default – Unchecked If checked. . Unchecked. select the dropdown in the column header. you can resize the last column of the results grid. Click Ok. The autofilter lets you filter with a variety of dropdown choices such as Greater than. the row number background will be white. For example. If checked. the Sort Options window displays when you click on a column header.

Options tab Draw Mode dropdown The choices are: Strict. Show panel Bands Default – Checked If checked.e. The printout will print in spreadsheet fashion. the column headers are included in the printout.Chapter 6 Data Grids 147 Report Link Designer When you issue a print command for a grid (Grid > Print Grid or right-click on the grid and select Print). This contains options for how your printout will display. and Borrow from Source. printing will not truncate the output at the page width. adds a blank band (bar) to the top of the grid. columns are printed on subsequent pages. If unchecked. Headers Default – Checked If checked. Odd/Even Rows Mode. i. column headers are not included. Footers – Not applicable to data grids Group Footers – Not applicable to data grids . the Report Link Designer displays (unless you chose to use the older version of the print grid in the Data Grids > Data options)..

If unchecked. Nodes Grid Default – Checked If checked. the grid lines will not printout. the column lines will not print in the data grid. Preview Line Count spinner Default .Disabled This is enabled if the Autocalculate Preview Lines option is unchecked. will autocalculate preview lines and the Preview Line Count spinner will be disabled.Not applicable to data grids . Grid panel Grid Default – Checked If checked. Group Footers Grid .Checked If checked.148 Preview panel Visible Default – Checked If checked. Autocalculate Preview Lines Default . the grid lines (the lines between the rows and columns) will printout. If unchecked. will print the column lines in a data grid. the preview columns will printout.

Chapter 6

Data Grids

149

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.

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 checkbox lets you give your printout a tree effect. If you uncheck the Flat Checkmarks option the checkmarks will be 3 dimensional. You can also have your Checkmarks 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.

150

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 portrait page width.

7
Procedure Editor
The Procedure Editor lets you create or modify procedures, functions, packages, triggers, types, and type bodies. It also has an optional PL/SQL debugging function. It includes browser style back/forward buttons for code navigation. By clicking the right mouse button or pressing F10 you access a context menu with numerous options such as Set Bookmark and Uncomment Block.

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

152

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. The Procedure editor also includes a Source Control toolbar (includes Get latest version, Check out, Check in, and Add Project) and a Formatter toolbar (includes Format code, Profile Code, and Launch Formatter Plus). If you have the optional PL/SQL Debugger, its toolbar will display to the right of the Procedure Editor toolbar. The last row toolbar is the Common Edit toolbar, a standard editing/formatting toolbar which is also used in the SQL Edit window.

Chapter 7 Procedure Editor

153

Shortcut Keys
Shortcut Key F1 F2 F3 F4 F7 F9 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 <CTRL>T <CTRL>U <CTRL>V 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 Display columns dropdown Convert text to Uppercase Paste

includes incremental searching 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. . 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. (period) <ALT><DOWN> <ALT><LEFT> <ALT><RIGHT> Cut Undo last change Redo Last Undo Jump to the procedure implementation in the body Jump to the procedure declaration in the spec Go to col. 1.154 <CTRL>X <CTRL>Z <CTRL><SHIFT>Z <CTRL><SHIFT><DOWN> <CTRL><SHIFT><UP> <CTRL><HOME> <CTRL><END> <CTRL><SPACE> <CTRL><TAB> <CTRL><ENTER> <CTRL><PAGE UP> <CTRL><PAGE DOWN> <CTRL>.

Chapter 7 Procedure Editor

155

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

156

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.

If you have the optional 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
1 2 3 4 While in the Proc Edit window, Go to File > Open File. The Load File window will display. Double-click on the selected file. The file is opened in the Procedure Editor.

Chapter 7 Procedure Editor

157

To Load Object from a database
1 2 3 4 5 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.

6

7

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.

158

To Create an Object using the New PL/SQL Object button
1 2 3 4 5 6 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.

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 to load the templates from the network if you elected to install TOAD to a network server share. See page 111 for details. You configure templates on the View > Options > Procedure Editor > Proc Templates page.

Chapter 7 Procedure Editor

159

TOAD will automatically substitute values for keywords in the templates. TOAD will perform the following substitutions. Object Name: Sysdate: Date/Time: Date: Time: Username: %YourObjectName% or *YourObjectName* %SYSDATE% %DATETIME% %DATE% %TIME% %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/2002 */

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.

subtypes. Functions are in indicated with an f ( ) and procedures are indicated with a p( ).160 The left panel contains the navigator tree a list of objects or package contents. parameters. system types. . It can also display the following declarations: constants. exceptions. The navigator tree represents nested procedures. 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. The upper right panel in the Procedure Editor contains the code for the selected object. Each procedure will open in a separate tab. variables. record fields. ref cursors. and Varrays. Compiling will be disabled for files that are not split. PL/SQL tables. Each package is composed of a Specification (SPEC) and/or Body. You can right-click in the tree and select what you want to display. Click on an item and it goes to that item in the code. cursors. records. You can have several procedures open. which is displayed in the hierarchy on the list.

. The Status panel shows the Row number and Column number of the cursor position. A horizontal splitter between the editor and the error panel can be sized up or down. A vertical splitter between the navigator tree and the editor lets you resize the navigator tree and the editor.Chapter 7 Procedure Editor 161 The Error panel lists errors on the left in a list box and details on the right. Double-click on an error to invoke the Instant Messages screen for that Oracle error. 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. Single-click on an error in the list to display the details and the error will highlight in the editor.

you need to right-click and select Show Navigator. it will run the GIVE_RAISE procedure. regardless of whether or not you have the debugger. the items appear alphabetically. uncheck the View > Options > Procedure Editor > Automatically show objects on Select Database Object Window option and set up filters before clicking the Run button. Navigator Tree Buttons Refresh Navigator This button refreshes the navigator tree. You can also right-click and select Execute without debugging. If you select the Load Object from Database button you get a filter window. This populates the list of existing objects more efficiently. If your database contains many items. 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 you close the navigator and want to reopen it. If GIVE_RAISE is the selected procedure and you click the Run button. . It runs the selected procedure. Close Navigator This button closes the navigator tree. If the button is DOWN (depressed).162 Run button The Run button is only enabled for the debugger.

. and the other read-only editors in TOAD. and the file will reload. “PROC_B” will display in red. Highlight names of stored procedures Default . for User Procedures. TOAD will highlight functions and procedure names in the Procedure Editor. Highlighting tab. if PROC_B is a stored procedure and you’ve designated stored procedures to be displayed in red. If checked. The Options > Procedure Editor page contains numerous options under General. For example. this allows editing in an external editor. TOAD will check the date stamp of the file to see if it was modified by the external program. NOTE: you must select a custom color in the Editor Options dialog. 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. General Reload files when activating TOAD if the file time stamp is changed Default – Unchecked If checked. Debugging. and Proc Templates. Select Yes.Chapter 7 Procedure Editor 163 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.Checked This option must be checked if you want the Load Source menu item enabled in the Procedure Editor right-click menu. File Splitting. If the file was modified. SQL Editor. This option refers to syntax highlighting. When a Procedure Edit window containing a file is reactivated (gets focus).

. instead of overwriting it. source is not prefixed with the owner. This is useful if when compiling a procedure.PROCEDURENAME IS If unchecked. the Create clause will read. Use “CREATE” instead of “CREATE OR REPLACE” when loading database objects Default – Unchecked If this option is checked. no object type is selected (just a blank grid). When loading PL/SQL into the Procedure Editor. and you must select before any objects are shown. an object type will be selected. source will be prefixed with the owner. Automatically show objects on Select Object from Database Window Default – Unchecked If checked. the Create clause will read “Create or Replace Procedure/Function Package” and overwrite any existing objects that have the same name. a different object of the same name already exists in the database. If unchecked. the Create Procedure will not overwrite an existing object. hence the compile will fail.. "Create Procedure/Function/Package . this basically puts owner name in the first line when loading from the database. and all objects that are not filtered will be shown.". . If unchecked. When exporting source.164 Include Owner when extracting source From database Default – Unchecked If checked. if this option is checked. Example: CREATE OR REPLACE PROCEDURE STHOMAS.

will enable the Compile Dependencies button. which you can then click to compile PROC_A. Only show one Procedure Editor per database connection Default – Unchecked If checked. Oracle flags PROC_A as INVALID. If unchecked. . this plays the TOADLOAD. This is similar to the option that limits the number of SQL Edit windows and Schema Browser windows. TOAD will check for this dependency. enable the Compile Dependencies button. TOAD will search the database for dependent objects of the currently compiled PL/SQL object (those procedures that call this procedure). the Compile Dependencies button is always enabled.WAV (croak sound) when the compile of a procedure has been completed. and if any are found. Toggle Modified Flag after compiling source from database Default – Unchecked If checked. and therefore not leave any INVALID objects out there as a result of your changing PROC_B.Chapter 7 Procedure Editor 165 Search for Dependent Objects following a compile Default – Checked If checked. If PROC_A calls PROC_B and you are editing and recompiling PROC_B. the Modified flag in the status panel will toggle to “Modified”. per connection. after you compile source from the database. forcing a need to recompile PROC_A. permits only one Procedure Edit window per database connection to conserve Windows resources. Notification when compile process is complete Default – Unchecked When checked.

166 Allow compiling when source loaded from database Default – Checked If checked. choose to never split files (this disables compiling).Checked If checked when you load a package spec or type spec the corresponding body will be loaded. and choose to save to separate files after splitting. the tabs will display with a horizontal scroll bar.Unchecked If checked. Unchecking this option enforces the practice of loading and altering source files instead of storing the only copy of the code in the database. The Debugging options apply to the optional DBA module and are discussed in TOAD Help. If unchecked. once a line of tabs is full. TOAD will let you compile source that is loaded from a database. and when you load a package body or type body the corresponding spec will be loaded. be prompted to split files. use file splitting tags. Show Navigator Panel Default – Checked If checked. displays the Navigator hierarchy of package procedures and functions in the panel that is to the left of the Stored Procedure Editor. . Always load Package or Type Spec and Body as pair Default . The File Splitting options let you choose to automatically split files. once a line of tabs is full the editor tabs will display on multiple lines. This lets you click the procedure names in the navigator to advance the editor to that section of source. Use multi-line tabs in the editor Default .

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 Format Statement TOAD’s internal formatting mechanism only supports single DML statements (update. You can also press F10 to display the right-click menu. If the item is a procedure. it displays the procedure popup window.Chapter 7 Procedure Editor 167 Right-click menu Right-click while you are in the Procedure Editor to access the right-click menu. insert. Formatting Tools will display in the menu instead of Format Statement. Many of these items are the same as the items found in the SQL Edit window right-click menu. If you use the internal formatter on anything other than individual DML statements you will get errors. . This provides a shortcut to the functions listed in the menu. Some of the functions that the menu contains are: Describe Displays popup window that describes the selected object. delete). If you have PL/Formatter or Formatter Plus installed.

Debug Panel. "END" for matching "BEGIN" or "END IF" for matching "IF” Procedure Editor Desktop Lets you show/hide the Navigator Panel. and Status Toolbars and includes a Customize Toolbars menu item Read Only Toggles a File’s Read-Only status .168 Find Closing Block Finds closing parenthesis.

Right-click to display the right-click menu for the Procedure Editor. Select Paste from the right-click menu OR the Edit menu. The Procedure Editor right-click menu lists DBMS_OUTPUT specific commands. Oracle provides a package. etc. delete specific lines of output. It uses a buffer that your PL/SQL code writes into. and paste keys work in the DBMS_OUTPUT textbox.Chapter 7 Procedure Editor 169 DBMS Output You get to this dialog via the View > DBMS Output menu item. To create a DBMS_OUTPUT statement 1 2 3 4 5 Highlight the desired selection from your SQL script. . You can edit DBMS_OUTPUT content. which is specifically designed with functions for debugging PL/SQL code. not while you are single stepping through the code. called DBMS_OUTPUT. make comments. Click the place in your script where you want to paste the DBMS_OUTPUT statement. all procedures must have run to completion before any DBMS_OUTPUT content is displayed. The standard copy. Select the Make Output Statement item. cut. and then a separate process queries the buffer out and displays the contents. Output only comes out after the procedure has completed execution. In nested procedure calls.

and the blank DBMS_OUTPUT Statement is pasted into your script. which you paste into your script and fill in the blank sections yourself. Select Paste from either the right-click menu or the Edit menu. Click the place in your script where you want to paste the statement. .170 Blank Output You can also select Blank Output to get a DBMS_OUTPUT template. To create a Blank DBMS_OUTPUT statement 1 2 3 Right-Click and select the Blank Output Statement item.

In the Title box type in a title such as "Unit Test in utPLSQL" In the Program box type the path to SQL*Plus Type the following in the parameters box: $UID/$UPW@$SID @c:\utplsql\runtest $FIL where the path to runtest is the one you chose above* Click in the shortcut box and type in the desired shortcut. Press OK to finish. such as: C:\Program Files\Quest\… then you must use single quotes in the parameters box. You can get more information about the background of utPLSQL at: http://oracle. 1 2 3 4 5 6 Save the script (on the next page) as C:\utplsql\runtest (or any other valid windows filename) Click the menu dropdown for Configure/Execute tools and select Configure. The Tool Properties window opens. . 7 8 * NOTE: If you install the runtest script in a directory that uses spaces. provides support for these instructions and for the script. Any support issues for utPLSQL should be directed to one of the aforementioned Web sites. a unit testing framework for PL/SQL applications. Click the Add button.net/projects/utplsql/ Please note that Quest Software. The Tools Option window opens. where you can download utPLSQL and the latest script at https://sourceforge.oreilly.Chapter 7 Procedure Editor 171 utPLSQL TOAD works with Steven Feuerstein's open source utPLSQL program. To run utPLSQL from the toolbar/shortcut Chris Rimmer created the following steps and script. Inc.com/utplsql You can visit the open source project home page.

1).'. / pause Press ANY KEY TO CLOSE EXIT .2 --This file takes the given filename. 1. strips off its directory and --extension and calls utplsql.test(filename). prefix_len PLS_INTEGER := LENGTH(utconfig.prefix). --Strip off the extension dot := INSTR(filename.test ('mypack'). END IF.pkb). END IF. BEGIN --Strip off the directory slash := INSTR(filename. --Now run the test utplsql.prefix THEN filename := SUBSTR(filename. then the $FIL parameter should be surrounded by single quotes: $UID/$UPW@$SID @'C:\Program Files\Quest Software\utPLSQL\runtest. --Chris Rimmer 15 Feb 2002 SET serveroutput ON SET verify OFF DECLARE filename VARCHAR2(100) := '&1'. IF slash <> 0 THEN filename := SUBSTR(filename. This relies on you using a naming convention where the package name is reflected in the file name. '\'. If the packages to be tested or the unit test packages are in a path which contains spaces.test with the result. dot .SQL Version 1.1). IF dot <> 0 THEN filename := SUBSTR(filename. END IF. dot PLS_INTEGER. or its unit test package (such as ut_mypack. 1). --Strip off ut prefix IF SUBSTR(filename. slash PLS_INTEGER. '. END. 1.0. 1.sql' '$FIL' Now when you are editing a package file (such as mypack. slash + 1). prefix_len) = utconfig. -1. prefix_len + 1). This script works with TOAD: --RUNTEST.pks) it will run utplsql.172 The same rule applies for your source code.

For example if you are using Microsoft Visual SourceSafe. .140 (ComponentSoftware) Personal Version NOTE: Earlier versions of these software products have not been tested with TOAD. and Add File. NOTE: The client portion of the Source Control install must be run.7 (requires the VM Development Interface) StarBase StarTeam 4.0 PVCS 6. right-click on a folder. Working Folder You must have a working folder set in order to use the TOAD Source Control interface. The following vendors support SCC API and have been tested with TOAD: § § § § § Microsoft Visual SourceSafe 6. a Microsoft API.5 (Quma) (use the QVCS client to add QVCS as a Source Control Provider) CS-RCS 2. Check-in. Other vendors might conform to the API but have not been tested with TOAD. integration cannot be guaranteed at this time. to set your working folder you would open Microsoft Visual SourceSafe.2 (requires the Developer Studio Integration option) QVCS 3. The SCC API provides functions to perform the common source control operations such as Check-out. You cannot run only the server piece of the Source Control install. and we cannot guarantee their compatibility. and select the Set Working Folder option.5.Chapter 7 Procedure Editor 173 Source Code Management TOAD supports the Source Code Control (SCC). therefore. 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. It defines a standard interface between development environments and source control products.

Check file out of source control Check file into source control All the other functions are on the right-click menu. The toolbar on the Procedure Editor contains the check-in and check-out buttons. . To set the Source Control Options 1 Select the Source Control Provider that you wish to use with TOAD from the dropdown. If you switch providers. and it is made writeable. 2 Source Control is run through the Procedure Editor. the file is reloaded from disk (it could be different than the file that was loaded). The Prompt for Comment checkboxes let you determine whether or not a dialog will display that lets you store comments with the respective action.174 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. 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. Check-in File When a file is checked-in. The Source Control Provider dropdown lists the SCC providers found in the registry. it is set to read-only again. you should restart TOAD.

Read-only files cannot be edited.ini file between TOAD sessions. Select project This produces a dialog (provider-specific) to let you select a source control project to work with. it only works with files. Confirm your client is configured to support SCC API. Go to View > Options > Source Control. if you do not want any changes stored to the database. Add File This adds the current file to source control and reloads it read-only. Select your SCC provider and check/uncheck options as desired. for example. All the SCC functions act upon the currently loaded file. You confirm this by confirming that the client or the client install has created this registry key. Steps for using Source Control from TOAD for the first time 1 2 3 4 Install your client. A file that is not checked out should have a read-only status. original version. Source Control functionality does not work with database objects.Chapter 7 Procedure Editor 175 Undo-checkout This command throws away any changes and reverts to the read-only. This is useful. The selected project is retained in the . . Get latest version This refreshes the file from the source control and reloads the file (still readonly).

Refer to your provider’s documentation if you need further details. Right-click in the Procedure Editor and choose Source Control > Select Project. It might provide a place for you to set a working folder. 8 If the file is already stored in Source Control. Otherwise. Remember. you can right-click and select Source Control > Add File to add it into Source Control. This assigns it a checked in status. it might also ask you to log in or browse for a database. NOTE: The working directory for the selected project must match the directory that you loaded the file from. Your SCC provider will display a dialog that will ask you to select a project. and you will have to check it out to modify it .176 5 6 7 Load the file that you want to work with into the Procedure Editor. you can check it in or check it out. Depending on the provider and the configuration. Source Control is run through the Procedure Editor.

Team Coding includes Flexible Code Control Groups that help you control objects from one or more schemas. Team Coding works with the Procedure Editor to control access and development of functions. It provides more features in a more integrated environment. Team Coding lets PL/SQL developers develop stored programs without concurrently modifying the same objects. and more. lets multiple Oracle users work on a Team Coding controlled project in their own schemas. With a third party version control product Team Coding allows a revision history to be kept for your code. packages. 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. and places script files under code control. procedures. lets you launch the third-party provider's browser. It also works with the Schema Browser > Favorites tab. Team Coding does not have to replace TOAD's version control. . triggers.Chapter 7 Procedure Editor 177 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. For more information about Team Coding refer to TOAD Help. using customizable groupings.

lets you step through the code as it executes. debugging begins and stops on breakpoints. You can also set argument values in the Set Parameters dialog. for functions that depend on the argument values. If you have the Debugger installed. logic. The PL/SQL Debugger.178 Optional PL/SQL Debugger The PL/SQL Debugger is an optional feature for TOAD. Objects you can Debug § § § § § Top-level Functions Top-level Procedures Package Functions Package Procedures Triggers . The Debug menu is only enabled in a Procedure Edit window. For all databases. you must have the Oracle Probe API installed in order to debug PL/SQL using TOAD. line-by-line. or it runs to the end. You can also set conditional breakpoints and apply pass counts. etc. statement-by-statement. After the procedure has executed. Unless you specify parameter values in the Set Parameters dialog. and it will use those values. which is run in the Procedure Editor window. as appropriate. and delete breakpoints. You can also access the Debug menu using the keyboard by pressing <ALT>U. you can view the DBMS_OUTPUT from the server. You can add. you can still check the branching. You can run a debug session with or without argument values. So. they will default to NULL values. the Debug toolbar displays to the right of the Procedure Edit toolbar in the Procedure Edit window. With the click of the toolbar button. edit.

Chapter 7 Procedure Editor 179 Objects you cannot debug § § Java classes Anonymous PL/SQL blocks Right-click over the editor. 2 3 4 If you want to step into other procedures and view debug information. Load a PL/SQL procedure into the editor or write a new procedure. and several Debug functions will appear on the submenu. TOAD generates the symbol table required to obtain debug information for this procedure. Compile the procedure by Pressing F9 OR Clicking the Compile button on the Procedure Editor toolbar. 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. you’ll need to click the Compile Dependencies with Debug toolbar button before beginning the debug process. select Debug from the menu. Press F7 (Trace Into) to start stepping through the code. . To start the Debugger 1 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.

The View > Options > Debugging > Show executable line indicators in gutter option (available for Oracle 8. This indicates where breakpoints may be set in the code. 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. compile it once again by toggling the Debug button on the main toolbar to the off position and pressing F9 to discard the symbol table. if you haven’t set any breakpoints you might want to use the Step function <F8> instead of the Execute function <F11>. the procedure will execute to completion.1. To avoid this confusion.180 When you begin debugging. a tooltip pops up that tells you what the value of that variable is at that point in the code. NOTE: When debugging a procedure. if no breakpoints have been set and no errors occur.7 and later) will display a small blue dot in the editor gutter for an executable line of code. When you finish debugging your PL/SQL code. watched variable values in the dependent procedures will have “no debug information” displayed in the watches window. Otherwise. 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. and it appears to have “done nothing. .” This is a common cause of confusion when people first start using the Debugger. Checking this option can cause the Debugger to run slow.

“Valid” or “Invalid” displays. To view the DBMS_OUTPUT 1 2 Select Debug > DBMS Output. . To return the windows to their docked as one position. 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. after execution of the procedure has completed. If you are not debugging a procedure. The Dockable Windows There are four stay-on-top windows in the Debug menu: Breakpoints. DBMS Output DBMS Output is also discussed in the Procedure Editor chapter. You can display all the windows at once. and DBMS Output. A right-click menu item lets you Dock to Procedure Editor which groups and docks all four windows.Chapter 7 Procedure Editor 181 The Status Panel Indicators When debugging PL/SQL code. drag them by their tabs and place them on top of each other. the word “Running” displays in a segment of the Procedure Edit window status panel at the bottom of the window. Watches. Call Stack. The DBMS Output dockable window displays with the variable value listed. You can double-click on a floating debug window's title bar to dock it. This creates a tabbed interface to the separate panels.

This will make your code smaller. so it will run faster. . This recompiles it without the debug symbol tables. compile your procedure and any called procedures one last time with the debugger toggled off.182 Preparing PL/SQL Code for Production Once you have finished debugging your PL/SQL code. For more information about the PL/SQL Debugger refer to TOAD Help.

Chapter 7 Procedure Editor 183 Procedure Editor Tasks This section demonstrates how to create a few simple functions using the Procedure Editor (converting temperatures from Fahrenheit to Celsius and from Celsius to Fahrenheit). the procedures are the temperature conversion functions. The Conversion Formulas Celsius = (Fahrenheit-32) * 5/9 Fahrenheit = (Celsius * 9/5) + 32 Stored procedures are useful for processes that will be repeated over and over again. In this example. .

From the Object Type dropdown menu select function.) 7 8 After F_TO_CELSIUS on the first line. OUT_CELSIUS := (5/9) * (IN_FAHRENHEIT – 32). type the following: (IN_FAHRENHEIT NUMBER) After RETURN NUMBER IS type the following: OUT_CELSIUS NUMBER Your code should now look like this: 9 Scroll past the comment section and after the BEGIN statement edit the next line (it contains a tmpvar holder) to match the following formula. Type in the function name “F_TO_CELSIUS”. The New Procedure Create Options dialog window displays. .184 F_TO_CELSIUS First. A template script displays with F_TO_CELSIUS in the Create or Replace line. 10 after RETURN type OUT_CELSIUS Notice the END statement has been automatically filled in. (Now you need to edit the script with the input and return arguments. Click OK. To Create a New Procedure 1 2 3 4 5 6 Click the Create a new procedure button. you need to create a new stored procedure function that will convert Fahrenheit to Celsius.

copy the code you’ve just created. all extra comments and spaces have been deleted. You can compile the script for a quick syntax check.) Then use the Edit/Replace function to change the copy of the Fahrenheit to Celsius script to a Celsius to Fahrenheit script. To Use Edit/Replace 1 2 3 Place the cursor on the text you want to replace. . Compile button This function converts Fahrenheit to Celsius. Type <CTRL>R or choose the Edit > Replace menu item. and you can correct and recompile. If you get errors. in this case F_TO_CELSIUS. Here. option New Tab. and paste it into a new tab in the Procedure Editor.Chapter 7 Procedure Editor 185 END F_TO_CELSIUS. The final script should look similar to this. they’ll display in the error panel. C_TO_FAHRENHEIT Now you can go to Edit > Select All and then Edit > Copy. The Find and Replace dialog displays with the selected item already in the Text to Find entry. (See the right-click menu.

The selection is already entered. Click the Replace All button to replace all occurrences of the text. which in this case would be IN_FAHRENHEIT. 10 Select the Replace All button. Type in IN_CELSIUS for the replacement. Confirmation dialogs will display. . compile the procedure. press ESC to close the dialog window. in this case C_TO_FAHRENHEIT. Press <CTRL>R to open the Find and Replace dialog. When you have finished replacing all.) The final script should look like the following: Next. Select your next replacement item. 11 Repeat the Find/Replace or manually edit to change the following: OUT_CELSIUS to OUT_FAHRENHEIT 5/9 to 9/5 – 32 to + 32 (You'll need to manually edit line 5 so that the formula is in the correct order.186 4 5 6 7 8 9 Type in what you want to replace the text with.

Chapter 7 Procedure Editor 187 Using the just created Celsius to Fahrenheit script. The Set Parameters window opens. and the dialog closes. A Procedure Completed message displays. you can test the function. Click OK in the Set Parameters window. such as 22. right-click. Type a value in the value cell. . Return to your Procedure window. and the return value is displayed. To input and output values 1 2 3 4 5 6 7 8 9 Open a DBMS Output window via View > DBMS Output.6 You can also test the functions in a SQL Edit window. Click OK. This adds a DBMS_OUTPUT statement. Check the Output OUT args checkbox. The value is automatically entered in the SQL Code panel. RetVal = 71. 10 Go to the DBMS Output window that you opened. A dialog displays with your argument filled in. but the Procedure Editor provides a shortcut to typing in your own anonymous PL/SQL block. and select Execute without debugging.

.

This eliminates having to drill down through hierarchical mountains to find the desired data. You can cancel certain long running list populating queries in the Schema Browser. 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. all views appear in the left panel when the Views type is selected. Keyboard users can easily use the scroll keys to perform the same tasks. . It also lets you compare details between objects of the same type with one click. For performance. TOAD delays fetching some schema lists until the dropdown or tab that requires that list is activated.8 Schema Browser The Schema Browser separates database objects by type. When you select an object. etc. Ways to invoke the Schema Browser window § § § Click the button in TOAD’s main toolbar. The Statement Processing popup will display which lets you cancel. details or the DDL structures for that object are displayed in the right panel. For example. Details for the objects are separated by tabs. all tables appear in the left panel when the Tables type is selected.

You can check or uncheck menu items to show or hide the tabs. When you exit. . an alphabetized dropdown. Any Schema Browser Object can be dragged and dropped into the SQL Editor. the window will hide the tabs that you unchecked in your previous session. Schema Browser options let you control how the object types will be displayed. This means that the procedure was compiled using the Oracle wrap utility and is not stored in readable format.190 Using the Schema Browser The object types that display in the left panel depend upon the database version. The vertical splitter between the objects panel and the details panel can be moved left or right via click and drag. The next time you run TOAD. In the non-tree view all the Object lists (left-hand side) can be sorted without requerying the database by clicking the column header. However. 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. When viewing Packages and Procedures. you might see "wrapped" rather than the code of the object. All the tabs that show in the details panel are details for the selected object. TOAD saves your options. all the objects in the list (left-hand side) have micro-help. You can also drag and drop multiple objects using multi-select (<CTRL> Click). or a tree view. You can choose a tabbed interface. deselect the rest for a cleaner interface. In the non-tree view. If you only want Views and Synonyms. you cannot hide the Tables tab. All the left-hand side Object lists (except Favorites) are now multi-select enabled. You can always show or hide tabs (for the tabbed view) or nodes (for the tree view) through the right-click menu. The default is a tabbed interface. hover the mouse over a table and it will display the tablename and the tablespace. For example.

The dropdown box above the Object tabs lets you select the desired schema. Panels Right-Click Menus The Schema Browser panels contain right-click menus. The right-click menu in the tree view display lets you configure which nodes of the tree view to show or hide. 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. 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 Tables tab is selected by default. You can press <F4> in the left-hand side lists to get describes for objects that have describes. Navigation When you first open the Schema Browser. You can rename these captions by simply clicking in a caption cell and typing. 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. . 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. have enhanced right-click menus that contain menu items for all the buttons on the objects panel and details panel of the page.Chapter 8 Schema Browser 191 You can double-click an object in the left-hand side list to get to the alter screen for the selected object. Many of the pages. and a list of all the tables in the selected schema displays. such as Tables and Views. In addition. 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 rename and rearrange tabs.

the “Table Name Select” dialog or the “Column Name Select” dialog.. e. select menu item View > Oracle Users List. The CNT on the status panel shows how many objects are in the object list for the object tab you’ve selected. This opens the Configure User Lists dialog where you can multi-select any combination of users you want to see. If you create a table and you don’t see it in your table list. It will bring up the “Select Session” dialog where you can then click the NEW button to create the new session. To set up a specific list of Oracle users (schemas) that you want to see. . Refresh Current List The Refresh current list button refreshes the objects panel (left panel) list. SCOTT_ORA8I. Refresh All The Refresh All button refreshes everything in the Schema Browser. The status panel shows what session you’re in. For details about “Show only schemas that own objects” see the Schema Browser options. The Change Active Session button has a dropdown button next to it. any dialog in TOAD that presents a schema dropdown list will be restricted to the schemas you select. click the change active session button. the Object tab window will be empty for that tab.192 If you want to narrow the list of schemas in the schema dropdown list you have two choices.g. From that point forward. e. subject to any active table filters. Its dropdown list displays all active sessions.LST.. in the TOAD\TEMPS folder.lst. You can click on a session from the list to change the active session. If an Object tab doesn’t contain any objects. Only show users that own objects in dropdown lists and Oracle Users List. If you want to create another session. click Refresh All which will requery. and the table name should display in the list.g. This list is saved and restored in a file named schema_databasealias.

or requeries. the filter is gray and it’s OFF. Filter § § § When the filter is red it’s ON. 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. Clear all data grid filters A button also lets you clear all data grid filters. ascending/descending empty. only the details panel. The filter can display four states: empty. On the Schema Browser page Tables > Data tab and Views > Data tab. Here. you can click on the Refresh Detail button to see the refreshed list. filtered. When there are no filters. You can expand and collapse individual nodes or all nodes. a four-way filter button displays a dialog where you can sort and/or filter. 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. When the filter funnel is gray it’s OFF. the data is sorted ascending/descending but not filtered.Chapter 8 Schema Browser 193 Refresh Detail The Refresh Detail button refreshes. If you dropped a column. ascending/descending filtered. .

194 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. . Data tab Omit SYS objects from the Procedure Dependencies List Default . DBMS_STANDARD. DBMS_UTILITY. when you select an object from the objects panel TOAD will auto refresh the details panel. etc.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). Save data grid layouts Default – Unchecked When checked. The options are on 2 pages accessed via the Data and Visual tabs. TOAD will automatically save the Data tab grid layouts with respect to column order and custom column widths. Auto refresh details after selecting object on left hand side Default – Checked If checked. such as standard packages.

FLT in the \TOAD\TEMPS folder. when you change sessions within the Schema Browser the selected schema will be the same. So. Only show one Schema Browser per database connection Default – Unchecked If checked. .Chapter 8 Schema Browser 195 Save Browser filters Default – Checked If checked. uncheck this option. If the user tries to create another Schema Browser window. This conserves operating system resources. TOAD will save the browser filters to disk in files named SCHEMA. buttons. the use of cursors. Use same schema after changing sessions Default – Unchecked If checked. because the Schema Browser is loaded with widgets. TOAD will only permit one Schema Browser window to be opened per Oracle connection. and bitmaps. is much faster than forcing Oracle to reparse and re-execute different queries each time. TOAD will just switch to the existing Schema Browser window. only the object name changes from query to query. and one is already open. where only the bind variable values change. 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. TOAD will use cursors when retrieving detail information to display in the details panels to the right of the Schema Browser window. If you want to reset your Schema Browser filters each time you close and open TOAD. Cache cursors used for queries (faster Browser but uses 12 cursors) Default – Checked If checked. Usually.

Include disabled FK constraints in data grid lookup window Default .Unchecked If checked. BLOB. disabled function key constraints will be included in the data grid lookup window. will use NOPARALLEL hint in the data grids. and NCLOB type columns will be excluded from the query for the Data tab in Tables and Views pages.Checked If checked. Use NOPARALLEL hint in data grids Default . Set focus to table data grid after selecting table 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.Unchecked If checked. . the focus will remain on the list of tables. Don't select BLOB/CLOB fields in data grids Default .196 Automatically show filter dialog for filtered lists on Browser Default – Unchecked If checked. then the Schema Browser will open with only those objects matching the filter. after you first pull up the Schema Browser page and select a Table 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. CLOB. BLOB and CLOB data types can be large and can take a long time to load.

If you respond yes. then a prompt will ask you if you want to keep fetching rows. e. It will fetch that number (n) of rows. User/Schema Lists Default – Show all users Radio buttons let you choose Show all users. or Only show users that own objects excluding Synonyms. . if it exists (db level option): textbox This lets you enter a default schema for the Schema Browser. it fetches n more rows and then prompts again. Limit grid fetch ___ fetches (25 records) Default – Unchecked If a value is entered.Chapter 8 Schema Browser 197 Default Browser to this schema. Milliseconds for List Search Timer on LHS Lists You can select how many milliseconds for the list search timer. the SQL results grids on the Tables > Data tab and the Views > Data tab are limited to that number of rows. This option does not affect the SQL results grid on the SQL Edit window. "Table Name Select". The spinner range is 500 to 20000 milliseconds.g. This option affects all windows in TOAD with Schema dropdown lists. Only show users that own objects. etc. "Column Name Select". This filter makes the schema dropdown list more manageable.

length. columns will show in the columns tab in the format "VARCHAR2(20)" including max length. TOAD will display the list of Primary Key columns on the Tables/Columns tab to the right of the Show Comments dropdown list. scale. toolbars will display above object lists on the objects panel. Show object create/alter dates on the right hand side Default – Checked If checked. . You can also check this ON or OFF via checkboxes on the Stats/Size tab. TOAD will show the table stats information. will display the date and time objects were created and updated on the details panel above the tabs. and precision (if applicable). this label might not be long enough. Show Column Length Info with Column Data Type Default – Checked If checked. scale. For some tables with long column names and/or compound primary keys. Show Primary Key Columns for tables Default – Checked When checked. and precision will display in separate columns in the grid. If unchecked. Show Table Stats for Table Details (on the Stats/Size tab) Default – Checked If checked.198 Visual tab Show toolbars above object lists on left hand side Default – Checked If checked.

Enable DROP ALL buttons Default .Unchecked If checked. . TOAD will automatically size the width of the list view columns in the details panel to the width of the text. corresponding tablenames will display after trigger names on the triggers object list. Sys Privs.Constraints.Chapter 8 Schema Browser 199 Show table names following Trigger names Default – Unchecked If checked. Sys Privs. Sort package procedures alphabetically Default . and Indexes tabs and the Schema Browser > Snapshots . Drop All buttons in the Schema Browser are in the details panel of the Schema Browser > Tables .Indexes tab. Triggers.Unchecked If checked the Schema Browser Drop All buttons will be enabled for the current session. package procedures will be sorted alphabetically.Unchecked If checked. and Resource Group tabs. and Resource Groups tabs Default . Only show top level grants for Users. will only display the top level grants on the Users. Auto-size list view columns Default – Unchecked If checked. Roles. Roles.

Dropdown Object Type Selection (the object types will display in an alphabetized dropdown list). If checked. once a line of object tabs is full. . or Tree View (a tree view style display).200 Browser Style radio buttons Radio buttons let you choose Tabbed Object Type Selection (Schema Browser object types will display in a tabbed interface). If you choose Tabbed Object Type Selection you can also choose to Use Multi-line tabs on the left side. once a line of object tabs is full the schema browser tabs will display on multiple lines. the tabs will display with a horizontal scroll bar. If unchecked.

TOAD will confirm any DROP operation on the Schema Browser. The Create Script button on the objects panel is used to generate a script.Oracle Statements to recreate the object -. The drop all buttons are disabled by default. . Dropping Objects Many objects can be dropped directly from the Schema Browser. the button is enabled whenever an object is selected in the list.for most of the objects displayed on the Schema Browser. Triggers.Chapter 8 Schema Browser 201 Objects Object Scripts TOAD can create DDL Scripts -. and on the Snapshots page . The scripts are always copied to the clipboard by default.Constraints. The drop all button is on the Tables page . 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. They will only be enabled if you check the Enable drop all option in the Schema Browser options. NO DROPS CAN BE REVERSED.Indexes panel. but after you respond Yes to the confirmation. 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. and Indexes panels. When an object has a drop button.

For example. For example. you might have hundreds of tables in a schema but only want to see those where the table name begins with "GEO”. if your filter is set to display only tables that begin with GEO. . also affects the table lists throughout TOAD. Synonyms can be filtered by Synonym scope: owned by schema only. This means you can define a filter for the schema DEMO and a different filter for PRODUCTION.202 Note that the listview displays for Table Information work differently. Not only is the display refreshed faster. For example. you can <CTRL> Click to select more than one column and then press <CTRL>C. although primarily intended to filter the Schema Browser window. and the appropriate filters will be loaded when you view that schema in the Schema Browser. owned by schema plus Public synonyms. if you are viewing a grid display of a list of columns for a table. with commas in-between (a comma-delimited list). Table Filters allow filtering on table names as well as column names. This will copy your selected columns to the clipboard. The browser filter. For example. Schema Browser filters are specific to a schema/owner name. The table name may also be searched. the query fetches fewer rows for faster response from the database. every table list will display a filtered list until the filter is changed. you can find all tables that have columns with FND_NO anywhere in the column name. they also modify the query used to fetch the data. Constraints can be searched by constraint name or constraint column name. The grids that display Table Detail Information support multi-row selection and always copy the first column to the clipboard. exclude SYS and SYSTEM synonyms. They can be filtered to show a subset of all the like objects in the schema. Filters All Object tabs in the Schema Browser have a filter. etc. Then you can paste the list into a SQL Editor or another application. The filters not only reduce the amount of data displayed.

You can change the Where or Order by clauses. Constraints. click the OK button. . To apply the filters. you must click the Filter toolbar button on the desired object tab.. You should not change the select list.Chapter 8 Schema Browser 203 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. TOAD will show you the query which is about to populate the browser. If you click View/Edit Query Before Executing. e. and the browser filters are applied.g. to bring up the Schema Browser Filters dialog where you can select the filter options.

Edit Custom Queries window The right-click menu also lets you edit custom queries via the Custom Queries > Edit Custom Queries menu item. and select/add variables while you create your query. . The query is built with your selected objects and placed into the SQL Editor for editing or running. A new blank query will display. Enter your new query name and the query. Select from a list of default queries. select the objects that you want to use for the query. To create a custom query 1 2 3 In the objects panel (left hand side) of the Schema Browser. Click the Post Edits button to create the query and add it to the selection list. The query is created and loaded into the SQL Editor.204 Custom Queries The Schema Browser lets you create custom queries. The window lets you rename a query. Right-click and select Custom Queries from the right-click menu. To create a new query template 1 2 3 From the Edit Custom Queries window click the Add Query button. You can now use your new query the same way you would use one of the standard provided queries. select/deselect Oracle versions.

To lookup foreign keys 1 2 3 4 5 6 In the Schema Browser. click the Tables tab. To filter rows by editing the query 1 2 3 4 Click Edit Query. Select the table that you want to edit and in the details panel click the Data tab. the data will be entered in the appropriate columns in the data grid. Edit the query within the editing window. Click in a column that has foreign keys. Click OK to run your new query and filter the lookup grid. Check syntax accuracy via the Check button. A drill down button displays. The Foreign Key Lookup window includes all foreign key constraints. Specify variables by clicking the Variable button and entering variable information. (You can exclude disabled constraints via the Options > Schema Browser > Data window). Click again to activate Editing mode. (If the box is checked and you type EMP it will filter out rows that do not begin with EMP). Click the drill down button and it will bring up the rows in the referential table. This lets you see and choose values. The filter by box lets you filter by typing. When you select a row and click OK.Chapter 8 Schema Browser 205 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. .

The steps include a job to truncate the table. .206 Tables This chapter discusses the Tables tab in detail and then summarizes some of the other tabs. jobs to deallocate the unused extents in increments over a number of days. The Incrementally drop table menu item invokes the Deallocate Table Extents window. a warning dialog displays. If the table is not large enough to drop incrementally. You can only incrementally drop tables with greater than 200 MB and greater than 1000 extents. 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. and a job to drop the empty table on the last day. 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.

The Long date format checkbox is checked by default. uncheck the box. (If the table is not large enough to drop incrementally. The spinner lets you select from 5 to 14 days. Click Yes. or to delete the procedure. If you prefer the short date format.) The Deallocate Table Extents window displays. A confirmation dialog displays. You can delete the incremental drop by deleting all related jobs in the list. The last several jobs on the jobs list will be deallocating and dropping the selected table. check the Jobs tab. . Use the Over this many days spinner to set the number of days you want the deallocation process to take. 5 6 Use the At this time spinner to set the time of day that you want to start the deallocation process. Click Execute. 7 To confirm that the procedure has been scheduled. Select the Incrementally Drop Table menu item. a warning dialog will display.Chapter 8 Schema Browser 207 To incrementally drop a table 1 2 3 4 In the Schema Browser > Tables page. The process is scheduled. Select the Begin the deallocation/drop process on date from the calendar dropdown. right-click on the table you want to drop.

then click the Execute button to create the Table. a script is created for your table that you can then paste into the SQL Editor or elsewhere. Grants. The Output tab lets you output the table script to Clipboard. Include Drop Statement. Private Synonyms. You can also access this window from the Create > Table menu item. Individual 'Alter Table' Commands. A Constraints panel lets you include the different types of constraints and has the following radio buttons: List constraints following table columns. Public Synonyms. see the Database > Export > Table Scripts menu item. 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. For creating multiple table scripts.208 Objects Panel Create Script The Create Script button displays a Table Script Creation window with the Options tab selected by default. and more. File(s). or Screen. and Script Comments. Click the Execute button to generate the table script. This window lets you create a new Oracle table. Sort for Creation. This is easier than remembering the Oracle syntax for this command. When you select the Execute button. Use the dialog to enter the table information. The Options tab contains many options including Include Schema name. . and One big 'Alter Table' Command. NOTE: Most but not all Oracle clauses are not supported for object DDL scripts. An Inclusions pane lets you include Table Comments. Create Table The Create Table button invokes the Create Table window.

the Export Data button was clicked. . select a table from the objects list and click the Alter Table button. modify. but you are using it to make modifications. The Export Data button displays the Data Export window for whatever table is selected from the left panel of the Tables page.Chapter 8 Schema Browser 209 Alter Table The Alter Table button invokes the Tables window which lets you drop. add not null constraints. It is the same window as the Create > Table window. The Table window will automatically display the Schema and the Name for the table you selected. To alter a table. Export Data The Export Data function creates “INSERT INTO” SQL statements for the data in the selected table. and add columns. Here. and set unused columns. change storage parameters and data type sizes. and this was the resulting Data Export window. the User Profile object was selected.

this choice will not be enabled. TOAD will exclude null columns from the columns clause and the values clause of the “INSERT INTO” SQL statement. If you do not have any primary key columns. NULL_COL_TEST ) VALUES (7. INSERT INTO Foo ( ID ) VALUES (8). . INSERT INTO Foo ( ID. E. and VARCHAR2 object types. 2). DATE. If you then check a primary key column. You can then selectively check/uncheck the columns you want to include/exclude.. INSERT INTO Foo ( ID. TOAD checks all the columns by default. INSERT INTO Foo ( ID ) VALUES (5). Exclude Primary Key Columns If checked.210 The Data Export window supports NUMBER. FLOAT. INSERT INTO Foo ( ID ) VALUES (9).g. 1). Exclude Null Columns If checked. your primary key columns will be unchecked. CHAR. NULL_COL_TEST2 ) VALUES (6. this box gets unchecked. Select All /Unselect All The Select All and Unselect All buttons let you quickly Select or Unselect all the columns. INSERT INTO Foo ( ID ) VALUES (9). Columns Tab You can check/uncheck columns you wish to include/exclude.

Foo ( ID ) VALUES (5).. Example: WHERE INVENTORY_NUMBER = 943 Destination Default – To File The Destination radio buttons let you choose between To Clipboard or To File. Include Schema/Owner Name in Insert Statements When this radio button is selected..g. . you must include the word “Where” in your statement. clause The Where clause is optional. If you include a Where clause. Insert COMMIT statements every __ rows spinner This spinner lets you designate how many insert statements to generate before generating a commit statement.Chapter 8 Schema Browser 211 Options Tab Where. E. the Schema or Owner Name will be included in insert statements.. You must supply a file name. Filename The filename area has a drill down button where you can drill down to the desired file. INSERT INTO Schema. You do not have to include a Where clause.

This is useful when applying changes to multiple users. If you are not the object owner. but you will still be able to view everyone’s privileges for that object and you will also be able to rearrange columns. . you will get a warning message. grant. You can view all users and their privileges. you cannot grant privileges that you don’t have the grant option for.. You can multi-select users using the <CTRL> key. The Revoke All button will revoke all privileges from everyone but you. right-click in the column. and revoke privileges for the selected table. and grant or revoke from the right-click menu. Grants will be highlighted in blue and admin grants will be highlighted in yellow. You can rearrange columns by clicking and dragging on the column headers. Table Privileges The Table Privileges button activates the Privileges window. If you only want to see the rows of users who have grants you can check the Show only users who have grants assigned checkbox. This window lets you view.212 Show Table in ER Diagram This shows the selected table in an ER Diagram. The Show SQL button lets you preview the SQL before applying changes. You can multi-select the users. If you do not have sufficient privileges to alter an object.

Chapter 8 Schema Browser 213 Create Constraint The Create Constraint button activates the Create Constraint window. Use this dialog to analyze the selected table from the tables object list. Click Yes to create the synonym or No to Cancel. 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. compute statistics. 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. You can either estimate statistics (faster than compute). or delete current statistics. the optimizer can run better queries. Use this dialog to create additional table constraints. You can also get to this dialog via the Create > Constraint menu item. . 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. This collects statistics so that COST based query optimization can be used. So. To analyze all tables in the current schema or other selected schema.

Not Like sets up the tablename query like this: [not like KEYWORD%]. then they are joined together with an AND statement in the SQL as opposed to an OR statement in SQL. Synonyms. Triggers. and Constraints. 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.214 Table Filter The Table Filter button displays the Browser Filters window for the Tables. simply select the filter button. .. After you set your filters. Rebuild Table This button invokes the Rebuild Table window. For example. e. Procedures. and click the Show Default Filter button.g. clear the filters by selecting Clear where you have filters. To set up a default filter. All the Browser Filter windows have a similar interface. Set up your default filters and press OK to close the window. the faster it will execute. To view all the objects again.FLT in the TOAD\TEMPS folder where SCHEMA is the schema name. The Browser Filters button can be found on the tabs for Tables. select OK and the browser displays the resulting objects. Views. The filter is stored in a file named SCHEMA. and select OK. table name and tablespace name. you can narrow the focus to only tables whose names begin with EMP and temporarily ignore all other objects in the schema. These filters will be set up by default each time the Schema Browser window is opened. go to View > Browser Filters. Browser filters are helpful for schemas that contain a lot of objects— the fewer objects that TOAD needs to load. If you select multiple filters.

.Chapter 8 Schema Browser 215 Compile Dependencies If your table is called by a Procedure or View this button will compile those dependencies. Once you click the Execute button you can’t rollback or undo your choice. 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. Once you select Yes the table is dropped and cannot be retrieved. The following dialog will display when you select the button. A confirmation window will ask you if you are sure you want to drop the table. Drop Table The Drop Table button lets you drop the selected table directly from the Schema Browser.

precision. Default value.5)” through the TOAD Option > Schema Browser > Show Column Length Info with Column Data Type setting. You can type directly into this panel to edit the various comments. It also displays each column Data Type whether or not the column accepts Null values. press <CTRL>C to create a comma-delimited list of columns to the windows clipboard and paste the selection into an editor. . precision. 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 multi-select columns. The dropdown default is Show no comments. and column comments. Primary Key columns are indicated by PK column numbers in the PK column. just select a different column or table. if any. To save the comment edits. column attributes (such as length. You can change the length.Columns The Columns tab lists all the columns for the selected table. A label to the right of the Add and Drop column buttons in the details panel displays the Primary Key column name(s). Table . scale).216 Details Panel The Tables details panel has tabs for displaying different details about the selected table. scale display to “NUMBER(10.

If you want to see the resulting SQL script of your command. and other appropriate information. 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. select the SQL tab. Character Default Values have to be wrapped within single quotes in order to make a valid "ALTER TABLE. To Add a Column 1 2 Enter the column name. Click the Execute button to add the column. and the Size.Chapter 8 Schema Browser 217 Table . The Nullable radio button is selected by default. You must enter the Column Name..Columns Details Panel Buttons Click the Add Column button to display the Column Definition window. The panel also contains a Clear Filter button. . and you can click the Clear Filter button to clear the filter. If it is red.1.5 or later. a filter is active for the data grid.." statement. data type. the Type. This dialog lets you add a column to the selected table.

the panel at the bottom lists the owner. and drop indexes. and column names that the foreign key constraint is pointing to. The editor at the bottom of the details panel lists the source code for the selected trigger. . the corresponding Column. Table . The Table – Triggers details panel buttons let you enable/disable triggers. analyze. and the Position. the Trigger Owner. drop triggers. and compile. It includes the Type. It also lists the Parameters and Values for each index. It lists the Constraint Name.Constraints The Constraints tab lists any constraints for the selected table. The list includes the Index Name. table. the Column(s). The Indexes details panel buttons include a Create script for selected index button and buttons that let you create. the Constraint Type. the Trigger Event. open a Procedure Editor window for the selected trigger. modify. The Table-Constraints details panel buttons let you enable/disable constraints and drop constraints. rebuild.218 Table . and the When Clause. whether or not it’s Enabled. For foreign key referential integrity constraints. and the Position.Indexes The Indexes tab lists the indexes for the selected table. Status. whether or not the index is Unique.Triggers The Triggers tab lists any triggers for the selected table. Table .

Double-click any data item to bring up a memo editor for that item. You can sort in ascending or descending order. Filter Tab . Grid configurations on this data tab are saved and restored from the TOAD\TEMPS folder structure. click the Clear Filter button on the Table Sort dialog.Chapter 8 Schema Browser 219 Table . This is similar to the SQL Results Grid on the SQL Edit window. check it to see if it parses ok. click the Clear Sort button. You can move items up and down the list. Single record view button Click on the book in the top left corner of the table to show single record views of the selected row. If you want to clear the entire filter for this table. Table Sort window Sort Tab To Sort. select the column(s) you want to sort and click on the pointing hand. The data in this grid is directly editable. You can easily rearrange columns by clicking and dragging on the column titles. and implement it via the OK button. because the query to populate the grid includes the ROWID column. Table . If you want to clear the sort column(s) for this table. The View/Edit query button opens the View/Edit Schema Browser query window which lets you edit the query.Data The Data tab displays the selected table with data in grid format.Data Details Panel Buttons The Filter Data toolbar button opens the Table Sort dialog where you can select the columns to sort and/or filter.

The Clear Filters toolbar button clears the filter criteria and the sort criteria. When finished. Data Details Panel buttons Continued The forward and backward buttons let you quickly move around from row to row in the recordset. You can further edit the resulting SQL right in the memo editor widget. If a table filter is in effect. the funnel icon on the Data tab will be red. click OK and the data in the grid will be sorted and/or filtered as specified. The filter tab provides dropdowns with additional filter choices. and Value to filter upon. The sort and filter criteria are saved in temporary files in the TOAD\TEMPS folder hierarchy. The Next Record button takes you to the next record in the recordset. . and so on. select the Column. Operator. See the Data Grids chapter for information on the Data Grids right-click menu. On the filter tab.220 You enter the filter criteria in the lower text panel. The First Record button takes you to the top of the grid (the first record in the recordset).

The GO (Refresh the Table Script) button refreshes the script.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. Once you click GO the script refreshes implementing the options you’ve changed and GO returns to its original gray color. This indicates that a change has taken place but is not yet reflected in the SQL script. The tab includes options.Chapter 8 Schema Browser 221 Table . updating any changes. the GO button turns red. When you change an option by either checking or unchecking it. The Copy Script to SQL Edit window opens a SQL Edit window and pastes a copy of the script into the window. .

Grants The Grants tab lets you view existing table grants and assign or replace existing privileges. Click Apply. and Privileges which opens the Privileges window. The privileges window for the selected table displays. Select an item from the dropdown. Tablespace.222 Table . Rows. A confirmation dialog will appear. Table . Table . To Add or Replace Privileges 1 2 3 4 5 6 Select the table from the object list. The Truncate Partition button lets you truncate a selected partition.Subpartitions This lists the subpartitioned columns. Click in the cell of the privilege you wish to change. have your DBA Grant select on dba_roles to schema. The display includes Subpartition Name. The Drop Partition button lets you drop partitions. If you cannot see any roles.Partitions This lets you see partitioned columns and partitions for the selected table. Partition Name. A dropdown displays. Click the Privileges button. Confirm by clicking OK. Revoke Privilege. The Grants details buttons include Revoke All. and Blocks. .

so you cannot drill down in the hierarchy endlessly (for example. which references manager_id. are captured. are displayed in the upper window of the details panel. which references emp_id. “+” on the keyboard expands one branch of the hierarchy. such as EMPLOYEE. Pressing the asterisk key. and the Size/Extents information. and <CTRL><SPACE> expands the whole tree. press <F4> and get a popup window describing the object in detail. Remember.Stats/Size The Stats/Size tab displays numerous statistics and size information about the selected table. The panel window columns are click and drag resizable. "*" will fully expand the current node. The two display options Show Stats and Show Size/Extents are checked by default. On each node of the hierarchy. Circular references. . The Stats. Table .Referential The Referential tab displays a hierarchy of tables and how the selected table is referenced by other tables and references other tables. such as SIZE IN BYTES and INITIAL EXTENTS.Chapter 8 Schema Browser 223 Table . You can select an item in the list. such as TABLESPACE NAME and NUM ROWS. This display is based on the existing foreign key constraints from table to table. are displayed in the lower window of the details panel. and a horizontal splitter is between them. there is a chain symbol for standard referential and a scissors symbol if the reference is Cascade on Delete.EMPLOYEE_ID. emp_id is referenced by manager_id. and so on).MANAGER_ID referencing EMPLOYEE.

224 Table -Used by The Used By tab shows the objects that reference the selected table such as views. the CUSTOMER table is selected in the objects panel. Here.Sales view. The Used By tab in the details panel shows that the CUSTOMER table is used by the Demo. triggers. . functions. procedures. and packages.

The Deps right-click menu lets you compile. Unknown Objects are listed as UNKNOWN. create a public synonym for the selected view. open the SQL script of the selected view in a SQL Editor. Deps (Used by). If there is a hierarchy of dependencies. views and synonyms. Script. The Dependencies tabs display the dependencies. Because the SYS/SYSTEM schemas contain a lot of synonyms. save. and drop buttons. display the privileges window for the selected view. the dependencies tree will display. users like to filter them out for easier navigation. the objects panel includes buttons that let you create the view script syntax. Grants. You can also get a popup describe window by selecting an object in the Deps list and pressing <F4>. The details panel displays details of the object the selected synonym is pointing to. describe. Synonyms You can create synonyms for the following objects: tables. packages. filter. the panel includes a Filters button which lets you filter out different types of synonyms. sequences. if the object is a view. So. the Show Public synonyms except those for objects owned by SYS/SYSTEM is selected by default. Deps (uses). procedures. The details panel also displays tabs and details associated with the object. functions. You can see details about synonyms pointing to tables. Data. compile. In addition to the basic create and drop buttons. The details panel includes tabs for Columns.Chapter 8 Schema Browser 225 Views In addition to the basic create. and copy the outline of a selected object. For example. and stored procedures. edit. the details panel will contain the same tabs the Object View tab displays in the details panel and the same associated details. Synonyms basically point to the original object. views. The symbol indicates a public synonym. . and Triggers. and compile dependencies.

function. Compile Spec Only. and Grants. The Compile button compiles the selected procedure. The Proc Edit button is enabled after you select a procedure. The details panel includes tabs for Code.226 Procedures In the left panel list of PL/SQL Procedures.1. select procedure B. and Packages. In addition to the basic save and drop buttons. and TOAD will recompile procedure A. and triggers for the current schema. A package body cannot function without a spec. The Compile Dependencies button will compile dependencies for the selected procedure. and click OK to execute the procedure. . the panel includes the following.7. Use this Privileges button to view or modify the privileges of the selected procedure to other user schema accounts or roles. Deps (Uses). click the Compile Dependencies button. Functions. function. A dialog asks if you want to compile the dependencies on the selected procedure. a pink X is for a Package that contains one or more invalid (red X) functions or procedures. or package. A dropdown lets you select to Load. Load Spec Only. Deps (Used by). On databases prior to 8. The Public Synonym button lets you create a public synonym for the selected procedure. The Compile All button compiles all procedures. Errors. or Load Body Only. or package. functions. The Execute Procedure button brings up the Set Parameters window where you can enter your arguments. Select Yes or No. it compiles only INVALID objects. The Procs Filter button displays a Browser Filter dialog for procedures. A circle with a slash through it in the left panel list indicates a package body that has no package spec. Arguments. For example. if procedure A calls your procedure B. A dropdown lets you Compile. It opens a Procedure Edit window for the procedure that you’ve selected in the objects panel. or Compile Body Only. packages. Refer to the icon legend (click the icon legend button) for more icon information.

load in the Procedure Editor. The Deps right-click menu lets you compile. table. table owner. the dependencies tree will display. describe. If there is a hierarchy of dependencies.Chapter 8 Schema Browser 227 The Dependencies tabs (Uses and Used By) displays the dependencies in the upper part of the panel. and copy the outline of a selected object. The Columns tab displays the column. compile. You can select an item in the Deps list. and usage. If you click on an error. . It also includes a Proc Edit (Trigger to Proc Editor) button that places the selected trigger in a Procedure Editor ready for editing. press <F4> and get a popup window describing the object in detail. The Source tab displays the SQL script for the selected trigger. filter. The trigger text is selectable via <CTRL>A and can be copied to the clipboard via <CTRL>C. and drop buttons. its location is highlighted in the script displayed in the lower part of the details panel. Triggers The Objects panel includes save. The details panel displays information about the selected trigger. The Errors tab displays the last errors that occurred when you tried to compile the selected procedure.

Yellow Square + Red Triangle + Blue Circle icons indicate UNIQUE indexes (vs. Indexes need to be periodically rebuilt in order to improve query performance. The Filters Indexes List button invokes the Browser Filters window that lets you filter Index Names and Table Names. non unique). In addition to the basic create. The Analyze Index button lets you collect statistics on the selected index so that COST based query optimization can be used. and drop buttons. the panel includes the following.228 Indexes In the list of indexes. The Create Script button copies the Create Index script of the selected index to the clipboard. Partitions. The details panel tabs include Column. . and Script. modify. So. and “f ( )” indicates function-based indexes. the optimizer can run better queries. "101" icons are BITMAP indexes. The Rebuild Index button lets you rebuild a table index. Refer to TOAD Help for more information about the Rebuild Index window.

an Oracle error message will display stating that you cannot disable constraints that have dependencies. Sequences Sequences are basically counters that Oracle maintains. You can enable/disable constraints. The right-click menu includes a Publish Java to PL/SQL menu item. The Constraints Filter button invokes a Browser Filter dialog window for constraints. The details panel has a Code tab.Chapter 8 Schema Browser 229 Constraints The Constraints tab displays the constraints in the objects panel. if any of the constraints you have selected to disable have dependencies. status. JAVA TOAD includes a JAVA tab for Oracle 8i and up databases. table and owner. . It lets you view the list of Java objects. and drop buttons. A red X displays next to disabled constraints in the objects list. When you disable constraints. In addition to the basic create. The buttons on the Grants tab in the details panel let you revoke privileges for the selected sequence or all sequences. alter. 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 details panel provides information about the selected constraint including its type.

which revokes the selected Role or Privilege (Revoke) or revokes all the Roles or Privileges (Revoke all). Links can be public (used by all schemas) or private (used only by the schema that created it). and Privileges. Resource Groups. The Roles and Privileges tabs contain Revoke and Revoke all buttons. Public links in the list have the symbol next to them. user name. and more. In addition to the basic drop button. You can lock and unlock accounts. host. DB Links are used in queries at the end of each table or view name. The details panel lists the owner. . You can view details for roles and privileges.230 DB Links DB Links lists all possible links from the database you are using. modify. The objects list right-click menu includes an Expire Account feature. 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. You can also create and copy the SQL script to the clipboard. The details panel contains tabs for Info. Locked accounts display in the objects list with a lock icon to the left of the name. Users You can create. You can copy (and then rename) users. Roles. and drop users. and the date and time the link was created for the selected DB link from the object list.

and INTERVALS. This feature is only available for Oracle 8 and higher databases. and edit user-defined datatypes. The objects panel lists user-defined datatypes in a hierarchical display.Chapter 8 Schema Browser 231 Jobs You can create. browse. Source for the selected job displays in the lower pane of the details panel. such as LOG USER. alter. You can also place jobs online or offline and view job details. depending on the item you select. You can set options via the View > Options > Types Tab page. execute. This feature is only available for Oracle 8 and higher databases. alter. and drop queue tables using Oracle’s built-in DBMS_AQADM package. This feature is only available for Oracle 8 and higher databases. Queue Tables This page lets you create. The details panel shows various parameters for the selected job. alter. . and drop jobs. Queues This page lets you create.0. The Edit User Type button invokes either the Edit Object Type window or Edit Collection Type window. Types This page lets you create. and drop queues and enable or disable enqueuing or dequeuing on those queues. Alter queue table is not supported in Oracle 8. using Oracle’s built-in DBMS_AQADM package. NEXT DATE.

The objects can be grouped into one or many folders. Many of the Schema Browser tabs include a right-click Add to Favorites list menu item. . The Details Panel displays the appropriate details. and right-click menu (which includes menu items that perform actions on the objects) for the object type. A script tab gives you the script to recreate the cluster and optionally the tables and index. It displays the clusters' columns and the tables and indexes involved. toolbars. Favorites The Favorites tab is a configurable tab that lets you add different objects from other Schema Browser tabs into one tab. The Create/Alter Clusters screen can be launched from the Clusters tab.232 Clusters This tab lets you quickly see all of the clusters in the database. The folders are specific to an instance. tabs.

Chapter 8 Schema Browser 233 Schema Browser Tasks This section will take you step-by-step through various tasks that you might want to perform with the Schema Browser. 2 Press <CTRL>C or select Edit > Copy from the menu. CITY. To copy table or view column names to the clipboard You can copy the column names from the list on the Tables/Columns tab or the Views/Columns tab via multi-select list and copy <CTRL>C. In this example. . To select more than one column. The selection is copied to the clipboard. and click on the ending part of the blocked selection. select the starting point. From Tables > Columns 1 Click the Column you want to copy. press <SHIFT>. ZIP_CODE. To select a continuous block of columns. press <CTRL> while clicking the columns you wish to select. the following selection is copied to the clipboard: CUSTOMER_ID.

you can export table data to either a file or the clipboard. If you want to filter out only certain records.234 To export table data in a certain order In the Data Export window. add an “ORDER BY” clause after the “WHERE” clause. TOAD adds the entire string onto the end of the SQL and executes it. which is accessible from the Schema Browser window > Tables page > Export Data button. . If you want to sort the data further. enter the WHERE clause in the where textbox on the Options tab.

. go to View > Options > Schema Browser and check Only show users that own objects in dropdown lists.g. views. and all other schemas are used as end-user logins. etc. e.. tables.Chapter 8 Schema Browser 235 To filter out schemas that do not contain objects from the schema dropdown list If you have a database where only a few schemas contain objects.

.

9 Other TOAD Options and Features The major windows covered in the previous chapters of this manual include: SQL Editor. and Schema Browser. This section will highlight some selected options and features found in other TOAD windows. . Procedure Editor.

The default is 10 point Courier. The File menu contains the basic file commands. Edit > Options Menu Application Options Editor Font button This option lets you set the editor font (top panel). Output background color dropdown You can change the background color of the output. Because of its small size. and all the other editor features found in the TOAD Editor Options window. If Quest ScriptRunner is not in your TOAD directory. The default is 10 point Courier. it will not include syntax highlighting. It lets you toggle between a full screen and split screen editor. It includes automatic formatting.238 Quest ScriptRunner Quest ScriptRunner is a low maintenance script execution utility included in your TOAD directory that lets you execute DDL and DML scripts. code templates. . hot keys. Output Font button This option lets you set the output font (bottom panel). several instances of Quest ScriptRunner can be running at one time. The Edit menu contains the basic text editing commands including Find and Replace. You can run it from the executable or from the command line.

or if the TOAD editor option files have been copied to the directory where Quest ScriptRunner resides. This option gives you access to: autoreplace.Unchecked If checked. So your TOAD options will override the fonts selections that are on this options page. Save previous connection information checkbox Default . Quest ScriptRunner will load and use them.Checked When this option is checked. Start in Full Screen edit mode until script is executed Default . and the ability to schedule scripts to run. connection information will be saved when you close Quest ScriptRunner and the next time you open Quest ScriptRunner you will automatically be logged on with that information. when you run Quest ScriptRunner from the command line. templates.Unchecked If checked. When a script is executed.Unchecked If checked. hotkeys. Quest ScriptRunner first looks for TOAD editor options in a Temps directory below the application.Chapter 9 Other TOAD Options and Features 239 Load TOAD editor options if installed into the TOAD path (ignore fonts above) checkbox Default . Exit if no connection provided on command line or entered at startup checkbox Default . or there is no automatic logon connection information saved. Quest ScriptRunner will close if you have not entered connection information on the command line. will open Quest ScriptRunner in full screen mode until you execute a script. looks in its local directory for the files. syntax highlighting. . the screen splits to display the results grid in the lower pane. and if not found. if Quest ScriptRunner is located in the TOAD directory.

Step through Script from Cursor. Script (default script options). Run to Cursor. 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. The other option pages include Printing. Run Menu The Run menu includes the following commands for running the script: Execute entire/highlighted Script. .Unchecked If checked. Execute Script step-by-step. Always exit after execution from TOAD or command line Default . and Toolbars (also includes toolbar buttons options). the login window will be invoked when you start Quest ScriptRunner. and Connect (opens a new connection to an Oracle database). Run from Cursor. Menu Shortcuts (click and type the desired shortcuts).Unchecked If checked. Run Current Statement (runs only statement where cursor is positioned).240 Show Login window at startup Default . will exit after it executes from either TOAD or the command line.

and Quest ScriptRunner will connect using the specified connection. Press <Enter> Quest ScriptRunner will launch and prompt for a connection. It will load the file into the editor panel.sql . QSR demo/demo@mydatabase c:\temp\mysql.Chapter 9 Other TOAD Options and Features 241 Launching Quest ScriptRunner from Command Line To Launch Quest ScriptRunner from the command line 1 2 3 Type QSR at the command prompt. 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 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.

SET ECHO. the entire path must be enclosed in double quotes: QSR demo/demo@mydatabase "c:\temp\my sqlfiles\mysql. SET ESCAPE/ESC. and SET LINESIZE/LINES. .242 If the filename or path contains spaces. SETHEADING/HEA. Refer to TOAD Help for more details. PROMPT/PRO.sql" Commands Supported Quest ScriptRunner supports many of the SQL*Plus commands such as REM/REMARK.

select columns. You can select Tables. The SQL Modeler uses floating list boxes for tables which include checkboxes for selecting column(s) and allow for scrollbars and resizing. or Delete statement. Views. and press the Space Bar to check or uncheck a box.Chapter 9 Other TOAD Options and Features 243 SQL Modeler The SQL Modeler lets you quickly create the framework of a Select. Open a new SQL Modeler Two ways to invoke the SQL Modeler § § Click the Database > SQL Modeler menu item. Insert. and create the desired type of statement. Click the Open a new SQL Modeler button on the main toolbar. The modeler allows for keyboard interaction with the tables. join columns. Update. or Synonyms. Press the Up Arrow and Down Arrow keys to move up and down. .

244 Table Selector Area This is where the tables are listed for the selected schema. A dropdown list lets you select a schema. To maximize the model viewing area. Checkboxes let you select columns. . press F2 or right-click in the model and select Full Screen Model from the right-click menu. Table Model Area The Table Model Area lets you graphically lay out a query. and a floating list box for the table displays in the Table Model Area. Double-click (or drag-and-drop) an item from the Table Selector list.

less than (<). Outer Join.. Views.Chapter 9 Other TOAD Options and Features 245 You can visually join or manipulate the Tables. equal (=).g. Model Area right-click menu Right-clicking over the model area displays the following menu items. such as Inner Join vs. You can establish your own joins by dragging and dropping a column from one table to another table column. Tables > Calculated Fields Adds calculated fields based on other table columns Show > Join Text Displays the column names that comprise the joins Show > Adjust Model Origin Adjusts the upper left object to the upper left of the window Show > Primary Key Shows or hides the Table Primary Keys as "(PK)" next to each PK col . or Synonyms. etc. Once the line is drawn. or Join Test. greater than (>). you can double-click the line to adjust its properties. Copy Model Image to Clipboard Copies a bitmap image of the model to the Windows Clipboard Tables > Visibility Displays a Tables Visibility window with checkboxes next to a list of tables that are in the model. Check/uncheck the individual tables to show/hide them. The selected column information will appear in the Criteria grid below. e.

246 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 Adds a WHERE clause to the query in addition to the column conditions from the Criteria tab SQL > Global Having 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 Automatically joins all tables based on existing DDL Foreign Key Constraints Full Screen Model Temporarily hides the Table Select list and Results tab .

Auto Arrange Tables. Object right-click menu Right-clicking over a Table object in the model displays the following menu items. Cascade Tables. Alias Field Names Sets logical column names Show Schema Name in SQL Shows or hides the schema name before each table in the generated query Set Table Alias Sets the Table alias Auto Join Automatically joins this table to others based on existing DDL Foreign Key Constraints Remove Table Permanently removes this table from the model Select All Selects all columns in the table . and Arrange Tables Vertically.Chapter 9 Other TOAD Options and Features 247 The right-click menu also includes Optimize All Table Sizes. Arrange Tables Horizontally.

To unhide the table.248 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. right-click over the empty model space and select the Tables > Visibility menu item .

TXT. which might not always be unique. Or to enter another WHERE criteria. Query Results. Other tabs in the window are Criteria. Descending. they will be displayed in the Criteria grid. and Explain Plan. and Explain Plan. the entire table name is used as the table alias. If the table name is eight characters or less in length. Sum. Field Name to enter a different logical column name. or No sort for that column. Double-clicking on the following Criteria columns has the following effects: Double-click on: Sort in a column to select Ascending. Aggregate Function to select an aggregate column function such as Average. bring up the dialog and click the Remove Condition button. and the resulting query will display. You can edit many of the column properties in the Criteria grid.Chapter 9 Other TOAD Options and Features 249 Results Grid After you lay out your query. the first three characters of the table name are used to generate the alias. Max. Query Results. Min. Count. To clear the form click the Clear Form button. If you want to AND multiple column criteria together. click the Generated Query tab. the aliases for ALL_OBJECTS and ALL_TABLES are both going to be ALL. or Variance. . "Table" and "Schema" are not editable here. go to the expert mode from the Input the WHERE Definition dialog. Standard Deviation. 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. Criteria tab If individual columns are selected. Generated Query. See page 63 for details about setting up table aliases. The Results Grid contains four tabs: Criteria. The alias comes from ALIASES. If the selected table does not have an entry in ALIASES. For example. which will be OR'd together with the above WHERE criteria. You can edit the alias as desired to make it unique or change it to something more meaningful.TXT.

250

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.

Chapter 9

Other TOAD Options and Features

251

Execute as SQL*Plus Report Opens the Query Report Format window which lets you format query results in a report style format

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.

252

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.

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 Right-clicking over the Query Results grid displays the following menu items.

Print Grid Invokes the Report Link Designer so you can print a hardcopy of the data

Save As Invokes the Save Grid Contents window which lets you save data to Clipboard or File.

Chapter 9

Other TOAD Options and Features

253

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.

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

254

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.

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.

Show Views on Table Selector Default - Unchecked If checked, views will display on the table selector.

Unchecked If checked.Unchecked/5 This lets you limit the number of visible columns on the table in the model area. only 5 columns will display and a scrollbox will let you view the rest of the columns. the Modeler will open in full screen mode. . Allow Cartesian Joins Default .Unchecked If checked. If checked. Limit visible columns to __ when adding tables to the model area checkbox/spinner Default .Unchecked If checked. the box is checked and you add a table with 10 columns. Model Table/View in Schema Browser opens Model in full screen mode Default . For example.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.Chapter 9 Other TOAD Options and Features 255 Show Synonyms on Table Selector Default . when you are in the Schema Browser . you will be prompted each time a Cartesian Join is going to execute. when you are in the Schema Browser . Warn on Cartesian Joins This checkbox is only enabled if the Allow Cartesian Joins checkbox is checked.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. if the spinner is set to 5. the modeler will allow Cartesian products. If checked. synonyms will display on the table selector.

256 Restore All Defaults button Click this button to discard your customized options and restore the default settings for the options. .

Chapter 9 Other TOAD Options and Features 257 Code Road Map You get to this window via the main menu button. The object at the arrow end of the line is referenced by the object at the black dot end of the line. Note: The Create the scripts for the objects in the map button requires the DBA module.crm file. and the respective object in the map is brought into focus. 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. and Toggle expand/collapsed package view. F4 or double-clicking on an object performs a describe for objects that are supported by the describe feature in TOAD. 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. . The Auto layout design buttons are designed to improve the map layout. the Tools > Code Road Map menu item or from the Schema Browser . You can also Save the map as a bitmap.crm (code road map) file..Procedures page > Right-click menu. The Code Road Map displays a diagram illustrating with arrows which object references which object. The Save file as. The left side contains the object browser treeview list. Clear the map.. button will save the map as a . Click on an item in the list. The toolbar buttons include Create new code road map. Open an existing . F2 in the map toggles full screen. Set colors for DB Objects lets you change the colors for all objects of a type on the screen. Information (lets you type comments which will be saved with the file).

. data type. F2 will toggle full screen. The ER (entity relationship) Diagram works in a similar way to the Code Road Map. F4 or double-clicking on an object performs a describe for objects that are supported by the TOAD describe feature. When you create a new diagram you can select what to display: primary keys. The toolbar includes a button that lets you Load the objects into the SQL Modeler. button saves the file as a . and synonyms can be added to the diagram. The Create the scripts for the objects in the map button requires the DBA module.erd file. press the Find dependencies button on the toolbar to find dependencies between the newly added objects and the existing objects. and indexes.258 ER Diagram You access this window via the main menu button. The Save as. Right-clicking in either the object browser list or the diagram will display the associated Schema Browser right-click menu for that object.Tables page > Right-click menu. Objects on the arrow end of the line are referenced by objects on the black dot end of the line. Each object in the ER Diagram includes an "X" on the caption bar that lets you remove the object from the diagram. The left side contains the treeview object browser list. You can add additional tables to the diagram by double-clicking on a table name.. views. not nullable. . The lower left hand pane lists tables. It shows dependencies and selected details. unique keys. the Tools > ER Diagram menu item or from the Schema Browser . foreign keys. New tables. After you add new objects.

Index-Organized Table radio button Select this if you want a table whose data rows are stored in the primary key index. Use this dialog to enter the table information. then click the Execute button to create the Table. Global Temporary Table radio button Select this if you want a table whose data is only visible for the current session. . This is easier than remembering the Oracle syntax for this command. Clustered Table radio button Select this if you want a table that is part of a cluster.Chapter 9 Other TOAD Options and Features 259 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. Advanced Queuing radio button Select this if you want to create an advanced queuing table. This window lets you create a new Oracle table. Standard Table radio button Select Standard Table if you want a normal relational table.

or manual edit of an existing SQL Loader control file. and set unused columns. create manually with a GUI. Data Types Options The Data Types Options page is accessed through the View > Options > Data Types item. The Table window will automatically display the Schema and the Name for the table you selected. You can check and uncheck the individual types. because you can't alter the table type. . It is the same window as the Create Table window. add not null constraints. change data type. you can create external tables. select a table from the objects list and click the Alter Table button. This window lets you drop. Alter Table You get to this window from the Schema Browser > Tables page > Alter Table button. modify. The Table Type radio buttons are disabled. Access parameters can be created by one of three methods: create with a GUI by sampling data. Select All and Select None buttons are in each panel. but you are using it to make modifications to an existing table. Refer to TOAD Help for more information about Create Table/Alter Table.260 External Tables radio button When you are connected to Oracle 9i or later. change storage parameters. The types checked are the only ones that will be included in the Table Data Types dropdown. Types are listed in the Native Oracle Types panel and the ANSI Types panel. To alter a table. The options that are checked will appear as items in the Data Types dropdown in the Create Table and Alter Table windows. and add columns.

To run a report 1 2 3 Select the report. because it can run in the background without tying up TOAD. The reports list is displayed in the Reports panel in tree views that are divided by major categories. The window does not close automatically when you close TOAD. The Print Preview window displays the preformatted report and lets you set your printer options. . Enter the parameters. The wildcard symbol “%” is a choice in each parameters list. Click the Run button. You select a report from the list. TOAD Reports runs as a separate program. The Run button will run the report and invoke a Print Preview window where you can select your printer settings. Or you can click on the Reports button on the toolbar. TOAD Reports enhances TOAD performance.Chapter 9 Other TOAD Options and Features 261 TOAD Reports TOAD Reports lets you print out various preformatted reports. The right panel contains a dropdown of Parameters that you need to set. If you have a long running report process you can close TOAD and leave the reports program open. The Close button closes the window. The parameters that are displayed depend upon the type of report you select. The Report Description panel displays a description of the selected report. You access the window from the View > Reports menu item.

Refer to TOAD Help for more information. For most object types. etc. 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. The following options require further explanation. All options are saved to and loaded from the TOAD. Snapshots Summary. NOTE: The HTML Schema Doc Generator includes command line support. Object Summary checkboxes Each Object Summary checkbox (Tables Summary.) when checked. the document will list each object type owned by the schema and the number of objects of that type in the schema. Content tab This tab contains checkboxes that let you select what to include in your HTML document.262 HTML Schema Doc Generator You access this window from the Tools > HTML Schema Doc Generator menu item. Counts of All Objects checkbox If checked. creates a list of characteristics of the object. Hyperlinks throughout the HTML document let you jump between sections of the documentation. Schema selections are saved and loaded on a per-database basis.INI file. the object name is a hyperlink to a more complete description of the object. .

each object is written to its own file. one file for each major section. Background Use Existing CSS file checkbox Most of the style options are written to a CSS file. schemas are broken into a few files. Format tab File Options radio buttons One file per schema If selected.). If more than one schema is selected.Chapter 9 Other TOAD Options and Features 263 Object Descriptions checkboxes Each Object Description checkbox enables additional checkboxes that let you specify what to include in the description. . and each summary section is written to its own file. a Default Value column will be added to the table descriptions and display the default value for each column in a table. the options that are written to the CSS file are disabled. If checked. If you want to use your own customized version of the CSS file. One file per object If selected. each schema is written to its own file. The Table Descriptions includes a Default Values checkbox. an additional HTML page will be created that is a link between the schema documents. 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. A few files per schema If selected. When this option is selected.

You can then view and edit the file. This option does not change the way the HTML documents are displayed when viewed through a browser.264 Indent HTML files checkbox When checked. 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. When the option is unchecked. If you use it as an inclusion file then only the tables or views listed will be included. A radio button also lets you select to specify object sets. the HTML code in the files will be indented with spaces so it can be more easily read. If you use it as an exclusion file then only the tables or views listed will be excluded. The filter button lets you select either the Tables or Views button. This lets you specify the objects using the GUI instead of editing a text file. Aliases for Schema Names tab This lets you add aliases for the generated HTML for individual schemas. no indentations will be made in the HTML code. In/Exclusions tab This tab lets you create and select inclusion and exclusion files. . so the resulting files are smaller and can be read faster by computers. The inclusion/exclusion files are suited for specifying a large percentage of schema objects. The Create a file button generates an inclusion/exclusion text file for the schema that lists all your tables or views. Headers/Footers tab This lets you add headers and footers and select the fonts for each header/footer. You can also add STARTSWITH: ENDSWITH: CONTAINS: filters.

. Type in the Host Name/IP (Host Name or the IP address) in the dropdown box. The Save Output button lets you save through the Save As window. The Telnet tab is used to communicate with servers implementing the Telnet protocol. and press <Enter>. press <Enter>. although at this time only displayable characters and the <Enter> key are supported (i. Telnet Telnet (Telecommunications Network) is a protocol for connecting to another computer and establishing a session there where you can issue commands. control characters. It functions like a terminal emulator. are not currently supported). . You access the Network Utilities options via the View > Options > Network Utilities page. including backspace. The lower panel shows the Telnet commands sent and received as part of the protocol. It provides Telnet capability through a simple interface. Right-click in the terminal window to access the context menu. type in your password.Chapter 9 Other TOAD Options and Features 265 Network Utilities You access the Network Utilities window via the File > Network Utilities menu item. The top panel is a console that displays messages from the server and the commands that you type in. The protocol is specified in Internet RFC 854. Type in the Port number.e. In the window your cursor will appear after “login:” Type in your login name. Click the Connect button. The menu lets you Clear the screen or copy information to the Clipboard.

266

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.

Chapter 9

Other TOAD Options and Features

267

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.

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

268

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.

Chapter 9

Other TOAD Options and Features

269

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
1 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. 2 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.

270

3

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.

4

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.

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.

NOTE: TOAD security is not enforced if the user has the DBA role.

For more information about TOAD Security refer to TOAD Help.

Chapter 9 Other TOAD Options and Features 271 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.

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

and changes parameters Tablespace Map – Provides a graphical view of tablespaces in your database TOAD Control Files – Displays control files Pinned Code – Pins code into the memory buffer New Database Wizard – Creates new databases Identify Space Deficits – Displays tables that do not have enough free disk space to allocate their next extent Redo Log Manager – Maintains the redo logs for a database 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 . The Quest DBA Module windows are discussed in TOAD Help. instance. and database parameter settings. and the Create Menu. DBA windows include the following: Database Monitor and Unix Monitor – Monitor database performance with charts Instance Manager – Checks on the status of the databases you can access Database Health Check – Performs a series of checks on a selected database and displays the results Top Session Finder – Finds the sessions in the database that are consuming the most resources Oracle Parameters – Alters parameters NLS (National Language Support) Parameters – Displays session.Chapter 9 Other TOAD Options and Features 273 Optional Quest DBA Module The optional Quest DBA Module adds database administration functionality to the DBA menu. the Schema Browser.

Policy Groups. and Resource Plans. Resource Plans. alter.Generates a script for various database level objects. Dimensions. Most of the tabs let you create.Displays summary for all databases on a server at one time Schema Browser The Quest DBA Module adds tabs to the Schema Browser including: Dimensions.Lets you compare two databases Generate Database Script . redo logs. Policy Groups. Policy Definitions. Resource Consumer Group. Policies. you can place tablespaces and rollback segments online or offline.Schedules Unix tasks to run regularly Unix and Windows Registry Parameters . Directories.274 Export Utility Wizard – Exports a schema script using Virtual DBA routines Import Utility Wizard – Imports 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 Compare Schemas – The DBA version of this function loads def files and saves the migration/synchronization report to a script file Compare Databases . Rollback Segments. Libraries.Sets parameters for Unix and Windows registry to improve database performance Database Probe . and view details of the associated object and include additional functions. Directories. Libraries. drop. Profiles. Refresh Groups. For example. Create menu The Quest DBA Module adds menu items to the Create menu including. Roles.Checks your database for errors on a regular basis and alerts you if a test that you designed fails Database Browser . . Roles. Tablespaces. Resource Groups. and roles Unix Scheduler . Tablespaces. Profiles. and System Privileges. such as tablespaces. Rollback Segments.

set “PLAY_WAVE=0”. there could be a problem with the sound card or sound devices. Where can I get upgrades? Upgrades can be obtained from the Quest web site.10 Frequently Asked Questions/Support For a comprehensive list of Frequently Asked Questions and other information about TOAD refer to the www.toadsoft.com for the latest version information. .com site.INI.quest. Something causes TOAD to hang during the splash screen. You can also rename TOADLOAD.quest.com. and try to run TOAD again. What can I do? If TOAD hangs during the splash screen.WAV to something else. Can TOAD connect using 16 bit Oracle SQL*Net? TOAD is a 32 bit application and therefore requires 32 bit SQL*Net. What is the current version of TOAD? See www. Edit TOAD. www. so that TOAD will not find it or attempt to play it.

Launch default web browser and go to Quest support on the web (http://www. Send a message to Quest Support (support@quest. but it might help the support staff because it includes options settings and other TOAD information. Send a message to the TOAD mailing list (toad@yahoogroups.276 TOAD Help To access TOAD Help while in TOAD. TOAD Help includes contents. TOAD. Change the active session for this window (useful to quickly compare server information for each session).quest.com). servers. press the F1 key.INI is included with your email to Quest Support or the TOAD mailing list as an attachment). when you submit the TOAD.INI file is optional.INI.com).INI does not include any connection information (passwords. The toolbar includes Copy the support bundle text to the clipboard.INI file to Quest Support or share it with other TOAD users. That information is stored in CONNECTIONS.com/support/). and details on TOAD’s features. So. Attach TOAD. the support bundle text is included as the body of your email) . usernames). the TOAD Getting Started Guide or TOAD Help please contact the customer support staff.INI to emails (When checked. Include this information in the body of your emails (When checked. your credentials (passwords etc. The information it contains will be useful for support when resolving issues and we recommend that you include this support information with emails to Quest Support. a searchable index. TOAD. It also contains details for troubleshooting problems. Customer Support If you have questions about using TOAD.) are not included. The Help > Support Bundle menu item window provides updated support information. Save the support bundle text to a file. and you can’t find the answers in the TOAD User’s Guide. Including the TOAD.

SYSDBA. etc. Virtual.ORA Location Server Version Server NLS_CHARACTERSET Server NLS_NCHAR_CHARACTERSET Connected User and Connect As (Normal.Chapter 10 Frequently Asked Questions/Support 277 Information Displayed Application Information § § § § § § § TOAD Version TOAD Registration Information TOAD Options (Debugger.) Installation Type (Network or Local) EXE and Client Directories (Client directory only applies to network installations) Knowledge Xpert Version and Location Formatter Plus Version and Location Oracle Client/Server Information § § § § § § § Client Version Client Location TNSNAMES. and Swap) . Xpert. SYSOPER) System Information § § Operating System Version Total and Available Memory (Physical. DBA.

you will also be able to check the status and update your own calls online. This information helps the customer support staff. You can type in information about your question or problem in the body of the letter. You can create your own support calls online at www. include the error text as well. .quest. When you contact customer support they will need to know what version of TOAD you are using.278 § § PATH Environment Variable TNS_ADMIN Environment Variable Oracle Home Registry Data § All registry information for each installed home is displayed.com/support If you create support calls online. (Located under HKEY_LOCAL_MACHINE\Software\Oracle. If your question is about an error message. The Help > About window displays customer support contact information including telephone numbers and your version number.

.............................................. 85................................................ 104 ..................... 211......................................TXT ................... 192.... 216 Column Name Select..........98....9......... 210.................. 259 custom queries..... 89................ 66 CONNECTIONS.............................. 88 Change Active Session.........................................................156 Browser Schema..........55.........................181 Capitalization ....... 35..... 153................... 229 Create ............................................................257 Code Templates .............................. 71............................9............. 100 Create Table ...........INI ................... 45.... 27.......................... 230 Create ...............58..... 225 Table..................... Also See Syntax Highlighting Columns .................. Also See Rollback Compile ....... 80.....................TXT ................................. 216 Commit.......................................... 184 Synonym.............. 15....................... 63..................................................63 Alter Table ..... 124............42............................100............................. 111.....................................................TXT .................. 127.....................................260 Analyze All Tables............ 169 Object .....37...... 197 Dropdown.................279 INDEX A Advanced Queuing. 245 CLOB.......218 Table ............................................. 14 Constraints............. 123 CNVFUNCS........ 218................. 250 ALIASES...................................................... 204 D Data Types Options .. 123 Bookmarks .... 104.................. 85................................................................................................ 230 DBMS Output...131..........259 Advice........... 229 Primary Key ..................... 213 Disable................ 73 Comments.. 93 Colors8.......................................................... 76.................. 63 Database...See Table Database Links ..213 Index ................. 198...... 38 Comment Code.................................................................................................. 137 DATEFMTS.104 Code Road Map ........................................ 87.............. 105..70... 9................. 89 Breakpoint.............. 80 Create ........ 230 List............ 203 Control Characters.... 233..... 213 Database Link................................................ 184 ASCII ......................... 201 Constraint ... 192 Clipboard ......... 152 Configuring the Editor............... 87........................................... 189 C Calculator.....................................23.................... 158 Procedure............................. 164...................... 128 B BLOB....213 Arguments. 72...........98..........................12 Aliases................ 100....117................ 230 Date Format...... 129. 247... 26......................................... 69............ 249.......................................... 12 Table ...................................................202....................................... 43..136 Call Stack ...................................

............................... 86......... 66......... 69........... 153.................................. 206 Index......104 DBMS Output ... 76......... 181 E Editor................................ 74.......... 76................. 68 INISUB................................... 180 Symbol Table ..... 181 Deallocate Table Extents................. 227 Recompiling ...... 76....... 34........................................................................................... 93 INI................. 214...............104 Explain Plan .......... 76.............. 137 SQL .... 68.............TXT .... 226.......................................................... 76.....................TXT ..............................179.................... 262 HTML..................... 44..............15 ER Diagram............. 8............. 50............................179 Dependent Objects .39........................108.................... 78.... 37.................................. 76........................................TXT ..................... 76........... 93 INISCR..... 228 INI ....................................... 182 Debugging.......40.............................234 Table Script . 156....... 267 ...................... 92...BIN .... 96................. 93 HTMLOPTS............ 37.... 74................................................................................................................. 182 Functions.......TXT..... 228 Rebuild ....................... 94 HTMLKEYS.......101 DATFUNCS....... 71.................165 Drag and Drop....... 75................. 94................ 61.............. 114 Syntax Highlighting ........................... 119... 70.......................... 156 H Help ........ 183 Read-Only ............202. 104 Gutter................ 73...................280 Dates ................ 153............. 94 INIKEYS. 70...............BIN ....209 Flat File ....................... 99... 78............................. 70 Code Templates................................68 Procedure ..... 219 Schema Browser .... 180............ 110 Editor Options23...............178........................... 95 Grid.........66...........123.........................165 With Debug Information .. 87....................... 71 Initial Caps....................... 101 Export..27 Parser Scripts.. 93 INIOPTS........................................ 76........................... 151................ 253 Table Data ........................................DCI...............180 Dependencies ....................................... 153 Grants ...... 222 GRPFUNCS..... 112 Key Assignments ... 68..........178........DCI................ 185........23......................... 68 HTMLSUB....... 72........ 23 HTML.. 262 HTML Schema Doc Generator............................ 276 Hotkeys........................ 37... 128 Data .... 71....................27..208 F Filters .......... 104 SQL Templates .........................103..... 100 Incrementally drop table.................... 50................................. 88..... 72.............. 45..... 104.. 71 I Import ... 181 Information... 76............................... 85 Foreign Key Lookup...................................................................179............180 Procedures ..............................193..................TXT ......... 195...TXT.. 130 Fonts ... 202............................66 Auto Replace Substitutions ..... 48.................................... 88 IP Addresses ......... 220 Data ......258 Exceptions............... 124.. 89 Offline . 37.......66........... 169.. 93.......... 63 As a Language Type ......... 180........................194........206 Debug ................................................. 37..66...... 205 G Goto ......TXT ........................ 125..............................71................TXT ............................................................................. 63.......128.63....................17........ 214 Find................. 163 End Connection....... 253 Editor ................................................................................ 181....... 26...... 218 Analyze................. 105 TOAD ... 94 External .............................. 93 HTMLSCR.......................................... 97..... 92..........

.................... 190..................................................... 167............ 123..... Also See Line Numbers NUMFUNCS......... 254 Primary................................................................................. 93 JAVASCR..... 107 Memo Editor .............................................................................................TXT ...............76....158 NEWPACK. 93 PLSQLSCR.......................... 41.................................. 246.. 71 Post............... 158 NEWPROC......................... 210 Numbers ...... 78 Load ...................................................................TXT ....TXT ............ 76...281 J Java features.........TXT ................................. 138.... 37 Password........21.....179 Mixed Case ......71 K Key.......................... 78 Editor...... 99......... 213................... 81.................................................. 76 Editors ........69 Lowercase .... 106................... 95....................................TXT ................... 77 Procedure Editor..265 NEWFUNC...................94 JAVAKEYS..... 77 Options .......21 Keystroke ... 104 Null.............................179 Script.................SQL ...............81......................................................................37........... 157 File ................................ 77 ... 104 Options Data Grids................................ 178 Navigator .................. 57...........BIN . 266 PLSQL...................... See Initial Caps MSCFUNCS........TXT ... 93 JAVAOPTS..................................... 76......... 166 Parameters ............. 100 LONGSCR......... 83................... 109 Logon ... 138 PREDFXCP.... 252................ 121 Ping............. 71.....................76.............SQL........ 37......... 93 PLSQLOPTS...... 158 NEWTRIG.................................................... 163 Schema Browser..................98...............213 Foreign .................... 94 PLSQLKEYS................. 69 PLSQLSUB.................. 245 Keyboard........................ 88 M Make Code .............. 245........................ 91.. 123.................................71 L Line Numbers....................................20 Method ........... 119....................................98.................................................................................................................................... 124 Menu ........DAT .............................................. 213...................... 158 NMBRFMTS.........SQL ....66. 14 Personal Oracle....................................................................104 N NAMEDSQL.......................... 123.... 85...................72......................................................... 15 PERSSQLS.DCI......44 Logoff ................ 198.............................. 210........ 194 SQL Editor ....SQL...77........................................52.......................................................................TXT ..272 JAVA....................... 253 Message Boxes.................................................... 68.................... 223... 72........................ 160..... 53 Parse . 163 Procedure .............. 104 O OPTHINTS.................126. 89...................... 226 Debugging ....................... 194 Right-click35.................. 250......................... 174 Printing .....................DAT .....68 JAVASUB.......................................TXT ....... 104 Printing ............................................BIN ...............DCI .. 121 Network Utilities...................................................... 137 Display..........................................TXT....................TXT...................... 123 LONG RAW .See End Connection Logon ..TXT .......9 LONG ......... 50....................TXT................... 86...... See Arguments PARAMS................................................TXT..................... 11 Other......... 99.. 76.............. 55 SQL Modeler .99........................ 9................. 88................................................................................................. 254 P Package.......

......... 219 S Save............ 223.... 225 Syntax Highlighting................202........... 116......... 120 SQLS........................... 73.... 249....... 154 Referential....... 50 Status Panel Indicator ................. 109........................................................ 101.................................................FLT ............................ 118................ 213 Filter ................................... 37................................. 225 Create............... 215.......................... 75......................... 122 Procedure Editor .........................................231 R Redo ......... 217 Alter.................. 213..............................212................... 164.........TXT .....................................38.......... 260 ..................................TXT ........... 74.................... 11..................................180 Errors.... 114......................7...162 Project Manager ....................... 250 Single Record View.. 58 Named SQLs.... 121............ 95............... 49. 49 SQL Results Grid .............10..225 Passwords............ 87................ 269 Sequence...............28 PSEUDO..................... 90 Edit ............... 226 Probe API................... 118 SQL*Net. 61 SQLFILES......... 180 Create ................. 69........... 96........ 229 Delete........................................... 203.............................. 268 Security .................................... 252 Canceling ................................................. 115........................................104 Public ........... Also See Commit ROWID ............................................... 226 Shortcut Keys ......................39..............96........................... 90 Set Parameters .................... 106..............................179...................... 38...................147 Results Grid........ 195... 41 Sort . 123.... 15.....14 Schema ..................276 Queue Tables.............. 213.................TXT ................................... 249 RExec ........... 130................. 161................282 Print Grid. 42. 40 Stay on Top ........ 244..................... 49.................... 234 Sort Options window..... 53.................................. 163 T Tab Delimited ......... 57..................................... 190 SQL Modeler ............................................. 161............................ 33.................................38.... 40....TXT......... 121 Personal .......................................... 137...252 Privileges.........................26. 99.............. 153 SQL Editor....................195 Search.......................... 162............... 49..... 153 Passwords......................................... 52..238 Quest Software Customer Support................ 116.................182..................266 Rollback ....................................... 34 SHORTSCR.................................... 63. 135 Source Control..........................231 Queues....................................................................214 SCHEMA....... 114....................................................... 12.......... 104 Strip Code..................................223 Report Link Designer ..................................................... 96........................................... 69 Show All...... 243 SQL Recall .. 230................................. 66...................................... 252 File ................178 Procedures Arguments ........................................... 164.....................................161 Execute......................................................... 121 Previously Executed .... 227 Vertical .................. 226 Compile Dependencies........................................................ 49......... 275 SQL*Plus. 54.... 111 STRFUNCS. 14 TOAD .................. 244 Add Column ........... 107 Synonym.......... 21 Table...............DAT .............. 124 TAB Key ............ 165.......... 110................................................158................... 120....... 174 Splitters Horizontal ........................... 219............37 Compile...............................55 Quest ScriptRunner ... 225 View ....................... 225 Q Queries11............... 51............. 222.... 74............... 124..................... 251........... 184 Dependent .............. 51..................

............... 109 Truncate ................................215 Tablenames38.............................214 Privileges... 231 U Uncomment Code.......................128............ 9.......................... 110........................... 209 Filter...................... 237....................................33.......... 86....................TXT ................................................................283 Analyze ................................................... 227 Types ................................ 275 Toggle.................. 93 TEXTSCR. 79 Word-Wrap Column....... 38.......................................................................................259 Data Types Options.......... 7.........86............................... 181 Trace Into ..................................8 TOAD Reports ................. 192...83 Team Coding......................................158 SQL Help ............15 Security ... 43 Uppercase ..................................................261 TOADLOAD ................158 New Package.................. 57 Substitution.................................269 TOAD Getting Started Guide............. 8.............35........................................ 37.................................................... 79 ........76........... 179 Triggers ...................... 9................101 TNS Ping.............. 202 Viewing...............................................................................................260 Drop .......... 154........................................DCI ........................................................................................... 65.................................. 275 Schema.......71 Thread .................. 152 Procedure Edit .......................... 87.. 13......... 73 Undo ...... 109.... 215 Update Grid Edits.................TXT.......... 19 Word Wrap......................................... 10............................ 104 utPLSQL.................. 17.....................55 Time Values .... 246 Bind ..................TXT ............ 112....................................................... 105......39................................................................................ 22 Navigation ..............165................................ 154.................................76..................................... 222 USRFUNCS........213 Create .....71 New Function. 87...................... 250 Toolbars.........158 New Trigger .......................................................................................104 TEXT.................................... 154 Modal .....94 TEXTKEYS.....................223 Script....................... 225 W Windows Dockable... 104.. 152 Procedure Edit Status ........... 53 Bound ...............................TXT..........177 Telnet .. 103.....................40............. 218..........................199...................................................215 Export Data ................ 219 Common Edit ............................68 TEXTSUB... 171 V Variables......... 88 User .......................... 153..ORA................................................................... 12..... 93 TEXTOPTS..................................................................................................................................... 15 TOAD ......... 66............................................................................... 54 Version Information ...................................................................................208 Select............... 212 Referential............................. 199 Tabs (in the editor text)..................................158 New Procedure...............267 TNSNAMES......................................... 181 MDI ....265 Templates Code Completion ........................................... 275 Views............ 86 List........................BIN ...