Chat now with support
Chat with Support

Toad for Oracle 2024 R2 Common Documents - Getting Started Guide

Welcome to Toad Toad Resources Required Privileges Create and Manage Database Connections Editor Basics Schema Browser Basics Data Grid Basics Work with Data Work with Database Objects Work with Code
Write Statements and Scripts Work with the Query Builder Execute Statements and Scripts Save Statements (SQL Recall) Work with PL/SQL Objects Debug Analyze Code Optimize SQL
Customize your Toad Environment Use Other Quest Software Products with Toad

About the Editor

The Editor window is the foundation for working with many types of statements and code. The Editor attaches itself to the active connection in Toad, but if you do not have a connection you can still use it as a text editor.

This topic describes the basic Editor components. As you use other features in Toad or if you customize the Editor layout, the appearance of the Editor will change.

Editor Toolbars

The Editor has the following default toolbars. Hover your mouse over a button to determine its functionality. You can show or hide toolbars and buttons to customize your work area. Show/Hide Toolbars

File

The main Editor toolbar that contains functionality for changing sessions, opening and saving files, printing, launching external software related to Toad, creating new PL/SQL objects, and launching the SQL Recall tool for saving and viewing statements.

Edit

Contains basic editing tools for writing and formatting code.

Execute

Contains buttons related to compiling or executing code.

Current Schema

Shows the currently connected schema and enables you to change the schema to execute the code against. Change Current Schema

Desktop

Shows the current desktop layout and enables toggling between SQL and PL/SQL desktops.

The SQL desktop is mainly for working with scripts, while the PL/SQL desktop is for working with procedures, functions and packages.

The desktop determines what tabs are displayed in the Editor:

  • The SQL Desktop shows the Data Grid, Trace, Query Viewer, Explain Plan, and Script Output tabs.
  • The PL/SQL Desktop shows the Call Stack, Breakpoints, Watches, Profiler, and PL/SQL Results tabs.

  • Both show the DBMS Output, Messages, and Team Coding tabs.

Macro

Contains buttons for creating and running macros. See Editor Macros for more information.

Code Analysis

Contains buttons for running Code Analysis. About Code Analysis

Team Coding

Contains buttons that support the Team Coding feature.

See About Team Coding in the online help for more information.

Editor Layout

The Editor is organized into the following areas:

Navigator Panel

The Navigator Panel is a desktop panel that displays an outline of the Editor contents in the active tab. You can click on the items listed to navigate to that statement in the Editor. The Navigator Panel is displayed on the left-hand side by default, but you can change where it is docked.

If the Navigator is not shown, right-click the Editor and select Desktop | Navigator.

Move through Code with the Navigator

Object Palette

The Object Palette shows a list of the database objects that are in the currently selected schema.

Pick Objects from the Object Palette

Editor

The main Editor window displays code in tabs. You can open new tabs for different bits of code, or different types of code. SQL and PL/SQL can go in the same tab. Toad can tell where the cursor is located and compile PL/SQL or run SQL as required.

Note: If you have multiple statements in the Editor, you must trail them with a valid statement terminator such as a semi-colon.

Desktop Panels

The desktop panels contain many options for tab display, depending on what kind of code you are working with and what you want to do with it. In addition, you can configure how these panels display to make Toad work for you. Customize the Editor Layout

Editor Right-click Menu

The right-click menu of the Editor contains many options to help you work with code. When you are trying to figure out how to do something, right-click the Editor to see if there is a menu or command for it. For example, right click a table and then select Describe to open the Describe Objects window. As another example, right click PL/SQL code and then select Compare To for options to compare the code with the database object or a file on disk. You can also select the object, then press F4.

  • An advanced context menu is available, similar to how Windows Explorer operates. When you SHIFT + right-click the name of an object in the Editor, Toad will show an advanced menu if the object can be resolved. If the object cannot be resolved, Toad shows the normal Editor context menu.

    Shortcut Keys

    Toad provides dozens of standard shortcut keys, plus you can assign new ones or customize the standard ones. Toad also allows you to print out your current list of shortcut keys.

    Customize Shortcut Keys

    You can customize the shortcut keys. Customize Shortcut Keys

    Editor Results Area

    At the bottom of the Editor are tabs that display results of your actions with code.

    Depending on your Toad Edition, any of these tabs display results:

    Output Area

    About the Output Window

    Editor Options

    You can customize the behavior of the Editor in many ways.

    To set Editor options

    1. Select View | Toad Options | Editor.
    2. Select an options group and then press F1 for information about those options.

    •  

    About the Output Window

    The Output window opens whenever an action produces results. The Output window can be re-sized or moved. By default the window is docked at the bottom of your screen.

    In addition, the Output window displays error messages and other general information Toad creates for you. Output is sent to various tabs as needed. Using the right-click menu you can work with the messages displayed in the Output window.

    Various Tabs

    Output is sent to various tabs in this window as needed.

    Tab

    Contents

    General tab

    This tab provides general information.

    <connection> tab

    This tab provides information about activities you have performed during a connection. For example, if you end or begin a Debugger session for a specific connection, a log of this activity is displayed in this tab.

    Spool SQL tab

    This tab displays SQL from the Spool SQL command. This is the SQL used by Toad to perform various functions.

    Right-Click Menu

    From the right-click menu you can perform the following actions.

    Command

    Result

    Clear

    Clears all messages in the active output tab.

    View Messages

    Displays the selected messages in a dialog box. This is useful when a message is too long to view in the Output window, or contains linefeeds.

    Copy

    Copies the contents of the Output window to the clipboard.

    Print

    Prints the contents of the Output window.

    Save to File

    Saves the contents of the Output window to a text file.

    Spool SQL to Screen

    Toggles spooling.

     

    About the Results Grids

    At the bottom of the Editor are tabs that display results of your actions with code within the edit window.

    Depending on your Toad Edition, any of these may display results:

     

    Toggle Fullscreen Editor

    You can expand the Editor to fill the entire screen, hiding all other desktop panes. The fullscreen Editor does not affect windows such as the Object Palette or Code Snippets.

    To toggle the Fullscreen Editor

    Select Toggle Fullscreen Editor (F2) from the Edit menu.

     

    Related Documents

    The document was helpful.

    Select Rating

    I easily found the information I needed.

    Select Rating