users guide for sql navigator

7/26/2019 Users Guide for SQL Navigator

1/464

F O R O R A C L E

Users Guide

Version 4


2/464

This guide contains proprietary information, which isprotected by copyright. The information in this guide is

subject to change without notice and does not representa commitment on the part of Quest Software. The

software described in this guide is furnished under a

license or nondisclosure agreement. This software may

be used or copied only in accordance with the terms of

this 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 purchasers personal usewithout the written permission of Quest Software, Inc.

2001 Quest Software, Inc. All Rights Reserved.

SQL Navigator is a trademark of Quest Software, Inc.Other trademarks and registered trademarks used in thisguide are the property of their respective owners.

8001 Irvine Center DriveIrvine, CA 92618USA

www.quest.com

U.S and Canada: 949 754.8000UK: +44.1628.601000Germany: +49.211.770967.0Australia: +61.3.9811.8000


3/464

Contents

Chapter 1 Quick Tour of SQL Navigator 5

Chapter 2 Whats new in this version? 51

Chapter 3 The SQL Navigator interface 109


4/464

ii Welcome to SQL Navigator Version 4 Users Guide

Chapter 4 Navigating the database 167

Chapter 5 Working with SQL statements and scripts 183

Chapter 6 Working with PL/SQL code 237

Chapter 7 Working with HTML and Java 329

Chapter 8 Working with database objects 339

Chapter 9 Tools for analysis and tuning 369


5/464

Contents iii

Chapter 10 Version Control and Team Coding 375

Chapter 11 SQL Navigator reports 413

Chapter 12 Customizing SQL Navigator 417


6/464

iv Welcome to SQL Navigator Version 4 Users Guide

Chapter 13 Installing server-side objects 441

Chapter 14 The SQL Navigator add-on modules 445

Chapter 15 About Quest Software 449


7/464

1Quick Tour of SQL Navigator

For installation instructions, please see the SQLNavigator Getting Startedguide.

In this chapter

Better code, faster. 6The SQL Navigator user interface 6Easy browsing and object navigation 8Fast access to any object 10Instant access to your favorites 12Commands and tools for handling database objects and code 14Visual editors for database objects 26Powerful SQL Editor 28Complete execution environment for stored programs 32Complete and extensible code template libraries 35Team coding and Version Control support 38Web development support 43Reporting tools 47How to find the help you need 48


8/464

6 SQL Navigator Users Guide

Better code, faster.

For all the latest product information, includingtips and techniques, visithttp://www.quest.com/sql_navigator.

The SQL Navigator user interface


9/464


All Toolbarscan be

floating, docked, orhidden. Toolbar

buttonsbecome activeaccording to itemselected.

Main menu bar.

The DB Navigatorshows the entiredatabase structure as atree with expandablenodes.

The optional Detailspanel shows essentialinformation about theitem selected in thetree.

The Workspacewindow gives youquick access to often-used objects andconnections.

Click on any item in the

Task Barto give itfocus.

The Outputwindowdisplays server outputincluding Oracle errors.


10/464


Easy browsing and object navigation

You can set and savefilters to limit theobjects displayed in thetree.

The optional Details panedisplays contents or properties ofthe object selected in the tree.

Commands available onfloating menus and toolbarschange according to the itemsselected in the tree.

The DB Navigator toolbarhelps you navigate andcontrol how schemaobjects are displayed.

Expand nodes (usingmouse clicks or the arrowkeys) to drill down tounderlying objects or data.Double-click an object toopen it for editing.

Drag often-used objects orconnections to yourWorkspace for fast access.


11/464


Visualization of schema

Supports most object types

Supports Oracle 8 partitioned tables and indexes

Drill-down on types

Selective viewing

Saved views

Quick table browsing

Create SQL in browser


12/464


Fast access to any objectQuickly find objects in any schema

Find objects from stored programs or scripts

Quick Describe


13/464


Oracle Data Dictionary views

Search filters


14/464


Sorted results

Optional detail view

Double-click anywhere to edit

Locate in schema

Batch selection and update

Instant access to your favorites

List view and Detail view


15/464



16/464


Managing the Workspace window

The number in brackets after the Workspacename tells you how many items are in the workspace.

To limit the types of objectsshown in the Workspacewindow, click the Filterbutton.

Double-click an object orconnection to open it.

Commands and tools for handling database

objects and code


17/464


Default settings for SQL Navigator menus

File menu


18/464


Edit menu


19/464


Search menu

View menu


20/464


Session menu


21/464


Object menu


22/464



23/464


Debug menu


24/464


Tools menu


25/464


Team Coding menu

Windows menu


26/464


Help menu

Menu synchronization


27/464


Toolbars

Toolbar Purpose


28/464


Visual editors for database objects

Opening an object editor from the View menu


29/464


Opening an object editor from the DB Navigator tree


30/464


Powerful SQL Editor

The SQL window and the results display

Updateable Querybutton

The SQL editing window

contains the SQLstatement(s) to be editedand executed.

It includes an ExecutionStatus pane.

When you execute aSELECT statement, the

Results pane displays therows returned in the form ofa dynamic grid with optionsfor viewing, sorting, andnavigating.

If you want to edit the data,use the Updateable Queryoption in the SQL Editortoolbar when executing.


31/464


Code markers

The Spool Output window


32/464


33/464


34/464


35/464



36/464


37/464


Complete and extensible code template libraries

Code Assistant window


38/464


39/464


Debugger commands


40/464


Team coding and Version Control support

Team Coding menu and toolbar


41/464


Viewing the status of objects under Team Coding control

Viewing object details in the Team Coding Viewer

Reviewing the Version Control archives


42/464


43/464


44/464


45/464


46/464


Previewing HTML output in SQL Navigator


47/464


48/464


49/464


50/464


51/464


Still cant find it?

For all the latest product information, including

tips and techniques, visit

www.quest.com/sql_navigator.


52/464


53/464

2Whats new in this version?

In this chapter

Whats new in SQL Navigator 4? 52Getting access to new features 52Interface Enhancements 53Editing Enhancements 72Debugger enhancements 89New and improved development tools 94Improved Team Coding facilities 104General and miscellaneous enhancements 105


54/464


Whats new in SQL Navigator 4?

To browse descriptions of new features

Getting access to new features

To reset toolbars to the default settings

1

2

3

4


55/464


To display or hide individual toolbars1

2

3

To add or remove individual commands

1

2

3

4

Interface Enhancements

Interface Enhancements


56/464


57/464


Toolbars


58/464


59/464


This menu... Has commands for...

Main window toolbars

Toolbar Purpose

Object menu and toolbar


60/464


61/464


62/464


63/464


64/464


Invoking the Properties display from the DB Navigator shortcutmenu


65/464


66/464


67/464


Automatic Source Preview

Previewing an objects source code from the DB Navigator


68/464


To preview the source code of text objects1

2

3

Easier switching between sessions

Choosing from the list of current sessions


69/464


Speedy selection of database objects

Click Open DB Object


70/464


to open the Select DB Object dialog


71/464


72/464


73/464


74/464


75/464


Improved PL/SQL Editor for stored programs withpowerful new Code Explorer


76/464



77/464


78/464


79/464


Hyperlinking in the Stored Program editor

Pointing to the variable while pressing Ctrl moves the cursor tothe declaration


80/464


Pointing to the object name while pressing Ctrl opens theAutoDescribe window


81/464


Easy switching between specification and body


82/464


Improved syntax highlighting

Integrated PL/SQL Profiler (Oracle 8.1.5+)


83/464


84/464


85/464


86/464


87/464


88/464


The Quick Browse and Edit Data commands open the SQL Editor


89/464


Source Code Search enhancements

Extract DDL enhancements


90/464


Shortcut menu options for code search results


91/464


Debugger enhancements

Debugger enhancements

Context-sensitive tooltip description for identifiers

Multi-paged Output window


92/464


Execution code generation enhancements


93/464


94/464


95/464


Step 3set options for variables, parameters, andCOMMIT/ROLLBACK


96/464


Step 4(optional) monitor profiling results

New and improved development tools

Formatter Plus and Knowledge Xpert


97/464


Describe tool enhancements

Selecting AutoDescribe for a table


98/464


The AutoDescribe window


99/464


Easier viewing of data in database objects

SQL Navigator does not support working with

LOB or Object table columns when using anOracle 7 client connected to Oracle 8 database.For full functionality, use an Oracle 8 client to

connect to an Oracle 8 database.

Support for LOBs (large objects)

Type View Edit


100/464


Object Data Viewer

Viewing a binary object in the BLOB viewer


101/464


Viewing character data in the CLOB viewer


102/464


Support for Oracle 8 partitioned tables and indexes


103/464


New and enhanced Visual Object Editors

New edit functions

User can set default schema for object editors


104/464


Query Builder enhancements

Code Assistant enhancements

Launch the Code Assistant from the View menu


105/464


The Code Assistant


106/464


107/464


108/464


More convenient Logon routine

Improved date/time representation and handling

More stable, easier to maintain


109/464


Superceded functionality


110/464


111/464

3The SQL Navigator interface

In this chapter

Overview of the SQL Navigator interface 110Menus, Toolbars, & Commands 122Keyboard shortcuts 135Code editors overview 142Workspaces: A smarter way of working 146Connecting to the Oracle database 155Viewing server output 161The Oracle Job Manager 162


112/464


113/464


All Toolbarscan be

floating, docked, orhidden. Toolbar

buttonsbecome activeaccording to itemselected.

Main menu bar.

The DB Navigatorshows the entiredatabase structure as atree with expandablenodes.

The optional Detailspanel shows essentialinformation about theitem selected in thetree.

The Workspacewindow gives youquick access to often-used objects andconnections.

Click on any item in the

Task Barto give itfocus.

The Outputwindowdisplays server outputincluding Oracle errors.


114/464


The Task Bar

To enable the SQL Navigator Task Bar

Managing windows


115/464


Saving Window Layouts

To save and swap window layouts

1

2

3

Accessing functions and tools

Navigating the database with DB Navigator


116/464


Tree view and detail view

To show or hide the DB Navigator details pane

Display and selection options

Data Dictionary views


117/464



118/464


Finding objects quickly

Displaying a schema object and its properties

To locate an open or selected object in the schema


119/464


You can hide the right pane to save screen spaceor increase the speed of the display.

Click (the Show/Hide Detailsbutton) on theDB Navigator toolbar

Or

Right-click in the DB Navigator window and

choose View Show/Hide Detailsfrom theshortcut menu.

Managing database objects


120/464


Opening a visual object editor


121/464


Opening objects

You can use the SQL wildcard character % as part

of your search for object names. The wildcard by

itself will return all object names meeting thecriteria.

To open a database object in a visual editor


122/464


To create a database object

Performing actions on a selected schema object


123/464


Oracle Data Dictionary views

Required privileges

How SQL Navigator handles the views

Using DBA dictionary viewsmay affectperformance for some Oracle instances,

depending on the number of users and objects, aswell as other environmental factors.


124/464


Menus, Toolbars, & Commands

Menus

Main menu bar

This menu Has commands for


125/464


Menu synchronization

SQL Navigator command list


126/464


Command Menu or Toolbar


127/464




128/464




129/464




130/464




131/464




132/464




133/464




134/464




135/464


Toolbars

Toolbars

Toolbar Purpose


136/464


The Team Coding Toolbar

The Session toolbar

The Object Toolbar

The Functions Toolbar

The Edit Toolbar

The Debug Toolbar


137/464


Keyboard shortcuts


138/464



139/464



140/464



141/464


Programming shortcuts

To program shortcut keys

1

2

3

Default settings


142/464



143/464


Debugging shortcuts


144/464


Code editors overview

Code editors

To create or edit Use this editor

SQL Editor overview


145/464


The SQL window and the results display


146/464


Code markers

The Spool Output window


147/464


The Stored Program Editor


148/464


Workspaces: A smarter way of working

You might want to try making your work easier by

creating specialized Workspaces for

All objects and files related to a project

All database connections

Built-in utility packs, procedures, or functions(such as DBMS_OUTPUT/PIPE/ALERT packages)

Home-grown utility packs


149/464


Caution If you save the password when you

create the connection, nopassword will berequired to open a connection from the

workspace.

To create a workspace


150/464


The workspace window


151/464


Managing the Workspace window

Managing workspaces

Managing workspaces

To add an object or file to the current workspace

You can set a preference to automatically add

objects to a current workspace when a specifiedevent occurs (such as opening or editing anobject).


152/464


Saving connection shortcuts in your Workspace

To connect to a database from the workspace

To open a workspace object for editing


153/464


To connect to a database and open a DB Navigator window

1

2

Caution If you save the password when you

create the connection, nopassword will be

required to open the connection from theworkspace.

To open a workspace

1

2

3


154/464


To filter the list of objects in a workspace

1

2

To open a workspace object or file

1

2

3

To remove an object or file from a workspace

Invoking the Describe command for a workspace object


155/464


To enable the AutoDescribe feature

1 2 3

To invoke the Describe command

1 2

3

To view or update objects in a workspace

Context-sensitive commands in workspaces


156/464


To do this With this object Use thiscommand


157/464


Connecting to the Oracle database

Connecting using Net8

Connecting Using Connect Strings

Examples of Connect Strings for SQL*Net 1

t:Seattle:PRODN

x:server1

d:boston:devp

Example of a Connect String for SQL*Net 2

Prodn1

SQL*Net 2.x connect strings (also called service

names) are defined in the file tnsnames.ora,usually located in the c:\orawin95\network\admindirectory for Windows 95 and in the

c:\orant\network\admin directory for Windows NT.

To modify these connect strings use only theOracle SQL*Net Easy Configuration Utility.


158/464


There are many communication protocols andconfigurations available for SQL*Net. For moreinformation, refer to any of the following

resources:

SQL*Net Administrators Guide

SQL*Net Users Guide

Your companys DBA or system administrator

Connecting using command line parameters

Connecting to Personal Oracle

Connecting to a database from the SQL Editor

To connect to a database via the SQL Editor

Connect name/password@database


159/464


To disconnect from a database via the SQL Editor

Disconnect name/password@database

To close a connection

To activate another session in another window

Oracle Logon

The Logon dialog on startup is controlled by a Preferencesoption. See page 422, Show Logon Dialog at startup


160/464


Automatically saving passwords

Creating a session

Switching between sessions


161/464


Choosing from the list of current sessions

To switch sessions or create a new session

Use the drop-downlist on the Session

Toolbar to switch

sessions.

Alternatively, youcan click the New

Session icon to

open a new one.

Fast access to connections stored in your Workspace


162/464


The workspace window can includeconnection shortcuts

Troubleshooting Connections to Oracle

Message Solution


163/464


Viewing server output


Interpreting the output display

Color Data type

To display the Output window


164/464


To change size of the buffer for server output

1

2

3

To print Output window contents

To copy and paste selected text from the Output window

1

2

The Oracle Job Manager

Managing jobs


165/464


To view job properties

1

2

Oracle Job Manager job properties

Control Tab

Field Description

Advanced tab

Field Description


166/464


To delete a job from the queue

1

2

3

To disable a job

You can disable only jobs that you own. If you try

to mark a job you do not own, the Job Managerdisplays a message stating that the job is not in

the job queue.

1

2

3

4

To edit or create a job

1

2

3


167/464


1

2

3

4

To run a job

1

2


168/464


169/464

4Navigating the database

In this chapter

Navigating the database 168The DB Navigator window 168DB Navigator commands 170Working with objects in the DB Navigator 172DB Navigator drag-and-drop tips 180


170/464


Navigating the database

The DB Navigator window

A hierarchical view of the database


171/464


To show or hide the DB Navigator details pane


172/464


Interpreting the DB Navigator display

This symbol Indicates that

DB Navigator commands

DB Navigator toolbar commands

Using the (Forward) and (Back) buttons


173/464


To show or hide details about the selected DB Navigator node

To move around in the Navigator window

To expand a node in the DB Navigator

To collapse a node in the DB Navigator

To expand the selected DB Navigator node and all itsdescendants

To refresh the entire DB Navigator tree from the database


174/464


Working with objects in the DB Navigator

Finding and opening objects in the DB Navigator

To display a dynamic list of all objects in a schema

1

2

3

4

Opening an object from the DB Navigator

Locating an object in the schema from an editor

To locate an open or selected object in the schema


175/464


You can hide the right pane to save screen spaceor increase the speed of the display.

Click (the Show/Hide Detailsbutton)on the DB Navigator toolbar

Or

Right-click in the DB Navigator window and

choose View Show/Hide Detailsfrom theshortcut menu.

Using filters to customize the display of objects

Oracle data dictionary views

Quickly finding objects in any schema

To display a dynamic list of all objects in a schema

1

2

3

4


176/464


To open a found object for editing

To select and edit multiple objects

Viewing the contents of a DB Navigator tree node

To open an object from the DB Navigator window

Finding objects by search argument


177/464


178/464


Displaying an objects place in the schema

To locate an object in the schema

To apply DB Navigator filters to restrict the object typesdisplayed for a session

LIKE ABC%

To define filter properties

1

2

3


179/464


4

5

6

To display the shortcut menu for a selected object

To perform an action on a database object in the DB Navigator

To view or hide details about the selected DB Navigator node

To create a database object from the DB Navigator

To edit a database object from the DB Navigator

To drop a database object from the DB Navigator


180/464


To rename a database object from the DB Navigator

To compile an object from the DB Navigator

In the DB Navigator

Browsing or editing table data from the DB Navigator

To browse or edit table data from the DB Navigator

1

2

To Do this


181/464


To build a query from a selected table1

2

3

To extract DDL in the DB Navigator and display it in the SQL

Editor

1

2

To invoke the DESCRIBE command for an object in the DBNavigator


182/464


To enable the AutoDescribe feature1 2 3

To invoke the Describe command

1 2

3

To view or edit database object definition in the DB Navigator

To execute a stored program from the DB Navigator

DB Navigator drag-and-drop tips

To drag database object names from the DB navigator into aneditor

To add a code location shortcut to a workspace


183/464


To add an external file to the current workspace

To add an object to a workspace

To add an object to the Query Builder work area

To copy an object from one schema to another

To open an external file in SQL Editor

To open an object in an editor


184/464


185/464

5Working with SQL statements andscripts

In this chapter

Writing and editing SQL code 184Fast query building with the Query Builder 212Executing SQL and working with results 226The Spool window 230Viewing results in the Result window 232


186/464


Writing and editing SQL code

The SQL Editor

To open the SQL Editor


187/464


The SQL window

To display the SQL editing window

SQL Editor toolbar commands

Command Description


188/464



189/464


SQL Editor shortcut menu commands

SQL Window

Command Description


190/464



191/464


The Output window

To display the Output window


Color Data type

To change size of the buffer for server output

1

2

3

To copy and paste selected text from the Output window

1

2

3


192/464


To clear the Output window

To print the contents of the Output window

Editing SQL code


193/464


Edit menu and toolbar quick-reference

TheEdittoolbar is dockable, so you can place it

where it is most convenient. To see a hint

describing the function of any button on the

toolbar, position the mouse pointer over it.

Point-and-click column names from any object

To insert a column name

1

2

3

4


194/464


The Edit menu The Edit toolbar


195/464


Inserting code from another file

To insert selected source code from another file

1

2

3

To insert the entire text from another file from another file

1

2

Inserting ready-made code via shortcut keys

To insert code from a template

1

2

J

J


196/464


Code templates and their assigned shortcuts

Code Description Shortcut Key

SQL*Plus command support


197/464


Validating syntax

Automatic indentation

Begin/End markers for loops and blocks


198/464


Using Bookmarks in the SQL Editor

To set a bookmark using a shortcut menu

1

2

To set a bookmark using a keyboard shortcut

To list bookmarks


199/464


To go to a bookmark using a shortcut menu1

2

3

To go to a bookmark using a keyboard shortcut

Previewing an objects source code

To preview the source

1

2

Formatting source code

To format source code

1

2


200/464


Dragging names of database objects into code

To drag-and-drop names of database objects

Using substitution variables for flexible SQL statements

Toggle onthe Scan Defines feature whenusing variables or text that contain the

characters &, &&, or = :[bind variable].

Otherwise, the statement containing thevariables will generate an error.

Specifying substitution variables with the & symbol

& &EMPNUM

SELECT *

FROM EMP

WHERE EMPNUM = &EMPNUM;


201/464


SELECT &COL1, &COL2

FROM &TAB;

CREATE USER &&UNAME IDENTIFIED BY &PASS;

GRANT ALL ON EMP TO &&UNAME;

Specifying substitution variables with the && symbol

&& DEFINE &&

&& UNDEFINE

Defining and undefining numeric and character variables

DEFINE UNDEFINE

To define numeric and character variables

DEFINE


202/464


DEFINE EMP_NAME=SCOTT

DEFINE EMP_NUM=4467

To undefine numeric and character variables

UNDEFINE

UNDEFINE EMP_NAME

Using Bind variables

VARIABLE s_table_name varchar2(30)

BEGIN

:s_table_name := EMPLOYEE;

END;

/

Debugging a variable in the SQL Editor

To generate a debug statement

1

2


203/464


Integrated impact analysis and quality assurance

Entering multiple SQL statements

To insert a saved text file into the SQL Editor

1

2

3

Entering PL/SQL blocks


204/464


BEGIN

Test_procedure;

END;

Copying selected text

To copy to the clipboard

To paste from the clipboard

Creating a DBMS_OUTPUT.PUT_LINE statement

To create a DBMS_OUTPUT.PUT_LINE statement for a variable

1

2


205/464


Jumping to a specified line

To go to a line number

Indenting and unindenting

To increase or decrease the indent of selected text

Inserting a CRUD matrix

Inserting ready-made code from templates

To insert prepared code into the editor

1

2 J

3

4


206/464


Recalling previously executed SQL

To recall previously executed SQL

1

2

3

Using bookmarks

To set a bookmark

To go to a bookmark


207/464


Undo or Redo your editing operations

To undo or redo an editing operation

Tuning with the Explain Plan tool

Analyzing queries with Explain Plan

The Explain Plan tool can be used to analyze the

execution of single SQL statements only.


208/464


To change default preferences for the Explain Plan tool1

2

To execute an Explain Plan for a SQL Statement

1

2

3

4

5

6

7

8

9

10

11

Viewing the Explain Plan tree

Printing the Explain Plan tree


209/464


When an Explain Plan tree printout exceeds one

page, the headings (such as the SQL Text and

statement ID lines) are not repeated. This makes iteasy for you to tilemultiple pages together to

display the explain plan tree as a single diagram

Viewing an Operation Description

To view the Operation Description

Browsing saved plans

To use the saved plans browser

1

2

3

4

5


210/464


Tuning a SQL script

Xpert Tuning

Xpert Tuning can be used to analyze theexecution of SQL scripts containing more thanone statement.

1

2

3

4


211/464


To set editor preferences1

2

3

Working with code templates and shortcuts

To open the Code Shortcuts and Templates dialog

To insert code from a template

1

2

J

J

To create a new template

1

2

3

4

5

6

7


212/464


To edit an existing template1

2

3

You cannot change a template name. Instead, you

can delete an existing template and createanother like it with a different name.

To delete a template

1

2

3

You cannot delete all the templates. There must

be at least one template remaining in the Code

Templates and Shortcutsdialog.

Customizing SQL Editor toolbars

Hiding or showing toolbars


213/464


To quick-select toolbars1

2

To customize toolbars

1

2

3

4

Adding and removing toolbar buttons

To hide or show a button

1

2

3

To assign a button

1

2

3

4

5


214/464


To remove a button1

2

3

4

Customizing toolbar button appearance

To customize button appearance

1

2

3

4

5

Fast query building with the Query Builder

SELECT UPDATEINSERT DELETE


215/464


The Query Builder window


216/464


Quickly build complex SQL statements

Sort and group

Save and re-use queries

Execute and Roll-back

Query Builder quick reference

To get started with the Query Builder

1

2

3


217/464


If you want to Then

1.

2.

1.

2.


218/464


If you want to Then

To set rules, options or criteria for a query

1

2

3

4

When a square button appears inside the cell, you

can use the spacebar or Ctrl+Enterto open the

column editing window.


219/464


Specifying WHERE clauses

If the column is selected

If the column is not selected

Automatic insertion of column names into a WHERE clause


220/464


Operator Meaning Example

Customizing Query Builder

Code catalogs for fast and easy coding


221/464


SQL Navigator provides two tools that assist ininformation sharing among members of adevelopment team. The shared catalog can beused to maintain a repository of code snippets,

while the standards catalog allows SQL and

PL/SQL templates to be stored.

For tips and techniques, seehttp://www.quest.com/sql_navigator

Using code catalogs and the Code Assistant


222/464


Code Assistant window

To open the Code Assistant


223/464


To change Code Assistant preferences and display settings

Automatically starting Code Assistant with editors

To set the Autostart Code Assistant preference

1

2

Viewing information about catalog objects

To show or hide the Information pane


224/464


Adding, editing or deleting catalog items

To add, edit or delete catalog items

The following constraints apply:

You cannot delete top-level nodes of the tree.

You cannot rename the top-level folders in thetree.

To rename a catalog item


225/464


Use descriptive names for catalog items. Namescan be up to 35 characters long and containuppercase letters, lowercase letters, and any ofthe following characters:

_ - & space< > / , ( ) ..

Saving your SQL statements and code in catalogs

You can use the Code and SQL catalog to build

your own version of the Syntax catalog. Simplyadd your own syntax items to the catalog and use

a consistent prefix to group the items together;for example:

Syn- IF THEN ELSIF

Syn- WHERE clause

Syn- SQL - Correlated subquery

Etc.

Alternatively, you can add new items directly intothe Syntax catalog of the Code Assistant.


226/464


Placing Items into the code catalogs

To add to the catalog from the editor window

1

2

Use descriptive names for catalog items. Namescan be up to 35 characters long and contain

uppercase letters, lowercase letters, and any of

the following characters:

_ - & space< > / , ( ) ..

To add to the catalog from the code catalog window

1

2

To move a snippet from the catalog into the editor

1

2

3

4


227/464


Saving and re-using code

Viewing Describe information


228/464


Executing SQL and working with results

Executing a SQL script

Displaying results

Error descriptions

Executing SQL statements


229/464


Viewing processing status

To execute the SQL statements displayed in the SQL Editor

To execute an individual SQL statement

SQL Editor Execution Status pane

To display an error description

Changing the contents of the execution status pane

To change the type of information displayed in the execution

status pane


230/464


SQL window Status line

Running multiple queries

Running the same script against different databases

The drop-down list on the Session Toolbar

Executing updateable queries


231/464


SELECT

Updateable queries are slow to execute.

Turn off the Updateable Query optionunless you expect to update the data

returned.

To run an updateable query

1

2 SELECT

3

4

5

To save your changes to the database

To undo your changes to the database


232/464


If the Commit and Rollback buttons on theSession toolbar appear dimmed, then youprobably have the Immediately Commit Every

DML Statement preference selected. This meansthat your changes to query results are

automatically being saved to the database.

To confirm or change this setting, choosePreferences from the View menu and then open

the Session preferences.

Errors from updateable queries

TOKEN:.(12121,2),

The Spool window

To display the text of the executed statement in theSpool window


233/464


Spool window toolbar buttons

Button Function

Spool window shortcut menu commands

Menu Option Function

To display SQL statements in the Spool window

Retrieving previously executed SQL statements

Spooling results as text


234/464


To view results in text form

To view results in text form

To view the text of a memo field

Viewing results in the Result window

Result Display of the SQL Editor


235/464


Working with query results

Editing query results

Exporting query results

To export query results

1

2

Printing query results


236/464


To print query results1

2

3

4

Viewing objects in table columns

To display the details of a selected record

To display multiple rows in a data sheet format

To sort the data sheet

To fetch sets of rows


237/464


Copying data from the Result window

To copy and paste selected data

1

2

3

4

Switching between SQL code and results

For this SQL Editor window Use this key

Selecting, inserting and deleting results data

To select the entire data sheet

To insert a new row into the data sheet before the current row


238/464


To delete the current row

To jump between a query and its results page

To jump to the associated results tab


239/464

6Working with PL/SQL code

In this chapter

Working with PL/SQL: Overview 238Typical PL/SQL editing scenario 240Working with packages 240Tools and commands for editing stored programs 242Database Source Code Search 267Writing and editing stored programs 268Executing stored programs 275Optimizing stored programs: The PL/SQL Profiler 280Debugging PL/SQL 295


240/464


Working with PL/SQL: Overview


241/464


Example

1

2

3

4

5

6

7


242/464


Typical PL/SQL editing scenario

Working with packages


243/464


Sample view of a package in two synchronized panes


244/464


Tools and commands for editing stored programs

Commands for are found here

Advanced editing features for stored programs

Smart code completion


245/464


Dot-lookup

Code Explorer

Customizable syntax highlighting for PL/SQL

Dynamic highlighting of matching pairs of brackets

Dynamic highlighting of the closest encompassing block

One-key switching between implementation and specification ofa packaged procedure

Hyperlinking

Syntax tooltips


246/464


Controlling what is displayed in the Stored ProgramEditor

Stored Program Editor toolbar commands


247/464


Managing stored programs as database objects

Object menu and toolbar commands (stored procedure open)


248/464


To Use this command


249/464


Editing code in stored programs

Edit menu and toolbar commands (stored procedure open)


250/464


To Use this command


251/464


Automated coding assistance


252/464


Searching for code or objects in the database

Search menu commands


253/464


To Use this command

Using other SQL Navigator windows with the StoredProgram Editor


254/464


View menu commands


255/464


To Use this command


256/464


Managing your editing session


257/464


Session menu commands

To Use this command


258/464


Access to tools and add-ons for stored programdevelopment

Tools menu commands (stored procedure open)


259/464


For Use this tool or add-on


260/464


Synchronizing advanced editing features

Viewing compiler errors

Oracle error code explanation display

To view a full Oracle error description

To view the source code corresponding to a listed error

1

2


261/464


The Knowledge Xpert


262/464


PL/Vision Control Panel settings

Tab / Category Setting Result

General

Exceptions


263/464



Logging


264/464



Tracing


265/464



Data Conversion


266/464



Transaction Management


267/464



File I/O


268/464



Knowledge Xpert


269/464


Database Source Code Search

To search source code

1

2

3

You can specify the search string, schema name,and object name using wildcard characters "%"

and "_" (according to SQL LIKEoperatordefinitions).

4

To view information about the objects found

To open an object displayed in the results table

To add a code location shortcut to a workspace


270/464


Writing and editing stored programs

Creating a new stored program

To create a new stored program

1

2

3

4

5

6

Modifying a stored program


271/464


To open a stored program for editing1

2

To insert a saved text file into the Stored Program Editor

1

2

3

To modify stored programs

Be cautious when modifying stored programs in aproduction database. Saving a program applies

the changes to the stored program on the server.

If there are compiler errors in the program code,Oracle invalidates the program on the server.

1

2

3

Faster development using the Code Explorer


272/464


Displaying the Code Explorer

To display the Code Explorer


273/464


Rapidly locating source code segments

To quickly move the cursor to a procedure or function

Begin/End markers for loops and blocks


274/464


Using bookmarks in source code

To set a bookmark using a shortcut menu1

2

3

To set a bookmark using a keyboard shortcut

To list bookmarks

To go to a bookmark using a shortcut menu

1

2

3

To go to a bookmark using a keyboard shortcut

Programmable keys for PL/SQL code


275/464


Compiling a stored program

To compile a stored program from the Stored Program Editor

Customizing color highlighting for PL/SQL and SQL

keywords

Converting HTML into a PL/SQL stored procedure

Correcting syntax errors


276/464


To highlight the line containing an error

Drag-and-drop PL/SQL editing

Correcting typing errors

Testing program code with debug statements


277/464


Executing stored programs

Executing stored programs

If you have the PL/SQL Debugger, you can setbreakpoints and watch variables before execution

in Debug mode.

To execute a stored program

Creating anonymous blocks


278/464


..STB

To generate an execution code block

1

2

3

4

5

6

Profiling Details dialog options

Option Description


279/464


Set Options dialog options

Option Description


280/464


Viewing results in the Output window

The Output window showing compile results with errors


281/464


Viewing an Oracle error description and solution

To view an Oracle error description

Editing window, Output window, and Oracle Error Information window

Stepping though stored programs

Running stored programs in Debug mode


282/464


Optimizing stored programs: The PL/SQL Profiler

Optimizing stored programs with theProfiler/Coverage tool

You can launch the Profiler from the Tools menu or theFunctions toolbar


283/464


To open the Profiler

Before using the Profiler, debug your stored

program, as there is no editing capability fromwithin the Profiler.


284/464


Viewing an open object in the DB Navigator

Using the Locate in DB Navigator command


285/464


Result of the Locate in DB Navigator command


286/464


Using the Profiler with the Stored Program editor


287/464


PL/SQL Profiler quick-reference guide

Action Node Type Command Shortcut


288/464


Action Command Shortcut

PL/SQL Profiler: Basic concepts

Run

Profiling data types

Group

Code Unit


289/464


Executable Line

Example: Identifying an execution bottleneck

1

2

3

4

5

6

7

Example: Using the coveragefeature for quality assurance

1

2

3

4

5


290/464


Installing the PL/SQL Profiler

PL/SQL Profiler window

Tree views

Runs view


291/464


Groups view

To view the profiling data for an item in the tree view

To select from a list of actions to perform

Interpreting PL/SQL Profiler result sets


292/464


Node Type Tab Result Set Description


293/464




294/464




295/464


Setting PL/SQL Profiler filters and sort options

Threshold and sorting works only if there is asingle series to be displayed in the Runs tree andCombine Runs in Group Result Setsis enabled

for the Groups tree.

Data Filters tab options

For this result Select this option


296/464



Chart Options tab options



297/464


298/464


The DBMS_OUTPUT package

DBMS_OUTPUT

Using the DBMS_OUTPUT package as an aid to debugging

DBMS_OUTPUT.PUT_LINE

DBMS_OUTPUT

DBMS_OUTPUT.PUT_LINE DBMS_OUTPUT.PUT_LINE

To insert a DBMS_OUTPUT.PUT_LINE debugging statement

DBMS_OUTPUT.PUT_LINE();


299/464


To produce a DBMS_OUTPUT statement for a variable

DBMS_OUTPUT(Value of = ||var_name);

Examples of DBMS_OUTPUT statements used for debugging

DBMS_OUTPUT.PUT_LINE(Reached update employee statement);

v_ename VARCHAR2

DBMS_OUTPUT.PUT_LINE(Value of Employee name is:||v_ename);

v_empno NUMBER

DBMS_OUTPUT.PUT_LINE(Value of Emp number is:||TO_CHAR(v_empno));


DBMS_OUTPUT


Color Data type

To set the Output window buffer size


300/464


Enabling Output for a database session DBMS_OUTPUT DBMS_OUTPUT

To set the Output window option ON

To disable the Output window option for a database session


301/464


Debugging Functions, Triggers and Packages

Debugging PL/SQL with the SQL Navigator Debugger

Overview


302/464



303/464


Debugger commands

Using the SQL Navigator debugger


304/464


create session

alter session

To compile a stored program or trigger with debug information

Debugging stored procedures


305/464



306/464


Oracle version requirements for the Debugger

Feature Supported in Oracle version?

Setting watched variables


307/464


my_record.field1my_table(i).field1

Increasing the number of variables in the watch

variable list may result in slower debugger

performance.

To add to the list of watched variables

1

2

3

To add arguments of a procedure to the list of watches

1

2

If a variable does not update as expected, place abreakpoint on the next executable line after the

expected update The breakpoint pauses the

debugger and updates the variables values.

To remove a watched variable name

1

2

3


308/464


Displaying watch variables during execution

Handling out-of scope-variables

The debugger maintains separate watch lists foreach program unit. Therefore, if a watch is

defined correctly, it will not be displayed when it

is out of scope.

The Debugger distinguishes package variablesthat belong to different namespaces:

Local

Specification

Body

You can specify the scope for a package variablefrom the Watch Properties dialog.


309/464


Displaying the call stack

A brief glossary of debugging terms


310/464


Initiating a debugging session

To initiate debugging

1

2

3

4

Shortcuts


311/464


To Choose this option

Debugging code run from an external application

id := dbms_debug.initialize(SQLNAV)

dbms_debug.debug_on;

SQLNAV initialize

dbms_debug.debug_off


312/464


Attaching an external session for debugging

To attach an external session for debugging

1

2

3 4

initialize

5

EXAMPLE

CREATE OR REPLACE

PROCEDURE test_proc1(n NUMBER) IS

BEGIN

. . .

END;


313/464


1

2

DECLARE

id VARCHAR2(30);

BEGIN

id := dbms_debug.initialize(SQLNAV);

dbms_debug.debug_on;END;

3

BEGIN

test_proc1(123);

dbms_debug.debug_off;

EXCEPTION

WHEN others THEN

dbms_debug.debug_off;

END;

4


314/464


5

BEGIN

dbms_debug.debug_on;END

Setting and viewing breakpoints

A new and useful feature in this version of SQL

Navigator is its one-click ability to set and modifybreakpoints within the Stored Program Editor.

If debug mode is enabled, clicking in the gutter onthe left side of the text-editing area displays aBreakpoint properties dialog. Here you can

specify line numbers and break conditions, and

disable or enable breakpoints.


315/464


To set or clear breakpoints before executing a procedure1

2

3

If you Toggle Breakpointon a line ignored

by the compiler, such as a comment, thebreakpoint will not be set. The debugger

displays an "Unable to Set Breakpoint"message when execution begins.

3

4

5

To set breakpoints during execution

1

2

To display existing breakpoints

1

2


316/464


Disabling breakpoints

To disable or enable a breakpoint (Debug menu)

1

2

To disable or enable a breakpoint (Execution Status window)

1

2

Setting conditional breakpoints


317/464


The breakpoint condition is evaluated beforethebreakpoint statement is executed.

Example:

1 CREATE OR REPLACE PROCEDURE DEBUG_MEAS2 l_variable BINARY_INTEGER;3 BEGIN

4 l_variable := 10;5 END;

If the user sets up a breakpoint on line 4 with acondition l_variable = 3, the debugger will break

on line 4 regardless of the condition. It does sobecause at that point the statement l_variable :=

10has not been executed, and the conditionl_variable = 3will not be evaluated correctly

To define or change a conditional breakpoint

1

2

3

Option Note

4


318/464


Controlling code execution in the debugger

Stopping

Use caution when stopping execution. Anyuncommitted changes made by the program maybe lost.

Stepping over code

To step over code

1

2


319/464


Stepping into code

To step into code

1

2

Stepping out

Run to caret


320/464


Evaluating and modifying variables

To evaluate or modify a variable

Testing variables

To test the result of a variable

1 2

3

4


321/464


5

If you see an error such as "Not compiled with

debug info" instead of the variable value, youneed to recompile the procedure with the Debug

information and re-execute it in the debugger tosee the value of variables.

Watching CURSOR variables

flags:FFF, rowcount:RRR.

RRR

FFF

%ISOPEN

%FOUND

%NOTFOUND

C1%NOTFOUND, C1%FOUND,C1%ISOPEN, C1%ROWCOUNT

Troubleshooting the Debugger

Oracle PL/SQL Error ORA-0600 when starting the Debuggeroption


322/464


To install Oracle Patches for Unix1

2

3

Debugging features support by Oracle

Limitations of the Debugger option


323/464


Prerequisites for running the Debugger option

ORA-04068 and ORA-04067 error messages

Setting up loopback connection on Personal Oracle7 forWindows

Caution! The listener.ora file must be editedexactly as shown. Changing the file format could

cause system problems that require additionaltechnical support.

To set up loopback connection on Personal Oracle7 for Windows

1

2

users guide for sql navigator

Documents