SQL Navigator® 7.

User Guide
Copyright 2019 Quest Software Inc. ALL RIGHTS RESERVED.
This guide contains proprietary information 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.
The information in this document is provided in connection with Quest Software products. No license, express or implied, by
estoppel or otherwise, to any intellectual property right is granted by this document or in connection with the sale of Quest Software
products. EXCEPT AS SET FORTH IN THE TERMS AND CONDITIONS AS SPECIFIED IN THE LICENSE AGREEMENT FOR
THIS PRODUCT, QUEST SOFTWARE ASSUMES NO LIABILITY WHATSOEVER AND DISCLAIMS ANY EXPRESS, IMPLIED
OR STATUTORY WARRANTY RELATING TO ITS PRODUCTS INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT. IN NO EVENT
SHALL QUEST SOFTWARE BE LIABLE FOR ANY DIRECT, INDIRECT, CONSEQUENTIAL, PUNITIVE, SPECIAL OR
INCIDENTAL DAMAGES (INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OF PROFITS, BUSINESS
INTERRUPTION OR LOSS OF INFORMATION) ARISING OUT OF THE USE OR INABILITY TO USE THIS DOCUMENT,
EVEN IF QUEST SOFTWARE HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. Quest Software makes no
representations or warranties with respect to the accuracy or completeness of the contents of this document and reserves the right
to make changes to specifications and product descriptions at any time without notice. Quest Software does not make any
commitment to update the information contained in this document.
If you have any questions regarding your potential use of this material, contact:
Quest Software Inc.
Attn: LEGAL Dept
4 Polaris Way
Aliso Viejo, CA 92656
Refer to our Web site (www.quest.com) for regional and international office information.
Patents
Quest Software is proud of our advanced technology. Patents and pending patents may apply to this product. For the most current
information about applicable patents for this product, please visit our website at www.quest.com/legal.
Trademarks
Quest, Toad, Toad World, SQL Navigator, Benchmark Factory and the Quest logo are trademarks and
registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit www.quest.com/legal. All
other trademarks and registered trademarks are property of their respective owners.
Legend

CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions
are not followed.

WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death.

IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting
information.

SQL Navigator User Guide

Updated - December 2019
Software Version - 7.6
Contents

Quick Overview 14
Better code, faster. 14
Who should use SQL Navigator? 14
Enter A New Authorization Key 14
Check for Updates 15

Working With SQL Navigator 16

Oracle Sessions 16
Finding Objects 16
Working With Objects 17
Web Development 18
Java Source Code 19
Analysis And Tuning 19
Team Coding And Version Control 20

Navigation 21
Main Menu 21
File Menu 21
Edit Menu 22
Search Menu 24
View Menu 24
Session Menu 26
Object Menu 27
Tools Menu 30
Team Coding Menu 33
Help Menu 34
Task Bar 35
Toolbars 35
Component List 36
Connection Category Color 40
Main Menu Keyboard Shortcuts 41
Customize The Screen Layout 43
Float / Dock 43
Toolbars in the Main Window 44
Main Menu Bar 44

Oracle Logon 45

SQL Navigator 7.6

3
User Guide
 Oracle Logon Dialog 45
Oracle Client Settings 45
Connection Parameters 45
Username / Password 46
Options 47
Oracle TNS Configuration 47
Advanced Service Options Dialog 48
Address List Options Dialog 49
DBA Dictionary Views 49
How SQL Navigator handles the views 50
Troubleshooting Connections to Oracle 50
Command Line Parameters 51

Code Editor 52
SQL Development 52
PL/SQL Development 52
Toolbox 53
Code Editor SQL 53
General Code Editor Functions 53
SQL Specific Functions 54
Team Coding Version Control 56
Tools and Applications 57
Code Editor PL/SQL 58
General Code Editor Functions 58
PL/SQL Specific Functions 59
Team Coding Version Control 60
Tools and Applications 61
Edit, Compile And Execute 61
SQL*Plus command support 66
Executing Scripts Invoked By At Sign (@) or Double At Sign (@@) SQL*Plus Commands 67
Connect To A Database Via The Code Editor 67
Bind Variables 67
Auto Code Completion 68
Scan Defines/Substitutions 68
Specifying substitution variables in SQL statements 69
DEFINE and UNDEFINE 70
New Stored Object Dialog 70
SQL Statement CRUD Matrix Dialog 71
SQL Query Results 71
SQL Query Results Data Grid 71

SQL Navigator 7.6

4
User Guide
 Rows Retrieved 72
Export / Print 72
Browse 73
Edit (Updateable Queries) 73
Group Display 74
Format 74
Sort & Display 74
SQL Query Log (The Spool Tab) 75
Export Data Dialog 75
Viewers: LOB, XML, Array 75
LOB Editor 75
ARRAY Editor 76
PL/SQL Execution Console 76
Run Time Parameters 77
Run Options 77
Code Test 78
PL/SQL Stub 79
DBMS_OUTPUT 79
Code Editor Keyboard Shortcuts 80
Right Click Over The Editing Pane 80
PL/SQL Debugger Keyboard Shortcuts 82
Further Shortcuts In The Code Editor Editing Pane 82
Further Shortcuts Viewing SQL Code Execution Results 83
Shortcuts In The Code Editor Toolbar 83
Toolbox 84
PL/SQL Debugger 84
Requirements 85
Debug 85
Code Explorer 86
Outline 87
DB Explorer 87
Describe 88
History 89
Dependencies 89
Columns 90

Visual Object Editors 91

Cluster Editor 92
Ways to Open The Cluster Editor 92
Constraint Editor 92

SQL Navigator 7.6

5
User Guide
 Using The Editor 93
Steps To Create A Constraint 93
Now the constraint is defined 94
Ways to Open The Constraint Editor 94
Database Link Editor 95
Ways to Open The Database Link Editor 95
Index Editor 95
Ways to Open The Index Editor 96
Nested Table Editor 96
Profile Editor 97
Requirements 97
Ways to Open The Profile Editor 97
Redo Log Group Editor 97
Ways to Open The Redo Log Group Editor 98
Role Editor 98
Requirements 98
Ways to Open The Role Editor 99
Materialized View Editor 99
Using The Editor 99
Editor Toolbar 99
Editor Tabs 100
Ways to Open The Materialized View Editor 100
Sequence Editor 100
Ways to Open The Sequence Editor 101
Synonym Editor 101
Ways to Open The Synonym Editor 102
Table Editor 102
Ways to Open The Table Editor 102
User Editor 103
Requirements 103
Ways to Open The User Editor 103
Varray Editor 103
View Editor 104
Using The Editor 104
Editor Toolbar 104
Editor Tabs 105
Ways to Open The View Editor 105
Java Editor 105
Ways to open the Java Editor 106

SQL Navigator 7.6

6
User Guide
 Instance Property Editor 106
Using The Editor 106
Instance Property 106
Editor Toolbar 107
Details Tab 107
Ways to Open The Instance Property Editor 108

Team Coding and Version Control Support 109

Use Team Coding with a VCS 109
Use Team Coding without a VCS 109
Work with non-controlled objects 110
Objects Supported by Team Coding 110
Administer Team Coding 110
Toolbar 111
Settings tab 111
Team Projects tab 111
Install Team Coding 111
Team Coding Settings 113
Team Projects 115
Setup Team Projects 116
Team Coding Roles 118
Configure Team Coding 119
Options 119
Configure Concurrent Version Systems (CVS) 120
Configure Git 122
Configure IBM Rational ClearCase 122
Configure Perforce (P4) 123
General tab 123
Options tab 123
Configure Serena PVCS Version Manager 124
Configure Subversion (SVN) 124
Client Tab 125
Server Defaults Tab 125
OptionsTab 125
Configure Microsoft Team Foundation Server 126
General Tab 126
Check In / Out Tab 126
History Tab 127
Advanced Tab 127
Team Coding Status 127

SQL Navigator 7.6

7
User Guide
 Team Coding Manager 128
VCS tab 128
Team Projects tab 128
Work with Team Coding objects 129
Provider logon 131
Using Git 132
Using Perforce 132
Using IBM Rational ClearCase 132
Mapped Drive and Views 132
Check in and Check out 133
Check in/check out individual objects 133
Check in all items 133
Automatic Check In and Check Out 134
Undo a checkout 134
Version Control Systems 134
Direct Supported 134
SCC Support 136
Concurrent Version (CVS) System Requirements 136
More about Git and SQL Navigator 136
More about IBM Rational ClearCase and SQL Navigator 137
More about Perforce and SQL Navigator 137
More about Team Foundation Server and SQL Navigator 137
TFS Work Items 138

Modules, Windows And Dialogs 140

Analyze Tool 140
Collect Statistics 140
Validate Structure 141
List Chained Rows 141
Auto Describe Tool 141
Benchmark Factory 143
Bookmarks Dialog 143
Capture Web Output 143
Start Capturing Web Output 144
While Capturing Web Output 144
Change Logon Password 144
Code Analysis 144
Access to Code Analysis 145
Rules and Rule Sets 145
Code Analysis Metrics 145

SQL Navigator 7.6

8
User Guide
 Code Analysis Window 146
Code Analysis Rule Sets 147
Create and Edit 147
Import and Export 147
Code Analysis Rules 148
Create or Clone 148
Edit 148
Import and Export 149
Code Assistant 149
Move a code snippet into the editor 149
Locate a code snippet in the Code Assistant 149
The Code Assistant Toolbar 150
Add to Catalog / Edit Dialog 151
Code Road Map 151
Code Road Map Toolbar 152
The Code Model 153
Model Code Dialog 154
Code Templates 155
Standard code routines for which templates have been provided: 156
Code Shortcuts And Templates Dialog 156
Default Templates 157
Code Test 158
Test Case Properties 159
Database Source Code Search 160
DB Navigator 161
DB Navigator Toolbar 161
Using DB Navigator 162
Filter Properties Dialog 163
Select filter 163
Select filter settings. 163
Describe 164
Difference Viewer 165
The Difference Viewer Toolbar 165
View Differences Dialog 167
Viewer Options 167
Appearance | Color Scheme 167
Appearance | Find Next Difference 167
File Comparison Rules 168
General 168

SQL Navigator 7.6

9
User Guide
 Define Minor 169
Edit Data 169
ER Diagram 169
ER Diagram Toolbar 170
ER Diagram Display Area 170
For each table in the model 170
To add tables to the diagram 171
Create ER Diagram 171
Explain Plan Tool 172
Explain Plan Window 172
Print the Explain Plan tree 173
Export Table 173
Find and Replace 176
Find objects Dialog 177
What To Search For 177
Now Objects Are Found 177
Find Recycle Bin Objects Dialog 178
What To Search For 178
Now Objects Are Found 178
Formatting Options 179
Formatting Options Toolbar 179
Set formatting options 179
HTML Viewer 180
Stored Procedure > HTML 181
Import HTML as PL/SQL 181
Sample code for displaying query results in a HTML page 182
Import Table 183
Java Manager 187
Job Scheduler 188
Jobs Tab 188
Programs Tab 189
Schedules Tab 190
Windows Tab 190
Window Groups Tab 191
Job Classes Tab 192
Job Log Tab 192
Window Log Tab 192
Job Scheduler (Requirements) 193
Job Scheduler system privileges 193

SQL Navigator 7.6

10
User Guide
 INIT.ORA configuration file 193
Locate In Tree 194
Output Window 194
Interpreting the output display 194
Actions 195
PL/SQL Profiler 195
Toolbar 195
Runs Tab 196
Groups Tab 197
Select PL/SQL Code on the Runs or Groups Tab 197
Profiler Filter/Preferences Dialog 198
Data Filters 198
Chart Options 199
New Group / Group Properties Dialog 199
PL/SQL Profiler Requirements 199
Profile Manager 200
To backup a profile 200
To restore a profile 201
Project Manager 201
Project Manager Toolbar 201
Manage Your Projects 201
Actions on Items in the Project Manager 202
Keyboard Shortcuts In The Project Manager Window 203
Project Filter Dialog 203
Publish Java to PL/SQL 203
Quick Browse 203
Rename Object 204
Search Knowledge Xpert 204
Knowledge Xpert 204
Select DB Object Dialog 204
Server Output 205
Tips For Use 205
Server Side Installation Wizard 205
Session Browser 205
Session Browser Toolbar 206
Sessions Grid 206
Session Information 207
Source Preview 208
SQL Modeler 208

SQL Navigator 7.6

11
User Guide
 SQL Modeler Toolbar 209
View Joins Dialog 210
Global WHERE Conditions Window 211
Global HAVING Conditions Window 212
Model Area 213
Add objects 213
Build a query 213
Create a table join 214
Menus in the Model Area 214
Tabs 216
Criteria Tab 216
Generated Query Tab 218
Query Results Tab 219
SQL Optimizer 219
Task Manager 219
Web Support Configuration Dialog 220
Wrap Code 220

View | Preferences 222

General 223
General | User Interface 223
User Interface 223
Pin at Start 225
Automatically Show Output Window 225
Startup 225
ER Diagrammer 225
Task Manager 226
Connection Category Color 226
General | "Drop" and "Truncate" safety options 226
Drop and Truncate 226
General | Session 226
Session 226
Trace 230
General | Default Tables 230
Default Tables 230
General | Explain Plan 230
Explain Plan 230
General | Code Assistant 231
Code Assistant 231
Displayed Pages 231

SQL Navigator 7.6

12
User Guide
 General | Printing 231
Printing 232
Editor 232
DB Navigator 233
General | Object Editors 233
Object Editors 233
General | Task Bar 234
Task Bar 234
Extract DDL 234
Extract DDL | General 234
Extract DDL/MetaData 234
Extract DDL 235
Extract DDL | Table/View Specific 236
Table/View specific 236
Partitioning 237
Extract DDL | Constraints 238
Constraints 238
Extract DDL | Materialized Views/Snapshots 238
Materialized Views/Snapshots 238
Extract DDL | Users 238
Users 238
Project Manager 238
Project Manager 238
Auto add items to Project Manager 239
Code Editor 239
Code Editor | General 239
General 239
Code Editor | SQL Scripts 241
SQL Scripts 241
Code Completion 243
Drag & Drop 243
Code Analysis 243
Lob Viewer 243
Team Coding 244
General 244
Keyboard Shortcuts (View | Preferences) 244

About Quest Software 245

Contacting Quest Software 245
Technical support resources 245

SQL Navigator 7.6

13
User Guide
 1

Quick Overview

Better code, faster.

SQL Navigator® provides an integrated environment for developing and testing Oracle stored programs and
procedures, schemas, objects, SQL scripts, and more—all from an easy-to-use graphical user interface.
The SQL Navigator family of products is a complete development environment for Oracle server-side
development and management. It has been conceived, designed and developed by Oracle developers and
DBAs with hands-on experience in the most common problems facing Oracle developers.

Who should use SQL Navigator?

SQL Navigator is intended for use by qualified Oracle developers and DBAs. (You know who you are!)
The developers of this product assume that the user has a good level of competence with Oracle relational
database concepts, designs, and methods, including SQL and its procedural extension PL/SQL, Oracle
database objects and datatypes.
Every attempt has been made to ensure that SQL Navigator is easy for developers and DBAs to install and use,
and is supported by comprehensive user assistance materials.
In the online help materials, we have not attempted to teach basic Oracle RDBMS skills nor to duplicate
information that is readily available from Oracle Corporation and from third-party publishers.

Enter A New Authorization Key

Click Tools | Product Authorization to enter a new product authorization key.

SQL Navigator 7.6

14
User Guide
Check for Updates
Click Help | Check for Updates to check for the latest version of SQL Navigator available.
Is there a newer version to download from the web site?

SQL Navigator 7.6

15
User Guide
 2

Working With SQL Navigator

Oracle Sessions
Icon Menu Description

Session Connect to an Oracle database instance / Open a new Oracle session. Manage your
Menu | database connections.
New
Open the Oracle Logon Dialog.
Session
TIP: SQL Navigator saves your connection profiles in the Project Manager window
for easy access.

Session Switch between open Oracle Sessions.

Menu|
Select TIP:

l You can set up multiple sessions with one or many database instances.
l Each session-related window (code editor, object editor, and so on)
remembers and automatically opens in the appropriate database session.

Send to Inside the Code Editor, while editing SQL code, you can send the current Code Editor tab
Session or a selected piece of code to another session. Highlight the code and click Send to New
Session. For more information, see Code Editor SQL on page 53.

Task SQL Navigator executes long-running tasks in separate threads in the background. The
Manager Task Manager is a display of all active and complete tasks for the current session.

TIP: Manage sessions in the Session Browser.

Finding Objects
SQL Navigator gives you several convenient point-and-click options for quick access to database objects.

SQL Navigator 7.6

16
User Guide
 Icon Tool Description

DB Explore the entire database structure as a tree with expandable nodes.

Navigator
TIP: Highlight a DB Navigator node and press F11 to find objects in that node.

Find Find objects by means of a search argument.

objects
Dialog TIP: To show a dynamic list of all objects in a schema - Select the schema node in
DB Navigator before you click Search | Find Objects.

Database Search stored programs, triggers and views for a character string in the source code.
Source
Code TIP: You can use this utility to perform a quick "where-used" impact analysis.
Search

Locate In Show the location of the current database object (for example, the one you are editing) in
Tree the DB Navigator hierarchy. Expand all intermediate nodes in the DB Navigator tree and
display the object’s detail view.

Find Locate objects dropped in the recycle bin.

Recycle
Requires Oracle 10g or 11g.
Bin
Objects
Dialog

Project The Project Manager provides instant access to your frequently used database objects and
Manager connections. Projects are holding areas where you can store shortcuts to things that you
frequently need to work with instead of searching for them in various lists and directories.

TIP: To find an object in DB Navigator from Project Manager: Right click on the
object in Project Manager and select Locate in DB Navigator. This opens the DB
Navigator window, expands tree nodes as necessary, and displays the details of the
selected object.

TIP:

l Use the Find Objects Dialog or DB Navigator for multiple-selection of objects.

l Your view of the Oracle Data Dictionary determines what objects you can see. For more
information, see DBA Dictionary Views on page 49.

Working With Objects

When you select an object, SQL Navigator enables all the appropriate menu or toolbar commands. The
available actions vary depending upon the type of object selected.

Icon Tool Description

DB Double click on an object to open it for editing.

Navigator

SQL Navigator 7.6

17
User Guide
 Icon Tool Description

TIP: Another way to open an object for editing - drag the object from:

l DB Navigator
l Find objects Dialog
l Project Manager

Drop the object on the application desktop.

Describe The Oracle DESCRIBE command reports the attributes, methods and arguments of an
object type. With the SQL Navigator Describe command you can describe not only
procedures, functions, packages, synonyms, and object types, but also tables, indexes,
clusters and objects.

Visual SQL Navigator editing tools for database objects.

Object
Editors

Code Maintain SQL and PL/SQL code.

Editor
Execute SQL queries. Debug PL/SQL code, prepare test data, run stored programs against
the database, and immediately view the results. Compilation errors are precisely
highlighted.

Quick View chained rows information.

Browse

Edit Data Edit data in a table object.

It is possible to display and edit multi byte data. National Language Support can be applied
to data in the Table Editor and Code Editor | Data Grid (SQL Query Results Data Grid).

Copy an object from one schema to another

1. Open a second DB Navigator window.
2. Drag the object from the source window to the target window.
3. Execute the DDL displayed in the editing window

Web Development
The SQL Navigator Web Development module provides an integrated development environment with advanced
coding, testing, and viewing of PL/SQL programs for the Oracle Web server. This allows users to develop the
PL/SQL code independent of the web server and view the HTML in an integrated web browser, thereby
eliminating the need to switch from their coding environment to an external browser. The stored procedure will
output the HTML code via the Oracle Web Cartridge.

SQL Navigator 7.6

18
User Guide
 Icon Tool Description

Capture Web Enable the web server. Each time you execute PL/SQL code, the generated HTML
Output is displayed in the HTML viewer.
Web Support Enter details of your Web server’s configuration.
Configuration
Dialog
Code Editor Code Web Server Procedures. The editor includes drag and drop coding for Web
toolkit packages, including htp and htf items. Execute the procedure.
HTML Viewer View HTML pages.

Import HTML as Convert a HTML file into a PL/SQL stored procedure.

PL/SQL

Java Source Code

Icon Tool Description

DB Navigator View Java-related objects (sources, classes, resources)

Database Source Code Search

Java Editor Edit Java source stored in the database.

Compile Java objects

Object Menu | Extract DDL Extract SQL DDL of Java Source

Java Manager Load Java classes (Oracle LoadJava utility)

Drop Java classes (Oracle DropJava utility)

Publish Java to PL/SQL Create a PL/SQL package from a Java class stored in the database.

Analysis And Tuning

SQL Navigator provides useful tools for tuning and database management. These tools are intended to be used
in conjunction with each other.

Icon Tool Description

Analyze Tool View and collect statistics, validate structure and list chained rows for database
structures such as tables, clusters and indexes.
Explain Plan Analyze the execution of a single SQL statement. By examining the execution plan,
Tool you can see exactly how Oracle executes your SQL statement, and how it can be
improved.

SQL Navigator 7.6

19
User Guide
 Icon Tool Description

ER Diagram Model a table and graphically see the dependencies and joins to other tables.

Code Road Display the complex PL/SQL inter-dependencies within a database.

Map

Integration Benchmark Factory® is a highly scalable load testing, capacity planning and
with performance tuning tool capable of simulating thousands of users accessing your
Benchmark database, file, Internet and messaging servers.
Factory

Team Coding And Version Control

SQL Navigator provides extensive and flexible Team Coding controls, including integration with third-party
version control systems. For more information, see Team Coding and Version Control Support on page 109.

SQL Navigator 7.6

20
User Guide
 3

Navigation

Main Menu
File Menu
Operations on files and projects, plus the Exit command.

Menu Menu Name More Information

Icon

New File Menu Icon Menu Name More Information

HTML File HTML Viewer

SQL Script Code Editor

New Project Open a new project window. See also Project Manager.
Use File | Reopen Project to return to the previous project.

Open File Open an external file in the Code Editor.

Reopen Project Reopen a project window. See also Project Manager.

Rename Rename the current project window. See also Project Manager.
Project
Delete Project Delete the current project window. See also Project Manager.

Save File Save the file to disk.

Save File As Save the file to disk. Optionally change the file name and location before
saving.
Print Print the file.

SQL Navigator 7.6

21
User Guide
 Menu Menu Name More Information
Icon

Print Preview Preview the file before printing.

Print Setup Enter setup options for printing.

Exit Close SQL Navigator

Edit Menu
Common text and code-editing actions.

Menu Menu More Information

Icon Name

Undo Reverse the previous editing action.

Redo Reapply the previous editing action
Cut Remove selected text and place it on the clipboard

Copy Copy selected text to the clipboard

Paste Insert the clipboard contents at the cursor location.

Select All Select all text in the item being edited

Indent Indent the current line

To increase or decrease the indent of selected text in the editor

Unindent Unindent the current line

To increase or decrease the indent of selected text in the editor

Comment Enclose the selected text inside PL/SQL comment marks

Uncomment Remove the PL/SQL comment marks from the selected text

Upper Case Convert selected text to upper case

Lower Case Convert selected text to lower case
Convert Convert all keywords and reserved words in the program to uppercase
Keywords
to Upper
Case
Convert Convert all keywords and reserved words in the program to lowercase
Keywords
to Lower
Case
Open Place selected text in the Code Editor
Selected
Text in

SQL Navigator 7.6

22
User Guide
Menu Menu More Information
Icon Name

Code Editor
Nil Insert Menu Menu Name More Information
Icon

File Insert a text file at the current cursor location.

DBMS_ Insert DBMS_OUTPUT.PUT_LINE('') at the current cursor

OUTPUT.PUT_ location.
LINE(")
This procedure displays program output after execution.
For more information, see DBMS_OUTPUT on page 79.

Debug Create a debugging statement for the variable at the

Variable current cursor location.

l The statement is copied to the clipboard.

l Use Edit | Paste to place the statement in the code.

CRUD Matrix Insert a CRUD (Create-Update-Delete) matrix, enclosed in

comment markers, at the current cursor location in the
Code Editor.
This provides a convenient method of documenting a
procedure.
SQL Statement CRUD Matrix Dialog

Got to Line Move to a specific line number in the editor.

Jump to Move to the other bracket within a given pair of brackets

Matching
Bracket

Toggle Place a bookmark at the current line.

Bookmark
You can set up to ten bookmarks (identified numerically 0-9).

Go to Return to a bookmarked line in the code.

Bookmark
Example Scenario: Set bookmark number 1 in the DECLARE section and bookmark
number 2 at your current editing location. To return to the DECLARE section press
Ctrl+1. After looking at your variable or cursor declarations, return to your editing
location by pressing Ctrl+2.

List View / Go to / Delete bookmarked lines in the code.

Bookmarks
Bookmarks Dialog

Open Open the database object referenced at the current cursor location.
Object at
Use to instantly find objects from stored programs or scripts, and open them in the
Cursor
Visual Object Editors.

Describe Show DESCRIBE information for the database object referenced at the current cursor
Object at location.

SQL Navigator 7.6

23
User Guide
 Menu Menu More Information
Icon Name

Cursor See also Describe.

Search Menu
Find text, code and database objects.

Menu Icon Menu Name More Information

Find Find a text string.

Find and Replace

Replace Find a text string and replace it with another.

Find and Replace

Find Next Find the next occurrence as per Find and Replace

Find previous Find the previous occurrence as per Find and Replace

Code Search Find source code in the database.

Database Source Code Search

Find Objects Find one or more database objects matching a search argument.
Find objects Dialog

Find Recycle Bin Objects Find Recycle Bin Objects Dialog

Requires Oracle 10g or later.

View Menu
Control what is displayed in the main application area.

Menu Menu Name More Information

Icon

DB Navigator Open / Focus DB Navigator

Code Editor Open / Focus Code Editor

Visual Object Visual Object Editors

Editor

SQL Navigator 7.6

24
User Guide
Menu Menu Name More Information
Icon

Menu Menu Name More Information

Icon

Cluster Editor Open a new instance of the Cluster Editor

Constraint Editor Open a new instance of the Constraint Editor

DataBase Link Editor Open a new instance of the Database Link

Editor

Index Editor Open a new instance of the Index Editor

Nested Table Editor Open a new instance of the Nested Table

Editor

Profile Editor Open a new instance of the Profile Editor

Redo Log Group Open a new instance of the Redo Log Group
Editor Editor

Role Editor Open a new instance of the Role Editor

Materialized View Open a new instance of the Materialized View

Editor Editor

Sequence Editor Open a new instance of the Sequence Editor

Synonym Editor Open a new instance of the Synonym Editor

Table Editor Open a new instance of the Table Editor

user Editor Open a new instance of the User Editor

Varray Editor Open a new instance of the Varray Editor

View Editor Open a new instance of the View Editor

Java Editor Open a new instance of the Java Editor

Instance Property Open a new instance of the Instance Property

Editor Editor

Project Show / Hide Project Manager

Manager
Window
Task Manager Show / Hide Task Manager

Output Window Show / Hide Output Window

Code Assistant Show / Hide Code Assistant

Code Show / Hide Code Templates

Templates

SQL Navigator 7.6

25
User Guide
 Menu Menu Name More Information
Icon

Auto-Describe Show / Hide Auto Describe Tool

Tool
Source Show / Hide Source Preview
Preview
Preferences Set SQL Navigator Preferences: View | Preferences

Screen Layout Save up to ten layouts of dockable windows and recall them. For more information,
see Customize The Screen Layout on page 43.

Menu Menu More Information

Icon Name

Nil Layout The current layout number is highlighted.

0-9
When you select a different layout number the current layout is
saved before the screen layout switches to the selected layout.
Use Layout 0 as a general-purpose default layout.

Reset Restore the current layout to the SQL Navigator default.

Docking

Session Menu
Manage and configure your connection to the database.

Menu Menu Name More Information

Icon

New Session Connect to an Oracle database instance / Open a new Oracle session. Manage your
database connections, including to create a database connection.
Oracle Logon Dialog

Select Switch between open Oracle Sessions. Show the current Oracle session.
You can set up multiple sessions with one or many database instances.

Server Toggle On / Off Server Output

Output

Capture Web Start/Stop Capture Web Output

Output

Include Watch, evaluate or modify a stored program variable.

Debug Info
1. Toggle On Include Debug Info.
2. Compile the program in the Code Editor.

See also: PL/SQL Debugger

SQL Navigator 7.6

26
User Guide
 Menu Menu Name More Information
Icon

Web Set up Oracle Web development support.

Configuration
Web Support Configuration Dialog

Wallet Features to decrypt the table keys to encrypt or decrypt application data
Operations
Menu Icon Menu Name

Generate Master Key

Open Wallet

Close Wallet

Suspend Suspend execution of the stored program.

PL/SQL Execution Console

Stop Terminate execution of the stored program.

PL/SQL Execution Console

Commit Commit all pending changes in all open editors for the current Oracle session.
Release any row or table locks held by the session.

Rollback Undo some or all of the changes made to the database during the current Oracle
session.
Release any row or table locks held by the session.

Change Modify the logon password of the current Oracle session.

Password
Change Logon Password

Empty Empty the recycle bin for the current Oracle session.
Recycle Bin
Reconnect Re-establish the database connection.

Close Close the current session. Close the Oracle connection. Disconnect from the Oracle
instance.
You can disconnect from an Oracle instance and remain connected to other
instances.

Close All Close all open sessions.

Object Menu
Operations on database objects.

SQL Navigator 7.6

27
User Guide
Menu Menu More Information
Icon Name

Create Create a database object.

DB Object

Open Locate and open a database object.

DB Object
Select DB Object Dialog

Open Open the selected database object for editing.

Not all database objects can be altered. You may need to drop the object and create a
new one.

Describe Show attributes, methods and arguments of the selected procedure, function, package,
synonym, table, index or cluster.
Ensure the required database connection is active.
Describe
See also Auto Describe Tool

Rename Rename the selected object.

Rename Object

Drop Remove the selected object from the database.

To disable the Drop command: View | Preferences | General | "Drop" and "Truncate"
safety options
(Oracle 10g and later): A recycle bin is available for handling and restoring dropped
objects. You can use DB Navigator to retrieve objects dropped from the database. See
also Find Recycle Bin Objects Dialog.

Drop with Remove the selected object from the database permanently. Do not place the object in
Purge the Recycle Bin.

Flashback Restore the selected object from the Recycle Bin.

Use DB Navigator to select an object in the Recycle Bin.
You can type a new name for the object in the New Name column if required.

Extract Extract the DDL or other SQL statements that define the selected object or access control.
DDL On requesting Extract DDL the SQL Navigator Preferences open: View | Preferences
| Extract DDL | General.
SQL Navigator encloses non-alphanumeric and mixed-case object names inside double-
quotes
You may like to use DB Navigator to select object(s).
Extract DDL runs as a background task. See Task Manager.

Get Get the metadata of the selected object(s).

Metadata

Publish Create a PL/SQL package from the selected Java class stored in the database.
Java to

SQL Navigator 7.6

28
User Guide
Menu Menu More Information
Icon Name

PL/SQL Publish Java to PL/SQL

Import Import objects from a DMP file.

Table
Import Table

Export Export objects to a DMP file.

Table
Export Table

Compile Compile/Rebuild the selected object.

Menu Menu Name More Information

Icon

Compile/Rebuild Compile the selected object.

Compile Compile dependents of the selected object.

Dependents
This eliminates the need to find and compile all dependent
objects that became invalid when altering a procedure,
table, or other structure.

Compile Compile dependencies of the selected object.

Dependencies

See also Task Manager, Code Editor.

Watch for feedback in the Output Window. If the object compiles with errors, open it in the
Code Editor and compile to make use of the Code Editor's error handling facilities.
If the object has been modified, you will need to save it before you can compile it. This is
to ensure that the changes in the object have been applied to the database.

Execute Execute the selected stored program and display the results in the PL/SQL Execution
Console.

SQL Open the selected object in SQL Modeler.

Modeler
Scenario Example: Select a table in DB Navigator. Open the table in SQL Modeler. Build
a query by selecting and dragging columns.

Quick Execute the SQL query for the selected table object in the Code Editor to view chained
Browse rows information.
See Quick Browse, SQL Query Results Data Grid

Edit Data Execute the SQL query for the selected table object in the Code Editor with Updateable
switched on.
See Edit Data, SQL Query Results Data Grid

Analyze View and collect statistics, validate structure and list chained rows for database structures
such as tables, clusters and indexes.
Analyze Tool

SQL Navigator 7.6

29
User Guide
 Menu Menu More Information
Icon Name

Truncate Remove all rows from a table and reset the STORAGE parameters to the values when
the table or cluster was created.
See also Task Manager.
To disable the Truncate command: View | Preferences | General | "Drop" and "Truncate"
safety options

Storage Oracle allocates space to objects in segments. Segments consist of contiguous sections
called extents.

Menu Menu More Information

Icon Name

Allocate Explicitly allocate a new extent for a selected table or index.

Deallocate Deallocate unused space at "the end" of a segment and make

that space available for other segments within the tablespace.

Coalasce Put together discontinuous fragmented extents.

For more information, see the Oracle documentation on the ALTER TABLE and ALTER
INDEX commands.

Enable Enable/Disable the selected constraint object.

If a constraint is enabled, Oracle automatically enforces it. If a constraint is disabled,
Oracle does not enforce it.
See also Constraint Editor.
Disable
See also Task Manager.
Locate objects of type Constraint using Find objects Dialog.

Grant Grant object privileges for the selected object.

Revoke Revoke object privileges for the selected object.

Locate in When an object is open in an editing window, and you want to see where that object
Tree resides in the schema, you can use Locate in Tree to jump to that object’s node in DB
Navigator.
Locate In Tree

Properties Show the properties of the selected object

Add to Add the selected object to the Project Manager

Project

Tools Menu
Invoke and control integrated tools.

SQL Navigator 7.6

30
User Guide
Menu Menu Name More Information
Icon

Code Test The Code Test panel automates the process of testing PL/SQL programs.
Code Test

Code Analysis Code Analysis analyzes code against a set of rules for best practices.
Code Analysis

View Compare two scripts / two objects.

Difference
View Differences Dialog

Formatter Format PL/SQL, SQL*Forms, Oracle Forms, and SQL*Plus source code.
Tools
Menu Menu More Information
Icon Name

Format Format the entire source currently in the editor.

Code
To format just a selection, select the text you want to format.
Output is displayed in the Output Window.

Syntax Check the syntax. Output is displayed in the Output Window.

Check
If syntax errors are detected, the text stays unchanged. The
errors are displayed in the Output Window.

Profile Create a summary of the code statistics. You can copy to

Code clipboard or save to file.

Multi-File Open the Multi-File Formatting Selection dialog.

Formatting
l Select Folder and enter the folder that directly
contains the files you want to format. Or

l Select Files and enter the files you want to format.

Select Backup files to folder to create a backup copy of the

files you are about to format.

Formatting Define how the Formatter Tool formats code.

Options
Formatting Options

Wrap Code Access Oracle’s Wrap Code utility.

Wrap Code

Session Manage sessions in the Session Browser.

Browser
Session Browser

Search Knowledge Xpert (formerly RevealNet) is a library of more than 900 pre-built PL/SQL
Knowledge routines, written by some of the world's leading PL/SQL experts, that can be
Xpert integrated into the standard PL/SQL environment.
Search Knowledge Xpert

SQL Navigator 7.6

31
User Guide
Menu Menu Name More Information
Icon

SQL Optimizer Analyze and tune the execution of SQL scripts.

SQL Optimizer
Requires installation of SQL Optimizer for Oracle.

Explain Plan Create, store and browse execution plans.

Tool
Explain Plan Tool

PL/SQL Analyze the execution time and efficiency of your stored programs.
Profiler
PL/SQL Profiler

SQL Modeler Create the framework of a Select, Insert, Update, or Delete statement.
SQL Modeler

Code Road Show the complex PL/SQL inter dependencies within a database.
Map
Code Road Map

ER Diagram Model a table and graphically see the dependencies and joins to other tables.
ER Diagram

Job Scheduler Work with Oracle Job Manager.

Job Scheduler

Java Manager Load and unload multiple Java source files, classes, resources and archives. This is
a convenient alternative to the Oracle LoadJava and UnloadJava command line
utilities.
Java Manager

Import HTML Convert a HTML file into a PL/SQL stored procedure, to be output via the Oracle Web
as PL/SQL Cartridge.
Import HTML as PL/SQL

Code Tester Open Code Tester for Oracle.

Requires installation of Code Tester for Oracle.

Benchmark Open Benchmark Factory.

Factory
Requires installation of Benchmark Factory.

Toad Data Open Toad® Data Modeler.

Modeler
Requires installation of Toad Data Modeler.

Profile Backup and restore SQL Navigator profiles.

Manager
Profile Manager

SQL Tracker Open SQL Tracker.

Requires installation of SQL Tracker.

SQL Navigator 7.6

32
User Guide
 Menu Menu Name More Information
Icon

Server Side Install the server-side components of SQL Navigator

Installation
Server Side Installation Wizard
Wizard

Product Enter A New Authorization Key.

Authorization

Team Coding Menu

Extensive and flexible Team Coding controls, including integration with third-party version control systems.

Menu Menu More Information

Icon Name

Administer Use the Team Coding Administration page to install, set up, and manage the Team
Coding environment.
Open Administer Team Coding.

Configure Set local Team Coding options.

Open Configure Team Coding.

Team View the status of the Team Coding configuration and features. See Team Coding
Coding Status.
Status

Team Use the Team Coding Manager to manage and work with the objects that are controlled
Coding by Team Coding. The Team Coding Manager displays Team Coding status and
Manager controlled objects for the current active connection.
Open Team Coding Manager.

Team View the summary of all controlled objects for the current active connection.
Coding
Summary
info

Provider Logon to the Version Control Product.

Logon
Requires that a version control product is in use. See Provider logon.

Add file Add a file to VCS.

SQL Navigator 7.6

33
User Guide
 Menu Menu More Information
Icon Name

Check out Use to check out and check in an object or script. See Check in and Check out.
To indicate the object or script to check in or check out:

l Select the object in DB Navigator, Find objects Dialog, Team Coding Manager,
Object editing windows.
Check in
l Open the object in one of the Visual Object Editors or Code Editor.

Not applicable when Automatic Check-Out and Automatic Check-In are enabled. For
more information, see Team Projects on page 115.

Undo Cancel the check-out. You are prompted to confirm that you want to discard any changes
Check Out you have made and restore the database version of the item as it was prior to checkout.

Confirm You have made and saved changes to the object and you want to discard
Yes those changes.
Confirm You have made and saved changes to the object and you want those
No changes to be retained in the database. As a result the version saved in the
third party version control system will be different from the version saved in
the database.

Check in Check in all changes

All

Compare Select a database object (in DB Navigator for example) and compare it with the latest
Contents revision.
Get Latest Get the latest version of an object or script as it is held in the Version Control System.
Revision
The Get Latest Revision command overwrites the version of the object or script in the
database, replacing it with the latest version held in the Version Control System.

Help Menu
Access to user-assistance

Menu Menu Name More Information

Icon

Contents General and How-To information

Context Help Open context-sensitive help for the current window or dialog
Not all windows and dialogs are linked to help topics.

Shortcuts & Look up keyboard shortcuts and function keys

Function Keys
Open Main Menu Keyboard Shortcuts

Find a Locate SQL Navigator commands

Command
Open Component List

SQL Navigator 7.6

34
User Guide
 Menu Menu Name More Information
Icon

SQL Navigator Visit for all the latest product information, including tips and techniques.
Community

Contact Open the Support Portal. Log issues, search the knowledge base and download
Support products.
https://support.quest.com/

Create Create the support bundle file: SupportBundle.dta.

Support
This file will contain information about your environment and installation of SQL
Bundle Files
Navigator. If you log an issue with support then they may request this file.

Check For Check for Updates

Updates

About SQL SQL Navigator version, licensing version and options, and contact information.
Navigator

Task Bar
The Task Bar lists all active SQL Navigator windows for the current project.
Use the Task Bar to select a SQL Navigator window to work on. That window is bought to the foreground,
giving it focus.

TIP:

l To show / hide the Task Bar, right click over the Main Menu or Task Bar and click Task Bar (List
of Windows).
l Point to an item on the Task Bar with your mouse to see a Tool Tip for the associated window.
l When there are lots of open SQL Navigator windows you may want to organize them on the Task
Bar. Active windows are grouped by session, with the most recent session’s windows appearing
on the left.

Toolbars
The following toolbars are available in the main window.
To show / hide a toolbar, right click over the Main Menu, any toolbar or task bar and select the toolbars to show.

Toolbar Description

Session Toolbar Duplicates some of the commands from the Session Menu.

SQL Navigator 7.6

35
User Guide
Toolbar Description

TIP: Pause/Resume and Stop buttons on the Session toolbar allow you to
interrupt execution of a current task. A hint on the Stop button dynamically shows
which task is running and (if applicable) its current progress.

Edit Toolbar Duplicates some of the commands from the File Menu and Edit Menu.
Functions Toolbar Duplicates some of the commands from the View Menu, Tools Menu and Help Menu.
Object Toolbar Duplicates some of the commands from the Object Menu and shows the current schema.
Team Coding Duplicates some of the commands from the Team Coding Menu.

TIP:

l Some modules within SQL Navigator have their own toolbars. You should refer to the module's
documentation for more information.
l To see a Tool Tip about an item on the toolbar, point to it with the mouse.

Component List
Icon Component Description
Name

Analyze Tool View and collect statistics, validate structure and list chained rows for database
structures such as tables, clusters and indexes.

Auto Report on the attributes, methods and arguments of an object type.

Describe
See also Describe.
Tool

Benchmark Simulate user transactions before and during application deployments, enabling
Factory performance issues to be addressed before end users are affected.

Bookmarks View / Jump to / Delete bookmarks.

Dialog
See also Edit Menu.

Browse Data View chained rows information.

See Quick Browse.

Change Modify the logon password of the current session.

Logon
Password
Cluster Join tables that are closely related for storing on the same area of the disk. This lets you
Editor interleave the rows of two or more tables together into a single area called a cluster.
Code Analyze code against a set of rules for best practices.
Analysis
Code Drag and drop PL/SQL syntax, SQL functions, column names, and database object
Assistant names into code.

SQL Navigator 7.6

36
User Guide
Icon Component Description
Name

Code Editor Edit SQL and PL/SQL code.

Code Show a hierarchical view the code.

Explorer
See Code Editor | Toolbox | Code Explorer.

Code Road Show the complex PL/SQL interdependencies within a database.

Map

Code Search See Database Source Code Search.

Code Insert ready-made code segments into any active editor window.
Templates
Code Test Automate the process of testing PL/SQL programs.

Constraint Use the Constraint Editor to specify table constraints.

Editor
Database Use the Database Link Editor to view, create or define database links.
Link Editor
Database Search stored programs, triggers and views for a character string in the source code.
Source Code
Search

DB Explorer Find and open database objects.

See Code Editor | Toolbox | DB Explorer.

DB Show the entire database structure as a tree with expandable nodes.

Navigator

Describe Report on the attributes, methods and arguments of an object type.

See also Auto Describe Tool.

Difference Compare objects in a split view.

Viewer
Edit Data Edit data in a table object.

ER Diagram Model a table and graphically see the dependencies and joins to other tables.

Explain Plan Analyze the execution of a single SQL statement.

Tool
Export Table Export selected tables.

Extract DDL See also Object Menu.

See also SQL Navigator Preferences: View | Preferences | Extract DDL | General.

Find and Find or replace text strings in the current text file.
Replace
Find objects Find objects in any schema.
Dialog

SQL Navigator 7.6

37
User Guide
Icon Component Description
Name

Find Recycle Search for objects in the recycle bin.

Bin Objects
Dialog

Formatting Configure how the Formatter Tool formats code.

Options
Formatter tools are available from the Tools Menu.

HTML Show HTML in the integrated viewer.

Viewer
Import HTML Convert a HTML file into a PL/SQL stored procedure. The stored procedure will in turn
as PL/SQL output the HTML code via the Oracle Web Toolkit.
Import Table Import tables.

Index Editor Use the Index Editor to view, create or alter indexes, and to set storage allocation.

Instance Use the Instance Property Editor to view or specify the startup parameters for the
Property instance.
Editor
Java Editor View and edit Java source.

Java Load and unload multiple Java source files, classes, resources and archives.
Manager
Job Access the Oracle Job Scheduler.
Scheduler
Locate In Jump to the selected object’s node in the DB Navigator tree.
Tree
Materialized Use the Materialized (Snapshot) View Editor to view, create or define snapshots.
View Editor
Nested Use the nested table editor when you require a large, efficient collection.
Table Editor

Open DB Select and open a database object similar to the standard Windows File | Open
Object command.
See Select DB Object Dialog.

Open Object See Edit Menu.

at Cursor
Oracle Manage your database connections, including to create a database connection.
Logon
Dialog

Outline Show the syntax tree of the current source.

See Code Editor | Toolbox | Outline.

Output Show SQL Navigator messages and server output including Oracle errors.
Window

SQL Navigator 7.6

38
User Guide
Icon Component Description
Name

PL/SQL Tools and features for debugging stored programs.

Debugger
See Code Editor | Toolbox | PL/SQL Debugger.

PL/SQL Analyze the execution time and efficiency of your stored programs.
Profiler
Profile Editor Use the Profile Editor to view, create or alter profiles.

Profile Backup and Restore SQL Navigator profiles.

Manager

Product See Enter A New Authorization Key.

Authorization
Project The Project Manager window provides instant access to your frequently used database
Manager objects and connections.
Publish Java Create a PL/SQL package from a Java class stored in the database.
to PL/SQL
Quick View chained rows information.
Browse
Redo Log Use the Redo Log Editor to view, create, or alter Redo Logs.
Group Editor
Role Editor Use the Role Editor to view or create roles.

Screen Save up to ten layouts of dockable windows and recall them.

Layout
See View Menu | Screen Layout

Search Drag and drop optimized routines directly into your program editor.
Knowledge
Xpert
Sequence Use the Sequence Editor to view, create, or alter sequences.
Editor
Server Side Install server side objects.
Installation
Wizard
Select DB Select and open a database object similar to the standard Windows File | Open
Object command.
Dialog

Select Switch between open Oracle Sessions.

Session
Session Manage sessions in the Session Browser.
Browser
Source Preview the source code of text objects (stored programs, triggers and views), or a
Preview package’s individual entry points.

SQL History The History tool lists successfully executed SELECT, UPDATE, DELETE commands
and PL/SQL blocks up to 1000 of the most recent ones in the current session.

SQL Navigator 7.6

39
User Guide
 Icon Component Description
Name

See Code Editor | Toolbox | History

SQL Modeler SQL Modeler dialog provides a fast means for creating the framework of a Select,
Insert, Update, or Delete statement. You can select Tables, Views, or Synonyms, join
columns, select columns, and create the desired type of statement.
SQL The SQL Optimizer makes observations about a selected SQL statement and the
Optimizer underlying database environment, then recommends several options to improve
performance.
Synonym Use the Synonym Editor to view or create synonyms.
Editor
Table Editor Use the Table Editor to create, alter, or define tables.

Task SQL Navigator executes long-running tasks in separate threads in the background. The
Manager Task Manager is a display of all active and complete tasks for the current session.
User Editor Use the User Editor to create, grant or revoke roles and privileges to users, including
forcing a password to expire.
Varray Editor Use the Varray Type Editor to create varying arrays.

View Editor Use the View Editor to view, create, or alter views.

View The Difference Viewer displays the compared objects in a split window.
Difference
See Difference Viewer.

Visual Object SQL Navigator’s editing tools for database objects.

Editors
Wrap Code The Wrap Code utility provides an easy way to access Oracle’s Wrap Code utility.

Connection Category Color

Optionally assign a connection to a category color in the Oracle Logon Dialog.
Possible categories could be: development, test or production. You could create your own categories and
assign colors as appropriate.
The color is displayed in the following places in SQL Navigator.

Component Name Description

Toolbars The connection entry in Session toolbar.

The border of windows belonging to the connection.

Task Bar Task Bar icons of windows belonging to the connection.

Code Editor Tab icons of the Code Editor window.

See also preference settings in View | Preferences | General | User Interface.

SQL Navigator 7.6

40
User Guide
Main Menu Keyboard Shortcuts
Generally available keyboard shortcuts are: Close Current Window = CTRL+F4 | Refresh = F5.

Icon Main Menu Keyboard Shortcut

File | Open File CTRL+O

File | Print CTRL+P

Edit | Undo ALT+Backspace

Edit | Redo SHIFT+ALT+Backspace
Edit | Indent CTRL+I

Edit | Unindent CTRL+U

Edit | Comment ALT+F7

Edit | Uncomment CTRL+ALT+F7

Edit | Upper Case CTRL+ALT+U

Edit | Lower Case CTRL+ALT+L
Edit | Insert | DBMS_OUTPUT.PUT_LINE('') CTRL+D

Edit | Insert | Debug Variable F2

Edit | Go to Line CTRL+G

Edit | Jump to Matching Bracket CTRL+J

Edit | Toggle Bookmark | Bookmark SHIFT+CTRL+n

Edit | Go to Bookmark | Bookmark CTRL+n

Edit | List Bookmarks ALT+B

Edit | Open Object at Cursor CTRL+Enter

Edit | Describe Object at Cursor CTRL+F3

Search | Find CTRL+F

Search | Replace CTRL+H

Search | Find Next F3

Search | Find Previous SHIFT+F3

Search | Find Objects CTRL+ALT+O

SQL Navigator 7.6

41
User Guide
Icon Main Menu Keyboard Shortcut

Search | Find Recycle Bin Objects CTRL+ALT+B

View | Project Manager Window CTRL+W

View | Code Editor CTRL+M

View | DB Navigator F12

Session | Stop Scroll Lock

Object | Create DB Object Alt+Insert

Object | Open DB Object CTRL+ALT+D

Object | Open CTRL+F2

Object | Describe CTRL+F3

Object | Drop ALT+Delete

Object | Drop with Purge SHIFT+Delete

Object | Extract DDL CTRL+D

Object | Compile | Compile/Rebuild CTRL+F9

Object | SQL Modeler CTRL+B

Open the selected object in SQL Modeler.

Object | Quick Browse F3

Object | Edit Data CTRL+E

Object | Grant ALT+G

Object | Locate in Tree CTRL+L

Tools | View Difference CTRL+ALT+V

Tools | Formatter Tools | Format Code CTRL+R

Tools | Search Knowledge Expert CTRL+K

Window | More Windows ALT+0

Help | Contents CTRL+F1

Help | Context Help F1

TIP: Many additional shortcuts are available for the various modules of SQL Navigator. For example, see
the Code Editor Keyboard Shortcuts.

SQL Navigator 7.6

42
User Guide
Customize The Screen Layout
Float / Dock
You can save multiple screen layouts of floating / docked items as per the View Menu | Screen Layout.

TIP: While moving a dockable item you can prevent it from docking by holding down the CTRL key.

Items that can More Information

be floating or
docked

Main Menu Bar The main menu bar can be floating or docked.

Dockable The following windows are dockable. They can be docked to any side of the SQL Navigator
Windows application window or any other dockable window. You can dock several windows to the
same site.

l Auto Describe Tool

l Code Assistant
l Output Window
l Project Manager
l Source Preview
l Task Manager

Dockable windows open in the same state (floating or docked) and in the same screen
position or at the same site as when they were last closed. Dockable windows retain size
and position between sessions.
The size and location of dockable windows are remembered in screen layouts as per View
Menu | Screen Layout.

NOTE:

l The size and location of the Output Window is remembered only when
docked.
l When the Output Window is docked, the Output Window remains visible ("on
top") when other windows are opened. When the Output Window is not
docked it can be hidden behind the current window.

Toolbars The toolbars can be docked to any side of the SQL Navigator application window or can
available in the float on top of the current window.
Main Window

Task Bar The task bar can be docked to any side of the SQL Navigator application window or can
float

SQL Navigator 7.6

43
User Guide
Toolbars in the Main Window
Customizations Description

Show/Hide Buttons 1. If the toolbar is docked, click the down arrow to the far right of the
toolbar.
If the toolbar is floating, click the down arrow on the title bar.
2. Click Add or Remove Buttons.
3. Select the buttons to show.

Add/Remove Toolbars. 1. If the toolbar is docked, click the down arrow to the far right of the
toolbar.
Reorder Items.
If the toolbar is floating, click the down arrow on the title bar.
Add items from a master list.
2. Click Add or Remove Buttons | Customize.

TIP: While the Customize dialog is open, move the mouse pointer
over a toolbar button and right click. Choose an option from the
shortcut menu. Reset the toolbar, delete or rename the button,
change its appearance or add a separator.

Reset the Toolbar to Default. 1. If the toolbar is docked, click the down arrow to the far right of the
toolbar.
If the toolbar is floating, click the down arrow on the title bar.
2. Click Add or Remove Buttons | Reset Toolbar.

Main Menu Bar

Customizations More Information

Customizable While the menu is docked, click the down arrow in the far right corner. If the menu is
Menu Items floating, click the down arrow on the title bar.

SQL Navigator 7.6

44
User Guide
 4

Oracle Logon

Oracle Logon Dialog

Manage your database connections, including to create a database connection.

Oracle Client Settings

Field Description

Oracle Home/Client Select from the list of available Oracle Home names.
TNSNAMES/LDAP/SQLNET Configuration File Path The location of your Oracle configuration files.
Names.Directory_Path As specified in your sqlnet.ora file.

Connection Parameters
Fill in the fields for one of the TNS, Direct or LDAP tabs.

TNS

Field Description

Database Select from the list of database connections in the TNSNAMES.ora file.

Direct
DIRECT is used for Direct Connection.

SQL Navigator 7.6

45
User Guide
 Field Description

Host Enter the name or IP address of the machine which hosts the Oracle server.
Port Enter the port number for the Oracle server.
Service Enter the service name of the Oracle server.
Name
SID Enter the Oracle System Identifier (SID) of the Oracle server. Use this option when connecting to an
instance running a version earlier than Oracle 8.1.

LDAP
Select from the databases on the LDAP server.

Username / Password
Field Description

Username Your Oracle username to the database.

When Save Password is selected the username field automatically recalls username/password
combinations based on the first letter(s) entered into the field.

Password Your Oracle password to the database/username combination.

Save Select to save the password for this database/username combination.

password
NOTE:

l Your password is saved in encrypted format.

l Ensure you have safeguards in place to prevent other users from physical access
to your computer (for example, automatic keyboard locking).
l If you have saved a password then deselect Save Password to delete it.

TNSNames Add a new service and configure the TNSNames.ora file: Oracle TNS Configuration.
Editor

TIP: To change the logon password for the active connection: Close this dialog. Select Session | Change
Password to open Change Logon Password.

SQL Navigator 7.6

46
User Guide
Options
Option Description

Bytes per Allow the system to automatically detect the number of bytes per character for the connection or
Character select from the list of available numbers.
The default preference is set in View | Preferences | General | Session. If you receive ORA-01026
errors (or similar) when working with the database, we recommend setting this preference to the
minimum possible value (2, 3 or 4) that eliminates the errors.

Connect Select the type of system privileges you want to use for this connection—Normal, SYSDBA, or
As SYSOPER.
Your Username must first be granted these privileges. For information about system privileges,
see the Oracle Database Administrator’s guide.

Enable Selected Use DBA views to query the Oracle Data Dictionary.
using
DBA Not Selected Use ALL views to query the Oracle Data Dictionary.
views
For more information, see DBA Dictionary Views on page 49.
Your Username must first be granted appropriate Oracle privileges.

Enable When selected, SQL Navigator generates a log file of database operations and results. Quest
Trace Support may request you enable trace for troubleshooting purposes.
Enabling Trace slows down your access to the database.

Category Optionally, assign to the connection a category color. For more information, see Connection
Category Color on page 40.

Oracle TNS Configuration

Field Description

Name The service name of the database.

Click Add to create a new configuration - Oracle TNS Configuration

Service configuration

Field Description

SID Specify the Oracle Instance.

Click Advanced to open the Advanced Service Options Dialog.
This field is visible if Use Oracle 8i release 8.0 Compatible Identification
is selected.

SQL Navigator 7.6

47
User Guide
 Field Description

Service name Type the service name.

This field is visible if Use Oracle 8i release 8.0 Compatible Identification
is clear.

Connection type Select a database connection type from the Connection Type list for the net
service name.
Oracle Corporation recommends you use the default setting of Database
Default.

Use Oracle 8i release 8.0 Select if the destination service is prior to release 8.1, then type its SID in
Compatible Identification the SID field.
Clear if the destination service is an Oracle release 8.1 database, then type
the service name in the Service Name field.

Address configuration

Field Description

Protocol Select a protocol from the list.

Host Name The host name of the computer where the database is located.
Port Number The TCP/IP port number. The default is 1521.
Add Add an address configuration.
Advanced Address List Options Dialog

Advanced Service Options Dialog

Option Description

Instance Name Type the database instance to access

Session Data Unit Type the SDU (Session Data Unit) to optimize the transfer rate of data packets
being sent across the network.
Use for Heterogeneous Select this option, if you want an Oracle8i server to access a non-Oracle system.
Services

For further information see the Oracle Administrator’s Guide.

SQL Navigator 7.6

48
User Guide
Address List Options Dialog
Option Description Compatibly with Net8
8.0 Clients

Try each address in order, until one FAILOVER=ON for release 8.1 clients Yes
succeeds
SOURCE_ROUTE=OFF for pre-
release 8.1 clients.

Randomly try each address until one LOAD_BALANCE=ON No

succeeds
FAILOVER=ON

Try one address selected at random LOAD_BALANCE=ON No

Use each address in order until a SOURCE_ROUTE=ON Yes

destination is reached

Use only the first address LOAD_BALANCE=OFF No

FAILOVER=OFF
SOURCE_ROUTE=OFF

Best Practice: Unless multiple address options are configured, the first address in the list is contacted.

DBA Dictionary Views

By default, SQL Navigator gives you USER object data dictionary views, meaning you can see only objects you
own or for which you have been granted object privileges.

When you Enable Edit Profiles, Roles, and Users.

DBA views in SQL
View the following nodes of the DB Navigator tree:
Navigator you can...
l Roles
l Some nodes under Users
l Datafiles under Tablespaces
l Redo Log Groups
l Rollback Segments
l Partitioned tables in another user’s schema

How to enable DBA Oracle Logon Dialog | Enable DBA Views

views in SQL
Navigator

Oracle requirements Your username must have one of the following roles or privileges:
to query DBA views
l DBA Role

SQL Navigator 7.6

49
User Guide
 l SELECT_CATALOG_ROLE Role
l SELECT ANY TABLE Privilege

DBA role and SELECT_CATALOG_ROLE role must be defined as the default roles in
Oracle.
In addition to the SELECT ANY TABLE privilege, Oracle 9i may also require the user
to have the SELECT ANY DICTIONARY privilege if the O7_DICTIONARY_
ACCESSIBILITY initialization parameter is set to FALSE.
For information about system privileges, see the Oracle Database Administrator’s
guide.

NOTE: Enabling DBA dictionary views may affect performance for some Oracle instances, depending on
the number of users and objects, as well as other environmental factors.

How SQL Navigator handles the views

When DBA dictionary views are selected, SQL Navigator interrogates the data dictionary differently:
Regardless of DBA View setting, SQL Navigator uses USER_% views for the logged-on user's objects.
Without DBA Views, SQL Navigator uses ALL_% views for other user's objects.
With DBA Views, SQL Navigator uses SYS.DBA_% views for other user's objects.

Troubleshooting Connections to
Oracle
Message Solution

Directory not Ensure that the Oracle bin directory is specified in the path.
in path
Enter the path command in the DOS prompt to check the path. If the directory is not in the
path, add it to the path in autoexec.bat and reboot the system.

Oracle Ensure that at least one of the 32 bit Oracle Required Support Files are installed. These files
Required are installed by default when you install any of the 32 bit Oracle products such as SQL*Net
Support Files and SQL*Plus.
not installed
To verify whether the Required Support Files are installed, start the Oracle installer. All
installed components are listed in the right side of the dialog box. If the Required Support
Files do not appear on the right-hand side list box, install these files from Oracle software
media.

Connect If you are connecting to a local database use 2: (or a blank) as the connect string. If you are
connecting to a remote database:

SQL Navigator 7.6

50
User Guide
 Message Solution

strings for • Ensure that the 32 bit SQL*Net client is installed

local and
• Ensure that the file tnsnames.ora has been properly configured using the SQL*Net Easy
remote
Configuration
database
• Ensure that proper network connectivity is available to the remote computer. Use the
TNSPING Utility from Oracle. Open a command prompt and enter tnsping <instance name>
6. If correctly configured, SQL*Net responds with 6 OK messages and measured response
times.
• Ensure that the SQL*Net listener application is running on the remote computer.

Command Line Parameters

Connection details can be passed via command line parameters. In addition, a key parameter /EXEC can be
passed along with the file name in the command line to force execution of a script.

TIP: Avoid storing your password in a Windows startup shortcut unless your computer is protected from
unauthorized access.

To connect to the database immediately on startup and bypass the Oracle Logon Dialog, pass the parameter in
the command line when starting SQL Navigator. Use the following format:
CONNECT=USERNAME/password@connect_string
Note the upper-case username. For example:
CONNECT=SCOTT/tiger@Marvin817
There is an alternative method, using /u, /p and /cs parameters (user, password, and connect string,
respectively). For example, you could create a Windows shortcut with the following Target property:
"C:\Program Files\Quest Software\SQL Navigator for Oracle\sqlnavigator.exe" /u=scott /p=tiger /cs=Marvin817

SQL Navigator 7.6

51
User Guide
 5

Code Editor

SQL Development
The Code Editor opens ready to edit SQL code.

More Information Brief Description

Code Editor SQL The Code Editor toolbar in SQL development.

Edit, Compile And Execute Write SQL code. Compile the code.
SQL Query Results Data Grid Browse the results of executed SQL queries.
SQL Query Log (The Spool View a log of executed SQL statements. Retrieve executed SQL
Tab) statements.

PL/SQL Development
The Code Editor layout for PL/SQL development is used when a stored object is opened or is being created.

More Information Brief Description

Code Editor PL/SQL The Code Editor toolbar in PL/SQL development.

Edit, Compile And Execute Write PL/SQL code. Compile the code.
PL/SQL Execution Console Set input parameters. Run the PL/SQL program.

SQL Navigator 7.6

52
User Guide
Toolbox
Icon More Brief Description
Information

Code Explorer Show a hierarchical view the code.

Outline Show the syntax tree of the current source.

DB Explorer Find and open database objects.

Describe Show the data structure for tables, indexes, views and synonyms.

History Show the most recent successfully executed SELECT, UPDATE, DELETE commands
and PL/SQL blocks in the current session.
Dependencies Show the Dependants and Depends On objects of the current script.

Columns Show/hide columns of the retrieved table in the data grid.

PL/SQL Tools and features for debugging stored programs.

Debugger
Show/Hide the PL/SQL Debugger in the Toolbox from the Code Editor toolbar.

TIP:

l Align the Toolbox left or right of the Code Editor (Right Click on the Toolbox).
l Pin/Unpin the Toolbox to allow more editing space.

Code Editor SQL

The Code Editor opens ready to edit SQL code. The toolbar is appropriate to SQL development. Each of the
toolbar icons is described below. In addition, all standard editing functions are available. See For more
information, see Edit, Compile And Execute on page 61. for more information.

General Code Editor Functions

Icon Tool Tip Description

Back Navigate between hyperlinked database objects (in the editing pane) and their
dependent objects and components.
Forward

New SQL Write a single SQL statement or a series of SQL statements in a new editing pane. The
toolbar will open for SQL development.

SQL Navigator 7.6

53
User Guide
Icon Tool Tip Description

New Create a stored object. Open the New Stored Object Dialog.
Stored
Object

Open File Open an external file in the Code Editor.

An alternative way to open file is to drag and drop a file from Windows Explorer to the
SQL Navigator window.

Save to Save the contents of the current Code Editor pane to an external file.
File
Open Locate a stored object using the Select DB Object Dialog and open the object in the
Object editing pane.
Auto Code Turn On/Off Auto Code Completion. When turned on, the Code Editor matches variables,
Completion parameters, procedures and types as you type.

Vertical Adjust the layout of the editing pane.

Split
Select from the options to split the editing pane in half either horizontally or vertically. The
content of the editing pane will be visible in both panes. You can scroll the panes
independent of each other.

TIP: To open a different script in one of the panes:

1. Open the second script in a new editing pane of the Code Editor.
2. Return to the split panes. In the pane to load the second script right-click
and select Split/Compare | Second Source.
3. Select the second source from the list of all scripts currently open in the
Code Editor.

SQL Specific Functions

Icon Tool Tip Description

Send to Session Switch to other sessions and continue working within the same window, with
the same script. This feature allows you to run the same script against different
databases without the need to copy it into another instance of the Code Editor.
It also allows you to correct the oversight of opening a file into the wrong
session.
You can choose from a list of current sessions or start a brand new session.

SQL Navigator 7.6

54
User Guide
Icon Tool Tip Description

NOTE:

l When you run that window (execute the SQL or compile the
PL/SQL code, for example), SQL Navigator will prompt you to
change to the new (current) session. It allows you to quickly
correct the oversight of opening a file into the "wrong" session.
l You can change session while editing SQL scripts only. This
option is not available to stored programs.

Add Condition Insert Where clause conditions in the SQL script using a graphical interface.

1. Type the SQL statement up to the where clause (Select * from emp_
table).
2. Click Add Condition to open the Add Filter window.
Remove All 3. Select and fill in the field, operator and value(s) accordingly.
Conditions
4. Click Ok to insert the where clause.

The Value(s) field is shown depending on which Operator has been selected.
Use when there is no semicolon (;) in the script.

Updateable On Edit the data returned by SQL queries. Update, delete and insert new
records and save your changes back to the database. This feature is
particularly useful for creating test data.

TIP:

l Updateable requires simple SELECT statements with no

joins, subqueries in select clause, calculated fields, group
by, having, count(), substr or DISTINCT.
l Updateable queries are slow to execute.

Off Data returned by SQL queries is read-only.

Stop on Error Use in conjunction with Execute to End to validate syntax.

Not Execute all SQL statements. Highlight all erroneous statements.

Selected
Selected Stop execution of SQL statements on encountering the first error.
Highlight the offending code.

Fetch All Limit the rows retrieved on execution of the SQL statement:

Not Selected Retrieve enough rows to fill the visible area of the grid.
Fetch additional rows on scroll down requests.

Selected Retrieve all rows.

SQL Navigator 7.6

55
User Guide
Icon Tool Tip Description

Spool Screen Select to capture a log of executed SQL statements in the SQL Query Log (The
Spool Tab).

Scan Turn On/Off Scan Defines/Substitutions

Defines/Substitutions
Turn on Scan Defines/Substitutions if your script uses variables or text that
contain the characters &, &&, or = :[bind variable]. Otherwise, the statements
containing the variables will generate an error.

Echo SQL On/Off

SQL History Show/Hide the Toolbox History

If the Toolbox is unpinned, showing History will not make History visible until
the Toolbox is shown.

Expand SQL Pane Maximize screen real estate of the SQL pane.

Skip to Top Execution Control Buttons:

l The location of the cursor marks the execution start point.

Skip to Previous l Use Skip to Previous and Skip to Next to move the cursor through the
SQL statements.

Execute to End l Click Execute to End or press F9 to run the script to the end.
l Click Execute Step or press F8 to execute the current statement.
Execute Step l To work with the result see SQL Query Results Data Grid.

TIP:
Stop
l You cannot run multiple queries within the same session
simultaneously. If you need to run multiple queries
Skip to Next simultaneously, you can open another connection to the same
database.

Skip to Bottom l To validate syntax use Execute to End in conjunction with Stop
on Error.

PL/SQL Debugger Show/Hide the Toolbox PL/SQL Debugger

If the Toolbox is unpinned, showing the PL/SQL debugger will not make the
PL/SQL debugger visible until the Toolbox is shown.

Abort Debug For more on debug see PL/SQL Debugger.

Session

Team Coding Version Control

To enable Team Coding see Administer Team Coding.

SQL Navigator 7.6

56
User Guide
Icon Tool Tip Description

Get Get the latest version of an object or script as it is held in the Version Control repository.
Latest
The Get Latest Revision command overwrites the version of the object or script in the
Revision
database, replacing it with the latest version held in the VCS repository. You can use the
View Differences Dialog to compare versions before overwriting the object.

Check Check out or check in the current object or script.

Out
Open:
Check In

Undo Cancel the check-out. You are prompted to confirm that you want to discard any changes
Check you have made and restore the database version of the item as it was prior to check-out.
Out
Confirm You have made and saved changes to the object and you want to discard those
Yes changes.
Confirm You have made and saved changes to the object and you want those changes
No to be retained in the database. As a result the version saved in the third party
version control repository will be different from the version saved in the
database.

Tools and Applications

Icon Tool Tip Description

SQL Optimizer SQL Optimizer

Explain Plan Explain Plan Tool

PL/SQL Formatter Format PL/SQL, SQL*Forms, Oracle Forms, and SQL*Plus source code.

Menu Menu More Information

Icon Name

Format Format the entire source currently in the editor.

Text
To format just a selection, select the text you want to
format.
Output is displayed in the Output Window.

Syntax Check the syntax. Output is displayed in the Output

Check Window.
If syntax errors are detected, the text stays unchanged.
The errors are displayed in the Output Window.

SQL Navigator 7.6

57
User Guide
 Icon Tool Tip Description

Menu Menu More Information

Icon Name

Profile Create a summary of the code statistics. You can copy to

Code clipboard or save to file.

Multi-File Open the Multi-File Formatting Selection dialog.

Formatting
l Select Folder and enter the folder that directly
contains the files you want to format. Or

l Select Files and enter the files you want to

format.

Select Backup files to folder to create a backup copy of

the files you are about to format.

Format Define how the Formatter Tool formats code.

Options
Formatting Options

Knowledge Xpert Search Knowledge Xpert

Code Analysis Code Analysis

Code Editor PL/SQL

The toolbar appropriate to PL/SQL development opens when you create / open a stored object in the Code
Editor. Each of the toolbar icons is described below. In addition, all standard editing functions are available. For
more information, see Edit, Compile And Execute on page 61.

General Code Editor Functions

Icon Tool Tip Description

Back Navigate between hyperlinked database objects (in the editing pane) and their
dependent objects and components.
Forward

New SQL Write a single SQL statement or a series of SQL statements in a new editing pane. The
toolbar will open for SQL development.
New Create a stored object. Open the New Stored Object Dialog.
Stored
Object

Open File Open an external file in the Code Editor.

SQL Navigator 7.6

58
User Guide
Icon Tool Tip Description

An alternative way to open file is to drag and drop a file from Windows Explorer to the
SQL Navigator window.

Save to Save the contents of the current Code Editor pane to an external file.
File
Open Locate a stored object using the Select DB Object Dialog and open the object in the
Object editing pane.
Auto Code Turn On/Off Auto Code Completion. When turned on, the Code Editor matches variables,
Completion parameters, procedures and types as you type.

Vertical Adjust the layout of the editing pane.

Split
Select from the options to split the editing pane in half either horizontally or vertically. The
content of the editing pane will be visible in both panes. You can scroll the panes
independent of each other.

TIP: To open a different script in one of the panes:

1. Open the second script in a new editing pane of the Code Editor.
2. Return to the split panes. In the pane to load the second script right-click
and select Split/Compare | Second Source.
3. Select the second source from the list of all scripts currently open in the
Code Editor.

PL/SQL Specific Functions

Icon Tool Tip Description

Open/Create Navigate to a function/procedure inside the package body.

Package Body

Entry Move the cursor to the function / procedure definition in the code.
Undo all changes Undo all changes since the last save.

Generate DDL Generate a DDL script of the procedure / function / package. Switch between the
script DDL script and procedure / function / package using the tabs at the bottom of the
screen. While the DDL script is on view the Code Editor toolbar adjusts to editing
SQL code.
Save to Database Save changes. Submit the PL/SQL to the database, compile, and report errors

Save to Database Save (clone) the object. The new stored program will have a definition identical to
As (Clone) the stored program currently open in the editor. Optionally select a new schema
and name for the object.

Execute Open the PL/SQL Execution Console from editing mode.

Procedure /
If the PL/SQL Execution Console is already open then execute the code.

SQL Navigator 7.6

59
User Guide
Icon Tool Tip Description

Function TIP: Once you have opened the PL/SQL Execution Console, toggle
between execution and editing mode via the tabs at the bottom of the
screen.

Stop procedure Use if required to stop execution of the procedure before it finishes.
execution
Toggle Breakpoint Add / Remove breakpoint on the selected line of code. For more on debug see
PL/SQL Debugger.

PL/SQL Debugger You can watch the result values during runtime. You can run stored programs in
parallel by opening additional sessions within SQL Navigator.
Show/Hide the Toolbox PL/SQL Debugger

Abort Debug For more on debug see PL/SQL Debugger.

Session

Team Coding Version Control

To enable Team Coding see Administer Team Coding.

Icon Tool Tip Description

Get Get the latest version of an object or script as it is held in the Version Control repository.
Latest
The Get Latest Revision command overwrites the version of the object or script in the
Revision
database, replacing it with the latest version held in the VCS repository. You can use the
View Differences Dialog to compare versions before overwriting the object.

Check Check out or check in the current object or script.

Out
Open:
Check In

Undo Cancel the check-out. You are prompted to confirm that you want to discard any changes
Check you have made and restore the database version of the item as it was prior to check-out.
Out
Confirm You have made and saved changes to the object and you want to discard those
Yes changes.
Confirm You have made and saved changes to the object and you want those changes
No to be retained in the database. As a result the version saved in the third party
version control repository will be different from the version saved in the
database.

SQL Navigator 7.6

60
User Guide
Tools and Applications
Icon Tool Tip Description

SQL Optimizer SQL Optimizer

Explain Plan Explain Plan Tool

PL/SQL Formatter Format PL/SQL, SQL*Forms, Oracle Forms, and SQL*Plus source code.

Menu Menu More Information

Icon Name

Format Format the entire source currently in the editor.

Text
To format just a selection, select the text you want to
format.
Output is displayed in the Output Window.

Syntax Check the syntax. Output is displayed in the Output

Check Window.
If syntax errors are detected, the text stays unchanged.
The errors are displayed in the Output Window.

Profile Create a summary of the code statistics. You can copy to

Code clipboard or save to file.

Multi-File Open the Multi-File Formatting Selection dialog.

Formatting
l Select Folder and enter the folder that directly
contains the files you want to format. Or

l Select Files and enter the files you want to

format.

Select Backup files to folder to create a backup copy of

the files you are about to format.

Format Define how the Formatter Tool formats code.

Options
Formatting Options

Knowledge Xpert Search Knowledge Xpert

Code Analysis Code Analysis

Edit, Compile And Execute

The Code Editor opens ready to edit SQL code. You will see the SQL Toolbar (Code Editor SQL) and a blank
canvas to write SQL code. If you create / open objects requiring PL/SQL code you will see the PL/SQL Toolbar
(Code Editor PL/SQL).

SQL Navigator 7.6

61
User Guide
Features Description

Standard All standard editing functions are available.

Editing
See:
Functions

Control the contents of the Code Editor Toolbars for Code Editor SQL or Code Editor
window PL/SQL as appropriate.

Manage objects in schemas Main Menu | Object Menu

Handle text-and code Main Menu | Edit Menu
Search for code or objects Main Menu | Search Menu
Access to various SQL Navigator windows Main Menu | View Menu
and tools

Manage database sessions Main Menu | Session Menu

Access add-ons, integrated applications Main Menu | Tools Menu
and additional tools

See also:

l Main Menu Keyboard Shortcuts

l Code Editor Keyboard Shortcuts
l Toolbars

Some functions are duplicated on the shortcut menu. Right click in the editing pane to open the
shortcut menu.

Working Drag and drop objects from the following SQL Navigator modules into the editing pane.
with
l DB Explorer
objects
l Project Manager
l DB Navigator

Show the definition of the object at the cursor location:

1. Right click on the object in the editing pane and select Go to Definition.
2. The result is shown in the Output Window.

Describe the object at the current cursor location:

1. Press CTRL and click the object's name.

2. This opens Describe for the object.

TIP:

l To construct SQL statements, drag and drop column names from the Describe tool
into the editing pane.
l If the described object is a text object (view, procedure, function, package or
packaged procedure/function) and the Source Preview window is open, the
object’s source is automatically previewed.

SQL Navigator 7.6

62
User Guide
Features Description

Automated Auto Code As you type an identifier the editor displays a selectable list of matching symbols
Coding Completion (variables, parameters, procedures, types) in the current scope.
Assistance
TIP: Turn on/off code completion from the Code Editor Toolbar.

Dot-lookup Type a dot character after a name of variable. The editor automatically displays
a selectable list of members of a PL/SQL record, cursor, package or
%ROWTYPE record.
Code The Code Explorer displays a hierarchical list of all symbols in the package or
Explorer procedure, and highlights the procedure the cursor is currently in. Double-click
on a symbol to navigate within the program. It dynamically parses and checks
syntax.

Hyperlinks To see the declaration of an identifier, press Ctrl+click. The text cursor
automatically jumps to the declaration of the symbol if it's defined within the
same program. If it's a name of an external database object, an Auto Describe
opens.
Syntax tool Point to a variable, parameter or procedure with the cursor to see a description
tips of it.

Insert Insert ready made code into the editor.

ready
1. Place the cursor in the editor window where you want the code to be inserted
made
code 2. Press Ctrl+J. The template names display in a drop-down list.
3. Select the name of the template you want to insert from the drop-down list.
4. Press Enter.

To manage, create and edit the ready made code, see Code Templates.

Drag and drop PL/SQL syntax, SQL functions, column names, and database object names into
code using the Code Assistant.

Code with Code Description

multiple
SQL SQL If you write multiple SQL statements in the editing pane then ensure each SQL
statements statement ends with either:

and l a semicolon (;)

PL/SQL l " / " on the next line.
blocks
TIP: There is a quick way to construct SELECT statements for multiple tables.
Highlight the tables in DB Explorer, drag and drop them into the editing pane.
This behavior is set in View | Preferences | Code Editor | General | Drag &
Drop.

PL/SQL PL/SQL blocks entered into the script must have either

l a forward slash /

SQL Navigator 7.6

63
User Guide
Features Description

Code Description

l or a period mark .

following the last line of the block.

This is necessary because the PL/SQL blocks can themselves contain blank lines
and semicolons.
When you create or execute a PL/SQL anonymous block, the semicolons are
required in the SQL statement. For example
BEGIN
Test_procedure;
END;

Execute Execute the SQL query

the SQL
See: The toolbar: Code Editor SQL.
query
or
Compile the PL/SQL code
Compile
the See: Code Editor PL/SQL, PL/SQL Debugger, DBMS_OUTPUT.
PL/SQL You can compile a program that is stored in the database. While the program is being edited,
code use the Save command to compile and store it. Once the program has been modified, you will
need to save the program prior to any further usage of the Compile/Rebuild functionality - This is
to ensure that the changes in the program have been applied to the database.
SQL Navigator displays all syntax and compiler errors in a separate scrollable pane. Click on the
error text to show the source code at the source of the error. Double click on the error text to
show the error message description, cause and actions as per the Oracle documentation.
Also watch for feedback in the Output Window.

Auto Reparse
Many features of the Code Editor, including the Code Explorer window, code completion, tool tip
display of program arguments, bracket matching, collapse loops/blocks, and others, rely on
automatic parsing of the PL/SQL code and internally generating a symbol table. This parsing
occurs when the editor first loads the objects, and it also occurs in the background in order to
maintain the symbol table as the user edits the code.
You can also manually trigger a full reparsing (updating of the internal symbol table) at any time
by right-click and select Auto Reparse from the shortcut menu. However, when loading a really
large script having this option on will slow down SQL Navigator. Hence, to avoid wasting CPU
resources, you should turn this option off when editing large scripts.

Symbols in the gutter margin

Symbols in the gutter margin provide a visual indication of the statement’s status.

SQL Navigator 7.6

64
User Guide
Features Description

Icon Description

Enabled breakpoint. For more on debug see PL/SQL Debugger.

Disabled breakpoint. For more on debug see PL/SQL Debugger.

Current execution line

Invalid breakpoint. For more on debug see PL/SQL Debugger.

This statement executed with errors.

Information about the error is displayed. Double click on this information to open the
Oracle Error Information dialog.

This SELECT statement produced results.

TIP:

l Double click on the icon to jump to the associated results tab (Press
CTRL+F11).
l There can be multiple results displays, one per statement executed.
Each result set is displayed in a separate tab.
l See SQL Query Results Data Grid
l When a result tab is selected, the corresponding statement will be
focused.

This non-select statement executed successfully.

This statement was executed with warnings.

Look and Feature Description

Feel
Collapse / You can collapse/expand a block, procedure, loop or IF statement by clicking
Expand on the - or + symbols to hide/show codes.
Statements
TIP: When the script is exceptionally long the collapse/expand codes
may slow down the application. You can choose to disable this feature
in View | Preferences |Code Editor | General| Enable Code Collapsing.

Syntax The Code Editor uses colors to highlight PL/SQL and SQL keywords, text and
highlighting comments.
When you set the cursor at a bracket within an expression, the matching
bracket is automatically highlighted.

Bookmarks Lines of code can be bookmarked so you can return to them easily.

l To add / list / go to bookmarks see the Edit Menu.

l (0-9) in the gutter margin indicate Bookedmarked lines.

SQL Navigator 7.6

65
User Guide
 Features Description

Feature Description

Variable To move the cursor to the declaration of a variable (or Auto Describe it if it’s the
declarations name of an external database)
Press CTRL and point to the variable with the mouse.
To return to the former position in the text, press ALT+Left Arrow.

Switch Press CTRL+SHIFT plus the down or up arrow to move the cursor between the
between specification and the body.
specification
and body

Formatter SQL Navigator's Formatter Tools is a unique utility for reformatting existing
Tools PL/SQL, SQL*Forms, Oracle Forms, and SQL*Plus source code. See the Code
Editor toolbar: Code Editor SQL or Code Editor PL/SQL.

Automatic When you insert multi-line text into the editor, the text is placed at the same
Indentation indentation level as the current cursor position. For best results, before inserting
text, place the cursor at the location and indentation level where you want the
inserted text to appear.

Manipulate Right click on the code and select Edit | Selection Mode | Block or press
rectangular ALT+F7.
blocks of
The block selection is limited to the length of the last line. To overcome this
code
limitation select View | Preferences | Code Editor | General | Allow Caret after
EOL.

Show/hide Right click on the code and select Edit | Show Tabs/Eol/Eof
invisible
characters

Switch Right click on the code and select Edit | Tabs/Spaces and select from the
between available options.
tabs and
Requires View | Preferences | Code Editor | General | Use Tab Characters
spaces
selected.

SQL*Plus command support

The Code Editor supports the following SQL*Plus commands:

l Comment Delimiters (/*...*/)

l Double Hyphen (- -)
l At Sign (@)
l Double At Sign (@@)
l Forward Slash (/)
l CONNECT

SQL Navigator 7.6

66
User Guide
 l DESCRIBE
l DISCONNECT
l EXECUTE
l REMARK

NOTE: Consult Oracle documentation for details about Oracle's SQL*Plus utility.

SQL Navigator also allows large scripts or SQL statements to be executed in the background, allowing you to
perform other functions on your PC simultaneously.

Executing Scripts Invoked By At Sign (@) or Double At

Sign (@@) SQL*Plus Commands
Ensure that all the required scripts are in the same directory and in the correct SQL format.
In the Code Editor, invoke the master script using the @ command.
The output of the executed scripts will be displayed in the appropriate window of SQL Navigator, for example
the output of a SELECT statement will appear in the grid (SQL Query Results Data Grid), while the output of a
CREATE statement will appear under the appropriate node in DB Navigator.

Connect To A Database Via The Code Editor

To execute a SQL statement or script within the Code Editor, you must first be connected to the
relevant database.
It is possible to connect and disconnect databases from within the Code Editor using SQL*Plus commands.

Connect Open a new Code Editor tab, and then type and execute a connect statement using the
following SQL*Plus format
Connect name/password@database

Disconnect Open a new Code Editor tab, and then type and execute a disconnect statement using the
following SQL*Plus format
Disconnect name/password@database

NOTE: If you type and execute the disconnect statement without specifying any database
details, the current session you are using will be disconnected.

Bind Variables
A bind variable is a variable in a SQL statement that must be replaced with a valid value or address of a value in
order for the statement to successfully execute.

SQL Navigator 7.6

67
User Guide
Bind variables enable you to use PL/SQL in a SQL*Plus script. They provide a mechanism for returning data
from a PL/SQL block so that it can be used in subsequent queries.
The Code Editor supports bind variables; use them the same way as you would use them in SQL*Plus.
Here is an example of how to declare a bind variable:
VARIABLE s_table_name varchar2(30)

To reference a bind variable in a PL/SQL block, preface it with a colon ( : )

BEGIN
:s_table_name := ‘EMPLOYEE’;
END;
/

Auto Code Completion

Scenario: Use Point-And-Click to insert column names for a database object into your code.
1. Ensure Auto Code Completion is turned on.
2. Place the cursor in the editor window where you want the column names to be inserted.
3. Type the name of the object followed by a period mark (.).
4. Select the name of the column you want to insert from the drop-down list.
5. Press Enter.

Scenario: Show a parameters list for a procedure or function.

1. Ensure Auto Code Completion is turned on.
2. Type in the name of the procedure or function followed by an open bracket '('.
3. Automatic code completion brings up a list of parameters (including alternative lists for overloaded
procs/funcs).

Scenario: Dot lookup for record members.

1. Ensure Auto Code Completion is turned on.
2. Type in the name of the variable followed by a full stop.
3. SQL Navigator displays a list of matching members. Dot-lookup automatically displays a ‘pick’ list of
members of a PL/SQL record, cursor, package or %ROWTYPE record.

Scan Defines/Substitutions

SQL Navigator 7.6

68
User Guide
The Code Editor lets you use substitution variables in SQL statements—similar to the way SQL*Plus
handles them.

NOTE: Turn on Scan Defines/Substitutions when using variables or text that contain the characters &,
&&, or = :[bind variable]. Otherwise, the statements containing the variables will generate an error.

Specifying substitution variables in SQL statements

Use substitution variables for flexible SQL statements. Flexible SQL statements are a powerful way to improve
productivity.

Feature Example Description

Use the & symbol followed by a variable &EMPNUM You can use &EMPNUM as a valid
name to specify a substitution variable. substitution variable name.

An example of a SQL statement SELECT * When you execute this SQL statement, the
demonstrating the use of a substitution Code Editor prompts you to enter the value for
FROM EMP
variable the employee name. This allows you to create
WHERE generic SQL statements that can be reused.
EMPNUM =
‘&EMPNUM’;

You can use substitution variables in any part SELECT When you execute this SQL statement, the
of the SQL statement. &COL1, Code Editor prompts you to enter the column
&COL2 names, as well as the table name.
FROM
&TAB;

You can use this concept to create other types CREATE

of generic SQL statements or scripts. One USER
practical application of this concept is creating &&UNAME
a generic script for creating user codes at IDENTIFIED
your site. BY &PASS;
GRANT ALL
ON EMP TO
&&UNAME;

You can use the double ampersand the same &&UNAME When you execute this SQL statement
way as the single ampersand with some
l The first time the Code Editor
differences.
encounters the && variable, it looks up
the variable to determine whether it
has already been defined in either a
DEFINE statement or in a previous &&
variable.
l If the variable is defined, Code Editor
substitutes the value in the SQL
statement.

SQL Navigator 7.6

69
User Guide
 Feature Example Description

l If the variable is undefined, the Code

Editor prompts you to enter the value
of the variable, defines the variable for
future look-ups, and substitutes the
value in the SQL statement.
l Once a && variable is defined, you are
no longer prompted to enter its value
in the same session until you
UNDEFINE the variable.

DEFINE and UNDEFINE

You can use the terms DEFINE and UNDEFINE to define and undefine numeric and character variables in
SQL scripts.

Statement Example Description

DEFINE DEFINE EMP_ Define a substitution variable.

NAME=‘SCOTT’
A character/varchar substitution variable definition uses single
DEFINE EMP_NUM=4467 quotes.

UNDEFINE UNDEFINE EMP_NAME Undefine a previously defined substitution variable.

TIP: Alternatively, right click in the editing pane and select SQL Script Options | Substitutions to open
the Substitutions dialog.

New Stored Object Dialog

Select the object type:

Procedure A procedure is a sequence of executable statements that performs a particular action.

Procedures can be stored in the database (where they are also executed) and reused; they
are then referred to as stored procedures. Stored procedures cannot be embedded in a SQL
statement.

Function A function is a block that returns a value. Functions can be stored in the database and
reused. Stored functions can be called from within a SQL statement.

Package+Body A package is an encapsulated collection of related schema objects, including modules and
other constructs, such as cursors, variables, exceptions, and records. Packages allow
procedures, functions, variables, and cursors that share common or related functions to be
compiled and stored as a single schema object.

SQL Navigator 7.6

70
User Guide
 l Packages allow encapsulation of internal subroutines and variables.
l With packages, you can specify which code is publicly available to programmers and
which data should be hidden. In addition, you can implement global variables, data
structures, and values; these persist for the duration of a user session.
l Packages have both a specification and a body. The package specification declares
procedures, functions, cursors, and variables.
l The package body contains the implementation of the public procedures and
functions, together with internal and private programs and variables.

Type+Body Object types are user-defined data types, equivalent to "classes" in object-oriented
languages, that may consist of composite data types or collections such as repeating groups
or complex record types. Object types may be associated with member functions and
procedures that are implemented in PL/SQL. These modules implement the methods of the
object type.
Like packages, object types have both a specification and a body.

l The specification lists the object's attributes and member functions.

l The body contains the actual code for the methods.

Trigger A trigger is a named PL/SQL unit that is stored in the database and executed in response to
a specified event that occurs in the database.

TIP: For each object type, SQL Navigator provides a ready made template or "shell" to make coding
easier. You can modify these templates. The template name and location is defined in the opening
comments when the new object is created.

SQL Statement CRUD Matrix Dialog

Insert a CRUD (Create/Update/Delete) worksheet into the code editor.
The CRUD matrix is inserted as commented text at the current cursor position. This can be a convenient way of
documenting and analyzing your procedures.

SQL Query Results

SQL Query Results Data Grid
Browse the results of an executed SQL query in a dynamic grid with options for viewing, sorting and
navigating. There can be multiple results displayed, one per statement executed. Each result set is displayed
in a separate tab.

SQL Navigator 7.6

71
User Guide
 NOTE:

l When a result tab is selected, the SQL query statement that generated the result is focused.
l If the data is LOB, XML or Array then double click on the data cell for more information. For more
information, see Viewers: LOB, XML, Array on page 75.
l The Data Grid supports National Language Support (NLS). Display and edit multi byte data.
l To display the results of a SQL query as text see SQL Query Log (The Spool Tab).

Rows Retrieved
Icon Tool Tip Description

Count Dataset The value appears in bold in the Status bar at the bottom of the Code Editor
Rows window.
Fetch More Retrieve more rows.
Fetch All Retrieve all rows.
Stop Fetching Use when it takes too long to fetch more/all rows.

Refresh Data Populate the grid with the latest data.

Export / Print
Icon Tool Tip Description

Print Data Grid Print the SQL query results.

TIP:

l Format the data grid as required for the printed

page before you print.
l To print preview, click the cursor in the data
grid and click File | Print Preview.
l Set printing preferences at View | Preferences
|General | Printing.

Export Data Open the Export Data Dialog.

TIP: Right click on the data grid to select a row or column or the entire data grid. You can copy selected
data to the clipboard. There is an option to include the row number or column heading with the copied
data.

SQL Navigator 7.6

72
User Guide
Browse
Icon Tool Tip Description

Top Display the first, previous, next or last record.

Prior Row

Next Row

Bottom

Edit (Updateable Queries)

Turn ON Updateable in the SQL Editor Toolbar (Code Editor SQL) before you execute the SQL query. The
status panel at the bottom of the Code Editor window says "Updateable" if the results can be edited. It says
"Read Only" if the results cannot be edited.

TIP:

l Press F2, Space or Enter to edit straight from the cell.

l A calendar opens for a date field (on pressing F2 or Space). Press Space to switch between the
Date field and Time field.
l Double click on the cell if a wider editing space is required.
l Right click on the data grid for more options.

Requirements

l The SELECT statement must be a simple SELECT statement (no joins, subqueries in select clause,
calculated fields, group by, having, count(), substr or DISTINCT). If you get an error message such as
TOKEN:.(12121,2) then your query does not conform to the restrictions for updateable queries.
l You must have the appropriate privileges to update the table or view.

Icon Tool Tip Description

Add Row Insert a new row before the selected row.

Duplicate Selected Rows Duplicate the selected row(s).

The duplicated data is highlighted in the grid until it is committed.

Delete Selected Rows Put the cursor on the row you want to delete and click .
Commit Transaction Save new or modified data to the database.

Rollback Transaction Undo changes made to grid.

SQL Navigator 7.6

73
User Guide
Group Display
To create a group display, right click the data grid and select Group by this column.

Icon Tool Tip Description

Cancel Grouping Cancel the group display.

Format
Icon Tool Tip Description

Default/User Defined User-defined column width. Overrides automatic column width setting.
Column Formatting Drag the separators to set column width.

Format Columns By Data Set the column widths to show the widest cell data.
Width
Column names may appear truncated.

Format Columns By Name Set the column widths to show the widest column name.
Width
Table data may appear truncated.

Format Columns By Set the column widths to show the widest column data or column name
Names And Data (whichever is greater).

TIP: The formatted widths are based on the results currently visible. The column widths may change as
you scroll down, retrieving new rows. To prevent the column widths from changing when scrolling, Fetch
All rows before scrolling.

Sort & Display

Icon Tool Tip Description

Grid View Display multiple rows in a data sheet format

TIP: Click any column header to sort and change the sort options.

Single Row View Display details of the selected record.

Expand Data Grid Maximize screen real estate of the data grid.

Auto Refresh Select to refresh the SQL Results Data Grid every (number specified) seconds.

SQL Navigator 7.6

74
User Guide
SQL Query Log (The Spool Tab)

View a log of executed SQL statements. Retrieve executed SQL statements.

1. Enable Spool to Screen. For more information, see Code Editor SQL on page 53.
2. Execute the SQL query. For more information, see Code Editor SQL on page 53.
3. Click the Spool tab to view the log.

TIP: Right click on the log to Select / Copy / Save / Print / Clear the log.

Export Data Dialog

Export the SQL query results

Options Description

Export to: l Format -

l HTML
l Excel
l XML
l Spool Text
l Table INSERTs
l Delimited Text
l Unicode -Select to export the data in unicode format.
l Open exported file - Select to open the file after it is exported.
l Clipboard - Select to copy the data to the clipboard for subsequent pasting.

Columns Select the columns to export.

Rows Export all records or a specific range. The records can be sorted.

Viewers: LOB, XML, Array

View the contents of a large object (LOB, XML, Array) that is a cell in a table or result of a SQL query. Click on
the cell containing the large object.

LOB Editor
You can work with the following Oracle8i LOB datatypes.

SQL Navigator 7.6

75
User Guide
 Datatype View Edit

BLOB (binary) Y N
CLOB (character) Y Y
BFILE (external) Y N
NCLOB (multibyte character) Y N

You can use toolbar buttons to perform actions on LOBs. The actions available depend on the LOB and include:

l Copy to clipboard
l Save to disk file
l Save, then view in external application
l View in preview window
l Mask or show ASCII values between 128 and 255
l View BFILE as image or HEX

NOTE: SQL Navigator does not support working with LOB or Object table columns when using an Oracle
7 client connected to Oracle 8 database. For full functionality, use an Oracle 8 client to connect to an
Oracle 8 database.

ARRAY Editor
l Click on +/- to add/remove items in the array.
l Select any item and click the arrow buttons to reorder the list.

PL/SQL Execution Console

From the Execution Console you can select an entry point (for packages), enter the parameter input values, and
choose various run options, such as profiling and directing the results to DBMS_OUTPUT.
The Execution Console helps you set various parameters for wrapping an anonymous block around a stored
program so that you can execute it. If you generate an anonymous block, the Console assigns a file name to
your block in the form: <Schema name>.<procedure name>.STB. If the anonymous block is for a packaged
procedure, then the assigned name has an additional component—the entry point.

NOTE: If an error occurs when trying to run a generated code block (for example, due to a syntax error),
the text is opened in the Output Window.

SQL Navigator 7.6

76
User Guide
Run Time Parameters
Option Description

Parameter Name and type of each input parameter.

Input Define input values for each parameter.

Field Description

Def Select to use the default input value.

Null Select to use a Null input value.
Exp Select to use a PL/SQL Expression.

Value/Expression When Exp is selected, enter a value or expression in the

Value/Expression column.

Load/Save Click to load the input parameter values from an external file.
Save Click to save the input parameter values to an external file.
Reset Click to Reset changes to the parameter values.

Run Options
Command Description

Auto-create test case When selected a test case is automatically created (when you click Execute) based
after code execution on the parameter values (both input and output) currently displayed in the grid.
For more information, see Code Test on page 158.

Use Profiler Select to use the PL/SQL Profiler.

Analyze the execution time and efficiency of your stored programs.
Click (...) to open the Profiler Options dialog.

Option Description

Collect Session Select to store session statistics in a table.

Statistics when Creating
the Profiling Run

Before Creating the Select when measuring performance and tuning.

Profiling Run …
Re-initialize the execution environment after a previous
run, giving you a better basis for comparison between
one run and another.

For more information, see PL/SQL Profiler on page 195.

SQL Navigator 7.6

77
User Guide
 Command Description

Direct results to Select Generate a DBMS_OUTPUT PUT statement for each OUT parameter.
Output
Clear Generate a Bind variable for each OUT parameter. This is useful when you
want to view complex data returned by the procedure, such as REF cursors
and LOBs.

For more information, see DBMS_OUTPUT on page 79.

Include exception Select to populate the Exception block when the Stub tab is generated.
block
TIP: Click Preview to generate the Stub tab.

Commit changes Once the procedure has finished executing, do you want to COMMIT / ROLLBACK
after code execution changes made by the procedure?

Preview Show the code to be executed.

NOTE: This generates the Stub tab. For more information, see PL/SQL Stub on
page 79. Toggle between the Code / Run / Stub tabs at the bottom of the
screen.

Execute Execute the PL/SQL code.

If Use Profiler is selected, opens PL/SQL Profiler.

Code Test
The Code Test panel automates the process of testing PL/SQL programs. See also the module: Code Test.

Command Description

Test Case Select the test case to work on.

In/Out Display the in/out parameters and associated values for the selected test case.
New Create a test case. Open Test Case Properties
Edit Edit the selected test case. Open Test Case Properties
Delete Delete the selected test case.
Test > Upload the selected test case into the parameters.
Param
Param > Update the selected test case with the current parameters.
Test
Manage Clone and edit existing test cases, create new test cases and run multiple test cases at once.
Open Code Test
Run Test Run the selected test case. The result of the test is displayed in the Test case status pane.
Run All Run all code tests available for the current object.
Tests

SQL Navigator 7.6

78
User Guide
PL/SQL Stub
Instead of using the Execution Console, you can generate and preview a PL/SQL block to execute a
stored program.

To generate a stub
From the PL/SQL Execution Console

1. Enter the run time parameters.

2. Select Include exception block to populate the exception block when the stub is generated.
3. Click Preview.

NOTE: Different stubs are generated depending on the selected options.

DBMS_OUTPUT
The DBMS_OUTPUT package is a standard package provided by Oracle specifically for the purpose of
debugging stored programs.

Feature Description

Insert a DBMS_OUTPUT.PUT_LINE statement in Edit Menu | Insert | DBMS_OUTPUT.PUT_LINE ('')

the code

Create a DBMS_OUTPUT.PUT_LINE statement In the Code Editor

for the selected variable in the editor.
1. Place the cursor on the variable.
2. Click Edit |Insert | Debug Variable. The debug
statement is generated and copied to the
clipboard.
3. Place the curser where you would like to insert the
debug statement in your code. Click Edit | Paste.

Capture output from DBMS_OUTPUT The SQL Navigator Output Window captures output from
DBMS_OUTPUT.

NOTE: The SYS schema owns this package. To view the procedure and parameter definitions of this
package you can display it in the Code editor.

SQL Navigator 7.6

79
User Guide
Code Editor Keyboard Shortcuts
Right Click Over The Editing Pane
Icon Right Click Keyboard Shortcut Description

Cut CTRL+X Remove the selected text from the editing pane. Place on
the Clipboard ready to Paste elsewhere.
Copy CTRL+C Alternative shortcut: CTRL+Insert

Paste CTRL+V Alternative shortcut: SHIFT+Insert

Nil Select All CTRL+A Select all the text in the editing pane. This is usually
followed by Cut or Copy.

Auto Code CTRL+ALT+A Turn on/off Auto Code Completion. (Auto Code
Completion Completion)
Use SHIFT+Spacebar to force code completion.

Go to CTRL+Enter Open the selected object in an appropriate editor: Visual

Definition Object Editors.
Errors are sent to the Output Window.

Describe CTRL+F3 Open Describe.

Object at
As per Object | Describe.
Cursor

Nil Toolbox | Next CTRL+ALT+N Scroll through the pages of the Code Editor toolbox.
Page
Toolbox: PL/SQL Debugger | Code Explorer | Outline | DB
Nil Toolbox | CTRL+ALT+P Explorer | Describe | History | Dependencies | Columns
Previous
Page

File | New CTRL+T Open a new tab for a SQL script in the Code Editor.
SQL Tab
File | Open CTRL+O Open a file from Windows Explorer.
File

File | Save to CTRL+S Save the file.

File
This option is enabled once the file has a name. For an
Untitlted tab, save the file using File | Save to File As first.

Object | New CTRL+N Create a stored object.

Stored Object
Object | ALT+N Create a body for an existing package or (object) type
Open/Create
Package
Body

SQL Navigator 7.6

80
User Guide
Icon Right Click Keyboard Shortcut Description

Object | F9 Opens PL/SQL Execution Console.

Execute
Object | SHIFT+F9 Generate PL/SQL Stub.
Generate
Execution
Stub
Object | Save CTRL+S Save the object to the database.
to Database
Edit | ALT+Y
Duplicate
Line
Edit | Format CTRL+R As per Tools Menu | Formatter Tools | Format Code
Text
Edit | ALT+F7 Enclose the selected text in comments.
Comment
Selection
Edit | CTRL+ALT+F7 Remove comment markers from the selected text.
Uncomment
Selection
Edit | Jump to CTRL+] Jump to matching Bracket.
Matching
Bracket
Bookmarks | Ctrl+Shift+0...Ctrl+Shift+9 Set a bookmark. The gutter margin in the Code Editor
Toggle marks the bookmark.
Bookmark

Bookmarks | Ctrl+0...Ctrl+9 Go to the set bookmark.

Go To
See also Edit | List Bookmarks ALT+B.
Bookmark

Split/Compare SHIFT+ALT+F11 Adjust the layout of the editing pane.

| Vertical Split
Select from the options to split the editing pane in half
Split/Compare SHIFT+F11 either horizontally or vertically. The content of the editing
| Horizontal pane will be visible in both panes. You can scroll the
Split panes independent of each other.
Split/Compare SHIFT+CTRL+F11
| No Split

Execute | Skip SHIFT+F7 Execute SQL statement in Code Editor.

to Top
As per Code Editor SQL
Execute | Skip SHIFT+F8
to Previous
Execute F9
| Execute to
End
Execute F8

SQL Navigator 7.6

81
User Guide
 Icon Right Click Keyboard Shortcut Description

| Execute Step
Execute | Skip F10
to Next
Execute | Skip F11
to Bottom

PL/SQL Debugger Keyboard Shortcuts

For more information, see PL/SQL Debugger on page 84.

Icon Right Click Keyboard Shortcut

PL/SQL Debugger CTRL+ALT+S

Toggle Breakpoint F5
Abort Debug Session SHIFT+CTRL+F9

Trace Into F7

Step Over F8

Add Watch CTRL+F5

Trace Out SHIFT+F8

Run to Cursor F4

Stop on Exception CTRL+ALT+X

Auto Step Over SHIFT+CTRL+F8

Auto Trace Into SHIFT+CTRL+F7

Pause Auto Stepping ALT+P

Further Shortcuts In The Code Editor Editing Pane

Keyboard Shortcut Description

CTRL+Home Go to the top of the file

CTRL+End Go to the bottom of the file
Home Go to the beginning of the line
End Go to the end of the line
CTRL+Right Arrow Go to the next word

SQL Navigator 7.6

82
User Guide
Keyboard Shortcut Description

CTRL+Left Arrow Go to the previous word

CTRL+I Indent current line/selection
CTRL+U Unindent current line/Selection
F6 Go to the next tab
SHIFT+F6 Go to the previous tab

Further Shortcuts Viewing SQL Code Execution Results

Keyboard Shortcut Description

ALT+n Following a SQL query with many result tabs, go to the result tab numbered n.
CTRL+F11 Switch between the Query and Results page.
ALT+Enter Edit Cell Data.

Shortcuts In The Code Editor Toolbar

Icon Tool Tip Keyboard Description
Shortcut

New SQL Tab CTRL+T Open a new tab for a SQL script in the Code Editor.

New Stored CTRL+N Create a stored object.

Object
File | Open CTRL+O Open a file from Windows Explorer.
File

File | Save to CTRL+S Save the file.

File
This option is enabled once the file has a name. For an Untitlted
tab, save the file using File | Save to File As first.

Auto Code CTRL+ALT+A Turn on/off Auto Code Completion. (Auto Code Completion)
Completion
Use SHIFT+Spacebar to force code completion.

Split/Compare SHIFT+ALT+F11 Adjust the layout of the editing pane.

| Vertical Split
Select from the options to split the editing pane in half either
Split/Compare SHIFT+F11 horizontally or vertically. The content of the editing pane will be
| Horizontal visible in both panes. You can scroll the panes independent of
Split each other.
Split/Compare SHIFT+CTRL+F11
| No Split

SQL History CTRL+ALT+R Recall SQL statement.

Open in the Toolbox: History

SQL Navigator 7.6

83
User Guide
 Icon Tool Tip Keyboard Description
Shortcut

PL/SQL CTRL+ALT+S Open in the Toolbox: PL/SQL Debugger

Debugger

Execute | Skip SHIFT+F7 Execute SQL statement in Code Editor.

to Top
As per Code Editor SQL
Execute | Skip SHIFT+F8
to Previous
Execute F9
| Execute to
End
Execute F8
| Execute Step
Execute | Skip F10
to Next
Execute | Skip F11
to Bottom
Object | ALT+N Create a body for an existing package or (object) type
Open/Create
Package
Body
Save to CTRL+S Save the object to the database.
Database
Execute F9 Opens PL/SQL Execution Console.
Procedure /
Function
Toggle F5 Add / Remove breakpoint on the selected line of code.
Breakpoint
PL/SQL CTRL+ALT+S Open in the Toolbox: PL/SQL Debugger
Debugger

Abort Debug SHIFT+CTRL+F9 For more information see PL/SQL Debugger.

Session

Toolbox
PL/SQL Debugger

NOTE: Show/Hide PL/SQL Debugger in the Toolbox from the Code Editor toolbar.

All the tools and features for debugging stored programs can be found inside the PL/SQL Debugger window.

SQL Navigator 7.6

84
User Guide
Use the debugger to perform the following functions:

l Run to the end or to the next breakpoint.

l Step over code.
l Step into code, when other procedures are called from the current line.
l Display the execution stack.
l View and modify any variable value.
l Set watch variables.
l Set and remove breakpoint on the fly as the code is executing, except in an anonymous block.
l Stop a running procedure.
l Set an option to either stop execution if an exception occurs, or ignore exceptions.

Requirements
Area Requirement

Oracle Debugging is functional only when you are connected to an Oracle server via a SQL*Net
server connection. If you are using a local database, such as Personal Oracle, use the loopback
connection SQL*Net connection to perform interactive debugging.

Oracle create session

Permissions
alter session

Debug To watch, evaluate, or modify variables of a stored program:

on/off
Compile the program with debug information: Session Menu | Include Debug Info.

Successful If the procedure fails to compile, it is displayed in red in DB Navigator. It cannot be debugged.
compile

Debug
Feature Description

Locals tab Use the Locals tab to test the effect of different variable values in your procedure.
Example Scenario: Your procedure performs a computation. Start the procedure, enter a
starting value and watch how the procedure handles the result. If you want to see a "what if"
computation, enter a new value for the variable in the Locals tab and repeat the procedure.
NOTE:

l If you see an error such as "Not compiled with debug info" instead of the variable value,
you need to recompile the procedure with the Debug information and re-execute it in the
debugger to see the value of variables. See Session Menu | Include Debug Info for
more information.

SQL Navigator 7.6

85
User Guide
 Feature Description

l The values in the Locals tab are only populated when the code is running.
l The values of the input parameters cannot be modified in the Locals tab.
l When you evaluate a variable in a current breakpoint, remember that the current
breakpoint has not yet been executed.

REF When evaluating/watching a variable of REF CURSOR type, its value is displayed in the
CURSOR following format:
type
flags:FFF, rowcount:RRR.
variables
RRR determines the number of records fetched so far by the examined cursor.
FFF is a combination of cursor status flags:
%ISOPEN
%FOUND
%NOTFOUND
If the user enters the watched variable names as C1%NOTFOUND, C1%FOUND,
C1%ISOPEN, C1%ROWCOUNT, the displayed value is the same as would result from
watching the cursor itself. (C1 is the name of the cursor)

Watches You can set breakpoints and watches at any time before or during a debug session. You do not
and have to recompile your program after you set breakpoints or watches.
Breakpoints
Add/remove breakpoints by clicking in the gutter margin left of the code. For more
information, see Edit, Compile And Execute on page 61. There is also an icon on the toolbar to
toggle on/off breakpoints. For more information, see Code Editor PL/SQL on page 58.
When execution of a procedure is paused at a breakpoint, you can evaluate or modify any
scalar variable within procedure code. If you change the value of a variable, you can confirm
the new value of the scalar variable by evaluating the variable again.
NOTE:

l You can open multiple editors and set breakpoints in several stored programs
simultaneously.
l When you evaluate a variable in a current breakpoint, remember that the current
breakpoint has not yet been executed.
l Variable values in the "watch" window are updated only at the breakpoint, so
strategically place breakpoints after the watch variable.
l Increasing the number of variables in the watch list may result in slower debugger
performance.

Code Explorer

Make your work with packages, procedures, and functions more efficient and error-free.

SQL Navigator 7.6

86
User Guide
Features
Code Explorer:

l Is based on an advanced parsing technique that understands PL/SQL syntax.

l Displays detailed information about a package’s components, such as variables and parameters, their
types, structure and cursors.
l Highlights the packaged procedure you are currently in.
l Supports drag-and-drop into the editor.
l Combines information from the specification and body.
l Distinguishes non-published procedures and functions (by icon).

Working with packages

Work with packages is fast and easy in the Code Editor with the integrated Code Explorer.
The Code Explorer graphically displays a tree-structure view of the package currently in the editor. It shows
variables, parameters, record structures, types, cursors, and so on.
The tree-view is synchronized with the editing cursor in the code-editing window, so when you click any
package component in the tree-view, you can see the corresponding PL/SQL code in the editing window.
Likewise, as you move the cursor in the editing window, the tree-view changes to show the object
corresponding to the PL/SQL code at the cursor location.

Auto Reparse
PL/SQL parsing occurs when the editor first loads objects, and in the background as the user edits the code.
You can also manually trigger a full reparsing (updating of the internal symbol table) at any time by right-click
and select Auto Reparse from the shortcut menu. However, when loading a really large script having this option
on will slow down SQL Navigator. Hence, to avoid wasting CPU resources, you should turn this option off when
editing large scripts.

Outline

A graphic representation of the syntax tree of the current source.

DB Explorer

Find and open objects.

Icon Tool Tip Description

Refresh Refresh the tree data.

Use if you have created new objects that are not visible in the tree yet.

SQL Navigator 7.6

87
User Guide
 Icon Tool Tip Description

Name Type in a filter phrase (for example c% to filter all objects with names starting with c).
Filter

Upper Click to toggle between Upper case filter and Mixed case filter.
case
The upper case filter is selected by default. Use the mixed case filter to find objects with
filter
names that are mixed case, lower case or have special characters.

Filter Open the Filter Properties dialog. Filter Properties Dialog

DB Explorer is similar appearance to DB Navigator. DB Explorer is a light version of DB Navigator, integrated

into the Code Editor for extra convenience.

TIP:

l Expand the tree nodes to display the filtered objects.

l Drag and drop objects from DB Explorer into the Code Editor.
l Set the behavior of dragging and dropping table names from View | Preferences | Code Editor |
SQL Scripts | Drag & Drop.

Describe

Show the data structure for tables, indexes, views and synonyms.

NOTE: To increase response time, the drop down list is not populated with objects when the tool is first
activated.

Icon Tool Description

Tip

Filter To show the complete list, leave the Filter blank and press Enter.
You can use wildcards to filter the objects. For example, type t% and press Enter to display
only objects with names starting with "t". Select an object from the list to show its column
names and types.

Quick View the chained rows information as per Object Menu | Quick Browse.
Browse
Select the object to Describe.
The results show in SQL Query Results Data Grid.

Edit Edit data in a table object as per Object Menu | Edit Data.
Data
Select the object to Describe.
The results show in SQL Query Results Data Grid.
The Edit Data command executes an Updateable query.

SQL Navigator 7.6

88
User Guide
History

The History tool lists successfully executed SELECT, UPDATE, DELETE commands and PL/SQL blocks up to
1000 of the most recent ones in the current session. In the History window, each SQL statement is accompanied
with the date, time and the schema that they were executed on.
You can easily recall the most recent SQL statements that have been executed in the current session.

1. Select the statement you want to recall.

TIP: You can press Ctrl+up arrow to move back in the sequence, and Ctrl + down arrow to move
forward.

2. Take action.

Button Description

New Tab Open a new Code Editor tab and paste the statement into it.
Insert Add the recalled statement to the current contents.
Replace Replace the current contents of the editing window with the selected SQL statement.
Clipboard Copy the statement to the clipboard, ready to paste the statement into another location.
Delete Drop the statement from the SQL History list.
Double Select an action (New Tab, Insert, Replace or Clipboard) that will be executed on double-
Click... clicking an entry in History.

TIP: You can also insert the statements by dragging and dropping them into the Code Editor.

Dependencies

Lists the Dependants and Depends On objects of the current script.

NOTE: Objects with a large amount of dependant and depends on objects will take more time to load. To
improve the performance, hide this pane when opening those objects.

TIP: Right click over the Dependents or Depends On lists to view available commands to manipulate
objects in the lists.

SQL Navigator 7.6

89
User Guide
Columns

The Columns window provides an easy-to-use tool to arrange and hide/show columns of the retrieved table in
the data grid.

TIP: Run a valid query statement to populate the window.

Action Description

Show/Hide columns Show selected columns. Hide deselected columns.

Select column Click on the column's name.

Arrange columns Click Move Up or Move Down.

NOTE: The settings will be saved and taken into account when you refresh or rollback the query.
However if you rerun the query, the settings will be set back to default.

SQL Navigator 7.6

90
User Guide
 6

Visual Object Editors

SQL Navigator’s editing tools for database objects:

l Are visual. They give you a graphical representation of a database object definition. This makes it easy
to see relationships and properties.
l Allow you to view database object definitions and create or alter database objects via a point-and-click
interface, eliminating the need to remember SQL syntax and write SQL statements manually.
l Generate the DDL or other database code automatically when you create or alter a database object. You
can also and edit the code directly, if needed.

When opened, a visual object editor connects to the active database session (Session Menu | Select).

Object Object Type SQL Navigator Visual Object Editor

Schema Indexes Index Editor

Database Links Database Link Editor

Materialized (Snapshot) Views Materialized View Editor

Sequences Sequence Editor

Synonyms Object Type Editor

Tables Table Editor

Constraints Constraint Editor

Nested tables Nested Table Editor

Clusters Cluster Editor

Varying arrays Varray Editor

Triggers Now in the Code Editor.

Views View Editor

SQL Navigator 7.6

91
User Guide
 Object Object Type SQL Navigator Visual Object Editor

Non-Schema Users User Editor

Roles Role Editor

Profiles Profile Editor

Instance properties Instance Property Editor

Redo Log Groups Redo Log Group Editor

Cluster Editor
Use the cluster editor to join tables that are closely related for storing on the same area of the disk. This lets you
interleave the rows of two or more tables together into a single area called a cluster.

About The cluster key is the column or columns by which the tables are usually joined in a query. You can
Cluster only cluster together tables that you own.
Objects
You can create either an index cluster or a hash cluster. With an indexed table or index cluster,
Oracle locates the rows in a table using key values that Oracle stores in a separate index. To use
hashing, you create a hash cluster and load tables into it. Oracle physically stores the rows of a
table in a hash cluster and retrieves them according to the results of a hash function.
The characteristics and usage of this database object are described in the Oracle documentation.

Ways to Open The Cluster Editor

Icon Action Description

From the Main Menu Open the Cluster Editor.

View Menu | Visual Object Editors | Cluster
Editor

From DB Navigator or Find objects Dialog Open the selected Cluster object in the Cluster
Editor.
Right click on a Cluster object and click Open.

Constraint Editor
Use the Constraint Editor to specify table constraints.

SQL Navigator 7.6

92
User Guide
About In Oracle, a constraint is a rule applied to an object that restricts the data allowed in any
Constraints instance of the object.
The characteristics and usage of this database object are described in the Oracle
documentation.

NOTE:

l SQL Navigator’s visual constraint editor is intended to be used only for table-related constraints.
l Once a constraint has been defined and saved to the database, it cannot be altered in the
constraint editor. To change the constraint it is necessary to drop it and then create a new
constraint with the necessary properties. Use DB Navigator or Find objects Dialog to locate a
constraint then Object Menu | Drop to drop the constraint.

Using The Editor

Steps To Create A Constraint
1. Click Create a new constraint to open the New Constraint dialog.

Field Description

Parent Schema Select the parent schema for the new constraint.
Parent Object Select the parent object (table) for the new constraint.
Name Name the new constraint.

Constraint Type Type Purpose

Check Specifies a condition that each row in the table must satisfy
Primary Designates a column or combination of columns as a table’s
Key primary key
Unique Designates a column or combination of columns as a table’s
unique key
Foreign Designates a column or combination of columns as the
Key foreign key

SQL Navigator 7.6

93
User Guide
 2. More on the Constraint Type.

Type Action

Check Enter the check condition following Oracle syntax conventions. Example: (loc is not null)

Primary Designate the column(s) to be used as the Unique, Primary Key, or Foreign key.
Key
To add columns to the constraint, use the arrow button to move one or more selected
Unique columns from the Available Table Columns pane to the Constraint Columns pane. The
double arrow adds all available columns to the constraint.
Foreign
Key

3. If the constraint type is Foreign key:

l Designate the Unique or Primary Key in the Reference field.
l If desired, select the On Delete Cascade property.

NOTE: Before selecting the On Delete Cascade property, be sure you understand the potential
consequences of using this option. It could result in lost data. Consult your Oracle documentation
for information about the DELETE CASCADE command.

Now the constraint is defined

Icon Tool Tip Description

Generate SQL for Extract the DDL for the new constraint and place it into the Code Editor.
changes

Revert to previous Undo your entries without saving them.

constraint
After saving your changes, you will not be able to use the Revert command.

Apply changes to Save your new constraint definition to the database. SQL Navigator generates the
DB DDL and commits it to the database.

Enable current This duplicates Enable/Disable Constraint on the Object Menu.

constraint

Ways to Open The Constraint Editor

Icon Action Description

From the Main Menu Open the Constraint Editor.

View Menu | Visual Object Editors | Constraint
Editor

From DB Navigator or Find objects Dialog Open the selected Constraint object in the Constraint

SQL Navigator 7.6

94
User Guide
 Icon Action Description

Right click on a Constraint object and click Editor.

Open.

Database Link Editor

Use the Database Link Editor to view, create or define database links.

About A database link allows access to a username on a remote database through the local database. A
Database public database link (which only a DBA can create) allows the remote database access to all
Links users of the local database.
The characteristics and usage of this database object are described in Oracle documentation.

NOTE:

l The SQL Navigator Database Link editor will try to automatically add the domain name when
required by the server. However if the user cannot see the view v$parameter, then the domain
name is not automatically added. The user should enter a fully qualified database link name in
the New Database Link dialog.
l Due to limitations in the Oracle Data Dictionary it is not possible for Extract DDL to correctly apply
the SHARED and AUTHENTICATED clauses in a CREATE DATABASE LINK statement

Ways to Open The Database Link Editor

Icon Action Description

From the Main Menu Open the Database Link Editor.

View Menu | Visual Object Editors | Database
Link Editor

From DB Navigator or Find objects Dialog Open the selected Database Link object in the
Database Link Editor.
Right click on a Database Link object and
click Open.

Index Editor

SQL Navigator 7.6

95
User Guide
Use the Index Editor to view, create or alter indexes, and to set storage allocation.

About An index is a sorted map of selected columns in a table or object. Therefore an index is similar to a
Index table, and the columns in an index refer to the rows and columns of the associated table. By
Objects indexing columns frequently used in queries, you can improve data retrieval performance.
An index can be either unique or non-unique.

l A unique index validates every new or changed row in a table for a unique value in the
column(s) in the index.
l A non-unique index allows duplicate values in rows.

A non-unique index often enables faster queries.

Oracle8 supports a type of index called a bitmap index. A bitmap index uses a compressed bit-
stream storage technique that allows very fast retrieval.
The characteristics and usage of this database object are described in Oracle documentation.

Ways to Open The Index Editor

Icon Action Description

From the Main Menu Open the Index Editor.

View Menu | Visual Object Editors | Index Editor

From DB Navigator or Find objects Dialog Open the selected Index object in the Index Editor.
Right click on an Index object and click Open.

Nested Table Editor

Use the nested table editor when you require a large, efficient collection.

About A nested table type is an unordered set of elements. The elements may be built-in datatypes or user-
Nested defined types. You can view a nested table as a single-column table or, if the nested table is an
Tables object type, as a multicolumn table, with a column representing each attribute of the object type.
A nested table definition does not allocate space. It defines a datatype, which can then be used to
declare:

l columns of a relational table

l object type attributes
l PL/SQL variables, parameters, and function return values.

When a nested table appears as the type of a column in a relational table or as an attribute of the

SQL Navigator 7.6

96
User Guide
 underlying object type of an object table, Oracle stores all of the nested table data in a single table,
which it associates with the enclosing relational or object table.
The characteristics and usage of this database object are described in Oracle documentation.

Profile Editor
Use the Profile Editor to view, create or alter profiles.

About A profile is a set of limits on the use of database resources that can be applied to a user. If you
Profiles assign the profile to a user, that user cannot exceed those limits. If a user exceeds a limit, Oracle
aborts and rolls back the transaction, and then ends the session. Profile settings include connect
time, password lifetime and reuse, idle time, and similar restrictions.
The characteristics and usage of this database object are described in Oracle documentation.

Requirements
To edit profiles:

l You must have the CREATE PROFILE system privilege.

l Query the Oracle Data Dictionary with DBA Views. For more information, see DBA Dictionary
Views on page 49.

Ways to Open The Profile Editor

Icon Action Description

From the Main Menu Open the Profile Editor.

View Menu | Visual Object Editors | Profile Editor

From DB Navigator Open the selected Profile object in the Profile Editor.
Right click on a Profile object and click Open.

Redo Log Group Editor

Use the Redo Log Editor to view, create, or alter Redo Logs.

SQL Navigator 7.6

97
User Guide
 About Every Oracle database has a set of two or more redo log files, collectively known as the
Redo database's redo log. Oracle uses the redo log to record all changes made to data.
Logs
The characteristics and usage of this database object are described in Oracle documentation.

Ways to Open The Redo Log Group Editor

Icon Action Description

From the Main Menu Open the Redo Log Group Editor.
View Menu | Visual Object Editors | Redo
Log Group Editor

From DB Navigator Open the selected Redo Log Group object in the Redo
Log Group Editor.
Right click on a Redo Log Group object and
click Open.

Role Editor
Use the Role Editor to view or create roles.

About A Role is a set of privileges that can be assigned to or removed from a user. (Use the User Editor to
Roles create and grant or revoke roles and privileges to users.)
The characteristics and usage of this database object are described in Oracle documentation.

Requirements
To edit roles:

l You must have the CREATE ROLE system privilege.

l Query the Oracle Data Dictionary with DBA Views. For more information, see DBA Dictionary
Views on page 49.

SQL Navigator 7.6

98
User Guide
Ways to Open The Role Editor
Icon Action Description

From the Main Menu Open the Role Editor.

View Menu | Visual Object Editors | Role Editor

From DB Navigator Open the selected Role object in the Role Editor.
Right click on a Role object and click Open.

Materialized View Editor

Use the Materialized (Snapshot) View Editor to view, create or define snapshots.

About A snapshot is a segment that contains the result of a query. The snapshot typically contains local
Snapshots copies of remote objects. From Oracle 8i onwards a materialized view is equivalent to a
snapshot but allows queries to be dynamically and transparently rewritten to use the
materialized view.

Using The Editor

Editor Toolbar
Icon Tool Tip Description

Create new Open the New Materialized View dialog.

Materialized view
Field Description

Schema Select the parent schema for the new Materialized view.
Name Name the new Materialized view.

Open object from DB Open the Select Materialized View dialog.

Select the materialized view from the database.

Clone current Create a clone of the selected materialized view. You will be prompted in the
Materialized view New Materialized View dialog to enter new name.

Revert to pervious Undo or revert any modifications made to the view.

Materialized view

SQL Navigator 7.6

99
User Guide
 Icon Tool Tip Description

Generate SQL for Generate SQL code for the changes made.
changes
Apply changes to DB Apply changes to the database.

Editor Tabs
Tab Description

Details 1. Select the Updateable and Query Rewrite options to include them in the query’s DLL.
2. Set the Parallel options and turn Logging and Cache on or off.

Refresh 1. Set the frequency of the refresh.

2. Set the rollback segments to be included.
3. Set when to populate the materialized view.

Storage 1. Set the Physical Attributes for the materialized view log.
2. Set the Storage Clause options for the materialized view log.

Master Display the owner, table and links for the materialized view (after the materialized view has been
Info saved).

Ways to Open The Materialized View Editor

Icon Action Description

From the Main Menu Open the Materialized View Editor.

View Menu | Visual Object Editors |
Materialized View Editor

From DB Navigator or Find objects Dialog Open the selected Materialized View object in the
Materialized View Editor.
Right click on a Materialized View object
and click Open.

Sequence Editor
Use the Sequence Editor to view, create, or alter sequences.

About A sequence is an Oracle object that delivers a unique number, incremented by some specified

SQL Navigator 7.6

100
User Guide
 Sequence amount, every time it is requested. Sequences are usually used to generate a primary key for a
Objects table or for a set of tables. You can use the sequence to create unique number that you can use
in your tables as primary identifiers.
The characteristics and usage of this database object are described in Oracle documentation.

Ways to Open The Sequence Editor

Icon Action Description

From the Main Menu Open the Sequence Editor.

View Menu | Visual Object Editors | Sequence
Editor

From DB Navigator or Find objects Dialog Open the selected object in the Sequence
Editor.
Right click on a Sequence object and click Open.

Synonym Editor
Use the Synonym Editor to view or create synonyms.

About A synonym is an alternate name for a table or view. A synonym can be private (for use only by its
synonym creator) or public (for use by any user). Primarily, synonyms enable multiple users to reference an
Objects object without adding the schema as a prefix to the object. They can also allow different
applications to reference the same object using different names.
You can make synonyms for the following database objects:

l tables
l views
l other synonyms
l functions
l packages
l procedures
l sequences
l database links

The characteristics and usage of this database object are described in Oracle documentation.

SQL Navigator 7.6

101
User Guide
Ways to Open The Synonym Editor
Icon Action Description

From the Main Menu Open the Synonym Editor.

View Menu | Visual Object Editors | Synonym Editor

From DB Navigator or Find objects Dialog Open the selected object in the Synonym Editor.
Right click on a Synonym object and click Open.

Table Editor
Use the Table Editor to create, alter, or define tables. Functionality includes:

l Adding and deleting columns

l Defining column properties
l Setting tablespace storage parameters
l Setting partitioning properties

Although you won’t need to type any PL/SQL code when editing tables in SQL Navigator, you should be familiar
with Oracle rules and guidelines for using tables.

NOTE:

l Be sure to place quote marks ("xxx") around any non-numerical data you enter in the default
column. If non-numerical data is not enclosed in quotes, then error message ‘ORA-00984:
column not allowed here’ is returned.
l It is possible to display and edit multi byte data in the Table Editor through National Language
Support (NLS).
l The Data tab operates as per the SQL Query Results Data Grid.

Ways to Open The Table Editor

Icon Action Description

From the Main Menu Open the Table Editor.

View Menu | Visual Object Editors | Table Editor

From DB Navigator or Find objects Dialog Open the selected object in the Table Editor.
Right click on a Table object and click Open.

SQL Navigator 7.6

102
User Guide
User Editor
Use the User Editor to create, grant or revoke roles and privileges to users, including forcing a
password to expire.

About In Oracle, a User is simply a unique log-in name. A user’s capabilities inside the database are
Oracle determined by the User’s role assignments.
Users
The characteristics and usage of this object are described in Oracle documentation.

Requirements
To edit users:

l You must have the CREATE USER system privilege.

l Query the Oracle Data Dictionary with DBA Views. For more information, see DBA Dictionary
Views on page 49.

Ways to Open The User Editor

Icon Action Description

From the Main Menu Open the User Editor.

View Menu | Visual Object Editors | User Editor

From DB Navigator or Find objects Dialog Open the selected object in the User Editor.
Right click on a User object and click Open.

Varray Editor
Use the VArray Type Editor to create varying arrays that can be used to:

l loop through the elements in order

l store only a fixed number of items
l retrieve and manipulate the entire collection as a value.

About The varying array is a collection type you can use when you want to retrieve entire collections as a
Varying whole. They are best suited for small collections. If you require a large, efficient collection, you
Array would be better to use a nested table collection type (see Editing a nested table).

SQL Navigator 7.6

103
User Guide
 Objects You must set a maximum number of elements for a varying array but you can change this limit.
A varying array object is normally stored in line, that is, in the same tablespace as the other data in
its row.
The characteristics and usage of this database object are described in Oracle documentation.

View Editor
Use the View Editor to view, create, or alter views.

About A view is a query that is named in the database so that it can be used as if it were a table. It can be
Views thought of as a virtual table in the database whose contents are defined by the Select query.
You can use views to rearrange, filter and select the way you see data in tables without creating any
copies of that data. Views help make data access simpler by hiding complexities. They can also help
separate data for different users as a security measure.
SQL Navigator’s view editor makes it easy to create and alter views. Although you won’t need to type
any PL/SQL code when editing views in SQL Navigator, you should be familiar with Oracle rules and
guidelines for using views.
The attributes of this database object are described in Oracle documentation.

Using The Editor

Editor Toolbar
Icon Tool Tip Description

Create new view Click to open the New View dialog.

Open object from Open an existing view.

DB
Clone current view Create a clone of the selected view. You will be prompted in the New View
dialog to enter a new name.
Revert to pervious Undo or revert any modifications made to the view.
view
Generate SQL for Generate SQL code for the changes made.
changes
Apply changes to Apply changes to the database.
DB

SQL Navigator 7.6

104
User Guide
Editor Tabs
Tab Description

Text Field Description

Create Enter the view column names, separated by commas.

View (

) AS Type the SQL for the view.

If you enter the Select * syntax to include all the table columns in the view, then
all the table column names from the Select * table appear automatically in the
CREATE VIEW pane.

Columns 1. Select a column.

2. Right click and select Edit Comments
3. Enter any comments required.
4. Repeat for each column as appropriate.

Options Select from the available options to be applied to the view.

Comment Enter any comments related to the view.

Ways to Open The View Editor

Icon Action Description

From the Main Menu Open the View Editor.

View Menu | Visual Object Editors | View Editor

From DB Navigator or Find objects Dialog Open the selected object in the View Editor.
Right click on a View object and click Open.

Java Editor
Features:

l Load a Java source file from the database into the editor
l Create a new Java source file
l Clone an existing Java source
l View and edit Java source with color syntax highlighting

SQL Navigator 7.6

105
User Guide
 l Compile the Java object
l Save the Java class to the database.

To see tooltips describing the toolbar buttons, simply point to them.

Ways to open the Java Editor

Icon Action Description

From the Main Menu Open the Java Editor with a new Java source.
View Menu | Visual Object Editors | Java Editor

From DB Navigator or Find objects Dialog Open the selected Java Source object in the Java
Editor.
Right click on a Java Source object and click
Open.

Instance Property Editor

Use the Instance Property Editor to view or specify the startup parameters for the instance.

About The characteristics of the Oracle database instance are specified during startup. These
Instance parameters are stored in a file called init.ora. This file may, in turn, call a corresponding
Properties config.ora file.
The Instance Property Editor is based on what the Oracle v$parameter data dictionary view
reports. Some attributes are Session Modifiable, which means that they are applied immediately
to the current session, but are not permanent. Others are System Modifiable and further may be
Immediate or Deferred (requiring a server shutdown/restart). Some are not modifiable at all.
These parameters and the rules governing their usage are described in Oracle reference
sources.

Using The Editor

Instance Property
Select the Instance Property you want to view. Not all properties can be modified.

Icon Description

The Property can be modified.

SQL Navigator 7.6

106
User Guide
Icon Description

The Property cannot be modified.

Editor Toolbar
Icon Tool Tip Description

Create new Instance property N/A to the Instance Property Editor. Oracle does not allow this
action.
Open object from DB Open the property from the current database

Clone current Instance property N/A to the Instance Property Editor. Oracle does not allow this
action.

Revert to pervious Instance Undo changes made to the property.

property
Generate SQL for changes Generate SQL code for the changes made

Apply changes to DB Apply the changes to the database

Details Tab
Attribute Description

Description Brief description of the parameter

Is Default Whether this parameter has been specified by the user as an initialization parameter
System Whether this parameter can be modified at an instance-wide level dynamically after the
Modifiable instance has started
Session Whether this parameter can be modified at the session level
Modifiable

Is Modified Whether this parameter has been modified after instance startup, and if so, whether it was
modified at the session level or at the instance (system) level
Is Adjusted Whether Oracle has adjusted a value specified by the user
Type The Oracle datatype
Value Current value for this session (if modified within the session); otherwise, the instance-wide
value
Alter For Whether the new value is to be current for this session or instance-wide

SQL Navigator 7.6

107
User Guide
Ways to Open The Instance Property Editor
Icon Action Description

From the Main Menu Open the Instance Property Editor.

View Menu | Visual Object Editors | Instance
Property Editor

From DB Navigator Open the selected object in the Instance

Property Editor.
Right click on a Property object and click Open.

SQL Navigator 7.6

108
User Guide
 Team Coding and Version Control
Support
Team Coding controls database objects and source files, such as procedures and functions. Team Coding
enables you to organize code work among different projects and control access to the code objects by locking
them in the database. You can use Team Coding alone or in conjunction with a version control system (VCS).

Use Team Coding with a VCS

Used with a VCS, Team Coding provides full source control with locking and full revision history. Team Coding
interfaces directly with the VCS to provide this control. Team Coding keeps track of changes to objects and
prevents modifications to the code in the database unless a SQL Navigator user checks the source out of the
VCS through Team Coding. Team Coding with a VCS works as follows:

l When the SQL Navigator user issues a check-out command, SQL Navigator checks a revision out of the
VCS and saves the code to the local SQL Navigator environment.
l When the SQL Navigator user saves the code, SQL Navigator writes it to the database.
l When the SQL Navigator user issues a check-in command, SQL Navigator checks the revision
into the VCS.

The Team Coding Administrator creates one or more Team Projects and associates them with projects in the
VCS. For more information, see Setup Team Projects on page 116.

Use Team Coding without a VCS

Used without a VCS, Team Coding works as follows:

l Administrators must protect production schemas by creating one or more Team Projects, which are the
only way that developers can check objects in and out of the database and work on them. This allows
the developers to work on the objects in their local environments without affecting the original objects.
l When a developer checks out an object through a Team Coding Project, SQL Navigator locks the object
in the database. This prevents the developer from unintentionally overwriting changes made to that
object by other developers. The developer checks the finished code into the database through the Team
Project, which unlocks the object again. For more information, see Check in and Check out on page 133.
l Team Coding without a VCS does not provide revision history as a VCS would. The source code is
maintained in the database, with no other versions available (other than through your own normal
backup methods). SQL Navigator does provide one "undo" option, which is to undo the check-in. For
more information, see Team Coding Manager on page 128.

SQL Navigator 7.6

109
User Guide
Work with non-controlled objects
When Team Coding is installed with a VCS, you also have full edit access to objects in the VCS that are not
controlled in Team Coding. This access is controlled from the Team Coding Manager. You can check those
objects into and out of the VCS to work on them in the Code Editor. The Team Coding Manager shows you
which objects are under the control of Team Coding (and therefore must be accessed through a Team Project)
and which can be accessed directly from the VCS.
Install Team Coding
Administer Team Coding
Objects Supported by Team Coding
Version Control Systems

Objects Supported by Team Coding

Team Coding controls the following database object types:

l Table
l Index
l Constraint
l Sequence
l View
l Trigger
l Function
l Procedure
l Package
l Package Body
l Type
l Type Body
l File (Script)
l Java Source
l Synonym

Administer Team Coding

Use the Team Coding Administration page to install, set up, and manage the Team Coding environment. On this
page a Team Coding Administrator can:

SQL Navigator 7.6

110
User Guide
 l Install the database objects that support Team Coding
l (Optional) Set up a version control system (VCS) to use with Team Coding
l Set global rules for the Team Coding environment
l Manage Team Projects that organize and control code work

Only a Team Coding Administrator can administer the Team Coding environment. The Team Coding
Administrator must have the role of TC_ADMIN_ROLE or an equivalent. For more information, see Team
Coding Roles on page 118.

To open Team Coding Administration

l From the Main Menu, select Team Coding | Administer.

Toolbar
Icon Description

Enable or disable Team Coding on this database. This icon works as a toggle to enable or disable
Team Coding in the connected database. Team Coding must be installed on the database before you
can enable it. For more information, see Install Team Coding on page 111.

IMPORTANT: When Team Coding is disabled, the Team Coding objects remain intact in the
database. However, Team Coding users will not be able to view anything in either of the Team
Coding Manager tabs.

Install or uninstall Team Coding. Team Coding is installed when the Team Coding database objects
are installed in the database. For more information, see Install Team Coding on page 111.

Administer Team Projects. Additional icons on the toolbar are active only when the Team Projects Tab
is active and at least one non-default project exists. See: Team Projects.

Settings tab
Set up a version-control system for use with Team Coding and set global rules for the Team Coding workflow.
For more information, see Team Coding Settings on page 113.

Team Projects tab

Create and administer Team Projects. At least one Team Project must exist to define which objects are
controlled through Team Coding. For more information, see Team Projects on page 115.

Install Team Coding

A Team Coding Administrator must prepare the database and configure Team Coding before users can begin
using it. This process includes:

SQL Navigator 7.6

111
User Guide
 l Install Team Coding objects in the database. These objects maintain the settings, projects, and other
metadata surrounding your Team Coding environment.
l Configure Team Coding settings. These are the general settings for Team Coding on the database and
apply globally for all SQL Navigator users of the objects that are controlled by Team Coding.

To install Team Coding

1. Select Team Coding | Administer. SQL Navigator displays a message that the Team Coding objects are
not installed. If this message does not display, then the Team Coding objects are already installed. To
install or reinstall the objects, click in the toolbar of the Administration dialog.

2. Click Yes to install the Team Coding database objects.

Setup Options
Page

Team Into Current Schema

Coding
Installation Install the Team Coding database objects into the connected schema. If you select the
connected schema, it must be publicly accessible and have DBA privileges.
Into Toad Schema
Many DBAs select the TOAD schema to keep their Toad objects organized in one place, but
otherwise there is no difference between selecting the TOAD schema or another schema. If the
schema does not exist, you are prompted to create it.
Administrator Role
Select or enter the administrator role for Team Coding. It is strongly recommended that you
accept the default, TC_ADMIN_ROLE. See Team Coding Roles.
Tablespaces in which to create objects
Select a tablespace for the Team Coding objects. The default is the default tablespace of the
installation schema that you selected.

NOTE: SQL Navigator assigns the Team Coding Administrator role (TC_ADMIN_ROLE)
to the selected schema. If you installed the objects in the TOAD schema but were
connected to a different schema, SQL Navigator assigns the role to both schemas.
SQL Navigator automatically assigns the TC_ADMIN_ROLE to the user who creates the
Team Coding objects. By default, all other users in the database can check in items,
check out items, and mirror their schema to a Team Coding project. You can grant the
Team Coding Administrator role to additional users, if necessary. See Team Coding
Roles for more information.

Migrate (Upgrades) If Team Coding was installed previously, you are prompted to migrate the previous
Team Team Coding settings. Select this option to migrate the previous settings.
Coding
Settings NOTE: A migration converts any existing Code Collections to Team Projects.

Finish Clicking Finish runs the script that installs Team Coding.When prompted, log in to the database
to execute the creation script and complete the installation of Team Coding.

SQL Navigator 7.6

112
User Guide
 3. Click in the toolbar of the Administration dialog to enable Team Coding in the database.

NOTE: This icon works as a toggle. When it is shown as depressed, Team Coding is active. At
any time, a Team Coding Administrator can click this icon to disable Team Coding but leave the
Team Coding database objects installed. When Team Coding is disabled, users will not be able
to view anything in the VCS Browser or Team Projects Browser in the Team Coding Manager.
You can enable and disable Team Coding as often as needed.

4. Configure Team Coding.

To configure Team Coding

1. The Team Coding Administration dialog is displayed after the script that installs Team Coding executes.
If this dialog is not displayed, select Team Coding | Administer.
You can use this dialog at any time in the future to change Team Coding settings.
2. Configure Team Coding settings as follows:
a. Set up a version-control system (VCS) to work with Team Coding (optional) and configure global
Team Coding settings. See Team Coding Settings.
b. Create Team Projects to determine which objects are controlled in Team Coding and to group
those objects and/or files into projects according to your workflow requirements. At least one
project must be created. See Setup Team Projects.

Team Coding Settings

The Team Coding global settings control the Team Coding environment at the database level. These settings
apply to all Team Coding users.
To work with these settings go to Team Coding | Administer, then select the Settings tab.

VCS
(Optional) Select a VCS to use for Team Coding. Then, click to set VCS settings.

SQL Navigator 7.6

113
User Guide
 NOTE: When a user with the TC_ADMIN_ROLE sets up a VCS, SQL Navigator stores the
server settings as the default for all Team Coding users. This feature only works with
Concurrent Versions System (CVS), Microsoft Team Foundation Server (TFS) and Visual
Source Safe, Perforce, IBM Rational ClearCase, and Subversion (SVN). See the
directions for your chosen VCS:
Concurrent Version Systems (CVS) Configuration Options
Git Configuration
IBM Rational ClearCase Configuration
Microsoft Team Foundation Server Configuration Options
Perforce Configuration Options
Serena PVCS Version Manager Options
Subversion Configuration Options
(Not required for Microsoft Visual Source Safe.)

Force Require users to enter a comment when checking in an object.

check-in
comment

Force Require users to enter a comment when checking out an object.

check-out
comment

Force new Force the VCS to create a new revision record when checking in an object, even if the object
revision on source is unchanged. Note: Some version-control systems do not support this feature and will
check-in not create a new revision for unchanged objects.

Remove When an object that is controlled by a Team Project is deleted in SQL Navigator, delete the
source object from the VCS.
from VCS
Select Prompt before removing to prompt users before removing the object.
when
deleting
an object

When When you open an object or script, Team Coding compares it with the latest revision in the
differences version control system (VCS) repository (unless it is checked out, in which case SQL Navigator
in source opens a read-only version of the file). If the database object or script differs from the version
versions saved in the VCS, SQL Navigator notifies you. Differences in objects could be due to a number
exist... of factors. For example, another tool or a script may have been used to edit the object, or the
archive in the VCS may have been updated by some means other than Team Coding.
You can choose one of the following options to resolve the difference:
Open Database Version: Always load the database version in read-only mode.
Open VCS Version: Always update the database with the version from the VCS repository and
load it in read-only mode. Caution: Opening the version from the repository will cause the object
in the database to be updated.
Prompt User: Prompt the user to choose between opening the database version or the VCS
version.

SQL Navigator 7.6

114
User Guide
Team Projects
Team Projects determine which objects are controlled by Team Coding. If you are a Team Coding Administrator
(meaning that you have the TC_ADMIN_ROLE) you can create one or more Team Projects to group the
controlled objects into logical work units, based on your organization's workflow requirements. To use Team
Coding there must be at least one Team Project.
When a version control system (VCS) is being used in Team Coding, you can link a Team Project to a
project in the VCS. This linking determines where the object source revisions of the Team Project are
managed in the VCS.
SQL Navigator enables you to create one or more sub-directories in a VCS project at the same time that you
create a Team Project. This feature is helpful if, for example:

l You plan to use multiple Team Projects and want to mirror each one to its own VCS directory under a
common root VCS project.
l You have multiple developers or development teams working on the same Team Project, and you want
to isolate their objects into dedicated directories within a common root project.

Use Team Projects page of Team Coding Administration to administer your Team Projects. Only a Team Coding
Administrator can administer Team Projects.

1. If using a version control system with Team Coding, log into the VCS from Team Coding | VCS Logon.
2. Go to Team Coding | Administer.
3. Select the Team Projects tab.

To Create a Team Project

See Setup Team Projects.

To change a Team Project

Under the Team Project that you want to change, do one of the following:

l To change the name of the project, right click the name and then select Rename Team Project.
l To edit the controlled database objects, click in the field next to Database Objects, then click the arrow to
select the schema that you want to edit. Refer to Setup Team Projects for information about how to
complete these fields and apply the changes.
l To make a project active (meaning Team Coding is active for the objects specified in the project) or
inactive (deactivate Team Coding for those objects), select or deselect the Active box.

To delete a Team Project

1. Select the Team Project to delete.

2. Click to delete the project, or right-click the project and select Delete Team Project.

3. Click Apply.

SQL Navigator 7.6

115
User Guide
To freeze a Team Project
1. Select the Team Project to freeze.

2. Click to freeze the project, or right click the project and select Freeze Team Project.

3. Click Apply.

NOTE: In the Team Projects list, the project is now marked (Frozen) rather than (Active) . Click to
unfreeze the project.

To work with revisions

The Team Coding Administrator can perform the following actions for a project:

Icon Action Description

Synchronize Synchronize differences between the version in the database and the version in
Changes the VCS. Select the objects that you want to synchronize.
(Disabled Synchronize resolves the following issues:
if a VCS
is not l Differences between the VCS source code and the object in the database.
being Any differences are resolved by the global setting of the "When differences
used) in source versions exist" option in the Team Coding Administrator window
(as configured by a Team Coding Administrator). If the option is set to
Prompt User (user chooses between opening the database version or the
VCS version) a non-administrator user can make that choice. Otherwise,
either the database or VCS version is opened, depending on the global
setting. See Set Team Coding Global Settings for more information.
l Objects in the database but not in the VCS are added to the VCS.
l Objects in the VCS but not in the database are added to the database.

Create New Create a new revision in the VCS for all controlled objects. This action loads all of
Revision in the objects for a Team Project into the Synchronize window. Select the ones for
the VCS which you want to make a new revision.
(Disabled
if a VCS
is not
being
used)

Compile Compile the selected object in the database.

PL/SQL
Objects in
DB

Setup Team Projects

The Team Coding Administrator must create at least one Team Project before users begin to use Team Coding.
A Team Project is linked to specific controlled objects and a version control system (VCS), if one is being used
with Team Coding.

SQL Navigator 7.6

116
User Guide
Team Coding must be installed and set up before Team Projects can be created. For more information, see
Install Team Coding on page 111.

To create a Team Project

1. If using a version control system with Team Coding, log into the VCS from Team Coding | VCS Login.
2. Select Team Coding | Administer.
3. Select the Team Projects tab.

4. Click in the Team Coding Administration toolbar.

5. Assign a name to the Team Project. Note: You can rename a project at any time: Right-click the name
and then select Rename Team Project.
6. Do one of the following:
l If you are not using a VCS with Team Coding, leave the VCS area set to the default (blank).

l If you are using a VCS with Team Coding, click next to VCS Project to specify a project (and
sub-project as needed) in the VCS. The selected project will contain the revisions made to the
source objects that this Team Project will control. You have the following options when selecting
this directory:

Option Description

New... Specify a nested sub-project for SQL Navigator to create under the selected VCS project.

1. Click New, then type a name for the sub-project.

2. Click OK to return to the Select Project window.
3. (Optional) To create a nested sub-directory under the new sub-directory, select the new
sub-directory in the tree, and then click New.

Sub- Store each object type in a separate sub-directory under the VCS directory that you created in the
Projects previous steps:

1. Select the check box.

2. To create the sub-projects in the VCS now, click Create Sub-Folders. Otherwise, SQL
Navigator will create them when the objects are checked out for the first time.

7. Click to do one of the following:

l Select All Schemas to include all of the user schemas in the database in this Team Project.
l Select an individual schema from the list.

l To add another schema, click and then select a schema.

l To remove a schema, click .

8. To filter the objects that are controlled with this project, expand the schema node and then refer to the
following table. By default, all objects of all object types are included in the project.

SQL Navigator 7.6

117
User Guide
 Action Description

Enable Clear the check box for any object type in this schema that you do not want to control with Team
Coding.
For tables, you can control how tables and their associated objects are checked out:

l Select the box at the Tables node to check out tables with their associated indexes, triggers,
and constraints.
l Select the individual Triggers, Constraints and Indexes nodes to check out those object
types separately from their associated tables.

Filters
Double-click to create filters that control which objects of each object type are controlled. You
( ) can add one or more filters. Use standard Oracle filtering such as string% or string_.
Use Filter to specify the objects that you want to control with this project.
Use Exclude to exclude objects from being controlled by this project.

9. Click OK.
10. (Optional) Create additional Team Projects.
11. Click Apply to direct SQL Navigator to create the Team Project(s) and the associated projects in the
VCS, if applicable. The objects are added to Team Coding, but not to the VCS.

NOTE: By default, a Team Project is marked as active when it is created. A status of (Active) means
that the objects in the project are controlled through Team Coding.

Team Coding Roles

Team Coding only has one defined role, that of the Team Coding Administrator: TC_ADMIN_ROLE. This role is
automatically granted to the user who creates the Team Coding objects. This user can set up or remove Team
Coding, set up global rules for the Team Coding environment, and set up Team Projects.
If necessary, you can grant the TC_ADMIN_ROLE to additional users. Be sure to select the Default checkbox
when you grant the role to additional users.
You do not need to assign a role to other Team Coding users. By default, all users in the database can:

l View the status of objects with the Team Coding Viewer

l Lock and unlock database objects
l Check items in and out of source control (if a VCS is in use)
l Mirror their schema to a Team Project

Administer Team Coding

SQL Navigator 7.6

118
User Guide
Configure Team Coding
Use the Configure Team Coding Options page to configure the following local settings that are unique to your
local SQL Navigator installation:

l (Optional) Configure connection to a version control system (VCS). See Version Control Systems.
l Configure code check-in and logging options. See also View | Preferences| Team Coding.

To set local Team Coding options

l From the Main Menu, click Team Coding | Configure.

Options
Option Description

VCS Select a version control system to use with Team Coding. Select None to use Team
Coding without a VCS.

NOTE: If the database you are connected to is controlled by Team Coding, this
selection is read-only and cannot be changed.

Settings Configure connection settings to the selected VCS.

Configure Concurrent Version Systems (CVS)
Configure Git
Configure IBM Rational ClearCase
Configure Perforce (P4)
Configure Serena PVCS Version Manager
Configure Subversion (SVN)
Configure Microsoft Team Foundation Server
(Not required for Microsoft Visual Source Safe.)

NOTE: If the database you are using is controlled by Team coding, these
settings are read-only and are controlled by the Team Coding Administrator.

Prompt for check-in Force users to enter comments when checking controlled objects in or out.
comment
If the Force check-in comments or Force check-out comments option is set
Prompt for check-out globally by the Team Coding Administrator, that option is read only on this page.
comment

Prompt for check-in Prompt users to check in their work when they close SQL Navigator.
all on exit

SQL Navigator 7.6

119
User Guide
 Option Description

Prompt for changes Prompt to alert you of changes made to the VCS configuration.
to VCS server config
Check-out object on Automatically check out a controlled object when it is opened in SQL Navigator.
opening
Check-in object on Automatically check in a controlled object when it is closed in SQL Navigator.
closing
Force new revision Force a new VCS revision when a controlled object is checked in, even if no changes
on check-in are made. Not all VCS systems support this feature.
VCS Logging Description
Show VCS command Display Team Coding VCS commands and responses in the Output Window.
output window

Enable VCS debug Save VCS commands and responses to the VCS debug log. To view this log, click
logging Open log file.

Configure Concurrent Version Systems (CVS)

These configuration settings are specific to Concurrent Version Settings (CVS).

1. From the Main Menu, click Team Coding | Configure.

2. Select Concurrent Version Systems (CVS) | Settings

Setting Description

CVS Specify the name of the CVS program file in one of the following ways:
Executable
l Specify the full path to the file, such as C:\Program Files\CVS\cvs.exe. This
forces SQL Navigator to use the specified program.
l Specify only the file name, rather than the entire path (the location of the program file
must be in your system path). SQL Navigator will use the first occurrence it finds of the
specified file name.

Global Specify any global options that you want SQL Navigator to pass to CVS whenever a CVS
Options command is executed by SQL Navigator. For example, the default option of -f tells CVS to
ignore your .cvsrc options file.
You can use more than one option. Separate multiple options with a space.

NOTE: Do NOT enter a -d CVSROOT option here. SQL Navigator adds this option
automatically, using the CVSROOT you provide in the CVS Login window.

SQL Navigator 7.6

120
User Guide
Setting Description

Dates and Description

Times in
CVS Output

Date Format These options specify how CVS will send dates. You can use the following formats:

d Day as a number without a leading zero (1-31)

dd Day as a number with a leading zero (01-31)

m Month as a number without a leading zero (1-12)

mm Month as a number with a leading zero (01-12)

yy Year as a two-digit number (00-99)

yyyy Year as a four-digit number (0000-9999)

Default: yyyymmdd

Time Format These options specify how CVS will send times. You can use the following formats:

h Hour without a leading zero (0-23)

hh Hour with a leading zero (00-23)

n Minute without a leading zero (0-59)

nn Minute with a leading zero (00-59)

s Second without a leading zero (0-59)

ss Second with a leading zero (00-59)

Default: hhnnss

Time Zone Direct SQL Navigator to adjust the time stamps read from the output of CVS commands. For
example, to subtract eight hours from all timestamps, specify a value of -800. To add three
hours, enter a value of 300.
Default: 0

Login Description

Login Omit a prompt when SQL Navigator logs into CVS after connecting to the database. The most
Automatically recently used CVSRoot will be used.
To use this option, the following must be true:

l The Team Coding option "Disable Login Prompt on Connection" must not be
enabled.
l The TC=NO command-line option must not be enabled.

SQL Navigator 7.6

121
User Guide
 Setting Description

l You previously logged in to CVS from SQL Navigator and:

The previous login used an authentication method that did not require a password
or
You checked the Save Password option on the login form.

Time Set the amount of time (in milliseconds) that SQL Navigator pauses after sending each
Between character of the password to the CVS password prompt.
Keypresses
The default is zero.

NOTE: If you find that CVS is returning "invalid password" errors, you may need to
increase this number. A suggested figure is 100 milliseconds.

Configure Git
These configuration settings are specific to git.

1. From the Main Menu, click Team Coding | Configure.

2. Select git | Settings

Setting Description

Git Client Point to a different Git executable. Typically, no change is required in this
field.

Automatically Login to Default Direct SQL Navigator to log in to the default repository without opening the
Git Repository login window.

Allow SQL Navigator Login to Direct SQL Navigator to update the Git user and email configuration settings
Update Repository User and for the repository. These are used to track the author of changes and
Email commits.
Commit Comments Set the default comment for commits if no comment is made by the user
during the commit. Git requires comments for commits.

Configure IBM Rational ClearCase

NOTE: SQL Navigator requires that you already have the IBM Rational ClearCase Client installed, a
valid ClearCase license, and the capability to run the ClearTool Command line.

SQL Navigator 7.6

122
User Guide
These configuration settings are specific to IBM Rational ClearCase.

1. From the Main Menu, click Team Coding | Configure.

2. Select IBM Rational ClearCase | Settings

Setting Description

ClearCase Executable Select the ClearCase executable file that you want to use.
Validate Validate that SQL Navigator can launch the selected executable.
Automatically load Views and VOBs Automatically load ClearCase views and versioned objects from the
from ClearCase Server specified hosts when SQL Navigator starts.

Reserve/unreserve on Use ClearCase reserved checkout.

checkout/checkin
Force Comments on Check in Force the inclusion of comments upon check-in of code.

Configure Perforce (P4)

These configuration settings are specific to Perforce.

1. From the Main Menu, click Team Coding | Configure.

2. Select Perforce (P4) | Settings

General tab
Setting Version

Server Name Specify the server for the Perforce repository.

Server Port Specify the access port on the sever where Perforce is set up (default is 1666).
Client Locate the path to the Perforce command line executable (P4.exe).

Options tab
Setting Version

Connection Set the following connection options:

SQL Navigator 7.6

123
User Guide
 Setting Version

Automatically connect to default Perforce client workspace

Performs automatic logon to the default workspace when logging in to Perforce.
Automatically load workspaces from P4 server

l If this option is set, SQL Navigator checks the Perforce server for client workspace
information when logging on to Perforce.
l If this option is not set, Perforce checks for saved workspace information on the client
desktop. (Deselect this option if Perforce loads slowly when you log in.)

Only load server workspaces for logon user

Only loads workspaces belonging to the logged-on user in the list of Perforce workspace
loaded from the server. Select this option if you need to reduce the load time at logon.

File Use locking during checkin /checkout

Locking
Locks files upon check in or check out.

Configure Serena PVCS Version Manager

These configuration settings are specific to Serena PVCS Version Manager.

1. From the Main Menu, click Team Coding | Configure.

2. Select Serena PVCS Version Manager | Settings

Setting Description

PVCS Client Enter or browse to the PVCS client executable.

Automatically Login to Default Log in to the PVCS repository when Team Coding starts.
Repository
Default Comment Set the default comment when code is checked in to PVCS. User-supplied
comments override this default.

Configure Subversion (SVN)

These configuration settings are specific to Subversion (SVN).

1. From the Main Menu, click Team Coding | Configure.

SQL Navigator 7.6

124
User Guide
 2. Select Subversion (SVN) | Settings

Client Tab
Setting Description

SVN Specify the Subversion executable file.

Executable

Global Send Subversion global options across all Subversion commands. For more information, see
Options the help information provided with the SVN client.

NOTE: The username and password global options are automatically included when
necessary with server-based connections.

Server Defaults Tab

Setting Description

Default Set default values to connect to your SVN Repository. SQL Navigator uses these values
Connection to create the URL to the repository.
Method
l Select Local Connection if the server is installed on the same machine as the
client.
l Select WebDAV Connection if the server is to be accessed across the HTTP
protocol.
l Select SVN Server Connection if the server is on a remote machine and is to be
accessed through the svn protocol.

OptionsTab
Setting Description

Use locking on check out / check Use locking when checking out files and to clear locks when checking in
in files.

NOTE: By default, Subversion does not use locks when working

with files. This option allows you to override this default behavior

SQL Navigator 7.6

125
User Guide
Configure Microsoft Team Foundation Server
NOTE: Please see your Team Foundation Server administrator before configuring any of these options.

These configuration settings are specific to Microsoft Team Foundation Server.

1. From the Main Menu, click Team Coding | Configure.

2. Select Microsoft Team Foundation Server | Settings

General Tab
Setting Description

Server Specify the name of the server where the TFS repository is installed and specify the TFS port
Location number on that server. Optionally, you can specify that connections are SSL.
Client Specify whether to connect through the internal or external client. Each option has advantages
and disadvantages. For more information, see More about Team Foundation Server and SQL
Navigator on page 137.

Connection Connect automatically to the default TFS workspace when SQL Navigator starts.

Check In / Out Tab

Setting Description

Disable prompts when Enable this option to suppress Team Foundation Server prompts whenever possible
possible during a check-in or check-out process.

NOTE: If check-in notes are required in the server configuration,

SQL Navigator prompts you to enter these notes during a check-in process,
regardless of this setting.

Validate before Validate the code before it is checked in.

checking in

Default locking Select a locking option:

l Lock the code on check-in or check-out

l Automatically determine the locking based on server settings
l Require no locking.

Associate Work items Set Link one or more TFS work items to the check-in change set.
with Change

SQL Navigator 7.6

126
User Guide
History Tab
Setting Description

Only show my Show only the code changes made in this SQL Navigator client when displaying
changes history.
Stop after Stop maintaining revision history after the specified number of check-ins.

Advanced Tab
Setting Description

Default Enter an alternate URL if your Team Project Collection has a non-standard URL that cannot be
URL correctly built using SQL Navigator’s configuration settings.
Custom When this value is set, SQL Navigator ignores all the other settings (Server, Port, Collection,
URL Virtual Dir, etc.) and uses the Alternate URL to build TFS calls to the Team Project Collection on
the server.

NOTE: It is recommended that this is only used in the very small number of cases where
the URL to the Team Project Collection is not configurable from the normal SQL Navigator
settings.

Collection Specify the TFS Collection to connect to , if using TFS 2010 or later.

Virtual Specify the path to the virtual directory, if using TFS 2010 or later.
directory
Alternative Specify an alternate URL for use if the primary URL is not available.
URL

Team Coding Status

Team Coding Status messages can assist you with configuration issues in Team Coding or in setting up the
VCS configuration.

How to show Team Coding status:

l From the Main Menu, select Team Coding | Team Coding Status.

SQL Navigator 7.6

127
User Guide
Using Team Coding status messages
When there is a hint or warning, double click the message on the Status tab to jump to the window in SQL
Navigator where you can address the issue.

NOTE: To make adjustments to the Team Coding global setup, click to Administer Team Coding.

Team Coding Manager

Use the Team Coding Manager to manage and work with the objects that are controlled by Team Coding. The
Team Coding Manager displays Team Coding status and controlled objects for the current active connection.
You can use Team Coding Manager as a floating pane or dock it to the left-hand side of SQL Navigator.

To open or close the Team Coding Manager

l From the Main Menu, select Team Coding | Team Coding Manager.

The Team Coding Manager includes these tabs:

l Team Projects
l VCS

NOTE: If nothing is displayed on these tabs, it means that Team Coding was disabled by a Team Coding
Administrator.

VCS tab
If a Team Coding administrator linked Team Coding to a version control system (VCS), the Version Control tab
(also known as the VCS Browser) provides a view of the Team Coding objects in their version control projects,
as well as other non-controlled projects. The folders for projects that contain Team Coding objects are colored
green to distinguish them from other projects.

The Team Coding-controlled objects are displayed in the browser with a green check mark , to distinguish
them from other files under source control. When these objects are checked out, their locks are controlled in
Team Coding and the internal Team Coding transaction table is updated.

Team Projects tab

The Team Projects tab (also known as the Team Coding Browser) lists all of the Team Projects that are
configured for the connected database. Only objects that are controlled by Team Coding are visible from this
view. When you check out an object from this tab, Team Coding locks it.

SQL Navigator 7.6

128
User Guide
Work with Team Coding objects
To display revision history
1. In either tab, select the object for which you want to view history.
2. Click again in the right-hand portion of the highlighted name to expose an arrow.
3. Click the arrow. The revision history popup is displayed.

To view summary information

» In either tab, hover the mouse over the name of an object to view its lock status and VCS information.

To work with and manage controlled objects

To perform an action on a controlled object, you select the object in either tab and then click the
appropriate action in the Team Coding Manager toobar, or use the right-click menu within the Team Coding
Manager window.

NOTE: You may need to customize the toolbar to display all of the available actions. Click the arrow at
the end of the toolbar, then select Add or Remove Buttons.

Select an action from the toobar or the right-click menu. (Actions not appropriate for the current workflow are
disabled.) See the following table for action descriptions.

Icon Action Description

Synchronize Synchronize differences between the version in the database and the version
Changes in the VCS. Select the objects that you want to synchronize.
(Disabled Synchronize resolves the following issues:
if a VCS
is not l Differences between the VCS source code and the object in the
being database. Any differences are resolved by the global setting of the
used) "When differences in source versions exist" option in the Team Coding
Administrator window (as configured by a Team Coding
Administrator). If the option is set to Prompt User (user chooses
between opening the database version or the VCS version) a non-
administrator user can make that choice. Otherwise, either the
database or VCS version is opened, depending on the global setting.
See Set Team Coding Global Settings for more information.
l Objects in the database but not in the VCS are added to the VCS.
l Objects in the VCS but not in the database are added to the database.

Create New Create a new revision in the VCS for all controlled objects. This action loads
Revision in the all of the objects for a Team Project into the Synchronize window. Select the
(Disabled VCS ones for which you want to make a new revision.
if a VCS
is not
being
used)

SQL Navigator 7.6

129
User Guide
Icon Action Description

Compile PL/SQL Compile the selected object in the database.

Objects in DB

Configure Team Open the local user settings for this installation of SQL Navigator. For more
Coding Settings information, see Configure Team Coding on page 119.

Administer Team Open the Team Coding Administration utility. For more information, see
Coding Administer Team Coding on page 110.

Team Coding View the current state of the local Team Coding installation, the VCS (if being
Status used), the Team Projects, Team Coding Settings, and other environmental
information. For more information, see Team Coding Status on page 127.

VCS Logon Log on to the VCS.

(Disabled
if a VCS
is not
being
used)

Select VCS
Project

Add File

Check out Check out one or more objects. When you check out an object or file, it locks
that item in the database. The item remains locked until you check in your
changes through Team Coding.
If a VCS is being used, there are two parts to a checkout

1. Check out the source from the VCS.

2. Create a check-out transaction for the object in Team Coding. This is
what determines the state of the object in DB Navigator or Team
Coding Manager.

If a VCS is not being used with Team Coding, only step 2 from the preceding
actions occurs. Team Coding does nothing with your source code in this case.

Undo checkout Cancel the checkout.

Check in Check in one or more objects to the VCS.

If a VCS is being used, there are two parts to a checkin:

1. Check in the source to the VCS.

2. Create a check-in transaction for the object in Team Coding. This is
what determines the state of the object in DB Navigator or Team
Coding Manager.

If a VCS is not being used with Team Coding, only step 2 from the preceding
actions occurs. Team Coding does nothing with your source code in this case.

SQL Navigator 7.6

130
User Guide
 Icon Action Description

Check in all Check in all objects that you currently have checked out in your local SQL
Navigator environment.

Get latest Retrieve the latest revision of the object from the VCS. The object is not
revision checked out, and there are no changes made to the database.

Compare Compare the VCS version of an object side by side with the version in the
contents database. You can also compare revisions in the VCS by selecting the
revision numbers that you want to compare in the VCS browser and then
clicking Compare Contents. See Compare Files and Objects for more
information.

Open Open the object in the Editor or the DB Navigator. To open an object so that
you can work on it in an editor, you must first check it out.

Delete Record Delete the object source from Team Coding and Version Control (if allowed
by the administrative settings.)

Filter Filter the items on the screen.

Refresh Refresh the view of the objects.

Expand/Collapse Expand or collapse the nodes in the tree. Click the arrow for options.

Break Team Break a Team Coding lock created by another user. (Can only be performed
Coding Lock by a Team Coding Administrator.)

Freeze Freeze an object to prevent updates to it. (Can only be performed by a Team
Coding Administrator.)

Un-Freeze Un-freeze an object. (Can only be performed by a Team Coding

Administrator.)

Team Coding and Version Control Support

Provider logon
The version control system (VCS) must be configured in Team Coding before you can log in. For more
information, see Install Team Coding on page 111.

To log in to a VCS from Team Coding

l Team Coding | Provider Logon.

Version Control Systems

SQL Navigator 7.6

131
User Guide
Using Git
1. Go to Team Coding | Provider Logon. The Git login window opens.
2. Enter your repository information, Git user name and Git email, and click OK. The Source Control Select
Project dialog opens.
3. Select your Git Sub Directory from the list of modules.
4. Open the source control VCS Browser. You can browse Git controlled objects, open files in the editor,
check in, check out or add files to the local Git repository.

Related Topics
Provider logon
Version Control Systems
More about Git and SQL Navigator

Using Perforce
1. Go to Team Coding | Select VCS Project.
If loading workspaces automatically from the server, or a workspace is already in the local cached list,
then select an existing workspace from the list.

1. Enter your Perforce user name and password, and click OK.
2. Select the Perforce project (depot) for use in SQL Navigator.

Version Control Systems

More about Perforce and SQL Navigator

Using IBM Rational ClearCase

When you log on to Version Control or Team Coding, you will be asked to select the Clear Case View.

Mapped Drive and Views

ClearCase views are client views of ClearCase Versioned Objects (VOBS).
The ClearCase mapped drive is the folder created when ClearCase created the view. This drive contains the
folders where your working files will be saved.
SQL Navigator lists all the views that you have installed on the local desktop. The view must be mapped to the
project VOB used by SQL Navigator.

SQL Navigator 7.6

132
User Guide
To log in to ClearCase
l Select your ClearCase view on the ClearCase Login tab.
l Select the Project VOB.

NOTE: SQL Navigator does not currently support saving working files to a separate folder. This is a read
only value.

l On the ClearCase Explorer tab, you can review the Project VOBs available in the ClearCase View.

When you select a Project VOB from Source Control, SQL Navigator will show a list of the controlled project
folders within the selected VOB. This version of SQL Navigator only supports a single level of folders within a
ClearCase Project VOB.

Version Control Systems

More about IBM Rational ClearCase and SQL Navigator

Check in and Check out

The check-in and check-out of objects that are controlled in Team Coding or the VCS can be done in different
ways in SQL Navigator.

Check in/check out individual objects

The Check In and Check Out buttons in Team Coding Manager can be used for both database objects and files.
When you check out an object or file, it locks that item in the database. The item remains locked until you check
in your changes through Team Coding. You must check out an object before you can compile it.
If a VCS is being used, there are two parts to a checkout

1. Check out the source from the VCS.

2. Create a check-out transaction for the object in Team Coding. This is what determines the state of the
object in DB Navigator or Team Coding Manager.

If a VCS is not being used with Team Coding, only step 2 from the preceding actions occurs. Team Coding does
nothing with your source code in this case.

To check individual items in and out

1. Open the script or select the object in the .

2. Click to check out an object or click to check in an object.

You can also check in or check out an object by right-clicking it in DB Navigator or Team Projects browser, and
then selecting the desired command.

Check in all items

To check in all objects at the same time, you can:

SQL Navigator 7.6

133
User Guide
 l Click on the Team Coding Manager toolbar.

l Select Team Coding | Check-in all to open a dialog where you can select objects individually from a list.

If a VCS is being used, there are two parts to a checkin:

1. Check in the source to the VCS.

2. Create a check-in transaction for the object in Team Coding. This is what determines the state of the
object in DB Navigator or Team Coding Manager.

If a VCS is not being used with Team Coding, only step 2 from the preceding actions occurs. Team Coding does
nothing with your source code in this case.

Automatic Check In and Check Out

You can have SQL Navigator automatically check in an item when you open it and check out an item when you
close it. You can also have SQL Navigator prompt you to enter a comment. For more information, see Configure
Team Coding on page 119.

Undo a checkout
To cancel the check out and reverse any changes, click on the Team Coding Manager Toolbar.
Alternatively, you can right-click the object then select Undo check-out.

Version Control Systems

You can use a version control system (VCS) in conjunction with Team Coding to control files and database
objects. SQL Navigator provides direct support to specific third-party version control systems and it also
provides SCC support to connect to additional version control systems. You must have Team Coding installed to
work with a VCS through SQL Navigator.

IMPORTANT: Quest Software is unable to provide support for source control issues caused by the
version control system, including the version control system's support for Microsoft's SCC API. If you have
problems connecting to Toad through SCC, contact the version control system's Support.

Direct Supported
Version Control System Version

Concurrent Versions CVS 1.11.9 and later

System (CVS)*
CVSNT 2.08 and later
For more information, see Concurrent Version (CVS) System Requirements on

SQL Navigator 7.6

134
User Guide
 Version Control System Version

page 136.

Git     * A git client for Windows must be installed.

For more information, see More about Git and SQL Navigator on page 136.

IBM Rational Version 7.1 for Windows.

ClearCase      *
ClearTool command line is required.
For more information, see More about IBM Rational ClearCase and SQL
Navigator on page 137.

NOTE: You must set up a working client view, mapped to the Project VOB
on the client computer, before using it in SQL Navigator.

Perforce       * 2010.2 (command-line client)

For more information, see More about Perforce and SQL Navigator on page 137.

NOTE: The Perforce client must match your operating system. For
example, if you are running Windows 7 64-bit, then you must use the 64-
bit Perforce client.

Serena PVCS         * 5.2 and later

NOTE: PVCS 6.6.1 and 6.8.0 are specifically not supported with Team
Coding.

Serena PVCS Version Manager:

l PVCS is supported with Team Coding for both 32-bit and 64-bit SQL
Navigator.
l It has been tested with Serena PVCS Version Manager 8.5/ 8.4, and
replaces existing Merant PVCS interfaces.
l PVCS Version manager Command Line Interface (CLI) is supported.
l PVCS Command Line option must be included when installing PVCS

Apache Subversion 1.6.5 and later

(SVN)*

Microsoft Team 2005 through 2013

Foundation Server
For more information, see More about Team Foundation Server and SQL
Navigator on page 137.

Microsoft Visual 5.0, 6.0, and 2005 (8.0)

SourceSafe

*These version control systems connect using a command-line client.

SQL Navigator 7.6

135
User Guide
SCC Support
In addition to providing direct support to the version control systems, SQL Navigator supports additional
version control systems through Microsoft's SCC API. You should be able to connect to any version control
system that uses SCC.
To connect to a version control system using SCC, you must install the system's SCC-compliant client. See the
system's documentation for instructions on how to install their SCC client.

NOTE: It is strongly recommended you use the native APIs for SourceSafe and PVCS when using Team
Coding (instead of the SCC integration).
Most version control systems that integrate with SQL Navigator through the SCC API ignore the "Force
revision" flag and the "Create a new revision for existing objects" option when exporting.

Concurrent Version (CVS) System

Requirements
To use Concurrent Version Systems (CVS) with Team Coding, you need to have a CVS command-line client
installed on your system. The following minimum versions are recommended:

l CVS client version 1.11.9 or later

l CVSNT client version 2.08 or later

Team Coding has been tested with the following clients:

l CVS clients 1.11.9 and 1.11.17 with the pserver authentication

l CVS client 1.11.12 with pserver and ssh authentication
l CVSNT clients 2.0.8 and 2.0.41a with the pserver authentication
l CVSNT clients 2.0.11, 2.0.26, 2.0.34, and 2.0.41 with sserver, pserver, and sspi authentications
l CVSNT client 2.0.14 with sserver, pserver, sspi, ssh, ext, and local authentications

More about Git and SQL Navigator

A git client for Windows must be installed. Git 1.8.3 mysygit.0 was tested.
Additional documentation is provided at https://support.quest.com/ and on ToadWorld.com.
When you are working with Git:

l SQL Navigator checks files in and out of the local repository residing on the client desktop.
l Changes are posted back to the local repository immediately.
l Updates to any centralized repository are handled outside of SQL Navigator.

Related Topics
Version Control Systems

SQL Navigator 7.6

136
User Guide
More about IBM Rational ClearCase and SQL
Navigator
NOTE: Limitations

l Tested on IBM Rational ClearCase Version 7.1 for Windows.

l Tested using Dynamic Views mounted on the default ClearCase MVFS mapped drive (M:\)
l SQL Navigator requires that all configuration is managed by ClearCase tools. ClearCase is a
complex environment, which typically requires a ClearCase System Administrator.
l Quest Software provides no support for ClearCase administration questions.

More about Perforce and SQL Navigator

Additional documentation is provided at https://support.quest.com/ and on ToadWorld.com.

NOTE: You can switch off the option to load workspaces from the Perforce Server.
By only loading workspace details for the currently active workspace, the workspace load also has been
significantly optimized,.
There is a configuration option to enable/disable "Automatically Load P4 Workspaces from P4 Server."
If Automatic load option is not checked, logging on to Perforce will only load workspaces that have been
saved to the client ini file during a previous session.
There is al manual 'Reload from Perforce' option, to load all workspaces from the Perforce server.
You can enter all workspace information manually, or load the information from the Perforce server.

Version Control Systems

More about Team Foundation Server and SQL

Navigator
In order to use SQL Navigator’s Team Foundation Server support, you need to have Team Foundation Server
(TFS) installed on your network. Please review Microsoft's documentation for instructions on installing and
configuring TFS.
Additional requirements are needed to work with TFS work items.
Team Coding includes two methods for interfacing directly with TFS: an internal client and an external client.
Although they have identical TFS functionality in SQL Navigator, each client has its own unique advantages and
disadvantages. See your TFS administrator before configuring it in SQL Navigator.

Internal TFS Client Advantages:

SQL Navigator 7.6

137
User Guide
 Uses Microsoft’s Web Services API to directly communicate with Improved speed (over the external
Team Foundation Server. client)
No need to install additional software
on the client machine
Disadvantages:
Does not include support for Check-in
Policy items
Certain administrative tasks, like
deleting workspaces are not supported

External TFS Client Advantages:

Uses Microsoft’s command-line Team Foundation client to Expected compatibility with future
communicate with Team Foundation Server. This command-line versions of Team Foundation Server
client is included with Microsoft Team Explorer, and should remain
Supports all features of Team
consistent throughout versions.
Foundation Server, including Check-in
Policies
Disadvantages:
Much slower than the internal client
since an instance of the external client
is launched for each TFS command
issued to the server
Requires the installation of Microsoft
Team Explorer

TFS Work Items

Team Coding check-in includes the ability to link one or more TFS work items to the check-in change set.
The following system requirements must be met:

l You have the necessary Microsoft Client Access License (CAL) to update work items in Team
Foundation Server.
l .Net framework 4.0 installed.
l Team Explorer or Microsoft Visual Studio 10.0 or 11.0 (VS 2010 or VS1012)
l SQL Navigator installs a required DLL (TFSWorkItemLink32.dll or TFSWorkItemLink64.dll depending on
the version) in the SQL Navigator program directory
l SQL Navigator registers the DLL with the required .Net assembly (.Net Regasm.exe).

To set up Work Items

1. Go to View | Options | Source Control.
2. With TFS selected as your provider, click Settings.

SQL Navigator 7.6

138
User Guide
 3. On the Check in / out tab, select Associate Work items with Change Set.
4. Click OK in the confirmation.

To Use Work Items

1. Check out a Team Coding controlled object.
2. Make a change and check it back in.
3. Open the Work Items tab in the check-in dialog and enter or select one or more work items.
4. Click OK to check in the item.

This change set will now be linked to the selected work items.

Version Control Systems

SQL Navigator 7.6

139
User Guide
 7

Modules, Windows And Dialogs

Analyze Tool
Use the Analyze tool to view and collect statistics, validate structure and list chained rows for database
structures such as tables, clusters and indexes.

Ways to open the Analyze Tool

From DB Navigator 1. Select a table, cluster or index node in DB Navigator.

2. Click Object | Analyze or right click Analyze.

From the Explain Plan Tool 1. Select a node in the Explain Plan Tool.
2. Click Show/Collect Statistics.

Collect Statistics
Select the collection method.

Collection Description
Method

Compute The entire object is scanned to gather data. The larger the object, the longer it takes to
Statistics complete the analysis.
Select this option only if the object is small.

Estimate Sample by rows or percentage of the object. The accuracy of the statistics depends on the
Statistics representatives of the sampling.
This option suits large objects.

SQL Navigator 7.6

140
User Guide
 Collection Description
Method

Delete Delete the statistics gathered for the object.

Statistics

Validate Structure
Use to verify the integrity of the selected object.
Select Cascade to additionally verify dependent objects. For example, if you validate the structure of a cluster
and select Cascade, SQL Navigator checks all tables and indexes in the cluster.

NOTE: Oracle returns an error message if it encounters corruption in the structure of an object. To fix
errors: Drop and recreate the object from the commands on the Object Menu.

List Chained Rows

Use to identify migrated or chained rows in a table or cluster. Having a high percentage of chained rows can
impair application performance. UPDATE statements that cause migration and chaining perform poorly.
Queries that select migrated or chained rows must perform more I/O than those that do not. For these reasons,
it is important to detect and correct them. See Oracle documentation on the possible ways of fixing chained-
rows problems.

1. The default name for the table that will contain the chained rows information is CHAINED_ROWS. This is
defined at View | Preferences | General | Default Tables.
2. Click Create Chained Rows Table to create the table. Watch for verification in the Output Window.
3. Click List Chained Rows to collect the information. Watch for verification in the Output Window.
4. To view the information select the CHAINED_ROWS table in DB Navigator and click Object Menu |
Quick Browse.

Auto Describe Tool

The Oracle DESCRIBE command reports the attributes, methods and arguments of an object type. The SQL
Navigator Describe command works with more objects than does the SQL*Plus version of the command. You
can describe not only procedures, functions, packages, synonyms, and object types, but also tables, indexes,
clusters and objects.

SQL Navigator 7.6

141
User Guide
Ways to open the Auto Describe Tool

From the 1. Click View | Auto Describe Tool.

View
2. Ensure the required database connection is active.
Menu
3. Select the object to describe. The object may be in DB Navigator, Project Manager, (for
example).

From the 1. Press and hold CTRL.

Code
2. Click on the object's name.
Editor
If the object is a text object (view, procedure, function, package or packaged procedure/function)
and the Source Preview window is open then the object’s source is automatically previewed.

TIP:

l Can be used to provide a quick summary of a table or view and all its column names and data
types.
l The Auto Describe Tool is dockable. For more information, see Customize The Screen Layout on
page 43.
l The Auto Describe Tool always stays on top of the application window.
l Select the following to automatically display the Auto Describe Tool when you press CTRL and
click on an object name and create a hyperlink: View | Preferences | Code Editor | General |
Describe Object at Hyperlink.

Tips to use the Auto Describe Tool

A quick way to To drag column names into a Select statement

construct a SELECT
1. Open the Auto Describe Tool.
statement
2. In the Code Editor select the table name.
3. Drag and drop column names from the Describe window into the SELECT
statement.

In the Code Editor To move the text cursor to the declaration of a variable (or Auto Describe it if it’s the
name of an external database) press CTRL and point to the variable with the mouse.
To return to the former position in the text, press Alt+Left Arrow.

Describe Command or Auto Describe Tool

Use either the Describe command or the Auto Describe Tool to describe an object

View Menu | Automatically see a description of any object you select.

Auto Describe
A dockable Describe window opens and stays on top of the application window.
Tool
As you select various objects you will automatically see a description of the selected object
in the Auto Describe window.

SQL Navigator 7.6

142
User Guide
 Object menu | Click the Describe command on the Object menu whenever needed. It opens a describe
Describe window for a single selected object and will not update automatically when you select
another object.

Benchmark Factory
Benchmark Factory® is a highly scalable load testing, capacity planning and performance tuning tool capable of
simulating thousands of users accessing your database, file, Internet and messaging servers. Benchmark
Factory can simulate user transactions before and during application deployments, enabling performance
issues to be addressed before end users are affected.

l Allows IT professionals to determine system capacity and isolate system stress related problems
l Common interface displays the testing of databases, Internet, e-mail and file servers.
l Simulates the maximum number of users on a minimal amount of hardware
l Enables IT professionals to discern problems before and after applications are deployed
l Comprehensive tutorials cover load testing, benchmarking, capacity planning and performance tuning,
including information on configuring your system and analyzing results.

NOTE: Requires installation of Benchmark Factory. Benchmark Factory is installed independent of SQL
Navigator.

Bookmarks Dialog
View / Go to / Delete bookmarked lines in the code.

Option Description

List of bookmarks Click on a bookmark to highlight it.

Jump View the highlighted bookmark in an editor.
Delete Delete the highlighted bookmark.

TIP: More bookmark actions can be found on the Edit Menu.

Capture Web Output

SQL Navigator 7.6

143
User Guide
When you first log in to SQL Navigator, the Web server is not enabled for use.

Start Capturing Web Output

1. Click Session | Capture Web Output.
2. Verify that the Oracle Web Toolkit is installed and visible to the schema. Check the Output Window for a
confirmation message.

While Capturing Web Output

Each time you execute PL/SQL code that generates HTML output, the generated HTML is displayed in the
HTML Viewer.

NOTE: If the PL/SQL procedure is run under the debugger, the HTML output is not visible until the
procedure is complete.

Change Logon Password

Modify the logon password of the current session.

Option Description

Old password The password you used to logon to the Oracle session.
New What you want to change the password to.
password
Verification Type the new password twice: once in the New password box and then again in the
Verification box.

Code Analysis
Code Analysis is an automated code review and analysis tool. It enables individual developers, team leads, and
managers to ensure that the quality, performance, maintainability, and reliability of their code meets and
exceeds their best practice standards.

NOTE: This feature is available in the Professional Edition and higher.

SQL Navigator 7.6

144
User Guide
Access to Code Analysis
Code Code Analysis is available in the Code Editor, which ensures code quality from the beginning of
Editor the development cycle. In the Code Editor, Code Analysis evaluates how well a developer's code
adheres to project coding standards and best practices by automatically highlighting errors and
suggesting smarter ways to build and test the code.
Code SQL Navigator also provides a dedicated Code Analysis window, where you can perform more
Analysis detailed analysis, evaluate multiple scripts at the same time, and view a detailed report of the
Window analysis.

Rules and Rule Sets

Code Analysis compares code against a set of rules (Code Analysis Rules) for best practices. These rules are
stored in rule sets (Code Analysis Rule Sets).
The Code Analysis rules and rule sets can be adjusted to suit the requirements of different projects. Regardless
of whether developers are responsible for their own code quality or if this needs to be managed centrally, Code
Analysis can be adapted to fit either need.

Code Analysis Metrics

Code Analysis uses a variety of metrics to evaluate code, including the following:

l Computational Complexity (Halstead Volume)—Measures a program module's complexity directly from

source code, with emphasis on computational complexity. The measures were developed by the late
Maurice Halstead as a means of determining a quantitative measure of complexity directly from the
operators and operands in the module. Among the earliest software metrics, they are strong indicators of
code complexity. Because they are applied to code, they are most often used as a maintenance metric.
l Cyclomatic Complexity (McCabe's)—Cyclomatic complexity is the most widely used member of a class
of static software metrics. It measures the number of linearly-independent paths through a program
module. This measure provides a single ordinal number that can be compared to the complexity of other
programs. It is independent of language and language format.
l Maintainability Index (MI)—Quantitative measurement of an operational system's maintainability is
desirable both as an instantaneous measure and as a predictor of maintainability over time. This
measurement helps reduce or reverse a system's tendency toward "code entropy" or degraded integrity,
and to indicate when it becomes cheaper and/or less risky to rewrite the code than to change it. Applying
the MI measurement during software development can help reduce lifecycle costs.

The Code Analysis Report includes detailed descriptions of the code metrics and how they work. For more
information, see Code Analysis Window on page 146.

SQL Navigator 7.6

145
User Guide
Code Analysis Window

The Code Analysis window provides detailed analysis, including a results dashboard, report, and tree view with
violations and code properties. You can also simultaneously analyze multiple files from this window.

NOTE: This feature is available in the Professional Edition and higher.

To perform detailed code analysis

1. Click Tools | Code Analysis.
2. Load files or objects to analyze.

Open files.

Load objects from the database. You can click the drop-down arrow beside this button to load all
objects or choose a group of objects to load.

3. Select the rule set you want to use in the Code Analysis toolbar (the default is Top 20).
4. To evaluate statements' complexity and validity, select Run SQL Scan in the Run Review list on the
Code Analysis toolbar.
5. Select the items to analyze in the grid.
Use SHIFT or CTRL to select multiple items.

6. Analyze code for all selected items. Click or press F9. (Ensure Run Review is selected.)

Alternatively, to apply your selection to all items press F5.

7. Review the Code Analysis results.

Send code back to the Code Editor from the selected file or object. SQL Navigator displays the Code
Analysis errors and violations in the tabs below the Code Editor.

Additional details

Grid The right side of the grid displays a dashboard of violations and statistics. The dashboard
Dashboard includes the item's Toad Code Rating (TCR), which is a composite of several rating criteria. The
score ranges from 1 (best) to 4 (worst). It provides a quick reference for how your code has
performed in the analysis.

Result tab The Results tab displays the analysis results in a tree view. Expand each node for details on the
violations. If you select a violation in the tree view, the preview on the right displays the
corresponding code.
The Result tab displays the results for the item selected in the grid. If you analyzed multiple
items and select them in the grid, the tab displays the results for all of the selected items.

SQL Navigator 7.6

146
User Guide
 NOTE: Click in the Code Analysis toolbar to view an icon legend.

Report tab The Reports tab summarizes the analysis results and includes rule definitions. Items in the table
of contents are hyperlinked so you can easily navigate the report.

NOTE: By default, the Report tab only displays the analysis for one item. However, you
can select Display all selected results on Report tab to include multiple items in the
report.

Code Analysis Rule Sets

A rule set is a collection of rules that Code Analysis uses to evaluate code. You can create your own rule set
and determine which rules to include. You can also import existing rule sets from outside SQL Navigator, and
export user-defined rule sets.

1. From the Tools Menu, click Tools | Code Analysis.

2. From the Code Analysis toolbar, click .

Create and Edit

Icon Description

Edit the selected rule set.

NOTE: You cannot edit SQL Navigator's standard rule sets.

Create a rule set

Use the selected rule set as your template

For each rule in the rule set, select the rule to include it, deselect the rule to exclude it.

Import and Export

Icon Description

Import a rule set. Navigate to the location of the rule set and click Open.
If the rule set has user defined rules then when importing you will be asked if a rule-export file exists,
and you want to import it. If so the rules are imported. If any rule numbering has to occur because of
conflicts, the rule set is automatically updated to the new rule numbers.

SQL Navigator 7.6

147
User Guide
 Icon Description

Export a user-defined rule set.

If the rule set has user defined rules then when exporting you will be asked if you want to export those
user-defined rules with the rule set. If so the rules are saved as RuleExport.XML in the same directory
as the exported rule set.

Code Analysis Rules

You can use existing Code Analysis rules or clone them and customize them to confirm your code meets your
code review requirements. you can import and export rules.

1. From the Tools Menu, click Tools | Code Analysis.

2. From the Code Analysis toolbar, click .

Create or Clone
Icon Description The Code Analysis Rule Builder

Create a Rule IDs are automatically generated sequentially from 7000 to 9000.
rule
Enter the Description and specify the Rule Tip.

l Specify Rule Severity, Rule Objective, and Rule Category.

Clone the
l Click to display the XML that SQL Navigator generates. This is helpful for use
selected
in an external XPath parser such as SketchPath to refine the XPath expression.
rule
l Create the XPath Expression. To test the rule, click .

A checked box in the User Defined column will be displayed for the rule you created.

Edit
Select the rule to edit. Edit the fields as necessary.

Field Description

Code Preview Enter code to use for testing the rule.

XPath Expression Edit the XPath. If this field is blank, then you cannot edit the XPath for the
rule.

To test the rule, click .

SQL Navigator 7.6

148
User Guide
To restore a rule or all rules, you can select the rule and click the 'Restore Original Rule Value' button, or the
double-arrow 'Restore All Original Rule Values' button.

Import and Export

Icon Description

Import a rule. Navigate to the location of the rule and click Open.

NOTE:

l If a modified SQL Navigator rule is imported, the changes are applied to the rule in
place.
l If a user-defined rule has a number that already exists, the imported rule is given the
next available rule number and added.

Export the selected user-defined rule.

Code Assistant
Drag and drop PL/SQL syntax, SQL functions, column names, and database object names into code.

Move a code snippet into the editor

1. Click View Menu | Code Assistant.
2. Click the cursor in the editor where you would like the snippet inserted.
3. Select the code snippet in Code Assistant. Double click on the code snippet or drag it into the editor.

Locate a code snippet in the Code Assistant

Code Snippets are stored in catalogs. The catalogs are as follows.

Catalog Description

Syntax Browse the ready-to-use library of PL/SQL syntax. The Knowledge Xpert gives SQL Navigator
and Web users a library of more than 900 pre-built PL/SQL routines that can eliminate hours of low-level
Catalog coding and debugging while enhancing application performance and reliability.
PL/Vision Knowledge Xpert products are available as optional add-on modules. For more information, see

SQL Navigator 7.6

149
User Guide
Catalog Description

Catalog Search Knowledge Xpert on page 204.

Code Store your own frequently used SQL statements and code fragments here.
and SQL
For example, you can store your frequently-used cursor declarations or variable declarations.
Catalog
TIP: The catalog sorts the folders and items alphabetically by name. Use your own naming
conventions or prefixes to group similar snippets together.

Syn- IF THEN ELSIF …

Syn- WHERE clause …
Syn- SQL - Correlated subquery
Etc.

The Code Assistant Toolbar

Icon Tool Tip Description

Add new item or node Add a code snippet or SQL statement. Open the Add to Catalog / Edit Dialog.

Edit item or node Edit the selected item. Open the Add to Catalog / Edit Dialog.

NOTE:

l To quickly rename an item: select it in the catalog then click on

it.
l You cannot rename the top level folders in the tree.

Delete item or node Delete the selected item.

NOTE: You cannot delete the top level nodes of the tree.

Paste snippet into Use to paste a code snippet into an editor:

editor
1. Click the cursor in the editor where you would like the snippet
inserted.
2. Click Paste snippet into editor.

TIP: Alternatively drag and drop the snippet into the editor.

Show information Show/Hide the information pane.

window
The information pane shows detailed information on the selected item.

Capture code Use to add a code snippet or SQL statement from an editor window into the
catalog:

SQL Navigator 7.6

150
User Guide
 Icon Tool Tip Description

1. Select the code in the editor window.

2. Click Capture Code.

This opens the Add to Catalog / Edit Dialog with the selected code already
inserted.

Save all catalogs to Save changes.

disk

Add to Catalog / Edit Dialog

Add a code snippet or folder to the Code Assistant Code and SQL Catalog. Manage items in the catalog.

Field Description

Name Make the name descriptive.

Names can be up to 35 characters long and contain uppercase letters, lowercase letters, and
any of the following characters:
_ - & space < > / , ' ( ) ..

Entry Type Select Code Snippet or Folder.

Snippet The snippet of code.

NOTE: For code snippets only.

Information The text to be displayed in the Code Assistant Information pane.

Hint The text to be used as a hint in the status bar at the bottom of the Code Assistant window.

Image The icon to identify the code snippet in the catalog (Generic, Function, or Procedure).

NOTE: For code snippets only.

Code Road Map

The Code Road Map graphically displays the complex PL/SQL interdependencies within a database.

SQL Navigator 7.6

151
User Guide
Code Road Map Toolbar
Icon Tool Tip Description

New code road map This opens the Model Code Dialog.

Clear diagram Clear the model window. Revert to the initial start up state.

Open file Open a saved map file (Extension: .crm).

Save file as Save the map with a new name (Extension: .crm).

Save file Save the map (Extension: .crm).

Save diagram as text file Save the map as a text file.

The file consists of a list of the objects and what they reference.
For example the following might be the results of a small code map:
PROCEDURE CRM_TEST EX_PROC_1 ---> PACKAGE CRM_TEST
EX_PACK_2
PROCEDURE CRM_TEST EX_PROC_1 ---> PROCEDURE CRM_
TEST EX_PROC_2
PROCEDURE CRM_TEST EX_PROC_1 ---> PROCEDURE CRM_
TEST EX_PROC_3
PROCEDURE CRM_TEST EX_PROC_1 ---> TABLE CRM_TEST
EMP_SNAPSHOT
PROCEDURE CRM_TEST EX_PROC_1 ---> VIEW CRM_TEST
SALES
The map is laid out as follows where the arrow means "calls".
OBJECT-TYPE SCHEMA OBJECT NAME --> OBJECT-TYPE
SCHEMA OBJECT NAME

Save diagram as bitmap Create a bitmap version of the map.

TIP: You could copy the image to the clipboard. Right click
over the map and select Copy Image to Clipboard.

Print diagram Print the model side of the map.

Print preview Preview before printing.

Code road map info Add a comment to your code map.

Collapse packages Collapse/Expand Package View.

SQL Navigator 7.6

152
User Guide
 Icon Tool Tip Description

Icon Tool Tip Description

Collapse Show/Hide referenced sub units under the

Packages object type.
Expand
Packages

NOTE: Applicable to Code Type | Package as set in the Model

Code Dialog.

Refresh diagram Refresh the diagram.

Choose colors for database Color code database objects.

objects

Zoom Zoom in or out of the model.

Previous auto layout / Next Scroll through layouts of the Code Road Map.
auto layout

The Code Model

The code model consists of two panels. The left panel shows a list of components in a hierarchical tree. The
right panel shows a graphic model of the code. The design is similar to models created using SQL Modeler.

Hierarchical Tree Graphical Model

The hierarchical tree is organized by Each object listing contains the name of the object, the schema
object type. All procedures are listed where it resides, and the type of object. For Code Type | Package in
under the Procedures node, and all Collapse Package view, any sub units that are referenced will be
tables under the Tables node. included under the object type. For example:
Click on an object to highlight it in the
Graphical Model.

Lines indicate where an object is dependent on another. Lines have

a knob end (the referencing object) and an arrow end (the
referenced object).

SQL Navigator 7.6

153
User Guide
 Hierarchical Tree Graphical Model

In this example, DISK_UTIL references the library NT_KERNEL,

specifically from the function GET_DISK_FREE_SPACE. The model
is in Collapse Package view.

A self-recursive reference is shown with the arrow returning back to

the object, as follows:

Actions: Actions:

l Click on an object in the tree l Right-click on an object to display the popup menu from the
view and the Graphic Model Schema Browser for that object type.
centers on that object.
l F2 toggles full screen mode.
l Right-click on an object to
l F4 or Double-clicking on an object performs a Describe, if
display the popup menu from
SQL Navigator supports Describes on that object type.
the Schema Browser for that
object.
l F4 performs a Describe, if SQL
Navigator supports Describes
on that object type.
l Double-click an object to
perform a Describe.

Model Code Dialog

Select the code to map and the options to use when the code is mapped.

Field Description

Schema The schema where the code is located.

Code Type Select from: function, package, procedure and trigger.

Code Unit The options depend on the Code Type selected.

Sub Unit The various parts of the package, sorted alphabetically. The first sub unit is selected by
default.

SQL Navigator 7.6

154
User Guide
 Field Description

NOTE: Visible for Code Type | Package.

Levels to The number of levels to model down from the starting object. The default is ten.
Model

Display Option Description

Mode
Code Model the code the object calls.
Only
Display a graphical representation of the run-time, call-stack dependencies.

Code Model both the code called and data (tables, views, and so on) referenced by the
+ Data object.
Display the database objects the code references and in what manner (for
example, read versus write). You can also include pertinent triggers and views.
Views are essentially treated as tables.

Display Select as appropriate. These options affect the visual display of the map. The data in the map
Options is not affected.

l Expand packages and types for calls into them

l Include triggers (for Code + Data)
l Include views (for Code + Data)
l Include calls to SYS-owned objects
l Include calls to other schema PL/SQL

Code Templates
Insert ready-made code segments into any active editor window.

Action Description

Insert code from a template 1. In the editor, place the cursor where you want to insert the code
into an active editor window. segment.
2. Choose one of the following:
l Type the shortcut key to the code template.
l Type the full or partial name of the code template and press
Ctrl+J to either insert the matching code template or select
from a list of matches.
l Press Ctrl+J. Select the template name from the drop-down list
and press Enter.

Add / Edit / Delete code Click View | Code Templates | Edit Code Templates. This opens the Code

SQL Navigator 7.6

155
User Guide
 Action Description

templates. Shortcuts And Templates Dialog

Each template is a file in the SQL Navigator installation Templates directory.
The maximum number of templates allowed, including preformatted
templates, is 100.

Standard code routines for which templates

have been provided:
Code Description Shortcut Key

Basic Loop Statement Shift+Ctrl+L

Boolean Statement Shift+Ctrl+B

Close Cursor Statement Shift+Ctrl+C

DBMS_OUTPUT.Put_Line Shift+Ctrl+D

Exception Shift+Ctrl+E

Exit When Statement Shift+Ctrl+X

For Loop Statement Shift+Ctrl+F

GOTO Label Statement Shift+Ctrl+G

IF Statement Shift+Ctrl+A

MLSLABEL Statement Shift+Ctrl+M

Number Statement Shift+Ctrl+N

Open_Cursor Statement Shift+Ctrl+O

Raise_Exception Shift+Ctrl+R

SQLCODE Statement Shift+Ctrl+S

VARCHAR2 Statement Shift+Ctrl+V

Variable_name Shift+Ctrl+T

While Condition Statement Shift+Ctrl+W

Code Shortcuts And Templates Dialog

Create your own code templates. Edit or delete existing code templates. Change the shortcut key definitions
attached to a template.

SQL Navigator 7.6

156
User Guide
Option Description

Templates Click on a template to select it.

Column Description

Name The name of the template. A template name is a single word with no spaces.
You cannot change a template name. Instead, you can delete an existing
template and create another like it with a different name.

Description A short description of the template.

Click in the Description field to edit it.

Shortcut The shortcut key combination used to insert the template code into an editor.
key
Click in the field to change the Shortcut key. Select from those available. To have
no shortcut key select None.

Code View / Edit the SQL code for the selected template.

Add Create a new template.

Delete Delete the selected template.

You cannot delete all the templates. There must be at least one template remaining in the Code
Shortcuts and Templates dialog.

Default Templates
Name Description Code Shortcut Key

Basic Loop Basic Loop Statement LOOP SHIFT+CTRL+L

    statements;
END LOOP;

Boolean Boolean Statement Boolean; SHIFT+CTRL+B

Close Cursor Close Cursor Statement CLOSE cursor_name; SHIFT+CTRL+C

DBMS_PutLine DBMS_OUTPUT.Put_ DBMS_OUTPUT.Put_Line(string); SHIFT+CTRL+D

Line

Exception Exception Statement EXCEPTION SHIFT+CTRL+E

    WHEN exception_name THEN
        statements;
    WHEN no_data_found THEN
        statements;
    WHEN others THEN— Handles all

SQL Navigator 7.6

157
User Guide
Name Description Code Shortcut Key

exceptions
        statements;

Exit_When Exit When Statement EXIT WHEN condition_is_true ; -- To exit SHIFT+CTRL+X

loop

For_Loop For Loop Statement FOR J IN 1..12 LOOP SHIFT+CTRL+F

    statements;
END LOOP;

GOTO_Label GOTO Label Statement GOTO label_name ; SHIFT+CTRL+G

IF IF Statement IF condition_is_true THEN SHIFT+CTRL+A

    statements;

MLSLABEL MSLABEL Statement MSLABEL; SHIFT+CTRL+M

Number Number Statement NUMBER( precision , scale ), SHIFT+CTRL+N

Open_Cursor Open_Cursor Statement OPEN cursor_name ; SHIFT+CTRL+O

Raise_ Raise_Exception RAISE exception_name ; SHIFT+CTRL+R

Exception

SQLCODE SQLCODE Statement SQLCODE; SHIFT+CTRL+S

VARCHAR2 VARCHAR2 Statement VARCHAR2( size ), SHIFT+CTRL+V

Variable_name Variable_name variable_name ColName%TYPE; SHIFT+CTRL+T

While_ While WHILE condition_is_true LOOP SHIFT+CTRL+W

Condition Condition Statement
    statements;
END LOOP ;

Unassigned SHIFT+CTRL+H

Unassigned SHIFT+CTRL+J

Unassigned SHIFT+CTRL+K

Unassigned SHIFT+CTRL+P

Unassigned SHIFT+CTRL+Q

Unassigned SHIFT+CTRL+Y

Unassigned SHIFT+CTRL+Z

Code Test

SQL Navigator 7.6

158
User Guide
The Code Test panel automates the process of testing PL/SQL programs.

To open the Code Test module

1. Open a procedure or function to test in the Code Editor.
2. Click Tools | Code Test
3. All test cases currently defined for the procedure / function are displayed. Packages are grouped by
entry point.

Icon Tool Tip Description

Open and Opens the Select DB Object Dialog.

Select
Object
Refresh Refresh the list of test cases against the current object.

Create Opens Test Case Properties. Create a new test case.

New Test
The first time you create a test case, you are prompted to install the Code Tester for
Case
Oracle repository. Installation of this repository is required. Complete the wizard that is
launched.

Edit Test Opens Test Case Properties. Includes the properties of the highlighted test case.
Case
Clone Test Opens Test Case Properties. Renames the test case. Includes the properties of the
Case highlighted test case.

Run Runs the selected test cases.

Selected
Test Cases l Test Case Selected

l Test Case Not Selected

As test cases are run, the status of each is shown.

TIP:

l Right click on the test case for further options.

l Use the search facility to search for test cases by name or parameter.
l Test cases created in SQL Navigator can also be used in Code Tester for Oracle.

Test Case Properties

You describe the expected behavior of a program and then SQL Navigator generates the required code for
the test case.

Field Description

Test Name The name of the test case selected or a new name. This field is

SQL Navigator 7.6

159
User Guide
 Field Description

editable.
Parameter, Input & Expected Configure input parameters and expected outputs.
Output
Test & Result

Exception Outcome Field Description

No Exception Select if you do not expect the test to raise an

exception.
Exception Select if you expect the test to raise an exception.
Expected
Fill in the expected Error Code as a number.

Elapsed Time Outcome Field Description

Check Select to test the time taken to execute the code.

Time The maximum time allowed for the code to complete
(ms) execution (in milliseconds).

Database Source Code Search

Search stored programs, triggers and views for a character string in the source code.

TIP: You can use this utility to perform a quick "where-used" impact analysis.

Open the Database Source Code Search dialog

Select Search | Code Search.

Define the search criteria

1. From the What tab define the search string.
2. From the Where tab select the schema and object type.
3. Click Search.

You can stop/suspend the search from the Session Menu or toolbar.

Now objects have been found

Take actions on found object(s)

SQL Navigator 7.6

160
User Guide
 Icon Action Description

Edit Double click on the object.

The object opens in the corresponding editor with the cursor at the line containing the
search string. For more information, see Visual Object Editors on page 91.

Describe View Describe information on the object.

Right-click on a row in the results set to see Describe information.

Add to Save a shortcut to the code location.

Project
Drag the selection from the result list to the Project Manager.
Manager

Source Open Source Preview.

Preview
Select found text objects to view their source code.

DB Navigator
DB Navigator shows the entire database structure as a tree with expandable nodes.

DB Navigator Toolbar
Icon Tool Tip Description

Back and Retrace your steps. Navigate between hyperlinked database objects and their
Forward dependent objects and components. Move between—

l An object and its dependencies, and vice-versa

l An index or trigger and the table to which it refers, and vice-versa
l A collector type and the base type of table it is related to
l A synonym and its base object

You can also use the Forward and Back buttons in conjunction with Up One Level.

Up One Change hierarchy levels in the DB Navigator tree.

Level
TIP: Use Back to return to the level where you first used moved up.

DB Set and Save filters to limit the objects displayed in the tree.
Navigator
Open the Filter Properties Dialog.
Preferences

Fully Expand the selected DB Navigator node and all its descendants.
Expand
Node from
DB

SQL Navigator 7.6

161
User Guide
 Icon Tool Tip Description

Refresh Refresh the selected DB Navigator node.

from
Current
Node

Show/Hide Show / Hide details about the selected DB Navigator node.

Details
l When you select a Schema node or Object Type node (for example, Tables or
Panel
Indexes) the details pane shows a list of objects contained in that node. This list
allows for selection of multiple objects for batch operations like Drop, Extract
DDL, or Compile.
l When you select a specific object the details pane shows attributes of the
selected object.

Using DB Navigator
DB Navigator displays all types of Oracle objects, giving you a hierarchical view of any schema, including
dependent objects. The tree view includes nodes for "My Schema," "All Schemas," and "Current Instance."

This symbol Indicates

The node can be expanded.

Click + to drill down to underlying objects or data.
Alternatively, press the right arrow key or the space bar while the node is selected.

The node can be collapsed.

Click the – sign.
Alternatively, press the left arrow key while the node is selected.

(Grayed text) The database object at that node is disabled or offline.

(Red text) The database object at that node is invalid.

SQL Navigator 7.6

162
User Guide
 TIP:

l Drag objects or connections that you use frequently to the Project Manager for fast access.
l Double click on an object to open it for editing (Visual Object Editors, Code Editor).
l Further commands are available on a selected object (or objects). Try the Object Menu. Right
click on the object.
l When a property is a reference to another database object (for example the base table for an
index, or synonym's base object), click on the reference in the Value column to jump to the
referenced object's node and display its properties.
l To move around in the Navigator window you can use the keyboard arrow keys. Use Page Up
and Page Down to scroll multiple lines.
l To purge objects: Select the object(s) in the Recycle Bin and right click Purge. Alternatively, right-
click on the Recycle Bin node and select Empty Recycle Bin.
l To copy an object from one schema to another:
1. Open a second DB Navigator window.
2. Drag the object from the source window to the target window.
3. Execute the DDL displayed in the editing window
l To switch to another session's DB Navigator window, select the session and click View | DB
Navigator.
l Your view of the Oracle Data Dictionary determines what objects you can see. For more
information, see DBA Dictionary Views on page 49.

Filter Properties Dialog

Create or modify DB Navigator filters that restrict the display of objects in the DB Navigator tree. You can save
your filters, so that they will be available from the DB Navigator toolbar.

Select filter
Field Description

Filter Name Select an existing filter name or enter a new one.

Select filter settings.

Tab Description

General Selected schemas will be visible in the DB Navigator tree when the filter is applied.
Global Selected top level nodes will be visible in DB Navigator when the filter is applied.

SQL Navigator 7.6

163
User Guide
 Tab Description

Filters
Object Selected object types will be visible in the DB Navigator window when the filter is applied.
Filters
Application of name masks
Type the name mask in the Filter box.

Name masks are specified according to Oracle’s LIKE operator definition. For
example, setting the name mask ABC% will result in displaying only those objects
with names beginning with the characters "ABC".
The name mask is applied to all selected object types. Click Assign Globally.to
apply the name mask to all objects.

Describe
The Oracle DESCRIBE command reports the attributes, methods and arguments of an object type. The SQL
Navigator Describe command works with more objects than does the SQL*Plus version of the command. You
can describe not only procedures, functions, packages, synonyms, and object types, but also tables, indexes,
clusters and objects.

To open the Describe window

Object Menu 1. Ensure the required database connection is active.

2. Select the database object.
3. Click Object | Describe.

DB Navigator Right click the object in DB Navigator and select Describe.

Project Manager Right click the object in Project Manager and select Describe.
Code Editor Right click the object in Code Editor and select Describe Object at Cursor.
Shortcut Ctrl+F3

TIP: To keep the existing Describe window open while opening additional Describe windows, click the
Pin toolbar icon in the Describe window. Set the default pin behavior in View | Preferences | General |
User Interface.

l Can be used to provide a quick summary of a table or view and all its column names and data
types.

SQL Navigator 7.6

164
User Guide
Tips to use the Describe window

A quick way to construct a SELECT To drag column names into the Select statement
statement
1. In the editing window, click the cursor on the table name.
2. Open the Describe window.
3. Drag and drop column names from the Describe window into
the SELECT statement.

Describe Command or Auto Describe Tool

Use either the Describe command or the Auto Describe Tool to describe an object

Auto Automatically see a description of any object you select.

Describe
A dockable Describe window opens and stays on top of the application window.
Tool
As you select various objects you will automatically see a description of the selected object in the
Auto Describe window.

Object | Click the Describe command on the Object menu whenever needed. It opens a describe window
Describe for a single selected object and will not update automatically when you select another object.

Difference Viewer
The Difference Viewer displays the compared objects in a split window. Differences between the objects
are highlighted, and the toolbars and menus give you access to controls for customizing the view and
creating reports.

The Difference Viewer Toolbar

Icon Tool Tip Description

Reload and Reload the external SQL/text files. Recompare.

recompare
files
Open files Open an external SQL/text file.

Save Save to an external SQL/text file.

Switch Switch left and right sides.

sides
Find Go to the previous difference.
Previous

SQL Navigator 7.6

165
User Guide
Icon Tool Tip Description

Difference
Find Next Go to the next difference.
Difference
Show All Show all lines of the compared objects.

Just Show Show only lines with differences.

Differences
Just show Show only lines with major differences (as defined by File Comparison Rules).
major
differences
Just show Show only matching lines.
matching
lines
Find Find a text string.

Find again Find the next occurrence of the text string.

Go to line Go to a specific line number.

number
Copy To Replace the selected line (right) with the selected line (left).
Right
Copy To Replace the selected line (left) with the selected line (right).
Left
Delete left Delete the selected line (left).
text
Delete right Delete the selected line (right).
text
Undo Undo the change made to the selected line.

Produce file Generate a report of differences.

differences
report
Comparison Compare similarities and differences in a summary.
summary
Show Show/Hide space characters as tilde (~) characters.
whitespace
Show line Show/Hide line numbers.
numbers

Show Show/Hide thumbnail view.

thumbnail
The thumbnail view (to the left of the viewing window) is a visual summary of differences.
view
Colored lines show the relative position of line mismatches. A white rectangle
represents the part of the text currently visible in the Difference Viewer window. You can
click on the thumbnail view to position the viewer at that point.

SQL Navigator 7.6

166
User Guide
 Icon Tool Tip Description

Use to quickly change locations within the viewing window.

Show line Show full details of the current line below the viewing window (so you don’t have to
details scroll to see the entire line)
File Open File Comparison Rules.
comparison
rules
Options Open Viewer Options.

View Differences Dialog

Select objects or scripts to compare in the Difference Viewer.

Viewer Options
Appearance | Color Scheme
1. Select a color scheme for each of:
l Matching Text
l Similar Text
l Different Text
2. Define how missing text should be displayed.
Select Color and click Select Color to choose the color block to show to represent missing text.
Alternatively, select Blank.
3. Click Font to customize the font, font style, font size and script.
4. Select Horizontal Lines Between Mismatches if desired.

TIP: All changes to the appearance can be previewed in the sample viewer display in the Viewer
Options window.

Appearance | Find Next Difference

Customize finding the next difference.

SQL Navigator 7.6

167
User Guide
File Comparison Rules
General
Option Description

Tab Stops Set the width of Tab Stops displayed in the Difference Viewer.

Synchronization The Synchronization Settings control the workings of the comparison engine that reports
Settings differences and similarities between the two files. You can set the synchronization
parameters low to allow more efficient searches for small differences, or higher for handling
larger files or files with large differences. Unless you are experienced in manipulating
comparison synchronization algorithms, you will probably find that the default settings work
well enough for most situations.

Option Description

Initial Match The minimum number of lines that need to match in order for text
Requirement synchronization to occur.
Skew The number of lines the Difference Viewer will search forward or
Tolerance backward when searching for matches. Smaller numbers improve
performance.
Suppress Suppress Recursion refers to the method used to scan for matches.
Recursion Recursion improves the ability to match up larger as well as smaller
sections of text, but it can take longer.

Ignore Minor Selected Ignore minor differences so you can focus only on significant differences.
Differences
Not Highlight minor differences in the Difference Viewer window. Minor
Selected Differences are as defined in the Define Minor tab.

SQL Navigator 7.6

168
User Guide
Define Minor
Option Description

Case Select the items you want highlighted as minor differences. Items not selected
will be ignored.
Leading Whitespace
Ensure General | Ignore Minor Differences is not selected.
Trailing Whitespace
Embedded Whitespace
/* Text within Slash-Asterisk */
(* Text within Parenthesis-
Asterisk *)

{ Text within Curly Braces }

Text Beginning With
Fortran Comments

Edit Data
Use to edit data in a table object.

1. Select the table object.

2. Click Object | Edit Data.
3. The Code Editor opens. The query is run with Updateable switched on. For more information, see SQL
Query Results Data Grid on page 71.

ER Diagram
The ER (Entity Relationship) diagrammer lets you quickly model a table and graphically see the dependencies
and joins to other tables.

NOTE: To ensure indexes are delivered in the correct order in a diagram, ensure the Oracle Data
Dictionary is queried with DBA Views. For more information, see DBA Dictionary Views on page 49.

SQL Navigator 7.6

169
User Guide
ER Diagram Toolbar
Icon Tool Tip Description

New ER Diagram Opens Create ER Diagram.

Clear ER Diagram Clear the ER Diagram window.

Open File Open a saved ER Diagram.

Save File As Save the ER Diagram.

Save File

Save Diagram as Bitmap

Print Diagram Print the ER Diagram.

Print Preview

ER Diagram Info Show detail of the ER Diagram.

Load ER Diagram in the For more information on the SQL Modeler, see SQL Modeler.
SQL Modeler

Find Table Dependencies Show joins between tables.

This feature does not add new objects to the diagram; it only finds joins
between objects already displayed.

Refresh Diagram Refresh the ER Diagram window.

Scale Zoom in / out of the window.

Previous auto-layout / Scroll through the layouts.

Next auto-layout

ER Diagram Display Area

For each table in the model
Diagram Description
Part

Title Bar The name of the table and schema it resides.

Body Area The columns in the table, the column type, whether the column is indexed, and icons as

SQL Navigator 7.6

170
User Guide
 Diagram Description
Part

applicable and selected in Create ER Diagram.

Connector Lines connect tables that are dependent on each other. Lines have a knob end and an arrow
Lines end. The referencing table resides at the knob end, and the referenced table at the arrow end.

To add tables to the diagram

Drag-and-drop from:

l DB Navigator
l From the tree, drag a single object only.
l From the Details pane, drag a list of objects.
l Find objects Dialog
l Project Manager

Create ER Diagram

Field Description

Schema Select the Schema where the table resides.

Table Select the table to diagram.

How many levels of Select as appropriate.

referential tables do you
The more levels of referential tables you load, the more complicated the diagram
want to load?
will become, and the longer SQL Navigator will take to create the diagram.

Display Options Select from:

l Show primary keys

l Show foreign keys
l Show unique keys
l Show data type
l Show not nullable
l Show indexes

If the display option has an icon associated with it, the icon is displayed to the
right of the option. In the diagram, the appropriate icon will appear to the left of
the table name.

SQL Navigator 7.6

171
User Guide
Explain Plan Tool
Use the Explain Plan tool to analyze the execution of a single SQL statement. By examining the execution plan,
you can see exactly how Oracle executes your SQL statement, and how it can be improved.
This tool lets you:

l generate plans and save them in the table of your choice

l organize your saved plans by various criteria, such as type (for example, online SQL statements, batch
SQL statements, and so on), module, or subsystem
l build separate plan tables for different subsystems in your project
l browse each table separately.

TIP: The Analyze Tool can be used in conjunction with the Explain Plan tool. The Explain Plan Tool does
not analyze tables itself prior to executing the Explain Plan, but it does have a toolbar button for manual
launch of the Analyze Tool.

Explain Plan Window

Generate Plans Drag a SQL Statement into the editor on this tab.

Option Description

Stmt ID If required, you can enter a Statement ID to identify the statement within
the current plan table.
Save SQL Select to save the SQL when saving the generated plan.
text
Comment Optionally, comment on the plan.

Plan Table Enter the Plan Table Owner or use the default listed.
Owner

Name Enter the Plan Table Name or use the default listed.

TIP: If specifying a new plan table, use the Create Table button to
create the table.

Generate Click to view the Oracle execution plan for the statement.

Browse Saved Browse previously saved execution plans.

Plans

Operation Explain the node selected in the Explain Plan tree. Show how each SQL operation is
Description executed in relation in the Explain Plan.
Show / Hide in Generate Plans | Show Description.

Plan The generated execution plan. Click on nodes to expand and collapse them.

SQL Navigator 7.6

172
User Guide
Print the Explain Plan tree
Use File | Print.
The following data is printed:

l The SQL Statement from which the explain plan tree was derived
l Statement ID, Type, Cost and Time stamp
l The Explain Plan tree, including the execution sequence numbers in brackets

TIP:

l When the printout exceeds one page, the headings (such as the SQL Text and statement ID lines)
are not repeated. This makes it easy for you to 'tile' multiple pages together to display the explain
plan tree as a single diagram.
l Use File | Print Preview to preview your output.

Export Table

Open the Export Tables window

Open the Export Tables window from Object Menu | Export Table.

TIP: Select the objects to be exported before you open the Export Tables window. Use for example DB
Navigator, DB Explorer, Project Manager, a list of results after finding objects.

Select the tables to export (1)

In the Export Tables window, tables in the Selected Tables list are exported.
Ways to move tables to this list (from the Browse Table to Export list):

l Double-click on a table.
l Selecting one or more tables and click >.
l Select one or more schemas and click >. This adds all tables in the selected schemas.
l Click >>. This adds all tables in all schemas.
l Select objects before you open the Export Tables window.

SQL Navigator 7.6

173
User Guide
Select export options (2)

Option Description

Objects to export Select the objects you want exported from the database to the DMP file.

Additional Parameters Field Description

Direct Data is extracted directly, bypassing the SQL Command-

processing layer. This method may be faster that a
conventional path export.

Consistent Uses the SET TRANSACTION READ ONLY statement to

ensure the data does not change during the execution of the
export command.
Select this parameter if you anticipate other applications will
update the data after an export has started.

NOTE: Tables are usually exported in a single

transaction. However, nested and partitioned tables
may be exported as separate transactions. If nested
or partitioned tables are being updated by other
applications, the exported data may be inconsistent.
To minimize this possibility without selecting the
Consistent parameter, export those tables at a time
when updates are not being performed.

Record Records an incremental or cumulative export in the system

tables SYS.INCEXP, SYS.INCFIL, and SYS.INCVID.

Compress Selected Flags table data for consolidation into one

initial extent upon import. If extent sizes are
large (for example, because of the
PCTINCREASE parameter), the allocated
space will be larger than the space required to
hold the data.

Not Export uses the current storage parameters,

Selected including the values of initial extent size and
next extent size. The values of the parameters
may be the values specified in the CREATE
TABLE or ALTER TABLE statements or the
values modified by the database system. For
example, the NEXT extent size value may be
modified if the table grows and if the
PCTINCREASE parameter is nonzero.

SQL Navigator 7.6

174
User Guide
Option Description

Field Description

NOTE:

l Although the actual consolidation is

performed upon import, you can specify the
COMPRESS parameter only when you export,
not when you import. The Export utility, not the
Import utility, generates the data definitions,
including the storage parameter definitions.
Therefore, if you do not select Compress
when you export, you can import the data in
consolidated form only.
l Neither LOB data nor subpartition data is
compressed. Rather, values of initial extent
size and next extent size at the time of export
are used.

Buffer size The size, in bytes, of the buffer used to fetch rows. This
(leave blank for parameter determines the maximum number of rows in an
default) array fetched by Export.
Use the following formula to calculate the buffer size:
buffer_size = rows_in_array * maximum_row_size
If you specify zero, Export Tables fetches only one row at a
time.
Tables with columns of type LOBs, LONG, BFILE, REF,
ROWID, LOGICAL ROWID, or DATE are fetched one row at
a time.

NOTE: See your Oracle operating system-specific

documentation to determine the default value for this
parameter.

Record Length The length, in bytes, of the file record. The

RECORDLENGTH parameter is necessary when you must
transfer the export file to another operating system that uses
a different default value.
If you do not define this parameter, it defaults to your
platform-dependent value for buffer size.
You can set RECORDLENGTH to any value equal to or
greater than your system's buffer size. (The highest value is
64 KB.)
Changing the RECORDLENGTH parameter affects only the
size of data that accumulates before writing to the disk. It

SQL Navigator 7.6

175
User Guide
 Option Description

Field Description

does not affect the operating system file block size.

You can use this parameter to specify the size of the Export
I/O buffer.

NOTE: See your Oracle operating system-specific

documentation to determine the proper value or how
to create a file with a different record size.

Statistics Select the type of database optimizer statistics to generate

when the exported data is imported.

Provide a Export should display a progress meter in the form of a

feedback dot period for n number of rows exported.
each time n
For example, if you specify FEEDBACK=10, Export displays
rows are
a period each time 10 rows are exported.
exported
NOTE: The FEEDBACK value applies to all tables
being exported; it cannot be set individually for each
table.

Specify files Field Description

Output file name The names of the export dump files.

(.dmp)
This field is mandatory.

Parameter file name A name for the file that contains a list of import
(.dat) parameters.
This field is mandatory.

Log file name (.log) The name of the log file.

All informational and error messages are written to the
log file.

Results (3)
When execution is complete there are three tabs in the Export Tables window. The results of the export are
shown on the Output tab. The Log and Parameter file tabs show the contents of their respective files.

Find and Replace

Find or replace text strings in the current text file.

SQL Navigator 7.6

176
User Guide
 NOTE: Select Regular expressions if you want your strings to be recognized as Regular Expressions.
Regular Expressions are a widely-used method of specifying patterns of text to search for. Special
metacharacters allow you to specify, for instance, that a particular string you are looking for occurs at the
beginning or end of a line, or contains >n< recurrences of a certain character.

Find objects Dialog

Find objects in any schema.

What To Search For

You can construct a search argument for any database object.

l You can use wild-card characters %" and "_" (according to SQL LIKE operator definitions).
l You can filter by schema, object type, date last modified and status.

TIP: To display a dynamic list of all objects in a schema

1. In DB Navigator, select a schema node in the top level of the DB Navigator tree.
2. Click Search | Find Objects.

Now Objects Are Found

Task Action

Describe View a description of object structure ( index, cluster, procedure, function, or package).
Use Describe or Auto Describe Tool on the selected object.

Sort Sort on any column (name, owner, type, creation/modification date, status) in ascending or
descending order.
Click the column header.

Open the Double click on the object.

object for
See Visual Object Editors or the Code Editor for more information.
editing

Locate in Display the selected object in DB Navigator.

schema
For more information, see Locate In Tree on page 194.

Batch On selecting multiple objects you can

selection

SQL Navigator 7.6

177
User Guide
 Task Action

and l apply commands like Copy Text, Drop, Extract DDL, Compile, Get Metadata, Properties,
update Send to Code Analysis, Add to Project Manager, Enable, Disable, and Truncate to the
entire batch of objects. For more information, see Object Menu on page 27.
l drag the group of objects into a text editor or DB Navigator.

TIP: Other actions are available. Right-click on the object and select a command from the shortcut menu

Find Recycle Bin Objects Dialog

Search for objects in the recycle bin.

NOTE: Requires Oracle 10g or later.

What To Search For

You can construct a search argument for any database object.

l You can use wild-card characters %" and "_" (according to SQL LIKE operator definitions).
l You can filter by schema, object type, drop date and System Change Number (SCN).

Now Objects Are Found

Task Action

Sort Sort on any column (name, owner, type, creation/modification date, status) in ascending
or descending order.
Click the column header.

Open the object Double click on the object.

for editing
See Visual Object Editors or Code Editor for more information.

Batch selection When multiple objects are selected, you can apply commands like Copy Text, Purge and
and update Flashback to the entire batch of objects.

TIP: Other actions are available. Right-click on the object and select a command from the shortcut menu

SQL Navigator 7.6

178
User Guide
Formatting Options
Configure how the Formatter Tool formats code. Formatter Tools are available from the Tools Menu.

Formatting Options Toolbar

Icon Tool Tip Description

Open Open a previously saved file of SQL Navigator formatting options.

Save Save the currently selected formatting options to the SQL Navigator
installation folder, filename FmtOptions.opt.

TIP: Click File | Save as in the Formatting Options window to save

the options to a different file name or location.

Reset Pane to Reset the Formatting Options to the default values

Recommended Defaults

TIP: SQL Navigator loads the Formatting Options from the default file (FmtOptions.opt) and default
location each time the Formatting Tool Options window is opened and when the Formatter Tool performs
formatting. The default location for Formatting Options is in the SQL Navigator installation folder.

Set formatting options

Category Options in the Category

Oracle Tooltips
Formatter
Show tooltips when the mouse cursor is hovered over certain options.
Options
Copy Options to Clipboard
Copy the options in both INI and XML format to clipboard for backup or reviewing purposes.
Show the Example Window
Show an example window when navigating different pages of the Formatter Options window.
You can specify a script file to be formatted as an example, or select the Document per Pane
option to use the example scripts from the Example document folder.
You can modify the example scripts in the Example window. Changes are saved
automatically.

SQL Navigator 7.6

179
User Guide
 Category Options in the Category

Header Select Enable to generate a header tagline after formatting the script. You can specify some
text to be included in the header tagline. Do not use /* or */ in the text.
Note: The date time options are currently not in use.

Spacing Set physical output characteristics such as tab size, margins, and indents.

Comments Select this option to align trailing comments to the right margin.

Case Modify the lowercase, uppercase, or initial capitals of various syntax elements.

Operators & Specify the behavior of various operators and punctuations.

Punctuations

Alignments Set alignments of various syntax elements.

List Define list attributes such as parentheses, commas and folding/stacking characteristics.
Arrangements

HTML Viewer
Show HTML in the integrated viewer.
This eliminates the need to switch from your coding environment to an external browser.

TIP:

l Enable Capture Web Output so each time you execute PL/SQL code, the generated HTML is
displayed in the integrated viewer. If the PL/SQL procedure is run under the debugger, the HTML
output is not visible until the procedure is complete.
l You can select links and submit forms from the integrated viewer. If the link or submit target is
another PL/SQL generated page then that page appears in the viewer. If it is an external link then
an error message will appear. You must fill in the Web Support Configuration Dialog for this to
work correctly.
l Use the Web Support Configuration Dialog to specify where images can be loaded or enter the
details of your web server's configuration.
l Click View in External Web Browser to open the page in your default Windows web browser.
This is useful for testing links to pages that are not PL/SQL generated. SQL Navigator will map
images as defined in the Web Support Configuration Dialog, but this mapping will only apply to
the generated page. All links, frame sources and your browser and Web server, not SQL
Navigator, will handle form posting.
l Click File | Print to print the page.

SQL Navigator 7.6

180
User Guide
Stored Procedure > HTML
Developing Oracle Web server applications involves programming with PL/SQL using the PL/SQL Web toolkit
supplied with Oracle Web Server. SQL Navigator provides an integrated development environment with
advanced coding, testing and debugging of PL/SQL programs for Oracle Web server.

Actions Description

Enable the Select Session | Capture Web Output.

web
server

Open the Code Web Server Procedures in the Code Editor.

procedure
The editor includes drag and drop coding for Web toolkit packages, including htp and htf items.
for editing.

Execute Execute the procedure in the Code Editor.

the
procedure. NOTE: You can use the SQL Navigator Debugger to step through the stored procedure, if
you want to debug the generation of HTML. However, the HTML will not be displayed
until the stored program has completed execution.

Preview View the translated HTML page in the HTML Viewer

HTML
output TIP: Use the drag and drop feature as you would for any script development. The Web
Server Syntax allows you to drag Web server syntax directly into your script. The results of
dragging and dropping syntax into your program are displayed.

Compile Use the Code Editor.

and save
your script.

See also Import HTML as PL/SQL for HTML > Stored Procedure.

Import HTML as PL/SQL

Convert a HTML file into a PL/SQL stored procedure. The stored procedure will in turn output the HTML code via
the Oracle Web Toolkit.

Actions Description

Enable the web Select Session | Capture Web Output.

server
Open the Code Click View | Code Editor.
Editor.
New Stored Create a new stored object in the Code Editor. Enter the name and the parent schema of
Object the new procedure.

SQL Navigator 7.6

181
User Guide
 Actions Description

Import HTML file Click Tools | Import HTML as PL/SQL

as PL/SQL
The import process wraps each line of the imported HTML file inside the htp.print ( … );
markers.
PL/SQL statements can be embedded in HTML code inside comments; for example:
<!--PLSQL a_random_plsql_statement; -->
These comments must start with the string
<!--PLSQL
and end with
-->
You can put things in the declaration section of the procedure (to declare a cursor, for
example) by ensuring they come first in the file, before the first <HTML> tag. For example:
<!—PLSQL
CURSOR emp_cur IS
SELECT ename
FROM emp;

Save the When the HTML is imported into the stored program, you can save the program to the
program to the database.
database.

See also HTML Viewer for Stored Procedure > HTML.

Sample code for displaying query results in a

HTML page
The following example code will display details from a query in a web browser.
First, create a table named emp with a column ename. Add some data to the ename column, and then run the
following procedure with the SQL Navigator Web Development Module enabled.

PROCEDURE PLH_EXAM1 is—this procedure generated from "\\phanevski1\c$\docs\EXEone.HTM".—warning:

any changes made to this procedure will not be—reflected in the original HTML file.
CURSOR emp_cur IS
SELECT ename
FROM emp;

begin
htp.print(‘ ‘);

SQL Navigator 7.6

182
User Guide
htp.print(‘<HTML>’);
htp.print(‘<HEAD>’);
htp.print(‘<TITLE>Embedded PL/SQL Example</TITLE>’);
htp.print(‘</HEAD>’);
htp.print(‘<BODY>’);
htp.print(‘<H1>Employee Names</H1>’);
htp.print(‘<TABLE>’);
htp.print(‘ ‘);
FOR emp_rec IN emp_cur LOOP
htp.print(‘ <TR>’);
htp.print(‘ <TD>’);
htp.print(emp_rec.ename);
htp.print(‘</TD>’);
htp.print(‘ </TR>’);
htp.print(‘ ‘);
END LOOP;
htp.print(‘</TABLE>’);
htp.print(‘</BODY>’);
htp.print(‘</HTML>’);
end;

Import Table

Open the Import Tables window

Open the Import Tables window from Object Menu | Import Table.

Select the tables to import (1)

Option Further Options and Description

Import all tables Import all tables in the DMP file into the current user's schema regardless of which
user the tables belong to.

Specify From User Import all the tables owned by the From User to the To User. Specify the from and to
To User users in the relevant fields.
To import tables from more than one user, use a space or comma (,) to separate the

SQL Navigator 7.6

183
User Guide
Option Further Options and Description

user names.

Manually enter table Type the names of the tables to import and click Add.
names
Do not include the schema prefix in the table name.

Select import options (2)

Option Description

Objects to export Select the objects you want imported to the database from the DMP file.

Additional Parameters Field Description

Reuse Reuses the existing datafiles making up the database. Selecting

existing this parameter causes the Import utility to include the Reuse
data files parameter in the datafile clause of the CREATE TABLESPACE
statement. This results in the Import utility reusing the original
database's datafiles after deleting their contents.

NOTE:

l The export file contains the datafile names used in

each tablespace. If you select this parameter and
attempt to create a second database on the same
system the Import utility will overwrite the first
database's datafiles when it creates the tablespace.
In this situation, it is recommended that this
parameter is deselected so that an error occurs if the
datafiles already exist when the tablespace is
created. In addition, if you need to import into the
original database, select the Ignore errors parameter
to add to the existing datafiles without replacing
them.
l If datafiles are stored on a raw device, deselecting
this parameter does not prevent files from being
overwritten.

Commit Sets the Import utility to commit after each array insert.
after
By default, the Import utility commits only after loading each table. If
each
an error occurs, a rollback is performed before continuing with the
array
next object.
insert
Selecting this parameter prevents rollback segments from growing
inordinately large and improves the performance of large imports. If
the table has a uniqueness constraint it is recommended that this
parameter is selected. If a table does not have a uniqueness

SQL Navigator 7.6

184
User Guide
Option Description

Field Description

constraint, the Import utility could produce duplicate rows if you

reimport the data.
If a table has nested table columns or attributes, the contents of the
nested tables are imported as separate tables. Therefore, the
contents of the nested tables are always committed in a transaction
distinct from the transaction used to commit the outer table.
If this parameter is not selected and a table is partitioned, each
partition and subpartition in the export file are imported in a
separate transaction.
For tables containing LONG, LOB, BFILE, REF, ROWID, UROWID,
or DATE columns, array inserts are not done. If this parameter is
selected, the Import utility commits these tables after each row.

Ignore Specifies how object creation errors should be handled. If selected,

errors the Import utility overlooks object creation errors when it attempts to
create database objects, and continues without reporting the errors.
Note that only object creation errors are ignored; other errors, such
as operating system, database, and SQL errors, are not ignored
and may cause processing to stop.
In situations where multiple refreshes from a single export file are
done and this parameter is selected, certain objects may be created
multiple times (although they will have unique system-defined
names). You can prevent this for certain objects (for example,
constraints) by deselecting the Constraints parameter when
importing. If you do a full import with the Constraints parameter
deselected, no constraints for any tables are imported.
If a table already exists and the Ignore errors parameter is selected,
then rows are imported into existing tables without any errors or
messages being given. This may be helpful when importing data
into tables that already exist in order to use new storage parameters
or because you have already created the table in a cluster.
If this parameter is not selected, the Import utility logs or displays
object creation errors before continuing. If a table already exists,
then errors are reported and the table is skipped with no rows
inserted. Objects dependent on tables, such as indexes, grants, and
constraints, will not be created.

NOTE: When importing into existing tables, if no column in

the table is uniquely indexed, rows may be duplicated.

Show When this parameter is selected the contents of the export file are
export displayed and not imported. The SQL statements contained in the
file export are displayed in the order in which the Import utility will

SQL Navigator 7.6

185
User Guide
Option Description

Field Description

contents execute them.

only

Buffer The size of the buffer, in bytes, through which the data rows are
size transferred.
(leave
BUFFER determines the number of rows in the array inserted by the
blank for
Import utility. The following formula gives an approximation of the
default)
buffer size that inserts a given array of rows:
buffer_size = rows_in_array * maximum_row_size
For tables containing LONG, LOB, BFILE, REF, ROWID, UROWID,
or DATE columns, rows are inserted individually.
The size of the buffer must be large enough to contain the entire
row, except for LOB and LONG columns. If the buffer cannot hold
the longest row in a table, the Import utility attempts to allocate a
larger buffer.

NOTE: See your Oracle operating system-specific

documentation to determine the default value for this
parameter.

Record The length, in bytes, of the file record.

Length
The RECORDLENGTH parameter is necessary when you must
transfer the export file to another operating system that uses a
different default value.
If you do not define this parameter, it defaults to your platform-
dependent value for BUFSIZ. For more information about the
BUFSIZ default value, see your Oracle operating system-specific
documentation.
You can set RECORDLENGTH to any value equal to or greater
than your system's BUFSIZ. (The highest value is 64 KB.)
Changing the RECORDLENGTH parameter affects only the size of
data that accumulates before writing to the database. It does not
affect the operating system file block size.
You can also use this parameter to specify the size of the Import I/O
buffer.

NOTE: Note: See your Oracle operating system-specific

documentation to determine the proper value or how to
create a file with a different record size.

Provide Displays a period each time the number of specified rows has been
a imported.

SQL Navigator 7.6

186
User Guide
 Option Description

Field Description

feedback For example, if you specify 10, Import displays a period each time
dot each 10 rows have been imported.
time n
rows are NOTE: The FEEDBACK value applies to all tables being
exported imported; it cannot be set on a per-table basis.

Specify files Field Description

Dump file name The name of the export file to import.

The default file extension is .dmp. This field is mandatory.

Parameter file The name of the file that contains the list of import
name (.dat) parameters.
This field is mandatory.

Log file name (.log) The name of the log file.

All informational and error messages are written to the
log file (if specified).

Results (3)
When execution is complete there are three tabs in the Import Tables window. The results of the import are
shown on the Output tab. The Log and Parameter file tabs show the contents of their respective files.

Java Manager
The Java Manager is a convenient alternative to the Oracle LoadJava and UnloadJava command line utilities.
Use the Java Manager to load and unload multiple Java source files, classes, resources and archives.

Field Description

Files to Load, Add & Manage the list of objects to load.

Remove

Options Set the command line switches found in the Oracle LoadJava and UnloadJava
command line utilities.
For details, consult the Oracle documentation.

SQL Navigator 7.6

187
User Guide
Job Scheduler
Access the Oracle Job Scheduler.
A job assigns a task to a schedule. The job tells the schedule which tasks - either one-time tasks created "on the
fly," or predefined programs - to run. A specific program can be assigned to one, multiple, or no schedule(s);
likewise, a schedule may be connected to one, multiple, or no program(s).

Tab Description Oracle

Jobs Tab Check the status and settings of existing jobs. All Oracle
releases
Create, run, schedule, edit and remove jobs.

Programs Define or select programs to be executed. Oracle 10g

Tab release or later
Schedules Define the frequency with which the Scheduler will execute a particular set Oracle 10g
Tab of tasks. release or later
Windows Define time windows during which resource plans will be activated. Oracle 10g
Tab release or later
Window Create a named group with containing windows with similar scheduling Oracle 10g
Groups Tab properties for ease of management release or later
Job Classes Group together jobs that have similar resource demands into job classes Oracle 10g
Tab to ensure best utilization of resources. release or later
Job Log Tab Show the current status and information about jobs over a specified date Oracle 10g
range or by owner. release or later
Window Log Show the current status and information about Windows over a specified Oracle 10g
Tab date range. release or later

Jobs Tab
The Jobs function in the Job Scheduler allows you to create, run or schedule jobs.
Note that some of the functionality below is only available in Oracle 10g or later releases.

Button Description

New Click to create a job. This opens the New Job Wizard:

1. Enter a Job Name (for 10g or later)

2. Select a Job Type (PS/SQL Block or Stored Procedure - in 10g or later)
3. Click Next (for 10g or later)
4. Enter the PL/SQL code or select a stored procedure to run
5. Click Next

SQL Navigator 7.6

188
User Guide
 Button Description

6. Specify a start date, start time and frequency for your job to run
7. Select a repeat frequency if desired
8. Click Finish.

The new job will appear in the Jobs window.

Save To attach a program, schedule or job class to a job (for 10g or later)

1. Select the job to be scheduled.

2. Select the program, schedule or job class to be attached to the job.
3. Click Save.

To schedule a job (for 10g or later)

1. Select the job to be scheduled.

2. Click En (Enabled) next to the job.
3. Select Start and End date and time.
4. Click Calendar, choose the frequency and intervals for the job and click
5. Click Save.

Advanced Edit available Attribute Values for the selected item (for 10g or later).

Clone Create a copy of the selected item (for 10g or later).

Run To run a job

1. Select the job to be run.

2. Click Enabled next to the job.
3. Click Run.

Drop Remove the selected item from the database (for 10g or later).

Programs Tab
(Only for Oracle 10g release or later)
A program defines what the Scheduler will execute. A program's attributes include its name, type (for
example: a PL/SQL procedure or anonymous block), and the action it is expected to perform. A program can
also accept zero to many arguments, which makes it a flexible building block for constructing schemes of
tasks to be scheduled.

Button Description

New Click to create a program

1. Enter a Program Name.

2. Select a Type, that is PL/SQL Block, Stored Procedure or Executable.

SQL Navigator 7.6

189
User Guide
 Button Description

3. If you do not want the program to be enabled by default, clear the Enabled check box.
4. Define the Action the program is to perform.
5. For PL/SQL Block or Executable, enter the relevant command string.
6. For Stored Procedure, select one of the available stored procedures from the database.
7. Enter any Comments if required
8. Click Save.

Save Save changes to a selected program or a new program.

Advanced Edit available Attribute Values for the selected item.
Drop Remove the selected item from the database.

Schedules Tab
(Only for Oracle 10g release or later)
A schedule defines when and at what frequency the Scheduler will execute a particular set of tasks. A
schedule's attributes include the date on which a set of tasks should begin, how often the tasks should be
repeated and when the set of tasks should no longer be executed, either as of a specified date and time, or after
a specified number of repetitions.

Button Description

New Click to create a schedule

1. Enter a Schedule Name.

2. Select Start and End dates and times.
3. Click Calender, select the required Frequency and Interval and click OK.
4. Enter any Comments if required
5. Click Save.

Save Save changes to a selected schedule or a new schedule.

Advanced Edit available Attribute Values for the selected item.
Drop Remove the selected item from the database.

Windows Tab
(Only for Oracle 10g release or later)
Assign resource plans to activate at different times such as during specific peak or off-peak periods.

SQL Navigator 7.6

190
User Guide
 Button Description

New Click to create a window

1. Enter a Window Name

2. Select a Resource Plan from the drop-down list
3. Select a Priority from the drop-down list
4. Select a Schedule to attach to run during the window as appropriate
5. Select the Duration (days, hours, months) for the window
6. Specify a start date/time and end date/time for the window
7. Select a repeat interval if desired

Click Save.
The new window will appear in the Windows list above.
Click Enabled to activate the window.

Save Save changes to a selected window or a new window.

Advanced Edit available Attribute Values for the selected item.
Open Activate the selected Window and commence running the scheduled jobs based on the durations
currently entered. You can change the duration values if required.
Close Stop the currently active window. Any jobs using that window as their schedule which were
started at the beginning of this window and have indicated that they must be stopped on closing
of the window will be stopped.
Drop Remove the selected item from the database.

Window Groups Tab

(Only for Oracle 10g release or later)
Create a named windows group to which you can assign any number of previously created windows on the
Windows Tab

Button Description

New Click to create a window group

1. Enter a Group Name

2. Enter any Comments relevant to that windows group

Click Save.
The new group name will appear in the Window Group Name list on the left-hand side.
Select those Windows listed in the right pane that you want included in the group.
Click Enabled to activate the window group .

Save Save the window group.

Drop Remove the selected item from the database.

SQL Navigator 7.6

191
User Guide
Job Classes Tab
(Only for Oracle 10g release or later)
The Scheduler provides the capability to group together jobs that have similar resource demands into job
classes. A job class can be used to ensure all jobs within it utilize the same job class attributes, execute at a
higher or lower priority than other jobs in other job classes and only allow jobs in the job class to start if there
are sufficient resources available.

Button Description

New Click create a job class

1. Enter a Job Class Name.

2. Select the appropriate Resource Consumer Group as defined for the database.
3. Select the appropriate Service as defined for the database.
4. Select a Logging Level for the database.
l Off
l Runs
l Full
5. Select the number of days the Log History will be retained.
6. Enter any required Comments

Click Save.

Save Save the job class.

Advanced Edit available Attribute Values for the selected item.
Drop Remove the selected item from the database.

Job Log Tab

(Only for Oracle 10g release or later)
You can view a history of the Job Scheduler transactions over a range of dates, including all job
owners if desired.

Field Description

From date / To date Select the Start and End date range to view.
Owner Select job owner to use in log display.
Refresh Update the display.

Window Log Tab

(Only for Oracle 10g release or later)

SQL Navigator 7.6

192
User Guide
You can view a history of the Job Scheduler window transactions over a range of dates.

Field Description

From date / To date Select the Start and End date range to view.
Refresh Update the display.

Job Scheduler (Requirements)

Specific system privileges are required in order for you to manage the Job Scheduler for connections to Oracle
10g and later.

Job Scheduler system privileges

The system privileges associated with the Job Scheduler (for Oracle 10g and later) are as follows:

System Purpose…
Privilege

CREATE JOB Enables you to create jobs, schedules and programs in your own schema.
Note: You can always alter and drop jobs, schedules and programs which you own, even
when you do not have the CREATE JOB privilege.

CREATE ANY Enables you to create jobs, schedules, and programs in any schema. This effectively gives
JOB the grantee the ability to run code as any user so it must be issued with care.

EXECUTE Enables jobs the ability to use programs from any schema.
ANY
PROGRAM

EXECUTE Enables jobs to run under any job class.

ANY CLASS

MANAGE Enables you to create, alter and drop job classes, windows and window groups. It also
SCHEDULER enables you to purge scheduler logs and modify scheduler attributes.

INIT.ORA configuration file

In order to successfully use the Job Scheduler, you may also need to adjust the settings on your server in the
INIT.ORA configuration file to allow use of the DBMS_JOBS package (Oracle 9.2 and earlier) or the DBMS_
SCHEDULER (Oracle 10g and later).
The following minimum settings are recommended:
job_queue_processes = 2
job_queue_interval = 10
job_queue_keep_connections = false

SQL Navigator 7.6

193
User Guide
(Remember to restart your server to apply these settings.)

Locate In Tree
When an object is open in an editing window, and you want to see where that object resides in the schema, you
can use Locate in Tree to jump to that object’s node in the DB Navigator tree. This action expands all
intermediate nodes and displays the object’s details—such as privileges and columns.
Locate in Tree is available from the following windows:

l DB Navigator
l Find objects Dialog
l Database Source Code Search
l Project Manager
l Describe
l Analyze Tool
l Quick Browse
l Edit Data
l Visual Object Editors

Output Window
The Output Window displays SQL Navigator messages and server output including Oracle errors.

Interpreting the output display

User Interface Description

Tabbed Pages There are tabs for each session, plus one for general messages not related to any
particular session.

Icons & Color The types of output are distinguished by font color. Icon markers make them even more
Coding noticeable.

Color Data type

Blue Server output

Red Error Messages

Black Other processing messages

SQL Navigator 7.6

194
User Guide
 NOTE: The Output window displays the results of program compilation and execution, including errors.
You can view the full Oracle error description by double-clicking the error code in the Output window.
The resulting dialog contains the error message description, cause and recommended actions, just as
they appear in Oracle documentation.

Actions
Action Description

Copy to the Clipboard Select the text you want to copy. Right-click the selection and select Copy.

Clear Right-click in the Output window and select Clear.

Print Contents Right-click in the Output window and select Print.

PL/SQL Profiler
Analyze the execution time and efficiency of your stored programs. The Profiler is particularly useful for finding
bottlenecks in stored code and quality assurance and testing.

NOTE:

l Requires Oracle 8.1.5 or higher.

l Before using the Profiler, debug your stored program, as there is no editing capability from within
the Profiler.

Toolbar
TIP: Use the Runs / Groups tabs to select Runs and Groups.

Icon Tool Tip Description Keyboard

Shortcut

Refresh Update both Run and Group tree views with the latest profiling data. Alt+R

Filters / Open the Profiler Filter/Preferences Dialog. Alt+P

Preferences
You can sort and filter the result data according to thresholds that you set.
This makes it easy to limit the amount of data displayed, and to isolate the

SQL Navigator 7.6

195
User Guide
 Icon Tool Tip Description Keyboard
Shortcut

most significant items. For example, you can select lines that were not
called during the run, or runs with total times higher than average.

Delete Delete the data for the selected run. Del

If a group is selected then delete the group. Removing the group does not
remove the associated run data.

Create New Create a new group. Open the New Group / Group Properties Dialog. Ins
Group
Create groups to logically connect code units and runs. You determine
which units and runs belong to a group. You can combine data for a single
code unit across multiple runs in order to determine the real coverage and
execution times. This is useful when testing stored code in several different
runs with different parameters.

Locate the Open DB Navigator with the tree expanded to highlight the selected object.
selected See where the object is in the database tree.
object in
DB Navigator

Open the Open the selected object in the Code Editor.

selected
Select a line of source code in the Source Viewer tab to open the Code
object
Editor at that line.

Properties Open the New Group / Group Properties Dialog to modify the selected Alt+F2
group.

Launch Xpert Open SQL Optimizer for Oracle.

tuning

Runs Tab
A run contains all code units that are called during execution. If a procedure or function is a part of a package,
the whole package becomes part of the run. The same rule applies to type methods.

Selection Description of information

All Runs Totals across all the available runs.

Coverage
Time Statistics

Run Basic run characteristics (comment, date, number of lines, etc…), totals across all the run units.
Coverage
Time Statistics

SQL Navigator 7.6

196
User Guide
Groups Tab
For each group, you have the option of displaying the data either separately by run, or with runs combined.

Selection Description of information

All Groups Totals across all the groups.

Time Statistics

Group Basic group characteristics, totals across the group units and runs.
Coverage
Time Statistics

Select PL/SQL Code on the Runs or Groups Tab

A PL/SQL code unit can be a stand-alone procedure or function, a package body, a type body or an anonymous
block. A package body and type body contains further procedures and functions. For a procedure or function, it
is sometimes possible to determine how many times it has been called during a run by parsing the available
source code and combining the data about the lines where the procedure/function is called.
The Profiler will show you a line-by line analysis of the execution, including the number of times each line was
executed and the time required for execution.
The Profiler:

l stores data about each code unit executed during a run, down to the level of source code lines
l divides all the available profiling data into hierarchically organized logical items
l displays profiling and coverage statistics about each item and compares them with others

The Profiler displays the profiling data alongside the actual source code. (This feature is not available if the
source code has changed since it was last tested in the currently selected run, or if it is not identical across the
runs in a group.)

Selection Description

Procedure, Basic characteristics, totals across the runs. Combines the group runs if Combine Runs
Function, Trigger in Group Result Sets is selected in the Profiler Filter/Preferences Dialog.
Body
Time Statistics
Call Distribution
Source Viewer

Type Body, Basic characteristics, total across the runs. Combines the group runs if Combine Runs in
Package Body Group Result Sets is selected in the Profiler Filter/Preferences Dialog.
Coverage
Call Distribution

SQL Navigator 7.6

197
User Guide
 Selection Description

Time Statistics
Source Viewer

NOTE: The Profiler uses the Oracle session it was activated in.

Profiler Filter/Preferences Dialog

Use the PL/SQL Profiler Filters/Preferences dialog to set the data filter options, sorting and chart drawing
properties.

Data Filters
TIP: Threshold and sorting works only if there is a single series to be displayed in the Runs tree and
‘Combine Runs in Group Result Sets’ is enabled for the Groups tree.

Option Description

Data Value Filter in Option Description

Runs Tree View
Display only items with value When selected, charts and lists display only the
items with the value specified
More than, Less than, Equal Set the method of filtering
to Zero, Nonzero

50 or other value Set the Threshold value.

Applicable when More than and Less than are
selected.

Total/Average Set the value against which the threshold value is

to be compared.
Applicable when More than and Less than are
selected.

Show Anonymous Set the tree views to display the anonymous blocks executed during runs.
Blocks

Parse Packages for Set the profiler to break package data down to discrete procedures/functions.
Subroutines

SQL Navigator 7.6

198
User Guide
 Option Description

Display Line Data Set the data displays to always show line data for the selected tree view item.
Directly
For example, when a run is selected, the charts/lists will show all the lines executed
in the run, not the run units.

Sort Result Sets in Enable sorting of the result data in the Runs display.
Runs Tree View
When selected, you can control the sort order by your selection of the Descending
Order option.

Combine Runs in Enable the combining of data from different Runs in the Group (for example, to
Group Result Sets obtain correct coverage value across the Runs).

Chart Options
Option Description

3D Select to add a 3D look and feel to the charts.

Group Chart Series Select the color generation method for the chart series when displaying Group data
(Groups tree view).

Run Chart Series Select the color generation method for the chart series when displaying Run data (Runs
tree view).

Chart Panel Control the chart background color.

Series Color Select the colors used when Gradient is selected.

Gradient

Series Color Select the colors used when Sequence is selected.

Sequence
TIP: Click on the color selection rectangles. Select a color from the Windows-
standard color selection dialog.

New Group / Group Properties Dialog

Use the Group Properties dialog to set group name, comment, used units and runs.
The Group Units and Group Runs list boxes display the units/runs used for analysis in the given group. You
must specify at least one group unit.

PL/SQL Profiler Requirements

SQL Navigator 7.6

199
User Guide
Required Oracle Conditions

To run the PL/SQL The DBMS_PROFILER package needs to be installed under SYS.
Profiler
This is does not happen by default on a new instance.

To collect session The users need access to V$SESSION, V$SESSTAT and V$STATNAME.
statistics
This condition is satisfied when the users have SELECT privilege on system views
V_$SESSION, V_$SESSTAT and V_$STATNAME.

For schemas that use The profiler server side objectsInstalling_server_side_objects (tables and
the PL/SQL Profiler sequences) need to be installed.

Profile Manager
Profiles saved in SQL Navigator can be:

l Re-used in other versions of SQL Navigator.

l Made available to other users of SQL Navigator.
l Used on other computers.
l Made available to support staff to help resolve issues.

To backup a profile
1. Open the Profile Manager: Windows Start | All Programs | Quest Software | SQL Navigator |
Profile Manager
2. Select Backup User Profile.
3. Select the version of SQL Navigator which has the preferences you want to save.
4. Select the directory into which the backup file is to be saved.
5. Enter a name for the backup file, or accept the name displayed.
6. Click Backup.

NOTE: The file is saved into the designated folder and has an extension of .prof.

SQL Navigator 7.6

200
User Guide
To restore a profile
1. Open the Profile Manager: Windows Start | All Programs | Quest Software | SQL Navigator |
Profile Manager
2. Select Restore User Profile.
3. Select the directory from which the backup file is to be restored.
4. Select the file containing the backed-up profile file. Click Next.
5. Select the version of SQL Navigator that you want the backed-up to replace. Click Restore.

Project Manager
The Project Manager provides instant access to your frequently used database objects and connections.
Projects are holding areas where you can store shortcuts to things that you frequently need to work with instead
of searching for them in various lists and directories.

Project Manager Toolbar

Icon Tool Tip Description

Select types of items to display See the Project Filter Dialog.

Sort items by specified field Sort items.

Display items in a list Show/Hide item details.

Display extra details about each item

View Tree Show/Hide Tree View.

Navigate between projects. Navigate folders in projects.

Go Up One Level Navigate the Project Manager.

Create New Folder Organize items in the project in folders.

Manage Your Projects

Action Description

File Menu | New Project Create a project.

File Menu | Rename Project Rename the current project.

SQL Navigator 7.6

201
User Guide
 Action Description

TIP: Change the current project in the Project

Manager window.

File Menu | Delete Project Delete the current project.

Drag and drop into the Project Manager Add items to the current project:
window.
l Objects from DB Navigator.
l Objects from Find objects Dialog.
l Code Selection from Database Source Code Search
l A file from Windows Explorer.
l An Oracle Connection shortcut.
(username/connection strings)

These items can include:

l schemas (in particular connections)

l schema objects
l code location bookmarks within stored programs
l schema object templates

Actions on Items in the Project Manager

Select an object in Project Manager and ...

Action Description

Preview the Source Preview

source code of
text objects

To connect to a You can select a database object in your Project Manager and open it for viewing or editing.
database from SQL Navigator automatically opens the required database connection and displays the
the Project object’s properties in an object editing window. Double click on the shortcut to open the
Manager connection.

Code Location Drag the selection from the result list in Database Source Code Search to the Project
shortcuts Manager.

Drop an object 1. Select the object in the Project Manager window.

2. Locate the object in DB Navigator.
3. Drop the object in DB Navigator.

SQL Navigator 7.6

202
User Guide
Keyboard Shortcuts In The Project Manager
Window
TIP: Right click in the Project Manager window to see all options available.

Keyboard Description
Shortcut

Ins Add Objects in Project Manager. Open Select DB Object Dialog.

Shift+Ins Add Files in Project Manager

Ctrl+H Hide items of the selected type (Requires you to select an object in the Project Manager).

Ctrl+U Go up one level (Requires you to have navigated to a sub-folder in the Project Manager
window).

Project Filter Dialog

Select the object types you want to display in the project manager window.

Publish Java to PL/SQL

Create a PL/SQL package from a Java class stored in the database.

1. Select a Java Class stored in the database. Use DB Navigator or the Find objects Dialog.
2. Click Object | Publish Java to PL/SQL.
3. Follow the prompts to generate a PL/SQL package that stores the procedures and functions used to call
Java methods for handling the stored object.
4. The package is generated and displayed in the window. Do you want to open it for editing before saving
it to the database, or save it as shown?

Quick Browse
View chained rows information.

1. Select the table object.

2. Click Object | Quick Browse.

SQL Navigator 7.6

203
User Guide
 3. The Code Editor opens. The query is run. For more information, see SQL Query Results Data
Grid on page 71.

Rename Object
1. Select the object.
2. Click Object | Rename.

Search Knowledge Xpert

Drag and drop optimized routines directly into your program editor.
Knowledge Xpert is a library of more than 900 pre-built PL/SQL routines, written by some of the world's leading
PL/SQL experts, that can be integrated into the standard PL/SQL environment. The complete PL/SQL Code
Library can eliminate hours of low-level coding and debugging while enhancing application performance and
reliability.

Knowledge Xpert
SQL Navigator users can now access 5,400 technical topics, error messages, pre-built and tested code
solutions, and code formatting technology. Using the Code Assistant, you can drag and drop these optimized
routines directly into your program editor.
For example:

l Knowledge Xpert for Oracle Administration A complete and essential resource for Oracle DBAs.
l Knowledge Xpert for PL/SQL Comprehensive PL/SQL knowledge combined with an extensive PL/SQL
code library.

TIP: Knowledge Xpert add-on modules are available directly from your Quest Software representative.

Select DB Object Dialog

Select and open a database object similar to the standard Windows File | Open command.

l Enter the name of the object or type in a name mask using the SQL wildcard (%)
l Specify the object type (optional)
l Select the object from a list of matches

SQL Navigator 7.6

204
User Guide
Server Output
Capture output from the Oracle server and display it in the Output Window.

Tips For Use

Toggle l Toggle on/off capturing server output from the Session Menu.
on/off
l Click Session | Server Output to toggle On/Off Server output.

Output l When toggled ON the Output Window opens if it is not already open.
Window
l Closing the Output Window does not stop the capturing of Server Output.
l The Output Window reopens automatically if you execute a stored program in a session
capturing server output.
l The default size of the run time buffer is 32k bytes.

Oracle l Output is captured for the current Oracle session.

Sessions
l Server Output is captured individually for each session. Capturing it in one session does
not automatically capture it in other concurrent sessions.

Server Side Installation Wizard

Installing server side objects.
The wizard requires connection as a DBA user so that the SQLNAV user can be created, as well as a number of
roles. The wizard permits you to specify a password of your choice for this user. Note that the option "Base
SQLNAV Repository" must be selected on at least one occasion to allow the other support features to be
installed. All objects installed by the wizard are installed into the SQLNAV schema.

Session Browser
Manage sessions in the Session Browser.
To open the Session Browser click Tools | Session Browser.

SQL Navigator 7.6

205
User Guide
Session Browser Toolbar
Icon Tool Tip Shortcut Description

New Session As per Session | New Session, open the Oracle Logon Dialog

Current Session Show the current session. Use to switch to a different session.

Include NULL and Show / Hide NULL and System OS users.

SYSTEM OS User
Refresh F5 Refresh the Session Browser.

Auto Refresh Every… Refresh the Session Browser automatically. Select Auto-Refresh
every and enter the refresh interval in seconds.

Sessions Grid
The current session is displayed in pink.

Action Description

Select / Highlight a The tabbed pages show details of the selected session. For more information, see
session Session Information on page 207.

Sort / Group l Click the column heading you would like to sort by.
Sessions
l Drag the column you would like to group the sessions by to the gray area above
the grid.

Show / Hide Right click on the grid and select Visible Columns. All columns are listed. Only selected
Columns columns are visible on the grid.

TIP: You can rearrange the columns. Drag and drop the column header into the
location you want.

Filter Sessions When a filter is applied, only sessions that meet the criteria are displayed.

1. Click the arrow alongside the column heading you want to apply the filter to.
2. Select the value you want to filter by.
3. Apply additional filters if required.

To apply custom filters

1. Click the arrow alongside the column heading you want to apply the filter to and
select (Custom...).
2. Create a conditional expression from the menu options provided.
l Values are case sensitive.
l Use And / Or to related multiple conditions.

SQL Navigator 7.6

206
User Guide
 Action Description

NOTE:

l The filtered columns are given a blue arrow. Click the blue arrow and
select (All) to remove all filters applied to the column.
l The filter expression is displayed below the Sessions grid. Click X to
remove all filters.

Kill Sessions Right-click the session and select Kill Sessions.

NOTE:

l When you kill a top level node you kill all sessions below it.
l You must have appropriate permissions (ALTER SYSTEM) to kill
sessions.
l You cannot kill the current session (displayed in pink).
l The following query is used to kill sessions: ALTER SYSTEM KILL
SESSION <SID, SERIAL#> IMMEDIATE

Session Information
Select a session on the Sessions Grid. Details for the selected session are displayed in the tabbed pages.

Tab Description

Session Further session information for the selected session.

Process Process information for the selected session.

IO IO information for the selected session.

Waits Waits information for the selected session.

NOTE: WAIT_TIME = -2 on platforms that do not support a fast timing mechanism. If you
using one of these platforms and you want this column to reflect true wait times, you must
set the TIMED_STATISTICS parameter to TRUE. Doing this has a small negative effect on
system performance.

Current The current SQL statement and explain plan for the select session.
SQL

Access Objects in the database currently locked by the selected session.

RBS Transaction information for online rollback segments for the selected session.
Usage

Parallel Parent and slave sessions belonging to a parallel session.

Session

Locks User and system locks. Locks are displayed in groups; Blocking, Blocked By, System, and All

SQL Navigator 7.6

207
User Guide
 Tab Description

Locks.

Long Ops Operations that run for longer than six seconds in absolute time, including some backup and
recovery functions, statistics gathering, and query execution.

Open Cursors that the selected session has opened and parsed.
Cursors

Source Preview
Preview the source code of text objects (stored programs, triggers and views), or a package’s individual
entry points.

1. Select the object

Module How to select the object

In the Code Editor Press CTRL and click on the object name
In DB Navigator Click on the object
In the Find objects Dialog results Click on the object
In Database Source Code Search results Click on the object
In the Project Manager Click on the object
In DB Explorer Click on the object

2. Click View | Source Preview.

TIP:

l While the Source Preview window is open, you can select objects in any of the windows named
above, and the object’s source code will automatically appear in the Source Preview window.
l Use a bookmark to conveniently mark various locations in the source code and quickly move
about in the text without searching through the code and without losing your current editing
location. You can set up to ten bookmarks. See Edit Menu.

SQL Modeler
The SQL Modeler provides a fast means for creating the framework of a Select, Insert, Update, or Delete
statement. You can select Tables, Views or Synonyms, join columns, select columns, and create the desired
type of statement.

SQL Navigator 7.6

208
User Guide
Section Description

Model Area Used to graphically lay out a query.

SQL Most frequently used Modeler functions.
Modeler
Toolbar
Criteria Tab Criteria used in generating the model.
Generated Automatically generated SQL as a result of the model.
Query Tab

SPLITTERS The SQL Modeler has two splitters to change how you divide the screen.

l There is a horizontal splitter between the Model Area and the Criteria/Generated
Query/Query Results tabs. Drag it up or down and release to see more or less detail.
l There is a vertical splitter between the Model Area and the Table Selector List. Drag it
left or right to see more or less detail.

SQL Modeler Toolbar

Icon Tool tip Description

New model Clear the modeler window ready to create a new query.

Open an Open a saved query.

existing
model
Save current Save the query. Specify the filename and location.
model as...
Save model Save the query to the current filename and location.

Model Edit current model information

information

Edit Edit calculated fields

calculated
fields

Generate a Select the type of statement you want to create.

SELECT
statement

If the query in the SQL Modeler is an UPDATE, DELETE or INSERT statement, a

rollback will occur automatically.

SQL Navigator 7.6

209
User Guide
 Icon Tool tip Description

Execute Use to test the query. The results show in Query Results Tab.
query
Explain plan Open the Explain Plan Tool.

Load in the Copy the new query to the Code Editor.

Code Editor

Show Table Show/Hide the Table Selector.

List
The Table Selector lists the tables, views and synonyms available to you for inclusion
in your SQL Model. You can select from the current schema or any other schema. Only
those tables, views or synonyms for which you have SELECT privilege will be listed.
To add a table, view or synonym, double click on it or drag and drop it onto the Model
Area.

Save sub Save sub query and return to master query

query and
return to
master query
Cancel sub Cancel sub query and return to master query
query and
return to
master query

Edit global Edit global WHERE clauses.

where
Open the Global WHERE Conditions Window.
clauses

Edit global Set Global HAVING conditions (Must have a Group By condition set in the Criteria
having Tab.)
clauses
Open the Global HAVING Conditions Window.

View joins View Joins Dialog

Auto join Auto join objects

objects

Percentage of zoom for modeler pane

View Joins Dialog

From this dialog you can see individual joins, browse through the joins, and make changes to the joins.

Dialog Description
Section

From / To The join fields, joined from one table to another.

SQL Navigator 7.6

210
User Guide
 Dialog Description
Section

Join Type You can change the Join Type from Inner to Outer. The line color denotes the type of join.
Outer Join On If you have selected an Outer join, you can change which table the outer join is performed
on.

Join Test You can change the test for the join.
You can make it Less than, Greater than, etc. instead of Equal to.

Buttons Previous Join Delete the current join.

Next join Move forward in the join list.
Delete Join Move backward.

OK Close the window and return to the SQL Modeler.

To open this dialog, click View Joins on the SQL Modeler toolbar. Alternatively, double click on a join line in the
Model Area.

Global WHERE Conditions Window

Add, Edit, Delete global where conditions as per the toolbar.

The Add and Edit buttons open the Global WHERE Definition dialog. Global Where entries are in the form of
<expression1> <operator> <expression2>.

TIP: You could alternatively populate the WHERE clause via the Criteria Tab. Entries into the cells of the
Criteria tab should be in the form of <operator> <expression2>.

Example
Construct the following query
SELECT dept.deptno, dept.dname, dept.loc
FROM scott.dept
WHERE ((dept.deptno BETWEEN 1 AND 25)
AND (dept.deptno < 40)
AND (dept.loc IS NOT NULL)
Follow the numbered steps

1. Open the SQL Modeler (as SCOTT/TIGER).

2. Double-click DEPT to add it to the model.
3. Right-click DEPT and choose Select All.
4. On the criteria tab, double click the Where Cond. cell under DEPTNO.

SQL Navigator 7.6

211
User Guide
 5. Choose < and fill in the value 40. Click OK.
6. On the criteria tab, double click the Where Cond. cell under LOC and then choose the Expert tab and
click Yes at the warning dialog.
7. In the top edit box, enter IS NULL. Click OK.
8. On the criteria tab, double-click the OR cell under LOC. Choose the Expert tab and click Yes at the
warning dialog.
9. In the top edit box, enter = 'CHICAGO'
10. In the table model area (the area around the table images), right-click and choose SQL>Global Where
11. In the top edit box, enter Data Field DEPT.DEPTNO. Click OK.
12. From the SQL Function panel, select BETWEEN _Const_ AND _Const_. Replace the constants with
values, for example 1 and 25 respectively. Click OK twice.
13. View the generated query. It should appear as described above.

Global HAVING Conditions Window

Add, Edit, Delete global having conditions as per the toolbar.

The Add and Edit buttons open the Global HAVING Definition dialog. Global Having entries are in the form of
<expression1> <operator> <expression2>.

TIP: You could alternatively populate the HAVING clause via the Criteria Tab. First set a GROUPed BY
field. Then set the Having clause for that field by entering it in the group cond. row. This has the limitation
that you can only have the selected field on the left side of the relational operator. If you need to have
multiple fields on that side of the operator, use the Global Having feature.

Example
Construct the following query
SELECT emp.empno, emp.ename, emp.job, emp.mgr, emp.sal,
emp.comm, emp.deptno
FROM emp
GROUP BY emp.deptno, emp.comm, emp.sal, emp.mgr, emp.job,
emp.ename, emp.empno
HAVING ((emp.sal + NVL (emp.comm, 0) > 4000))
Follow the numbered steps

1. Open the SQL Modeler (as SCOTT/TIGER).

2. Double-click EMP to add it to the model.
3. Right-click EMP and choose Select All, then deselect Hiredate.
4. In the Criteria tab, double-click the Group By field for DEPTNO.
5. Double-click the Group By fields for COMM, SAL, MGR, JOB, ENAME and EMPNO as well.

SQL Navigator 7.6

212
User Guide
 6. Click the Global Having button in the toolbar. Click the Add button to add a new Having clause.
7. Enter the Having clause to say:
l EMP.SAL + NVL(EMP.COMM, 0) > 4000
8. Click OK.

View the generated query.

It should appear as described above. This query selects all the employees whose salary plus commission is
greater than 4000. The NVL command substitutes a null value in the specified column with the specified value,
in this case, 0.

Model Area
Use the model area to visually join or manipulate the Tables, Views and Synonyms.

Add objects

Show/Hide the Table Selector on the SQL Modeler Toolbar. It lists the tables, views and synonyms available to
you for inclusion in your SQL Model. Double-click each desired Table, View, Synonym, OR drag and drop them
from the list to the model area. As the objects are presented on the model area, join lines are drawn from any
established foreign keys in the DDL.
Additionally, drag-and-drop objects from:

l DB Navigator tree (single object only)

l DB Navigator details pane (when a list is displayed)
l Find objects Dialog
l Project Manager

TIP:

l To open SQL Modeler with a table, select the table in DB Navigator then click Object Menu | SQL
Modeler.
l You can click in a table header and drag and drop the table where you want it in the Model Area.

Build a query
Steps Description

Clear an existing query from the Model Click New Model on the SQL Modeler Toolbar.
Area, if required.
Define the type of statement you want to Choose SELECT, UPDATE, DELETE, or INSERT from the SQL

SQL Navigator 7.6

213
User Guide
Steps Description

create. Modeler Toolbar.

Add objects to the Model Area. Drag and drop Tables, Views, or Synonyms from the Table
Selector to the modeling area.
You can show/hide the Table Selector on the SQL Modeler
Toolbar.

Specify table columns to be used in the Select column names in the tables in the Model Area.
query.
NOTE: If no table columns are selected, then all columns
will be included in the query.

Set criteria for the query See the Criteria Tab.

View your query as SQL code or as a Click the Generated Query Tab and Query Results Tab.
data grid.

Save the model Save the model from the SQL Modeler Toolbar.

TIP: You can use the SQL Modeler Toolbar to copy the query to the Code Editor window.

Create a table join

1. Add two table names to the Model Area.

2. In the first table, click the column name that you want to join. Drag it to the corresponding column name
in the second table.
3. When the join is successfully created, SQL Modeler draws a connecting line that represents the join
between the two table columns.

TIP: To specify criteria for a table join, double-click on the connecting line joining the two columns. This
opens the View Joins Dialog.

Menus in the Model Area

Right click the model

Menu Description

Copy Model Image To Copy a bitmap image of the model to the Windows Clipboard
Clipboard

SQL Navigator 7.6

214
User Guide
Menu Description

Tables Visibility Show / Hide tables in the model.

Hidden tables are not included in the Generated Query
(Generated Query Tab).

Calculated Add calculated fields based on other table columns.

Fields

Show Join Text Show the column names that comprise the joins.
Adjust Model Move the model so the upper left object is in the upper left
Origin of the Model Area.
Primary Key Show the Table Primary Keys. Show PK next to each
Primary Key column.

Indexes Show the Table Indexes. Show IDX next to each Index
column.
Show Field Show the column data type in each table.
Type

SQL Run Query Run the query in a way that allows you to halt it in the middle
in Thread if necessary.
Global Open the Global WHERE Conditions Window. Use to add a
Where WHERE clause to the query.
Clauses

Global Open the Global HAVING Conditions Window. Use to add a

Having HAVING clause to the query.
Clauses
TIP: Use the Criteria Tab to set GROUP BY first.

Query Add variables. These variables are used in the Global

Variables WHERE Definition Dialog and Global HAVING Definition
Dialog.

Auto Join All Objects Join all tables based on DDL Foreign Key Constraints.
Hide fields Show / Hide the list of columns in the table in the model area.
Zoom to table Select a table to focus.
Toggle Full Screen Mode Show / Hide the Table Select List and Criteria/Generated Query/Query
Results tabs.
Optimize All Table Sizes Minimize the size of the tables in the Model Area.
Arrange Tables Arrange the tables in the Model Area.

Right click the Table object

Menu Description

Set Table Alias Set the Table Alias. The value is added to the Criteria Tab.

SQL Navigator 7.6

215
User Guide
Menu Description

Alias Field Names Set the Field Alias for each column in the table. The values are added to the
Criteria Tab.

Auto Join Automatically join this table to others based on DDL Foreign Key Constraints.
Show Schema Name in Shows / Hide the schema name in the Generated Query (Generated Query Tab).
SQL
Remove Table Remove this table from the model.
Select All Select / unselect columns in the table.
Unselect All
Invert Selection
Optimize Size Restore the size of the table to its default size.

Hide Temporarily hide the table from the model.

While the table is hidden it will not be included in the Generated Query (Generated
Query Tab).

TIP: To hide multiple tables or show hidden tables, right click on the Model
Area and select Tables | Visibility.

Keyboard Shortcuts

Key Action

Up and down arrow keys Move you around in lists

Space bar Select / Unselect boxes
Tab Move forward one area (table, menu, list, etc)
Shift-Tab Move back one area (table, menu, list, etc)

Tabs
Criteria Tab
1. Add tables, views and synonyms to the Model Area.
2. In these tables, views and synonyms, select the columns you want to add to the Criteria tab. Only
Selected columns appear on the Criteria tab.

TIP: To rearrange the order of the columns on the Criteria tab, drag and drop them left or right.

SQL Navigator 7.6

216
User Guide
Field Description

Only fetch Select to apply the DISTINCT command to the query.

unique
records

Schema The schema cannot be edited.

Null Value Double click in the cell to enter a value to substitute for any null values.
Subst.
To clear the cell, highlight it and press Delete.

Aggregate Double click in the cell to select an aggregate column function, such as Average, Count, Max,
F. Min, or Sum.
To clear the cell, highlight it and press Delete.

Where Double-click in the cell to open the WHERE Definition dialog.

Cond.
Section Description

Conditions Set a condition which tests if a column is equal to (or <, >, <=, >=, <>, LIKE,
BETWEEN) a constant or another field _or_ a condition where the selected field
is in a sub query.
Clear Click to reset the dialog box and begin the WHERE condition again.
Form
Remove Click to remove the WHERE definition.
Condition

TIP: A quick way to remove the WHERE definition is to highlight the cell and press
Delete.

Or Double-click in the cell to open the WHERE Definition dialog (as above).

This WHERE criteria will be OR'ed together with the above WHERE criteria.
If you want to AND multiple column criteria together, then select Expert from the
WHERE Definition dialog. For more information, see Global WHERE Conditions Window on
page 211.

Group By Double-click in the cell to select it as a GROUP BY column.

A number in parentheses indicates the order of the columns in the GROUP BY clause.
See also The Having Cond. cell.
To clear the cell, highlight it and press Delete.

Having Double click in the cell to select an aggregate column function (such as Average, Count, Max,
Aggregate Min, or Sum) for the HAVING clause.
This allows for the following type of query:
SELECT emp.job_id
FROM employee emp

SQL Navigator 7.6

217
User Guide
 Field Description

GROUP BY emp.job_id
HAVING ((AVG (emp.salary) > 1500))
To clear the cell, highlight it and press Delete.

Having Double click in the cell to open the GROUP BY Definition dialog.
Cond.
NOTE: Requires a value in the Group By cell. To create more complex Having
conditions see Global HAVING Conditions Window for more information.

To clear the cell, highlight it and press Delete.

Sort Double click in the cell to sort this column as Ascending, Descending, or no sort.
To clear the cell, highlight it and press Delete.

Visible Double click in the cell to have it be visible / hidden. When visible the column is returned in the
column list.

Field Alias Double click in the cell to change the field name alias.

Table Alias Double click in the cell to enter a value for the table alias.
To clear the cell, highlight it and press Delete.

Right-click over the Criteria grid:

Menu Description

Suppress Current Column Remove this column from the query

Best Fit (All Columns) Set the column width of the Criteria grid to show all text

Default Width (All Columns) Set the column width of the Criteria grid to the default width

Copy Query Grid Image to Clipboard Copy the Criteria grid to the clipboard

Generated Query Tab

This tab lists the automatically generated SQL statement.

NOTE:

l Any changes made to the Model Area or Criteria Tab will automatically regenerate this SQL
statement.
l You cannot directly edit the SQL on the Generated Query tab.

SQL Navigator 7.6

218
User Guide
Right-click over the query

Menu Description

Copy Copy the query to the clipboard.

Save As Save the query to a file.

View Query in Code Editor Copy the query directly to the Code Editor.

Query Results Tab

Show the results of executing the generated query.

NOTE:

l Insert, Update, and Delete queries can only be executed in the Code Editor.
l Making changes to the Tables or Columns, then clicking on the Query Results tab will prompt you
whether or not to re-query the data.

SQL Optimizer
SQL Optimizer supplements Oracle tuning skills for developers. The SQL Optimizer makes observations about a
selected SQL statement and the underlying database environment, then recommends several options to
improve performance. Users can then view the logic behind the advice, implement the recommendation, apply it
to the database, and see the results. The SQL Optimizer module automatically produces all necessary SQL to
effect the corresponding change.

NOTE:

l SQL Optimizer can be used to analyze the execution of SQL scripts containing more than one
statement.
l SQL Optimizer is an external application. It is installed independently of SQL Navigator.
l Example Scenario: in the Code Editor highlight the text of the SQL statement you want to
investigate and click SQL Optimizer.
l For more details, see the online help supplied with the SQL Optimizer product.

Task Manager
SQL Navigator executes long-running tasks in separate threads in the background. They lock only the current
session. Background execution happens automatically, and means that all the application’s functionality
remains available to the user while the task is running in a separate session.
The Task Manager is a display of all active and complete tasks for the current session.

SQL Navigator 7.6

219
User Guide
The following background tasks can be managed through the Task Manager:

Background Tasks More Information

Batch commands on database objects, such as Drop, Compile, Truncate and Object Menu
Extract DDL
Enable Constraint Editor

Execute PL/SQL code PL/SQL Execution Console

View Differences Difference Viewer

Full expansion of a node in DB Navigator DB Navigator

Source Code Search Database Source Code

Search

Find Objects Find and Replace

NOTE:

l Right click on a task to Suspend, Resume, End or Delete.

l Ending some tasks, such as compiling dependants in a complex table, may appear to "hang."
This is due to SQL Navigator waiting for a response from the Oracle server. Even though there
may be a delay, control will ultimately be returned to SQL Navigator.

Web Support Configuration Dialog

Specify a local directory where images can be loaded or enter details of your Web server’s configuration.
This is required to view images and follow hyperlinks in your documents.

Wrap Code
The Wrap Code utility provides an easy way to access Oracle’s Wrap Code utility. This window is connection
independent so you do not need an open database session to use it.

SQL Navigator 7.6

220
User Guide
To wrap code
1. Click Tools Menu | Wrap Code to open the Wrap Code window.
2. Input File details:

Field Description

Input File Enter the file (of PL/SQL code) you want to wrap, including the full path.

TIP: Click the drill down button to browse for the file.

Input File Text When you have selected the file, the text of the file appears here.

TIP: Right-click in the text area to copy the code to the clipboard.

Output File By default this is given the same name as the input file, but with extension .plb.

3. Click Wrap Code.

Field Description

Output File The wrapped code appears in the Output File Text area and is automatically saved to
Text the specified Output File.

TIP: Right-click in the text area to copy the code to the clipboard.

SQL Navigator 7.6

221
User Guide
 8

View | Preferences

Section Topic

General General | User Interface

General | "Drop" and "Truncate" safety options
General | Session
General | Default Tables
General | Explain Plan
General | Code Assistant
General | Printing

General | Object Editors

General | Task Bar

Extract DDL Extract DDL | General

Extract DDL | Table/View Specific
Extract DDL | Constraints
Extract DDL | Materialized Views/Snapshots
Extract DDL | Users

Project Manager Project Manager

Code Editor Code Editor | General

Code Editor | SQL Scripts

LOB Viewer Lob Viewer

Team Coding Team Coding

SQL Navigator 7.6

222
User Guide
 NOTE: Settings in View | Preferences can be changed by any user and apply to the current user only -
unless otherwise stated.

General
General | User Interface

Set SQL Navigator preferences.

User Interface
Option Description

Style Select the look and feel of SQL Navigator windows from the following styles:

l Standard
l Flat
l XP
l Native (the default style)
l Office 2003

Tutorial Messages Select to display tutorial messages automatically for windows. First-time users may
find these messages especially helpful.
Hints Select to show Tool Tips. Tool Tips are labels that pop up when you point to a button
or other control.
Font Select the font to use in SQL Navigator windows.
Date Displayed Select the preferred layout for showing dates.
Format
Time Displayed Select the preferred layout for showing the time.
Format
Display time in Should DATE fields include the time?
DATE fields

Bold Folders in Select to show folders as bold in the DB Navigator tree. Showing the folders as bold
DB Navigator Tree may help clarify the structure of a complex tree.
Used by: DB Navigator.

Default Directory The default directory SQL Navigator points to for Open and Save operations.
Used by: File Menu, Toolbars, Code Editor, HTML Viewer.

Background Color The color of the background area.

SQL Navigator 7.6

223
User Guide
Data Grid
Related to: Code Editor | SQL Query Results Data Grid, Edit Data, Quick Browse

Option Description

Show Row # Select to show row numbers in the data grid.

Display Long Select the display for LONG columns.

columns
On demand Data in a LONG column is displayed in a separate pop-up editor.
(in pop-up
For each cell:
editor)

The word Indicates the cell has data. Double-click the

"MEMO" in upper word to display the data in a pop-up editor.
case

The word Indicates there is no data to display.

"memo" in lower
case

Full text Columns are effectively treated like normal string (VARCHAR2)
(within cells) columns, that is, data is displayed within the corresponding cells as a
single string.

Trim column width When an object is copied from the Code Editor or one of the Visual Object Editors and
while pasting pasted to another tool, for example Note Pad...

Selected The length of each pasted column is trimmed to approximately the length
of the longest character string in the column.
Not The pasted data reflects the actual length of the column as defined in the
Selected object.

Display Selected Show Null values as "(Null)" in the data grid.

NULL values as
(Null) Not Selected Show Null values as empty cells in the data grid.

Data Grid Font The font used in the data grid result set.
Show Row Set up an alternate row color in the data grid.
Background Color

SQL Navigator 7.6

224
User Guide
Pin at Start
Option Tool Description

Analyze Analyze Tool

Selected The window is pinned.
Open multiple instances of
the tool at the same time.
Describe Describe Not The window is not pinned. If
Selected you reopen the tool, the
newly opened instance of
the tool will replace the
Explain Plan Explain Plan Tool current instance.

NOTE: Once a window of the

Object Editors Visual Object Editors
selected type is open, you can pin
or unpin it at any time.

Automatically Show Output Window

Related To: Output Window.

Option Description

Errors Show the Output window automatically when errors are sent to it.
Server Output Show the Output window automatically when server output is sent to it.
Information Show the Output window automatically when informational text is sent to it.

Startup
Option Description

Show Splash screen Select to show the Splash screen when you launch SQL Navigator.
Reopen active windows Select to show all active windows from the last time SQL Navigator was used.
Show Welcome Screen Select to show the welcome screen when you launch SQL Navigator.

ER Diagrammer
Related To: ER Diagram.

Option Description

Show real index names Show real index name instead of the one generated by the system.

SQL Navigator 7.6

225
User Guide
Task Manager
Related To: Task Manager.

Option Description

Auto delete complete&more-than-one- Remove completed tasks, and still running tasks that started more
day tasks than one day ago.

Connection Category Color

Related To: Connection Category Color.

Option Description

Connection Color for Taskbar When selected the Connection Category Color for the Task Bar is
displayed.
Connection Color for Forms When selected the Connection Category Color for forms is displayed.
Connection Color for Code Editor When selected the Connection Category Color for the Code Editor is
Tabs displayed.

General | "Drop" and "Truncate" safety options

Drop and Truncate
Related to: Object Menu | Drop and Object Menu | Truncate.

Option Description

No "Drop" or "Truncate" for Select to disable the Delete option for table and cluster objects.
Table/Cluster

No "Drop" for Stored Programs/Triggers Select to disable the Drop command for stored programs and
triggers.

General | Session
Session
Option Description

Allow multi Code Editor windows Related To: Code Editor.

per Session

SQL Navigator 7.6

226
User Guide
Option Description

Selected Allow multiple Code Editor windows per Session.

Not Show multiple instances of the Code Editor in the same
Selected window as tabs.

Show Logon Dialog startup Select to show the Oracle Logon Dialog when you launch SQL
Navigator.

Show code editor after connection Selected Show the Code Editor after a connection is made.
Not Selected Show the DB Navigator after a connection is made.

Default date format Select the default date format, for example, MM/DD/YYYY.
Used when a date-to-string conversion request is explicitly made; for
example, in SELECT TO_CHAR(SYSDATE) FROM DUAL.
Otherwise a binary format is used for date/time handling. On screen
date/time representation is made using the client machine’s Regional
Settings (set in the Windows Control Panel).

NOTE: <Same as Displayed Date Format Setting> refers to

View | Preferences |General | User Interface | Date Displayed
Format.

DBMS Output On by default Related To: Server Output.

Selected Server Output is switched on, on connecting to the

database.
Not Server Output is switched off, on connecting to the
Selected database.

DBMS Output buffer (bytes) Change the buffer size for server output. Set the desired upper limit for
the DBMS Output Buffer (Bytes).
Related To: Output Window.

Cache Capacity The number of database objects that can be placed in the cache before
the cache refreshes itself and accesses the database.

Optimizer Goal/Mode The approach the Oracle optimizer uses to optimize a SQL statement.
For more information, see the ORACLE 7 SERVER Concepts Manual.

Immediate load in Open Object Related To: Select DB Object Dialog.

Dialog
Selected SQL Navigator automatically builds a pick-list of all
available database objects.

Not Specify selection parameters before loading the pick list

Selected of database objects.
This saves time and resources.

SQL Navigator 7.6

227
User Guide
Option Description

Close when last session window Selected SQL Navigator terminates a session when all session
closes windows are closed.
SQL Navigator prompts you before terminating the
session, unless you have disabled the prompt previously.

Not A session can still be active when all its windows are
Selected closed.

Show Users in Schema Lists Related To:

l The All Schemas node in DB Navigator.

l The Current Schema drop-down list in the Object toolbar
(Toolbars).
l The drop-down lists in the editing windows.

Selected The lists of schemas will be populated with Users—

regardless of whether those users own any objects.

Not The schema lists will include only users with objects.
Selected

Retrieve large numbers as strings Selected Numeric fields from the database with a precision
exceeding 15 digits will be converted to strings on the
server.
Not These numbers will be represented in scientific notation.
Selected

The advantage of converting large numbers to strings rather than

displaying them in scientific notation is to avoid loss of precision in
screen displays and reports. However, note that converting numbers to
strings means that they:

l Will be left-aligned in windows and dialogs

l Will be sorted alphabetically rather than numerically in sorted
lists
l Cannot be used with SQL Navigator calendar functions

NOTE: The related View | Preferences |Code Editor | SQL

Scripts | Retrieve all result fields as strings overrides this
preference.

Show All Constraints Related To: DB Navigator

Selected Show system-defined constraint names for NOT NULL

attributes.
Not Exclude system-defined constraint names.
Selected

SQL Navigator 7.6

228
User Guide
Option Description

Bytes per character The number of bytes to allocate per character. If you select Autodetect
then SQL Navigator attempts to determine the actual number of bytes
per character while establishing connection.

NOTE: You can override this preference for specific connections

from the Oracle Logon Dialog. If you receive ORA-01026 errors
(or similar) when working with the database, we recommend
setting this preference to the minimum possible value (2, 3 or 4)
that eliminates the errors.

Retrieve tablespace usage info Select to add the following columns to the tablespace details pane:

l size_mb – the allocated size of the tablespace in megabytes

l used_mb – the number of megabytes currently used by the
tablespace
l used_percent – the percentage of the tablespace currently
used.

NOTE: Available only for users with access to DBA views. For
more information, see DBA Dictionary Views on page 49.

National Language Support (To No NLS is not supported by default.

make this option changes effective Support
right away, shut down SQL
Navigator then restart) Display Display and enter data in the Code Editor Data Grid (SQL
and Query Results Data Grid) in any language supported by
Edit Windows. This option is not applicable with the column or
multi- object names. However, multiple languages can be
byte displayed without making any changes to the system
data environment.

Read Buffer Size The number of records SQL Navigator reads per database request.

Use user's dictionary views This preference is specific to background queries to list objects and to
get object details for the logged in user’s schema

Selected SQL Navigator uses USER views to query the Oracle

Data Dictionary.
Not SQL Navigator uses ALL or DBA views to query the
Selected Oracle Data Dictionary, dependent on the value of Enable
DBA Views in the Oracle Logon Dialog.

Keep existing sessions alive Option Description

Issuing 'select * from dual' every interval (minutes)

SQL Navigator 7.6

229
User Guide
Auto run script at connect

Option Description

Auto run script at connect Run the named script on connecting to the database.
Close script on successful Select for the named script to close automatically when it has finished
execution running.

Trace
Option Description

Enable Select to log all transactions with the database to a file. This is useful for debugging purposes.

Level Select the type of messages the trace file will record.

General | Default Tables

Default Tables
Option Description

Exception Table Owner Name of the schema where the exception table is to be stored.
Exception Table Name of the exception table.
Chained Rows Table Owner Name of the schema where the chained rows are to be stored.
Chained Rows Table Name of the chained rows table.

General | Explain Plan

Explain Plan
Option Description

Explain Plan Table User name of the owner of the default plan table.
Owner
Explain Plan Table Name of the default plan table.
Table Access Full The number of rows that must exist in a table before the icon in the execution plan is
warning Threshold changed from green to red to draw your attention to the full table scan.

Abbreviate Join Select to abbreviate the text that is displayed in the execution plan for table joins.
Text
The abbreviation feature reduces the large amount of join text associated with a large
query so that you can focus on the overall steps in the execution plan.

SQL Navigator 7.6

230
User Guide
 Option Description

Explain Plan Color The color of the individual items in the execution plan.

TIP: Click the ... button, then click the Color column in the row of an item to select
a new color.

General | Code Assistant

Code Assistant
Option Description

Auto Start with Editors and Open Code Assistant automatically when an editor or the Explain Plan
Explain Plan Tool is opened.

Standards Catalog Directory The directory path for the Standards Catalog.
Shared Catalog Directory The directory path for the Shared Catalog.

Displayed Pages
Option Description

Syntax Catalog Show the Syntax Catalog in the Code Assistant.

Web Catalog Show the Web Catalog in the Code Assistant.
Code Catalog Show the Code Catalog in the Code Assistant.
SQL Catalog Show the SQL Catalog in the Code Assistant.

PL / Vision Catalog

Option Description

PL / Vision Lite Show the PL / Vision Lite Catalog in the Code Assistant
PL / Vision Professional Show the PL / Vision Professional Catalog in the Code Assistant.

General | Printing
The printing preferences control the appearance of printer output from various SQL Navigator windows, dialogs
and reports.

NOTE: Of all the options in this section, only General | Printing | Editors options are applicable to the
Code Editor.

SQL Navigator 7.6

231
User Guide
Printing
Option Description

Measurement Units The measurement unit for margin width and other print settings.

Header and footer Enable/Disable headers and footers on printed output.

NOTE: Header and footer properties are specified separately (see below).

Font The font to be used for printing SQL Navigator output.

Margins

Option Description

Left Margin The width or height of the page margins using the Measurement Unit specified above.
Right Margin
Top Margin
Bottom Margin

Header

Option Description

Font The page header properties.

Alignment Be sure to enable Header and Footer (above) if you want headers and footers to be printed.

Footer

Option Description

Font The page footer properties.

Page Number Be sure to enable Header and Footer (above) if you want headers and footers to be printed.

Date

Editor
Option Description

Syntax highlighting Applicable to output printed from an editing window; for example, the Code Editor.
Show line numbers

SQL Navigator 7.6

232
User Guide
DB Navigator
Applicable to output printed from DB Navigator.

Option Description

Header Type the text you want to appear as header text in the printed output from DB Navigator.
Orientation If you select a printer orientation other than Default, your setting will override any setting made
in the Print Setup dialog when you print.
Print Print the selected item or the entire DB Navigator Tree.
Selection

General | Object Editors

Object Editors
Option Description

Auto Recompile Selected Automatically recompile dependent objects when an object is altered.
Dependents
Not Force a manual recompile of dependent objects based on your
Selected preference. This is the default.

Auto Recompile Selected Automatically recompiles only the dependent objects that have a status of
Invalid Only invalid.
Not Force all dependent objects to recompile automatically when using the
Selected debugger feature.

Apply changes This option specifies the conditions necessary for the Apply Changes toolbar button to be
available. Select to have the button available

l only when you have made changes to valid objects, or

l when you have made changes to any objects (valid or invalid), or
l available at all times.

Save on clone Select to automatically save a cloned object without prompting.

SQL Navigator 7.6

233
User Guide
General | Task Bar
Task Bar
Option Description

Group Similar Display buttons with similar functionality into groups.

Taskbar Buttons

Group Similar Specified the maximum numbers of separate items on taskbar before grouping is
Taskbar Button performed. (if the threshold is 4 and there are 4 items on the taskbar, when another
Threshold window is opened, it will be grouped).

NOTE: Requires selection of group functionality (above).

Order Taskbar Items Selected Task bar items of one session are grouped close together followed by
by Session items of other sessions.
Not All items of the same type will be grouped together regardless of their
Selected sessions.

Reverse Order of When selected, new Task bar items will be populated on the left hand side.
Taskbar Items
Rotate Taskbar Item Horizontal / Vertical direction of Task bar item captions.
caption when
vertical
Allow Taskbar Items Display Task bar items on multiple lines if the current line is full.
to expand onto
multiple lines

Extract DDL
Extract DDL | General
NOTE: Preferences preceded by an asterisk (*) are applicable to team coding operations when the Team
Coding preference (see Use Extract DDL Preferences) is checked.

Extract DDL/MetaData
Option Description

Show this window before performing the Show the preferences before the DDL is extracted from the
task object.

SQL Navigator 7.6

234
User Guide
Option Description

<schema>, <object> File Name Prefix Selected The default file name will be prefixed with the
schema name and object name.
Not The default file name will be the same as the
Selected object name.

New tab in the Code Editor for each object Selected Show a new tab for each object that is
extracted DDL.
Not All the objects' extracted DDLs will be on the
Selected same tab.

Extract DDL to the same tab in the Code Selected The script is inserted into the current tab in the
Editor Code Editor.

Not A new tab is created with the SQL scripts.

Selected

Extract DDL
Option Description

Extract DDL on Allow drag & drop of the extracted DDL to another database within the same DB
drag & drop within Navigator tree.
DB Navigator
Keywords case Select the case used for keywords in the DDL.
Names case Select the case used for names in the DDL.
Generate Show pre-generated comments in the DDL. Can be helpful to identify different parts of
comments the script.
Prefix with Any Object Name that is displayed within the DDL is prefixed with the Schema Name.
Schema name

Include Drop Include the drop statement at the beginning of the DDL to drop the object first.

Option Description

Include "Cascade Constraints" with DROP

Include "Force" Include Drop with Force in the DLL statement for type objects.
with TYPE DROP
Use "CREATE Add Create or Replace to the start of the object, rather than just having Create.
OR REPLACE"
Include Include the Tablespace name in the DDL.
"Tablespace
name"
Include "Storage Include the Storage clause in the DDL.
clause" (Only Non-

SQL Navigator 7.6

235
User Guide
Option Description

Default Values for

Partitioned
Tables)*
Include "Physical Include the Physical Attributes clause in the DDL.
Attributes Clause"*

Include "Grants"* Include the Grants in the DDL.

Option Description

Include Object Grants (for Users) Includes any object grants for users in the DDL.

Body and Spec for Includes DDL for both the body and the specification when extracting from packages or
Packages/Objects objects. The package specification declares procedures, functions, cursors, and
variables. The package body contains the implementation of the public procedures and
functions, together with internal and private programs and variables.

Show Trigger The Oracle Data Dictionary stores the DDL used to create a trigger in the all_triggers_
Snapshot view, along with all the other trigger parameters.

Selected SQL Navigator extracts the DDL as stored in the all_triggers_view.

Any user comments stored in the DDL are retained when extracting the
DDL.

Not SQL Navigator constructs the DDL from the object’s parameters, and any
Selected user comments will not be retained.

Separator Select the character to be used as the separator in the DDL. If you extract DDL for
Character several objects, the DDL for each object will be separated using the selected separator.

NOTE: The '/' character is used automatically when extracting DDL for objects
without stored code.

Format Output (will Format the DDL according to Formatting Options.

not include Inline
Inline advice is never included even if Tools | Formatter Tools | Enable Inline Advice is
Advice)
selected.

Extract DDL | Table/View Specific

Table/View specific
NOTE: Preferences preceded by an asterisk (*) are applicable to team coding operations when the Team
Coding preference (see Use Extract DDL Preferences) is checked.

SQL Navigator 7.6

236
User Guide
Option Description

Include "Constraints" * Includes any constraints for the object in the DDL.

Option Description

Disable "Constraints" *Generate DDL with constraints in a disabled state.

Include "Triggers" *Includes any triggers for the object in the DDL.
Include "Indexes" Includes any indexes for the object in the DDL.
Include "Comments" *Includes any comments for the object in the DDL.
Include "Primary Key in Includes the Primary Key for the table in the DDL.
Table Definition"
Include "Synonyms" Includes any Synonyms for the object in the DDL.

Exclude Table column *Excludes all default values for the object from the DDL.
default values*
Include Includes any encryption-related clauses (such as encryption algorithm to be
ENCRYPTION clause used, salting and so forth) for the object in the DDL.
Include FORCE clause Select the measurement unit you want to use for specifying margin width and
other print settings.
Include datatype definition Include datatype definition for any columns that are of complex type.
for table column
Include Byte/Char for Display Byte or Char as length for a column.
Table Columns

Partitioning
Option Description

Include "Storage Clause" for Includes any Partition settings from the Storage Clause for the object
Partitions in the DDL.

Include "Storage Clause" for Index Includes any Index Partition settings from the Storage Clause for the
Partitions object in the DDL.
Storage Clause Options Include storage clauses with either non-default values or all values in
the DDL.
Include "Tablespace Name" for Includes the Tablespace names any Partition for the object in the
Partitions DDL.
Include "Tablespace Name" for Index Includes the Tablespace names in any Indexed Partition for the object
Partitions in the DDL.

Exclude Partition List for Local Index Excludes Local Index Partitions for the object in the DDL.

NOTE: Not applicable when Include "storage Clause" for

Index Partitions (above) is selected.

SQL Navigator 7.6

237
User Guide
Option Description

List Individual Hash Partitions Selected The "individual_hash_partitions" clause will be used.
Not The "hash_partitions_by_quantity" clause will be
Selected used.

Extract DDL | Constraints

Constraints
Option Description

Include ON DELETE SET NULL clause Includes the ON DELETE SET NULL clause in the DDL.

Extract DDL | Materialized Views/Snapshots

Materialized Views/Snapshots
Option Description

Include BUILD clause Choose the type of build clause used for snapshots.

Extract DDL | Users

Users
Option Description

Include encrypted password Select to include the user's password (encrypted) in the extract ddl script.

Project Manager
Project Manager
Option Description

Hide inactive project Only display the selected Project Manager window.
windows

SQL Navigator 7.6

238
User Guide
Option Description

Hide Project Manager Once a connection has been made successfully, close the Project Manager
after connecting window.
Remember Oracle Displays the Home/Client column. Remembers the Oracle client for each
Home/Client for each connection and automatically connects the next time the item is opened (if the
connection connection is closed).

Auto add items to Project Manager

Option Description

On Connect Once a connection has been made successfully, add the connection to the Project
Manager.
Direct connections are not added to the Project Manager.

On Create/Open Once an object has been created or opened it is added to the Project Manager Window.
object
On Create/Open Once a file has been created or opened it is added to the Project Manager window.
file
On Browse/Edit If the user browses data in a table, then the table is added to the Project Manager
Data Window.
On Describe object If the user chooses to describe an object, then the object is added to the Project
Manager Window.
On Execute object If the user executes a procedure or function, then that object is added to the Project
Manager Window.

Code Editor
Code Editor | General
General
Option Description

Find Text at Cursor Automatically place the word at the current cursor position into the Find box.
Font The font used in the Code Editor window.

Code Convention Paste objects in lower case into the editor. Also affects column names in the drop
Lowercase down list as part of code completion in any of the text editors, as upper or lower case,
when you type in a table name with the '.' operator.
The preference was previously known as Drag and Drop Objects to Lowercase.

SQL Navigator 7.6

239
User Guide
Option Description

Auto Indent Position the cursor under the first nonblank character of the preceding nonblank line
when user presses Enter.

Indent Size Indent Size used when Indenting selected text using CTRL + I.
Not applicable if Use TAB Characters is selected.

Use TAB Characters Selected Insert tab characters.

Not Selected Insert space characters.

If Smart TAB is selected this option is off.

Tab Size The horizontal width of the Tab space in number of characters.

Smart Tab Tab to the first character in the preceding line.

If Use TAB Characters is selected this option is off.

Smart Fill Begins every auto-indented line with the minimum number of characters possible,
using tabs and spaces as necessary.
Keywords to Convert all keywords to uppercase as they are typed into the editor.
Uppercase

Syntax highlighting Enable the highlighting of syntax within the editor.

Option Description

Highlighting Default Styles with color schemes for syntax highlighting.

Style
Colors Set a custom style for syntax highlighting. Also set the highlighting
style to custom.

Column Track When selected the cursor "remembers" its starting column position and moves to the
same position when you move it up or down to a new line.
Use together with Allow Caret after EOL.

Hot Links When selected the user can open an object from the SQL text via Ctrl+Click.

Allow Caret after Selected The user can move the cursor beyond the end of the current line. The
EOL cursor’s vertical movement ignores the EOL position of the line current
line.
Use together with Column Track.

Not The user cannot move the cursor beyond the end of the current line. The
Selected cursor’s vertical movement is constrained by the EOL position of each
line.

Show Line Numbers Show line numbers in the Code Editor.

Show Right Margin When selected, draw a vertical line in your editing window representing the right-hand
page boundary.

SQL Navigator 7.6

240
User Guide
Option Description

Option Description

Right Margin Width Placement is controlled by the Right Margin Width setting.

Templates Open the Code Shortcuts And Templates Dialog.

Create, edit, or delete templates.

Describe Object at When selected, open the Describe window (Describe) when press Ctrl and right-click
Hyperlink on an object name and create a hyperlink.
Highlight Current When selected, the line containing the cursor is highlighted.
Line
Allow Tab Items to Display Tab items on multiple lines if the current line is full. Select for ease of
Expand onto Multiple navigating through multiple open PL/SQL objects and SQL queries.
Lines

Enable Code Related to: Edit, Compile And Execute

Collapsing
When selected, the Code Collapsing functionality is turned on allowing the user to
collapse/expand blocks of code.

Option Description

Disable Code When a script/object exceeds the specified number of

Collapsing when line lines, Code Collapsing is disabled to improve
count exceeds performance.

Save successfully Select to save a copy of successfully executed queries in C:\Documents and
executed sql in the Settings\<username>\Application Data\Quest Software\SQL Navigator\Unified
History tool Editor\history.
Turn Off Variable Select turn off the pop up hints that are displayed when you hover the mouse over
Hints function or procedure names, or variables.
Scan Related to: Scan Defines/Substitutions
Defines/Substitutions
Sub-tab row location Specify the position of the sub-tab to be displayed.

Close Code Editor When selected, the Code Editor closes when the last tab in the editor is closed.
when last tab closes

Code Editor | SQL Scripts

SQL Scripts
Option Description

Spool Output When selected, returned results are sent to the spool pane (SQL Query
Log (The Spool Tab)) of the Code Editor on query execution.

SQL Navigator 7.6

241
User Guide
Option Description

This option does not turn on/off the Spool option of the existing code editor
tabs.

Option Description

Default Specifies how many rows of returned results are sent to the
Rows spool pane of the Code Editor on query execution when
Displayed Fetch All is set to OFF.
Bring to When selected, the Spool tab is shown on top after the
front after execution of a PL/SQL block.
execution

Split Window to Display Results Selected The data grid is shown below the script tab.

Not Selected The data grid is shown in a whole window.

Fetch All Selected Retrieve all results and display in the data grid.
Not Retrieve the number of rows that can be displayed in the data
Selected grid. Scroll down the grid to retrieve more rows.

Show Errors in Output Window Selected Show a brief error message in the Execution Status pane
below the editing area. Show detailed error messages in the
Output Window.

Not Show a brief error message in the Execution Status pane

Selected only.

Retrieve all result fields as When selected, this option causes all numeric fields to be converted to
strings strings on the server.
Use Table Alias Select to use table aliases in the SQL statements generated by Quick
Browse and Edit Data.

Cursor focus stays in the SQL When selected, the cursor will stay in the Script area instead of moving to
query after single execution the data grid.

Highlight query for When selected, the SQL that has been executed, and corresponds to the
corresponding data result data shown in the data grid, is highlighted.
Focus query for corresponding When selected, the cursor will stay in the Script area instead of moving to
data result the data grid.

Allow session switching Selected You can switch sessions for an open editor. This means you
can easily run the same SQL statement(s) against multiple
databases.
Not You will need to open multiple editing windows to accomplish
Selected this task.

SQL Navigator 7.6

242
User Guide
Code Completion
Option Description

Delay
(milliseconds)

Automatic When selected,a ‘pick’ list of matching symbols (variables, parameters, procedures, types) in
Code the current scope is displayed when you start typing in an identifier.
Completion
When selected, it will also include Automatic Dot-Lookup.

Automatic Dot when selected, a ‘pick’ list of members of a PL/SQL record, cursor, package or %ROWTYPE
Lookup record are displayed when you type a dot character after a name of variable.
Automatic Dot Lookup can be selected as a stand-alone option.

Drag & Drop

Option Description

Drag & Drop of Tables Specifies what will be inserted when a table node is dragged and dropped from DB
or Views nodes Explorer into the Code Editor.
If this preference is set to insert a query statement for each table, using Ctrl or Shift
key while drag and drop will not have any effect on the format of the queries.

Drag and Drop When selected, drag & drop code objects (such as procedure, function) will include
arguments with code their arguments (such as Input parameters, Output parameters)
objects

Code Analysis
Module: Code Analysis

Option Description

Embed Code Analysis in When selected, a Code Analysis tab appears in the editor window next to the
editor windows Code tab which you can open as required.

Lob Viewer
Option Description

Hex Dump Mask Filter for ASCII characters.

LOB Save Path Specify the default location to save the lob content.
Text Font Specify the font attributes to be used for displaying text content.
Fixed Font Specify the font attributes to be used for displaying non-text content.

SQL Navigator 7.6

243
User Guide
Team Coding
General
Option Description

Disable Team Coding Selected Team Coding is disabled for the connection. The Oracle
Detection on Connection connection will run faster.
Not Queries are run against the Oracle connection to detect the
selected Oracle server team coding settings. This is the default
behavior.

Disable Login Prompt on When selected, the team coding third-party provider login prompt will not
Connection appear on connection.

Show in DB Navigator Select to add Team Coding functions to the DB Navigator right-click menu.
Selecting this may have a performance impact.

Include Schema in DDL Select to include the schema name in the DDL of an object when it is
extracted to a file.

Team Coding Files Encoding Select the encoding of files that Team Coding uses to save the DDL of
database objects. Default: UTF-8 No BOM.

Keyboard Shortcuts (View |

Preferences)
Action Keyboard Shortcut

Select next item CTRL+Enter

Toggle: Selected / Not Selected Spacebar

Open drop down boxes ALT+Down Arrow key

Close drop down boxes ALT+Up Arrow key

Expand subgroup + on number pad

Close expanded subgroup – on number pad

Decrement values in numeric spin controls CTRL+Down Arrow

Increment values in numeric spin controls CTRL+Up Arrow

SQL Navigator 7.6

244
User Guide
 About us
Ab o u t Qu est So ftware

We are more than just a name

We are on a quest to make your information technology work harder for you. That is why we build community-
driven software solutions that help you spend less time on IT administration and more time on business
innovation. We help you modernize your data center, get you to the cloud quicker and provide the expertise,
security and accessibility you need to grow your data-driven business. Combined with Quest’s invitation to the
global community to be a part of its innovation, and our firm commitment to ensuring customer satisfaction, we
continue to deliver solutions that have a real impact on our customers today and leave a legacy we are proud of.
We are challenging the status quo by transforming into a new software company. And as your partner, we work
tirelessly to make sure your information technology is designed for you and by you. This is our mission, and we
are in this together. Welcome to a new Quest. You are invited to Join the Innovation.

Our brand, our vision. Together.

Our logo reflects our story: innovation, community and support. An important part of this story begins with the
letter Q. It is a perfect circle, representing our commitment to technological precision and strength. The space in
the Q itself symbolizes our need to add the missing piece — you — to the community, to the new Quest.

Contacting Quest Software

For sales or other inquiries, visit www.quest.com/company/contact-us.aspx or call +1 949 754-8000.

Technical support resources

Technical support is available to Quest customers with a valid maintenance contract and customers who have
trial versions. You can access the Quest Support Portal at https://support.quest.com.
The Support Portal provides self-help tools you can use to solve problems quickly and independently, 24 hours
a day, 365 days a year. The Support Portal enables you to:

l Submit and manage a Service Request

l View Knowledge Base articles
l Sign up for product notifications
l Download software and technical documentation
l View how-to-videos
l Engage in community discussions
l Chat with support engineers online
l View services to assist you with your product

SQL Navigator 7.6

245
User Guide