SQL Navigator™ 7.2 User Guide © 2015 Dell 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 Dell Software Inc. The information in this document is provided in connection with Dell 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 Dell Software products. EXCEPT AS SET FORTH IN DELL SOFTWARE’S TERMS AND CONDITIONS AS SPECIFIED IN THE LICENSE AGREEMENT FOR THIS PRODUCT, DELL 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 DELL 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 DELL SOFTWARE HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. Dell 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. Dell 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: Dell Software Inc. Attn: LEGAL Dept 5 Polaris Way Aliso Viejo, CA 92656 Refer to our web site (www.software.dell.com) for regional and international office information. Trademarks Dell, the Dell logo, SQL Navigator, Toad, Toad World and Benchmark Factory are trademarks of Dell Inc.and/or its affiliates. Microsoft, Windows, Windows Vista, Windows Server Internet Explorer and Excel are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. Oracle, PL/SQL, SQL*Net and Java are trademarks or registered trademarks of Oracle and/or its affiliates. Citrix® is a trademark of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. Serena and PVCS are registered trademarks of SERENA Software, Inc. Perforce is a trademark of Perforce Software. Apache and Apache Subversion are trademarks of The Apache Software Foundation. IBM, Rational and ClearCase are registered trademarks of International Business Machines Corporation. Borland and StarTeam are trademarks or registered trademarks of Borland Software Corporation in the United States and other countries. Other trademarks and trade names may be used in this document to refer to either the entities claiming the marks and names or their products. Dell disclaims any proprietary interest in the marks and names of others. 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 - February 2015 Software Version - 7.2 Contents Quick Overview 14 Better code, faster. 14 Who should use SQL Navigator? 14 Enter A New Authorization Key 14 Check for Updates 14 Working With SQL Navigator 15 Oracle Sessions 15 Finding Objects 15 Working With Objects 16 Web Development 17 Java Source Code 18 Analysis And Tuning 18 Team Coding And Version Control 19 Navigation 20 Main Menu 20 File Menu 20 Edit Menu 21 Search Menu 22 View Menu 23 Session Menu 25 Object Menu 26 Tools Menu 29 Team Coding Menu 32 Help Menu 33 Task Bar 34 Toolbars 34 Component List 35 Main Menu Keyboard Shortcuts 39 Customize The Screen Layout 41 Float / Dock 41 Toolbars in the Main Window 42 Main Menu Bar 43 Oracle Logon 44 Oracle Logon Dialog 44 SQL Navigator 7.2 3 User Guide Oracle Client Settings 44 Connection Parameters 44 Username / Password 45 Options 45 Oracle TNS Configuration 46 Advanced Service Options Dialog 47 Address List Options Dialog 47 DBA Dictionary Views 48 How SQL Navigator handles the views 49 Troubleshooting Connections to Oracle 49 Command Line Parameters 49 Code Editor 51 SQL Development 51 PL/SQL Development 51 Toolbox 51 Code Editor SQL 52 General Code Editor Functions 52 SQL Specific Functions 53 Team Coding Version Control 55 Tools and Applications 56 Code Editor PL/SQL 57 General Code Editor Functions 57 PL/SQL Specific Functions 58 Team Coding Version Control 59 Tools and Applications 59 Edit, Compile And Execute 60 SQL*Plus command support 65 Executing Scripts Invoked By At Sign (@) or Double At Sign (@@) SQL*Plus Commands 66 Connect To A Database Via The Code Editor 66 Bind Variables 66 Auto Code Completion 67 Scan Defines/Substitutions 67 Specifying substitution variables in SQL statements 68 DEFINE and UNDEFINE 69 New Stored Object Dialog 69 SQL Statement CRUD Matrix Dialog 70 SQL Query Results 70 SQL Query Results Data Grid 70 Rows Retrieved 71 SQL Navigator 7.2 4 User Guide Export / Print 71 Browse 72 Edit (Updateable Queries) 72 Group Display 73 Format 73 Sort & Display 73 SQL Query Log (The Spool Tab) 74 Export Data Dialog 74 Viewers: LOB, XML, Array 74 LOB Editor 74 ARRAY Editor 75 PL/SQL Execution Console 75 Run Time Parameters 76 Run Options 76 Code Test 77 PL/SQL Stub 78 DBMS_OUTPUT 78 Code Editor Keyboard Shortcuts 79 Right Click Over The Editing Pane 79 PL/SQL Debugger Keyboard Shortcuts 81 Further Shortcuts In The Code Editor Editing Pane 81 Further Shortcuts Viewing SQL Code Execution Results 82 Shortcuts In The Code Editor Toolbar 82 Toolbox 83 PL/SQL Debugger 83 Requirements 84 Debug 84 Code Explorer 86 Outline 87 DB Explorer 87 Describe 88 History 88 Dependencies 89 Columns 89 Visual Object Editors 90 Cluster Editor 91 Ways to Open The Cluster Editor 91 Constraint Editor 91 Using The Editor 92 SQL Navigator 7.2 5 User Guide Steps To Create A Constraint 92 Now the constraint is defined 93 Ways to Open The Constraint Editor 93 Database Link Editor 93 Ways to Open The Database Link Editor 94 Index Editor 94 Ways to Open The Index Editor 95 Nested Table Editor 95 Profile Editor 95 Requirements 96 Ways to Open The Profile Editor 96 Redo Log Group Editor 96 Ways to Open The Redo Log Group Editor 96 Role Editor 97 Requirements 97 Ways to Open The Role Editor 97 Materialized View Editor 97 Using The Editor 98 Editor Toolbar 98 Editor Tabs 98 Ways to Open The Materialized View Editor 99 Sequence Editor 99 Ways to Open The Sequence Editor 99 Synonym Editor 99 Ways to Open The Synonym Editor 100 Table Editor 100 Ways to Open The Table Editor 101 User Editor 101 Requirements 101 Ways to Open The User Editor 102 Varray Editor 102 View Editor 102 Using The Editor 103 Editor Toolbar 103 Editor Tabs 103 Ways to Open The View Editor 104 Java Editor 104 Ways to open the Java Editor 104 Instance Property Editor 105 SQL Navigator 7.2 6 User Guide Using The Editor 105 Instance Property 105 Editor Toolbar 105 Details Tab 106 Ways to Open The Instance Property Editor 106 Team Coding and Version Control Support 107 Code Control Groups 107 How do CCGs work? 107 Example 1: A Single Application 107 Example 2: Multiple Applications 109 Code Collections Viewer 109 Toolbar 110 Code Collection Viewer 110 Toolbar 111 Linking a CCG to a user schema 112 Example -- Linking a CCG to a user schema 113 Import Dialog 113 Export Dialog 114 Team Coding Viewer 115 Toolbar 115 List of Objects - Status Codes 116 Version Control Browser 117 Toolbar 117 TC Locks option 118 Check In / Check Out Dialog 119 Different Files Dialog 119 Team Coding Settings 120 Configuration 120 File Extension Options 121 General 121 Team Coding Status Dialog 123 Version Control Products 123 Concurrent Versions Systems (CVS) 123 CVS Configurations Options 123 CVS Login Window 126 Updating Working Folders 127 Multiple Connections And CVS Logins 127 Authentication Methods and the CVS Root 127 SSH Authentication Using The ext Method 128 SQL Navigator 7.2 7 User Guide Modules, Windows And Dialogs 130 Analyze Tool 130 Collect Statistics 130 Validate Structure 131 List Chained Rows 131 Auto Describe Tool 131 Benchmark Factory 132 Bookmarks Dialog 133 Capture Web Output 133 Start Capturing Web Output 133 While Capturing Web Output 134 Change Logon Password 134 Code Analysis 134 Access to Code Analysis 134 Rules and Rule Sets 135 Code Analysis Metrics 135 Code Analysis Window 135 Code Analysis Rule Sets 136 Create and Edit 137 Import and Export 137 Code Analysis Rules 137 Create or Clone 138 Edit 138 Import and Export 138 Code Assistant 139 Move a code snippet into the editor 139 Locate a code snippet in the Code Assistant 139 The Code Assistant Toolbar 140 Add to Catalog / Edit Dialog 140 Code Road Map 141 Code Road Map Toolbar 141 The Code Model 143 Model Code Dialog 144 Code Templates 145 Standard code routines for which templates have been provided: 145 Code Shortcuts And Templates Dialog 146 Default Templates 147 Code Test 148 Test Case Properties 149 SQL Navigator 7.2 8 User Guide Database Source Code Search 149 DB Navigator 150 DB Navigator Toolbar 151 Using DB Navigator 151 Filter Properties Dialog 152 Select filter 153 Select filter settings.