10

User Guide
2009 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 purchasers
personal use without the written permission of Quest Software, Inc.
If you have any questions regarding your potential use of this material, contact:
Quest Software World Headquarters
LEGAL Dept
5 Polaris Way
Aliso Viejo, CA 92656
Web site: www.quest.com
email: [email protected]
Refer to our Web site for regional and international office information.
Disclaimer: The information in this document is provided in connection with Quest 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 products. EXCEPT AS SET FORTH IN QUEST'S TERMS AND CONDITIONS AS SPECIFIED
IN THE LICENSE AGREEMENT FOR THIS PRODUCT, QUEST ASSUMES NO LIABILITY WHATSOEVER AND
DISCLAIMS ANY EXPRESS, IMPLIED OR STATUTORY WARRANTY RELATING TO ITS PRODUCTS
INCLUDING, BUT NOT LIMITEDO, THE IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE, OR NON-INFRINGEMENT. IN NO EVENT SHALL QUEST 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 HAS
BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. Quest 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 does not make any commitment to
update the information contained in this document.
Trademarks
Quest, Quest Software, the Quest Software logo, ActiveRoles, Aelita, AppAssure, Benchmark Factory, Big Brother,
DataFactory, DeployDirector, ERDisk, Foglight, Funnel Web, I/Watch, Imceda, InLook, IntelliProfile, InTrust, IT Dad,
I/Watch, J Class, J int, J Probe, LECCO SQL Expert, LECCO Tech, LiteSpeed, LiveReorg, MessageStats, NBSpool,
NetBase, PerformaSure, PortalVue, Quest Central, SharePlex, Sitraka, SmartAlarm, Spotlight, SQL LiteSpeed, SQL
Navigator, SQL Watch, SQLab, Stat, Stat!, StealthCollect, Tag and Follow, Toad, T.O.A.D., Toad World, Vintela,
Virtual DBA, Xaffire, and XRT are trademarks and registered trademarks of Quest Software, Inc in the United States
of America and other countries. Other trademarks and registered trademarks used in this guide are property of their
respective owners.
Third Party Contributions
DEVELOPER EXPRESS, INC., ExpressQuantumGrid SUITE SOFTWARE COMPONENT PRODUCT,
ExpressBars SUITE SOFTWARE COMPONENT PRODUCT, ExpressPrinting System SOFTWARE COMPONENT
PRODUCT, ExpressScheduler SUITE SOFTWARE COMPONENT PRODUCT, ExpressPivotGrid SUITE
iii
SOFTWARE COMPONENT PRODUCT, ExpressQuantumTreeList SUITE SOFTWARE COMPONENT PRODUCT
, ExpressVerticalGrid SUITE SOFTWARE COMPONENT PRODUCT, ExpressNavBar SUITE SOFTWARE
COMPONENT PRODUCT, ExpressLayout Control SOFTWARE COMPONENT PRODUCT, ExpressSpreadSheet
(Cross-Platform) SOFTWARE COMPONENT PRODUCT, ExpressMasterView SOFTWARE COMPONENT
PRODUCT, ExpressDBTree SUITE SOFTWARE COMPONENT PRODUCT, ExpressOrgChart SUITE SOFTWARE
COMPONENT PRODUCT, ExpressFlowChart SUITE SOFTWARE COMPONENT PRODUCT, ExpressWeb
Framework SOFTWARE COMPONENT PRODUCT, COMPONENTAGE SOFTWARE - DIALOG WORKSHOP
FOR DELPHI/C++BUILDER, ECONTROL LTD. ECONTROL SYNTAX EDITOR SDK, FABIO DELL'ARIA -
EUREKALOG SOFTWARE, FAST REPORTS, INC. - FASTREPORT 4, /N SOFTWARE, INC. IP*WORKS,
PROJ ECT J EDI, DEVART ORACLE DATA ACCESS COMPONENTS (ODAC), SICOMPONENTS -
SCHEDULING AGENT, ELDOS CORPORATION SECUREBLACKBOX, MIKE SHKOLNIK SMIMPORT SUITE,
DEEP SOFTWARE - STORAGE LIBRARY, STEEMA SOFTWARE TEECHART PRO V8, VCLZIP,
VIRTUALSHELLTOOLS, MIKE LISCHKE - VIRTUALTREEVIEW, AXOLOT - XLSREADWRITEII
Toad for Oracle 10
Install Guide
September, 2009
iv

Table of Contents
Introduction 77
New in This Release 77
In All Toad Editions 77
In the Professional, Xpert, Development Suite, and DBA Suite Editions 82
In the DB Admin Module and DBA Suite 83
Introduction to Toad 85
DB Admin Module 86
History and Compatibility of Toad and Oracle 91
Toad History 91
Oracle History 92
Client/Server Compatibility 92
Toad and Oracle Enterprise Manager 92
Disabling Access to OEM Functionality in Toad 93
Customizing Your Toolbar 93
Using Toad Options to Hide Windows 93
Using Toad Group Policy Manager 94
Getting Help 95
Online Resources 95
Toad Online 95
What's New Tab 95
Join Mailing Lists Tab 95
Release Notes Tab 95
Online Resources Tab 96
Help File 97
Quick Search Bar 97
Check for Updates 97
Toad for Oracle User Guide
Table of Contents
4
Download Toad Tips 98
Frequently Asked Questions (FAQ) 98
Show Tips 98
Navigating the tips window 99
Notes tab 99
Hiding the tips window 99
Toad Advisor 99
About Toad 100
Release Notes 100
Support Bundle 100
Support Bundle Overview 100
Support Bundle Toolbar 101
Troubleshooting 102
Unicode Troubleshooting 102
Hints and Tips: Connecting To Personal Oracle 103
Hints and Tips: Table Does Not Exist Errors 104
Working with other Quest Products 105
Knowledge Xpert 105
Using Knowledge Xpert in Toad 105
Using SQL Optimizer with Toad 106
Switching between versions of SQL Optimizer 106
Benchmark Factory 107
Setting Benchmark Factory Properties 108
Quest Code Tester Integration 109
Toad Basics 111
Toad Tips 111
Errors 111
Toad for Oracle User Guide
Table of Contents
5
Toad Error 111
Application Error 112
RAC Support 113
Additional Information for RAC Connections 113
Drag-and-Drop 113
Task Bar & Status Bar 117
Task Bar 117
Status Bar 118
ASCII Chart 119
Toolbars, Menus and Shortcut Keys 122
Configurable Toolbars and Menus - Overview 122
Shortcut Keys 123
Menu hotkeys 129
Shortcut keys 129
Toolbars 130
Personalized Menus and Toolbars 130
Other 130
Restoring Lost Toolbars 134
Standard Toolbars 135
Saving the desktop 137
Missing Toolbars 138
Menus 142
Adding sub-menus 143
Installation and Administration of Toad 144
Window Privileges and Toad 144
Toad for Oracle, Read-Only 144
What is Toad Read Only? 144
Why use Toad Read Only? 144
Toad for Oracle User Guide
Table of Contents
6
Where to get Toad Read Only? 144
Toad Security 145
Toad Read Only Installation 145
Registering Toad 145
Silent Installation 146
Extracting the MSI Installer 146
Full Installation 147
Network Installation 147
Citrix Installation 148
Silent Uninstall 148
Options, Parameters and Meanings 149
Group Policy Management 151
Toad 151
Citrix Support 151
Installing Toad on a Citrix server 152
Connecting to Toad through Citrix 152
User Configuration Files in Citrix 152
Script Manager and Citrix 152
SQL*Net Versions 152
Configuration Files 153
V$ Tables Required 153
The Toad INI file 159
SQL Results panel splitter 159
Keep users from dropping or truncating tables 159
Put lines of comments between identifier and name of procedure 159
How to create your ToadStats.ini file 160
Properties Files 163
Transferring Configuration files 171
Toad for Oracle User Guide
Table of Contents
7
Server Side Objects Installation 172
Installing Server Side objects 172
Using the Server Side Install Wizard 173
Connecting to Oracle 177
Server Login Window 177
Troubleshoot the Server Login Window 177
Using the Connection Grid 177
Refreshing Oracle information 178
Create New Connection 179
LDAP 180
Troubleshooting 180
Selecting Connection Color 181
SET ROLE 181
Auto Connect 183
Save Passwords for Connections 184
Save Pwd? Column 184
Save Passwords Check Box 184
Password Options 184
Select and View Favorite Connections 184
Organize your login display 185
Use Existing Connection 185
SQLNET Editor 186
Backing up your SQLNET File 186
LDAP Editor 187
Backing up your LDAP File 187
Using the LDAP Editor 187
Oracle Homes 188
Toad for Oracle User Guide
Table of Contents
8
Selecting the Oracle Home 188
Selecting a Default Oracle Home 189
Oracle Home Editor 190
TNSNames Editor 191
TNSNames Editor Overview 191
Limitations of the TNSNames Editor 191
Load and View TNSNAMES Files 192
Switching Views 192
Pasting Entries into the TNSNames File 193
Checking Syntax 193
Add Service and Details 194
Configuration Notes 195
Cloning a Service 195
Delete Service or Details 196
Edit Service 196
Saving Changes to TNSNames Files 197
Testing a Connection 197
Working with Two Files 197
Tutorials 199
CodeXpert 199
Using the CodeXpert Tutorial 199
Creating a Ruleset Tutorial 200
PL/SQL Debugger 201
Debugging a Procedure or Function 201
Enter the code in the Editor 202
Add Watches - Debugging Tutorial 203
Set Parameters- Debugging Tutorial 203
Run Code and Display Output - Debugging Tutorial 205
Toad for Oracle User Guide
Table of Contents
9
Change Watch Properties - Debugging Tutorial 205
Disable a Watch - Debugging Tutorial 205
Step Through the Code - Debugging Tutorial 206
Add Breakpoints - Debugging Tutorial 206
Disable Breakpoints - Debugging Tutorial 207
Edit Line Number 207
Use Passcount - Debugging Tutorial 207
Use Conditional Breakpoint - Debugging Tutorial 208
Use Passcount and Conditions together - Debugging Tutorial 208
Debugging a Package 209
Debugging an INSERT Trigger 214
Debugging an UPDATE Trigger 216
Debugging a DELETE Trigger 218
SQL*Loader 220
SQLLoader Tutorials 220
Basic SQL*LoaderTutorial 220
Control File 225
Intermediate SQL*Loader Tutorials 228
Advanced SQL*Loader Tutorial 233
Team Coding 238
Team Coding Tutorials 238
Installing Team Coding Database Objects - Team Coding Tutorial 238
Setting up and Enabling TC without Version Control Software 239
Team Coding Roles 239
Administrator (TC_ADMIN_ROLE) 239
Project Manager (TC_MGR_ROLE) 239
Team Leader (TC_LDR_ROLE) 239
Users without a role granted 239
Toad for Oracle User Guide
Table of Contents
10
Setting up and Enabling Team Coding with Version Control Software 240
Steps 241
RMAN Templates 244
RMAN Scripts in Toad 244
Working with RMAN Templates 244
Executing RMAN Scripts from Toad 245
Comparing 246
Data Duplicates 246
Compare Single Objects 246
Comparing Databases 247
Compare Databases 247
Compare Databases - Database Tab 248
Compare Databases - Options Tab 249
Compare Databases - Object Set Tab 250
Compare Databases - Results 251
Compare Databases - Sync Script 253
Sync Script toolbar 253
Scheduling Compare Databases as Windows Task 253
Comparing Data 254
Comparing Data 254
Reviewing Differences 255
Compare Files (Difference Viewer) 256
Compare Files and Objects 256
To compare two files on disk 256
To compare objects in the Schema Browser 257
To compare differing objects from a schema compare 257
Viewing File Differences 257
File Comparison Rules 258
Toad for Oracle User Guide
Table of Contents
11
Difference Viewer Options 260
Comparing Schemas 260
Compare Schemas 260
Compare Schemas - Schemas Tab 260
Compare Schemas - Options Tab 262
Compare Schemas - Object Set Tab 263
Compare Schemas - Results 264
For example: 264
Compare Schemas - Sync Script 266
Sync Script toolbar 266
Scheduling Compare Schemas as a Windows Task 267
Controlling Sessions 268
Select Session 268
End Connections 268
Test Connections 268
Configure User Lists 268
Session Information 269
Change Password 270
Commit & Rollback 270
Transaction Processing with Auto-commit 270
Connect and Disconnect 271
DBMS_Flashback 271
Requirements 271
Using Wall-Clock time 272
Using an SCN 272
Using Flashback 272
Toad for Oracle User Guide
Table of Contents
12
Diagnosing Problems 273
View Extents 273
Identify Space Deficits 273
Log Switch Frequency Map 274
Tablespace Map 274
Quest Space Manager 276
TKProf Interface Wizard 276
Undo Advisor 278
Undo Advisor (OEM) Overview 278
Altering the Undo Tablespace 279
Altering Undo Retention 280
Switching Tablespaces 280
Segment Advisor 280
Segment Advisor (OEM) 280
Examining Objects 281
Advisor Tasks 282
Advisor Recommendations 282
LogMiner Interface 283
LogMiner Overview 283
Logminer Wizard 284
LogMiner Interface Grid 286
Health Check 287
DB Health Check 287
DB Health Check - Checks and Options 288
DB Health Check - Check Descriptions 289
DB Health Check - Schemas 309
Health Check - Differences Since Last Run 309
DB Health Check - Email Results 311
Toad for Oracle User Guide
Table of Contents
13
DB Health Check - Saving Results 311
Trace File Browser 312
Trace File Browser 312
General Functionality 313
Statement Details 314
Wait Summary 315
Query Summary tab 316
File Header 316
CodeXpert 317
CodeXpert Overview 317
CodeXpert Icon Legend 318
CodeXpert Toolbars 318
Code Xpert Options 319
Prompt for CodeXpert Run names 320
Use Central Repository for DB Inserts 320
Scanning tab 320
SQL Classification Options tab 320
Running CodeXpert 321
Working with Results 322
Additional Information 322
Configuring RuleSets 327
Left Pane 328
Right Panel 328
Rules Tab 328
Summary Tab 328
RuleSet Toolbar 328
Rules Tab Toolbar 329
Summary Tab Toolbar 330
Toad for Oracle User Guide
Table of Contents
14
Creating a RuleSet 330
Create Ruleset Wizard 331
RuleSet Properties 331
SQL Scanning 332
SQL Conversion Overview 333
Indicator Conversion 333
INDICATOR keyword found in an INTO clause 333
Original SQL statement 334
After conversion 334
TWO Variables found in the INTO clause without a separator 334
Original SQL statement 334
After conversion 334
External Parameter Conversion 335
Original SQL statement 335
After conversion 335
PL/SQL Conversion 335
Original SQL statement 335
After conversion 335
Date Conversion 335
Example 1 336
Original 336
Conversion 336
Example 2 336
Original 336
Conversion 336
Example 3 336
Original 336
Conversion 336
COBOL Conversion 337
Toad for Oracle User Guide
Table of Contents
15
Conversion for variable name 337
Conversion for comment 337
Conversion for concatenate character 337
For example: 337
Local Variable Conversion 337
For example: 338
Scanning tab 338
Skip SQL within comments 338
Skip SQL that only involves the SYS.DUAL table 338
Ignore duplicate SQL statements 339
Whole word matching for the first SQL keyword 339
Maximum scanned word size (Bytes) 339
SQL Classification Tab 339
Simple SQL 339
Number of table scan operations less than 339
Complex SQL 340
Number of table scan operations 340
Including SYS.DUAL table 340
With Full Index Scan 340
Problematic SQL 340
Number of table scan operations greater than 340
With full table scan 340
With full table scan iterated by nested loop 341
Retrieve table size by counting: SYS.DBA_SEGMENTS 341
Retrieve table size by counting: System tables 341
Applying the Classification Options 342
Full Table Scan Threshold 342
Default values 342
Calculating Table Size 342
Toad for Oracle User Guide
Table of Contents
16
Example Determining the Full Table Scan threshold using SYS.DBA_
SEGMENTS 343
Database Administration 344
Audit SQL/Sys Privs 344
Audit SQL/Sys Privileges Toolbar 344
NLS Parameters 345
Toad Features Security 345
Disable Saving Oracle Passwords by Toad 348
Read-only 348
ASM Manager 348
ASM Manager Overview 348
Viewing Disk Groups 349
Disk Group Toolbar 350
Files, Directories and Aliases toolbar 350
Creating Disk Groups 351
Dropping Disk Groups 352
Altering Disk Groups 352
Viewing Clients 353
Audit Objects 354
Audit Objects 354
Setting an Object Audit 355
Multiple Object Privileges 355
Multiple Object Privileges 355
Granting Multiple Privileges 356
Revoking Multiple Privileges 356
Oracle Parameters 357
Oracle Parameters 357
Viewing Parameter Strings 358
Toad for Oracle User Guide
Table of Contents
17
Changing a Parameter String 359
Tablespaces 359
View Tablespaces 359
Tablespace Details 361
Space Manager 362
Setting up Space Manager 362
Graph Usage 365
Forecast Usage 366
Zoom 366
Print Graph 366
Zoom 367
Redo Log Manager 367
Redo Log Manager 367
Balancing Redo Log Groups 369
Importing and Exporting Data 370
Data Pump 370
Data Pump Overview 370
Data Pump Job Manager Overview 371
Setting up an Import/Export Directory 372
Remapping Schemas, Tablespaces, and Datafiles 372
Filtering Data with Queries 373
Using the Metadata Filter Grid 374
Import Wizard 375
Export Wizard 385
Export Dataset 390
Export Dataset 390
File Formats and Options 391
Commit Intervals 394
Toad for Oracle User Guide
Table of Contents
18
Export DDL 396
Export DDL 396
Select Objects to Export as DDL 396
Export as DDL Output 396
Export DDL Script Options 397
Create and Drop 398
Schema name 398
Drop statement 398
Use purge option for tables 398
Related Objects 398
Formatting 398
Tables 399
Indexes 399
Online 399
Compute Statistics 399
No parse 399
Force 399
Use interval expression for next date 400
Indexes 400
Format 400
Materialized view comments 400
Column Comments 400
Extract both spec and body when only one is selected in objects grid 400
Always keep spec and body in the same file or editor tab 400
Queues 400
Grants to the role 401
Start with minval 401
General options 401
Explicitly specify NULL in table DDL 401
Toad for Oracle User Guide
Table of Contents
19
Rebuild FK's referencing selected tables 401
Insert statements 401
Table comments 401
Column comments 401
Constraints 401
List constraints after columns 402
Individual "Alter Table" commands 402
Single "Alter Table" command 402
Other Related Objects 402
Parse triggers for schema name 402
Export File Browser 403
Export File Browser Toolbar 403
Viewing an Export File 404
Finding Information in an Export File 404
Reading the Treeview 405
Open Export File Window 405
DB Compare Mode 406
Troubleshooting 407
DDL Operations 408
General Export 409
Export Table as Flat File 409
Export Utility Wizard 410
Data Subset Wizard 411
General Import 416
Import Table Data 416
Import Utility Wizard 419
SQL*Loader Wizard 420
Troubleshooting 420
Toad for Oracle User Guide
Table of Contents
20
Using the SQL*Loader wizard 420
"Command Line" options 422
Skip 422
Load 422
Errors 422
Rows 422
Read size 422
Bind size 423
Stream Size 423
Resumable timeout 423
Resumable name 423
Column array rows 423
Direct 423
Parallel 423
Resumable 423
Multithreading 423
Skip index maintenance 423
Silent 423
Implements all of the keywords. Skip unusable indexes 424
Load Statement 424
Database redo Log 424
Load Type 424
Load Method 424
Length 424
Byte order 424
Byte order mark 424
Character set 424
Read buffers 424
Preserve blanks 424
Toad for Oracle User Guide
Table of Contents
21
Combine Physical Records Area 425
Field Delimiters 425
By Field 425
Preview Fields 426
Generate Database Script 427
Generate Database Script 427
Scheduling a Database Script as a Windows task 428
Generate Schema Script 429
Generate Schema Script 429
Object Listing Tab 431
Scheduling a Schema Script as a Windows Task 432
Managing Projects 433
Using Automation Designer to Control Toad 433
About the Automation Designer 433
Using the Automation Designer to Schedule Actions and Apps. 435
Scheduling from a Toad Window 436
Using Actions 437
Creating a new action from a Toad window 437
Creating a new action from the Automation Designer 437
Setting the number of actions saved in the vault 438
Clearing the Action Recall Node 438
Example 439
Running Actions with Parameter Files 440
Sending Actions by email 440
Receiving Actions by email 441
Action Catalog 441
Import Export 441
DB Misc 441
Toad for Oracle User Guide
Table of Contents
22
Utilities 442
File Management 442
Control 442
Import Table Data Action 443
Export DDL Action 443
Export Dataset Action 443
Dataset 443
ANSI Join Syntax 444
Actionable Query 444
Restrictions/Validations 445
Execute Script 445
Script Source 445
File list 445
Text 446
Output 446
Directory 446
DB Health Check Action 446
HTML Schema Doc Generator Action 446
Object Search Action 447
Compare Schemas Action 447
Email Action 447
Email properties 447
Recipients 447
From 448
Append Clipboard Contents 448
SMTP Server and Port 448
Execute Shell Action 448
Properties 448
Parameters 448
Toad for Oracle User Guide
Table of Contents
23
Macros 448
Archive Action 449
Properties 449
Zip tab 449
Unzip tab 449
FTP Action 449
Ping Action 450
TNS Ping Action 450
Service Action 451
Format Files Action 451
Create Directory Action 451
Delete Directory Action 452
Move Directory Action 453
Tips 453
Create File Action 453
Delete File Action 454
Move File Action 455
Tips 455
Copy File Action 455
File Exists Action 456
If...Then...Else Action 457
Repeat...Until Action 457
Example 458
While...Do Action 459
Example 460
Test Variable Action 461
Example 461
Set Variable Action 461
Variable Support 461
Toad for Oracle User Guide
Table of Contents
24
Example 462
Variable Prompt Action 462
Message Action 462
Variable Support 462
Example 462
Pause Action 463
Example 463
File Iterator Action 463
Variable Support 464
Example 464
Folder Iterator Action 465
Variable Support 465
Example 465
List Iterator Action 467
Variables 467
Example 468
Log Comment 469
ToadApps 469
Between ToadApps 470
Within a ToadApp 470
Linking apps 471
Project Manager 472
Project Manager Overview 472
Project Manager Toolbar 474
Removing Dead Links 475
Configuring the Project Manager 476
Reset all Defaults 476
Use Defaults 476
Editor file load options 476
Toad for Oracle User Guide
Table of Contents
25
Reload into existing window 476
Load into new window 477
Navigate to previous invocation 477
Prompt each time 477
Export Options 477
Compress export file (.zip) 477
Watch progress 477
FTP server passwords 477
Save encrypted passwords 477
To-Do 477
Past due color drop down 477
Server side compression 478
Utility for 'compress' action 478
Web Browser 478
Filename 478
Browse 478
Find default 478
Dragging and Dropping 478
Prompt if multiple actions are available 478
Use user setting 478
Refresh folder links 478
Include subdirectories 478
Refresh after changing properties 479
Prompt before rebuilding 479
Shell for remote file execution 479
Tree 479
Font 479
SmartExpand 479
Property Descriptions 480
Toad for Oracle User Guide
Table of Contents
26
Title 480
Program 480
Working dir 480
Parameters 480
Extensions 480
Run 480
Icon 481
Resetting Defaults 482
Working with the Project Manager 482
Drag-and-Drop 484
Double-Click 484
Right-click Menu 484
Connection Panel 487
Project Nodes 489
Schema Nodes 491
Adding 491
Right-click 491
Note Property 492
Folders 497
FTP Folder Actions 499
Add FTP Folder Items 499
To Do Lists 500
Query Viewer 501
Query Viewer 501
Finding Queries in Context 501
Query Viewer Filters 502
Using the Query Viewer 502
SQL Command Recall 503
Toad for Oracle User Guide
Table of Contents
27
SQL Statement Recall (History - F8) 503
SQL Statement Recall (Personal) 503
SQL Statement Recall (Named) 503
Script Manager 503
Script Manager Overview 503
Connections grid 504
Scripts 504
Output 504
Messages 504
Opening Script Manager 504
From File Menu 504
Scripts Provided with Toad 505
DBA Scripts 505
Oracle 8i Data Dictionary scripts 505
Script Manager Toolbar 505
Managing Script Datafiles 506
Appropriate Script Datafile names 506
Manage Script Entries 508
Reorder Grid 508
Print Grid 508
Execute Scripts 512
Execute the Scripts 513
Output 514
Messages Tab 515
Output tab 515
Quick Scripts 515
Monitoring 517
Toad Server Statistics 517
Toad for Oracle User Guide
Table of Contents
28
Analysis 517
Waits 517
Latches 517
Sessions 517
Instance Summary 517
Monitor 518
SQL Monitor 518
Toad UNIX Monitor 518
Requirements 519
Troubleshooting 519
Refresh rate 519
Zoom 520
Connecting 520
Viewing Graph History 520
ADDM/AWR 520
ADDM/AWR (OEM) 520
AWR Browser (OEM)Overview 521
Snapshot List Area 522
Chart List Area 522
Chart Display 522
Advice Display 522
Generating an ADDM Report 523
Working with ADDM Reports 523
Generating an AWR Report 524
Generating an AWR SQL Report 524
Generating an AWR Diff Report 525
Generating an ASH Report 526
Data Select Dialog 526
Toad for Oracle User Guide
Table of Contents
29
Snapshot Management 527
Collection Settings 527
Snapshot Interval 527
Retention 527
Top N SQL 527
Snapshots 528
Baseline Management 530
Viewing Baseline Template Information 531
Creating New Templates 531
Dropping a Baseline Template 532
Database Browser 532
Database Browser 532
Database Nodes 533
Database Objects nodes 533
Database Browser Toolbar 534
Database Monitor 535
Toad Database Monitor 535
Zoom 536
Database Monitor Toolbar 536
Database Monitor Email Alerts 537
Flushing the SGA or Buffer Cache 537
Database Monitor Options 538
Database Probe 538
Database Probe Overview 538
Database Probe Toolbar & Status Bar 540
Database Probe Settings 540
Refreshes 541
Gauges 541
Toad for Oracle User Guide
Table of Contents
30
Active Alert Count 541
Tested 542
Fired 542
Extinguished 542
Alert Map 542
Adding and Editing Alerts 542
Name 542
Active 543
Alert position 543
Description 543
Refreshes before computing 543
Expression Builder 543
Index Monitoring 544
Index Monitoring 544
Activating Index Monitoring 545
Deactivating Index Monitoring 545
Instance Manager 546
Instance Manager 546
Instance Manager - Status Tab 547
Instance Manager Startup 548
Instance Manager - Shutdown 550
Instance Manager - Alter 551
Session Browser 551
Session Browser Overview 551
Session Browser Toolbar 552
Flip the Session Browser Layout 552
Viewing Sessions 553
Filtering Sessions 554
Toad for Oracle User Guide
Table of Contents
31
User Defined Filters 554
Static Filters 554
User Defined Filters 554
Left Side Panel 554
Minimum version 555
Right Side Panel 555
Adding a User Defined Filter 555
Features of the Add Filter dialog box 555
Expression box 555
Columns 555
Lookup 556
Editing a User Defined Filter 556
Deleting a User Defined Filter 557
Static Filters 557
Exclude NULL 557
Exclude slaves 557
Viewing Information 558
Selecting Columns to Display 558
Calculated V$SESSION column 558
Viewing Sessions Detail Information 559
Session Details 559
Single Record View 559
Multi Record View 559
Process Details 559
Single Record View 560
Multi Record View 560
IO Details Tab 560
Single Record View 560
Multi Record View 560
Toad for Oracle User Guide
Table of Contents
32
Waits Details 561
Current Statement Details 561
Current Statement toolbar 561
Open Cursors Details 562
Access Details 562
Locks Details 562
Types of Locks 562
RBS Usage Details 563
Long Ops Details 563
Percent Column Calculation 563
Statistics Details 564
Types of Locks 564
User Locks 564
System Locks 565
Changing the View 565
Advice 565
Performing Actions on Sessions 566
Queries Used to Kill Sessions 566
SGA Trace/Optimization 567
SGA Trace/Optimization 567
Execution Stats 568
SQL Shared Pool 568
SGA Trace Toolbar 569
SGA Trace Explain Plan Options 569
Always set session to statement user 570
Use connected user/schema 570
Always set session to statement user 570
Use connected user/schema 570
Toad for Oracle User Guide
Table of Contents
33
StatsPack Browser 571
StatsPack Browser Overview 571
Snapshot List Area 571
Chart List Area 571
Chart Display 572
Working with Snapshots 572
Statspack Snapshots Toolbar 572
Selecting Groups of Snapshots 573
Viewing advice for snapshot intervals 573
Working with Charts and Datagrids 575
Configuring the viewing area 576
Viewing Series within Charts 576
Synchronizing Wait Times Charts 577
Refreshing the viewing area 577
Top Session Finder 579
Top Session Finder 579
Single Parameter Mode 579
Multiple Parameter Select Mode 580
Top Session Finder toolbar 580
Top Session Finder - Options 581
Short Parameter List 581
Exclude Inactive Sessions 581
Exclude Sessions Inactive for the past ___ Minutes 581
Limit Pie Chart to top ___ sessions 581
Top Session Finder - Viewing Data 581
Dataset tab 581
Right-click options 582
Pie Chart tab 582
Toad for Oracle User Guide
Table of Contents
34
Right-click options 582
Finding a Specific Session 583
Optimizing (Tuning) 584
DBMS_REDEFINITION Wizard 584
Estimate Index Size 585
Load and Scan Indexes 585
Using the Grid 586
Saving the grid 586
Estimate Table Size 586
Load and Scan Tables 587
Using the Grid 587
Estimating Index Size 588
Saving the grid 588
Explain Plan 588
Pinned Code 589
Flushing the SGA Cache 589
Refreshing the SGA Cache view 590
Repair Chained Rows 590
Analyze tab 590
Data tab 590
Repair tab 591
Results tab 591
Rebuild Table 591
Unix Kernel Parms 592
Options 592
Calculate 593
Windows Registry Parms 593
Reading Registries 594
Toad for Oracle User Guide
Table of Contents
35
Updating Registries 594
Registry Export Files 594
Analyze All Objects 594
Analyze All Objects 594
Analyze Options 596
DBMS_STATS functions 596
Profilers 597
Profilers 597
Profiler Analysis 598
Opening a run 598
Opening a unit 598
Toggle PL/SQL Profiling 599
Editor Profiler Tab 600
Editor Profiler Nodes 600
Editor Profiler Tab Toolbar 602
Profiler Filters 602
Line Item Profiler 602
Using DBMS_PROFILER 602
DBMS_PROFILER Session 603
Collected Data 603
Using DBMS_PROFILER with the Java debugger 603
The SYS.DBMS_PROFILER package 604
Install Profiler Server Side Objects 604
Anonymous Blocks and Lines Not Executed 605
Hierarchical Profiler 605
The DBMS_HPROF package 605
Install Profiler Server Side Objects 605
Parameters 607
Toad for Oracle User Guide
Table of Contents
36
Oracle Tuning 608
Oracle Tuning Advisor (OEM) Overview 608
Creating Oracle Tuning Tasks 609
Viewing Oracle Tuning Tasks 609
Quest SQL Optimizer 610
Quest SQL Optimizer Overview 610
Tuning Lab-SQL Optimizer 611
Tuning Lab-Find Best SQL Alternative 611
Tuning Lab-Deploy Outline 611
Tuning Lab-Index Expert 612
Tuning Lab-Find Best Index Alternative 612
Tuning Lab-Best Practices 612
Test for Scalability 612
Rebuild Multiple Objects 612
Rebuild Multiple Objects Overview 612
Email Notification - Rebuild Multiple Objects 613
Rebuilding Indexes 614
Rebuild Recommended Indexes 614
Create Script to Rebuild Recommended Indexes 615
Rebuild Checked Indexes 615
Create Script to Rebuild Checked Indexes 615
Rebuilding Tables 615
Load My... 615
Load... Like 616
Load by User 616
Load by Tablespace 616
Reload 617
Clear Selected Rows 617
Toad for Oracle User Guide
Table of Contents
37
Clear Entire List 617
Thresholds and Performance Options 617
Height > 618
? Deleted Rows > 618
% Storage used < and % Storage used > 618
Setting Conditional Thresholds 618
Size is greater than 618
# Extents is greater than 619
Using Conditional Thresholds 619
Tables and Indexes 619
Use Online option 619
Parallel 619
Refresh Index Data 619
Indexes Only 619
Nologging 619
Alter indexes to logging after rebuild 620
Change Sort Area Size for this session to: 620
After Rebuilds, change sort area size to: 620
Change Extent Sizes 620
Tablespaces 621
Options 622
Formatting Options 622
Changes in the Formatter 622
Toad Options 623
Toad Options 623
Searching Options 623
Data Grids - Data 624
Use Read-Only Queries 624
Toad for Oracle User Guide
Table of Contents
38
Confirm record deletions 625
Warn of cascading constraints on deletions 625
Preview CLOB and LONG data 625
Deferred LOB read 625
Stop data fetches when available memory becomes less than n MB 625
Show ROWID in editable grids 625
Trim string data in CHAR and NCHAR columns 625
Display large numbers in Scientific Notation 626
Date format: (dropdown list) 626
Time format: (dropdown list) 626
Sliding window for entering two digit years 626
Data Grids - Visual 627
Tabs 627
Tab Through 627
Row Select 627
Multi Select 627
Immediate Edit 628
Confirm sorts when clicking on column header 628
Size to header 628
Size to data 628
Allow columns narrower than header width 628
Allow columns wider than grid width 628
Preview column height n 629
Show Focus Rectangle 629
Show grid selection 629
Show grid lines 629
Grid line width n 629
Show row numbers 629
Use grid border color 629
Toad for Oracle User Guide
Table of Contents
39
Show Group Summaries 630
Null columns 630
Data font 630
Data Background 630
Header font 630
Header Background 630
Preview Column font 630
Data Types 630
Cache Object Type list per Connection 631
DBA 631
Delete 632
Show segment names on grid hint 632
Remember legend window state 632
Remember segments window state 633
Remember filters window state 633
Debugger Options 633
DBMS 634
JDWP 635
Script 635
Default Buffer size 635
Editor - Behavior 636
Apply commit/rollback to all tabs (threaded queries) 636
Auto Indent 636
Backspace unindent 636
Backup editor every n minutes 637
Block select 637
Clear grid on editor clear 637
Collapse empty lines 637
Confirm Clear All Text 637
Toad for Oracle User Guide
Table of Contents
40
Copy text in rich text format 637
Cursor beyond end of line 637
Double click line select 638
Enable code folding 638
Find text at cursor 638
Group redo/undo 638
Hide cursor when typing 638
Preload objects on "Load Object from DB" window 638
Scroll past last line 638
Treat underscore char as a word character 639
Use lower case object names from select windows 639
Use single Editor instance for PL/SQL if possible 639
Word wrap 639
Word break on right margin 639
Mode 640
Tab Stops 640
Block indent 640
Optimal fill 640
Code Templates 640
Syntax Highlighting 640
Editor - Code Assist 641
Cache Code Insight results 641
Ctrl+Click jumps to PLSQL objects 641
Jump to package and type body 641
CTRL+Click describes objects 642
Show object types as text in pick list 642
Display parameter hints after typing open parenthesis 642
Display pick list after typing object name followed by a period 642
Sort pick list alphabetically 642
Toad for Oracle User Guide
Table of Contents
41
Delay popups ... milliseconds 642
Save only valid statements 642
Show only statements for the active session 642
Write statements to disk prior to execution 643
Statements to save: 643
MakeCode format list 643
Creating and Editing MakeCode languages 643
MakeCode Variable Name 644
Select Statement based on cursor position 644
Strip Code copies to clipboard 644
Editor - Display 644
Highlight execution line when not debugging 644
Lock results tab 644
Persist display of execution time 645
Persist dynamic highlighting when not focused 645
Persist selection when not focused 645
Persist selection when using navigation keys 645
Show word wrap indicator 645
Show control characters 646
Show current line focus rectangle 646
Show executable line indicators in gutter 646
Show line numbers 646
Show results tab toolbars 646
Use multi-line editor tabs 646
Highlight table names 647
Highlight view names 647
Highlight stored procedure names 647
Use when printing 647
Editor 647
Toad for Oracle User Guide
Table of Contents
42
Line number 647
Gutter and Margin 647
Visible gutter width: 647
Visible right margin position: 647
Editor - Open/Save Options 648
Automatically split files when multiple objects separated by "/" 648
Prompt to split files 648
Never split files 648
Automatically combine spec/body when saving object to file 649
Prompt to combine spec/body 649
Never combine spec/body 649
Prompt for reload on activation if timestamp has changed 650
Prompt to save on editor close 650
Format files when opened 650
Owner Name 650
Packages/Types 650
Editor - Printing 651
Word wrap 651
Hide collapsed 651
Transparent 651
Colors 651
Line Numbers 651
Email Settings 652
Executables 654
Execute/Compile 654
Poll for DBMS Output when detected 654
Prompt for substitution variables 655
Always open Parameters window 655
Save proc parameters between sessions 655
Toad for Oracle User Guide
Table of Contents
43
Save profiler Settings between sessions 655
Use hierarchical profiler on Oracle 11g and newer 655
Allow compiling when source is loaded from database 655
Compile Spec and Body as pair (Package or User Type) 656
Default to "Compile with Debug" 656
Use "CREATE" instead of "CREATE OR REPLACE" when loading database
objects 656
Notification when compile process is complete 656
Set optimizing compiler value (10g only) 656
Set Modified Flag off after compiling from database 656
glogin.sql 657
login.sql 657
Execute login scripts 657
Restore SET defaults prior to script execution 657
Limit results to 658
Warn when available memory becomes less than n MB 658
Show Script Grids 658
Maintain Script History 658
Show Script Start/End times 658
Font 658
Error Font 658
Files - General 658
Files - Open/Save Dialogs 660
Sort Alphabetically 660
Options - General 661
Log File 662
Number of errors to log 662
Network Utilities 662
Font 663
Toad for Oracle User Guide
Table of Contents
44
Background Color 663
Oracle - General 664
Save passwords for all Oracle connections 664
Remember passwords for Oracle reconnects 664
Windows style (convert all newlines to CR/LF) 664
Unix style (convert all newlines to LF) 665
Schema 665
Table 665
Save previous Explain Plan results (requires Toad tables) 665
Schema/Table boxes 665
DBMS Buffer Size 665
DBMS Output Font 666
Default schema for connections to: current connection 666
Default schema for connections to: current schema@current connection 666
Used in 666
CR/LF Example 667
Oracle Optimizer Hints 668
All Others 668
Oracle - Transactions 669
Commit 670
Rollback 670
Prompt For Commit/Rollback when changes detected, or detection is not
possible due to lack of privileges on dbms_transaction 670
Proc Templates 670
Query Builder 671
Automatic AutoJoin 671
Include schema in generated SQL 672
Automatically Select All Columns 672
Allow Cartesian Joins 672
Toad for Oracle User Guide
Table of Contents
45
Use ANSI Syntax 672
Open full screen from Schema Browser 672
Limit visible columns to n when adding tables to the model area 672
Object Font 673
RMAN Templates 673
Schema Browser - Data 674
Save layouts 674
Set focus to table data grid after selecting table 674
Highlight columns populated by sequence/trigger pair 674
Enable value lookup for foreign key constraints 674
Use NOPARALLEL hint 675
Don't select BLOB/CLOB fields in data grids 675
Warn after n fetches (n records) 675
Fetch 25 rows at a time through db links 675
Schema Browser - Left Hand Side 675
After an object is created 675
After an object is altered 675
Limit to nn Items 676
Restore History on connection 676
Show All Users 676
Only Show Users That Own Objects 676
Only show users that own objects excluding Synonyms 676
Only show users that own objects excluding Synonyms and Temporary Tables
676
Save Filters for object lists 676
Show Filter dialog before refreshing 677
Items separated by commas 677
One item per line 677
Toolbars above object lists 677
Toad for Oracle User Guide
Table of Contents
46
Tab/Drop-Down Icons 677
Item Hints 677
Font & Color 677
Schema Browser - Right Hand Side 678
Sort package procedures 678
Show Body when Package Name is Selected 678
Omit SYSobjects from Procedure Dependencies List 678
Compile Mode 678
List primary key columns 679
Include hidden columns 679
Show Column length info with Column data type 679
Allow extra lines for column comments 679
Show Create/Alter dates 679
Update RHS on database object selection in LHS 679
Only show top-level grants for Users, Roles, Sys Privs, and Resource Groups
tabs 679
Items separated by commas 680
One item per line 680
Schema Browser - Types Tab 680
Source Control Options 682
Source Control Provider 682
Prompt for Check Out comment 682
Prompt for Check In comment 682
Prompt for Add File comment 682
Disable login prompt on connection 682
Automatic Check-Out 682
Automatic Check-In 683
Prompt for Check Out Comment 683
Prompt for Check In Comment 683
Toad for Oracle User Guide
Table of Contents
47
Prompt for Check In All on Exit 683
Schema Replacement for Stored Code, Triggers and Views 683
Enable Actions in Schema Browser & Project Manager 683
Simultaneously Check Out/In Spec and Body 683
Default: Force New Revision on Check-In 683
Default Working Directory 684
VCS Provider Options 684
Startup 684
Toolbars/Menus 685
Auto-save current desktop 685
Show window titles on Window Bar 685
Show connect strings on Window Bar 685
Use Vertical Text when Toolbars are Vertical 686
Multi-Line Window Bar 686
Multi-Line Connection Bar 686
Quick connect/disconnect dropdown count 686
Connection Bar and Window Bar Fonts 686
Visual Style 686
Toolbars/Menus - Shortcuts 686
Variables 687
Windows 687
Auto-open bring to front 687
Describe windows 687
Scroll pinned windows at n millisecs 688
Show USER@DATABASE in captions 688
Use Alias instead of database (set in login window) 688
Show spec and body in package describes 688
Language Management 688
Language Management Overview 688
Toad for Oracle User Guide
Table of Contents
48
Syntax Highlighting 690
General tab 692
Highlighting tab 692
Style type 693
Background 693
Font color 693
Capitalization effect 693
Custom Font 693
Font Style 693
Borders 693
Tokens Tab 693
Parser Tab 694
Regular expression test 694
Evaluates to token type 694
Default Highlighting style 694
Parent block 695
Enabled from character position: _____ to ______ 695
Rules Tab 695
Rule type 696
Change token type 696
Style 696
Range Highlighting 696
Collapsed text string 696
Active Highlighting 697
Draw block staple 697
Self Closing Range 697
Parent block 697
Gramma 698
Range Offset 698
Toad for Oracle User Guide
Table of Contents
49
Cancel next rules 698
Relative to end of condition 698
Sub Languages Tab 698
Code Templates Tab 699
Grammar 700
Code Completion Templates 700
Auto Replace Substitutions 702
Export 703
Import 703
Printing 705
Printing 705
Printing editor contents 705
Printing a Data Grid 705
Print Grid 705
Report Link Designer 706
Using the ReportLink Designer 706
Title Properties 706
Colors tab 707
Fonts tab 707
Behaviors tab 707
Miscellaneous tab 707
Reporting 708
Toad Control Files 708
Dependencies 709
ER Diagrams 709
ER Diagram 709
ER Diagram Toolbar 710
Creating an ER Diagram 711
Toad for Oracle User Guide
Table of Contents
50
Reading the ER Diagram 712
Navigating the Diagram 713
Model tab 713
Workspace tab 713
Workspaces 714
Integration with Toad Data Modeler 714
Workspace Format 715
Explain Plans 716
Explain Plan Overview 716
Execute Explain Plan on SQL Statements 717
Explain Plan Results 717
Object Usage 718
Printing and Copying Explain Plans 719
Viewing Previous Explain Plan Results 719
Saving Explain Plans 719
Comparing Explain Plans 720
Code Road Map 721
Road Map Overview 721
Code Road Map Toolbar 721
Choosing Code to Model 722
Display Options 723
Reading the Code Model 723
Working with the graphic model 724
Saving a Text Model 725
Copying the Code Model 725
HTML Schema Doc Generator 726
HTML Schema Doc Generator 726
Scheduling Schema Doc Generation as a Windows Task 728
Toad for Oracle User Guide
Table of Contents
51
Master/Detail Browser 728
Master/Detail Browser 728
Master/Detail Browser Toolbar 729
Generating XML Output 730
Selecting the Master Object 731
Adding Detail Datasets 731
Defining a Master/Detail Relationship 732
Reports Manager 733
Reports Manager Overview 733
Reports Manager Toolbar 734
Creating a Report 735
Example Query for RefCursor Output 735
Queries 736
Parameters 736
Value (Literal) 736
Value (Expression) 736
String Parameter 737
Table List Parameter 737
Other Parameter Types 737
Creating a Master/Detail Dataset 737
Copying a Report 738
Adding Run Info Data to a Report 738
Changing a Report's Category 738
Importing/Exporting Reports 739
Scheduling a report as a Windows Task 740
Reporting from Data Grids 740
Report 740
Printing or Exporting Reports Manually from the Command Line 740
Toad for Oracle User Guide
Table of Contents
52
One Parameter 741
Multiple Parameters 742
Report Builder Wizard 742
Spool SQL 744
Spool SQL 744
Utilities 745
Archive 745
Wrap Code 745
Troubleshooting 746
Service Manager 746
Adding Services 746
Removing Services 747
Refresh 747
Starting and Stopping Services 747
External tools 747
Configure Toad Tools 747
Execute Toad Tools 750
FTP 750
Server Settings 750
FTP 752
Rename File 755
Java Manager 755
Java Manager Overview 755
Load Objects 755
Create public synonym 756
Resolve 756
Definer 756
Force loading of classes whether or not they were previously loaded 756
Toad for Oracle User Guide
Table of Contents
53
Resolver 756
Encoding 757
Schema 757
Grant access to other users 757
Drop Java Objects 757
Drop synonym 758
Encoding 758
Schema 758
Network Utilities 758
Network Utilities 758
Telnet 759
RExec 759
Ping 760
TNS Ping 760
IP Addresses 761
SSH 761
Task Scheduler 762
Task Scheduler 762
Add Task Wizard 763
Viewing Task Properties 763
Scheduling a Task 764
Unix Job Scheduler 764
Unix Scheduler Overview 764
Scheduling and Deploying Tasks 766
Adding a Server 766
Adding a SID 766
Assigning New Tasks 768
Setting Task Properties 770
Toad for Oracle User Guide
Table of Contents
54
Scheduling Tasks 771
Pre-defined Schedules 772
Options for scheduling 772
Basic Entries 772
Additional Customization 773
Adding Additional Schedules 773
Setting Parameter Information 774
Checking Required Elements 774
Advanced Features 775
Saving the Task File 775
Header 776
Using the Logging Facility 777
Fetching the Log File List 777
Viewing Log Files 778
Deleting Log Files 778
Viewing the Crontab File 778
Starting and Stopping the Cron program 778
Source Control and Team Coding 779
Support for Version Control Products 779
Team Coding 779
Third Party File Based Source Control 779
Notes 780
CVS Support 780
Third Party File Based Source Control 780
Third Party File Based Source Control 780
Source Control Toolbar 782
Running Source Control 782
Team Coding 783
Toad for Oracle User Guide
Table of Contents
55
Team Coding Overview 783
Team Coding and SCC Interaction 784
Using Team Coding in SQL Navigator Environments 785
Installing and Enabling Team Coding 786
Configuration Settings 789
File Extension Options 789
General Settings 789
User Settings 789
Global Settings 789
Using Team Coding 790
Team Coding Toolbar 790
Viewing Object Status 792
Team Coding Viewer 792
Viewing Team Coding Object Status 793
Status in the Editor Status Bar or Team Coding Viewer Status Column 793
Detailed File Properties 794
Version Control 794
Checking Objects and Scripts in and out 795
Using Automatic Check-in and Automatic Check-out 795
Manually check-in or check-out 795
Entering Comments on Check in or out 796
Check In All 797
Undo Checkout 798
Freezing an Object 799
Code Control Groups Overview 799
Using Code Control Groups Example 1 - a Single Application 800
Using CCGs to map objects from multiple schemas to one VCS Project 800
Including certain types and schemas 800
Toad for Oracle User Guide
Table of Contents
56
Excluding objects 801
Scripts 801
Using Code Control Groups Example 2 - Multiple CCGs 801
Using CCGs to map objects from one schema to different VCS projects 802
Code Control Groups Toolbar 802
Enabling Code Control Groups 803
Creating a CCG 803
Viewing and Modifying CCGs 804
Specifying CCG Object Masks 804
Object Mask Ranking 805
Specifying File Server Scripts 805
Mapping a User to a CCG 806
Example of User Mapping 806
Remapping a Project Association 808
Team Coding Viewer Filter 808
VCS Use 808
Exporting Objects 808
Importing Objects 809
Version Control 810
Version Control Browser 810
TC Locks Option 811
TC Locks not selected 811
TC Locks selected 811
Browsing Version Control Archives 812
Viewing Differences Between Revisions 812
Getting the latest Revision 812
CVS Requirements 813
Setting up the Oracle Database 813
Toad for Oracle User Guide
Table of Contents
57
Configuring Toad for use with CVS under Team Coding 814
CVS Configurations Options 814
Updating Working Folders 816
Logging Into CVS 817
Multiple Connections and CVS Logins 818
Authentication Methods and the CVS Root 818
CVS Authentication Methods tested with Toad 819
Using pserver and sserver methods 819
Using local and ext methods 819
SSH Authentication Using the ext Method 819
Example SSH configuration steps: 819
Missing CVS\Entries File Error 820
Setting up your Entries file 820
Additional CVS Entries File Information 821
Setting up your Entries file 821
Working from the Command Line 822
Command Line Syntax 822
Command List 823
Examples 826
Converting Old Settings Files to Actions 827
Command Line Passwords 828
Export Tables, Views, SQL Queries from the Command Line 828
Create the Action 828
Run from the Command Prompt 829
Errors 829
Run Analyze Objects from the Command Line 829
Adjust the file 829
Commands 831
Toad for Oracle User Guide
Table of Contents
58
Run CodeXpert from the Command Line 834
Scheduling CodeXpert 835
Command Line Error Log 835
Running Actions from the Command Line 835
Command Line Syntax 835
Parameters in Command Line Syntax 836
Connections in the Command Line Syntax 836
Examples of command line syntax 838
Run Compare Databases from Command Prompt 839
Adjust the file 839
Run from the Command Prompt 841
Run Compare Schemas from a Command Prompt 842
Run Copy to another Schema from Command Prompt 842
Build the file to run Copy Data to another Schema 842
Adjust the file 842
Run from the Command Prompt 843
Run Generate Database Script from a Command Prompt 843
Adjust the file 843
Run from the Command Prompt 844
Run Generate Schema Script from Command Line 845
Adjust the file 845
Run from the Command Prompt 846
Run Rebuild Objects from the Command Prompt 846
Adjust the file 847
Backwards Compatible commands 850
Run from the Command Prompt 850
Run Reports Manager from the Command Line 851
Create the command file 851
Toad for Oracle User Guide
Table of Contents
59
Adjust the command file 852
Running the command file 852
Using Variables 853
Using Variables 853
System Variables 853
User Variables 853
Working with Code 854
Editor 854
Toad Editor 854
Configuring the Editor 855
Troubleshooting the Editor 855
Auto Backup 857
Closing an Editor tab 857
Code Snippets 857
Configuring your Desktop 858
Describe (Parse) Select Query 860
Execute as Script 860
Execute Snippet 860
Execute SQL via SQL*Plus 860
Executing SQL Scripts 861
Execute Statement 861
Extract Procedure 862
Highlight Snippet 863
Load and Execute a Script File 863
Moving Between Editor Tabs 863
Object Palette 864
Opening Files 865
Save All 866
Toad for Oracle User Guide
Table of Contents
60
Current Schema Drop down 866
Toad Insight Pick lists 866
File Management 867
Macros 868
Viewing Possible Macro Commands 869
Navigation 870
Sorting Statements 872
Sort 872
General 872
Initial Node Expansion 872
Lower-case text 872
Sort 872
Font 872
Statements 872
PL/SQL Components 873
Other configuration options 873
Editing 874
Code Statistics 875
Working with Results 877
Troubleshooting 878
Explain Plan 878
AutoTrace 878
SQL Trace (tkprof) 879
Server Statistics 879
Optimizer Mode 879
SQL Tuning 879
Various Tabs 879
Popup menu 880
Environment Tab 881
Toad for Oracle User Guide
Table of Contents
61
System Variables 881
User Variables 882
Output 882
Data Grids 882
History 882
Working with Statements and Scripts 883
Commands to execute code 884
F9 884
SHIFT+F9 884
Highlighting SQL Snippets 885
SQL*Plus Syntax - Supported 885
SQL*Plus Syntax - Ignored 888
SQL*Plus - Unsupported 888
Marking Code to Fold 889
Data Grid 890
DBMS Output 891
Aliases 891
Using Aliases 891
ALIASES.TXT file 891
Skipping Aliases 892
Tracking Aliases 892
Opening a Script 893
Variables Window 893
Strip Code Statement and Make Code Statement Functions 893
Strip Code Statement 894
Make Code Statement 894
Selecting the Code Development Tool 894
Creating Make Code Templates 895
Examples: 895
Toad for Oracle User Guide
Table of Contents
62
Quick Describe 896
Keeping Popup Describe Windows on Top 896
SQL Statement Recall 896
Saving only valid SQL statements 897
Editing Saved SQL Attributes 897
SQL Statement Recall Toolbar 897
Main Toolbar 897
SQL Filter Toolbar 898
Viewing Recalled SQL 898
Working with Recalled SQL 898
Add to Personal SQLs 899
Add to Named SQLs 899
Working with PL/SQL 900
Default Templates 900
Editing Templates 901
Auto Replace Keywords 901
KEYWORD RESULT REPLACEMENT 901
Using a package function or package procedure template from the Create
PL/SQL Object Window 902
Debugging 903
Debugger Overview 903
Compiling Dependencies with Debug Information 904
Troubleshooting the Debugger 904
Minimum Oracle Database Requirements 906
Database Version Notes 907
Debugging on a RAC 908
Starting the Debugger 908
Stopping the Debugger 909
Toggle Compiling with Debug 909
Toad for Oracle User Guide
Table of Contents
63
General Options 909
Setting Parameters 909
Debugger Output Options 910
Do not output results 910
Print to DBMS Output (char/number columns only) 910
RPAD columns to a width of N characters 911
Fetch no more than N rows per cursor 911
Load into grid from memory (strong and weak) 911
Dependencies & References 911
Preparing PL/SQL Code for Production 912
Debugging Types 912
Debugging Java 912
Troubleshooting 914
Determine that the Java debugger is selected 914
Oracle debugger hanging 914
General Limitations 914
Oracle 9iR2 Issues 914
Stepping into Code 915
Oracle 10g Issues 915
Debugger jumps over bulleted lines of code 915
Debugger gutter line execution bullets not visible 915
Directing Output to the DBMS Output window 915
Tracing into System.out.println 915
Debugging Scripts 915
Show/Hide Grid 916
Debugger Output 916
Troubleshooting 917
Enabling or Disabling DBMS Output 917
DBMS Output Specific Commands 917
Toad for Oracle User Guide
Table of Contents
64
Editing DBMS Output Content 917
Breakpoints 917
Breakpoints Window Toolbar 918
Standard Breakpoints 919
Conditional Breakpoints 919
Format of a Conditional Breakpoint 919
Supported Operators 920
Pass Count Breakpoints 920
Combining Conditional and Pass Count Breakpoints 920
Watches 922
Watches Window Toolbar 922
Configuring the Smart Watch window 923
Moving Smart Watches to the Watch panel 923
Explicit record declarations: 924
Implicit record declarations: 925
Collections Records 926
External Debugging 929
Before Initializing 930
Initializing 930
After running external application 930
Call Stacks 931
Triggers 931
INSERT 932
UPDATE 932
DELETE 932
Multiple Trigger Priorities 932
Query Builder 933
Query Builder Overview 933
Query Builder Toolbar 933
Toad for Oracle User Guide
Table of Contents
65
Quick Start 934
Model Area 935
Explain Plan 936
Query Builder Options 936
Viewing Joins 936
Populating the Where Clause 936
Populating the Having Clause 938
Creating a SubQuery 940
Reverse Engineering a Query 940
Query Report Format 941
Generated Query 941
Query Results 942
Removing columns from the Tree 942
Working with Data 943
Column Names Supported 943
Graph Properties 943
OPS$ Accounts 943
Viewing or Hiding Docked Windows 944
Hidden Docked windows 944
Viewing Source Surrounding a PL/SQL Error 945
Sample output 945
Dataset Operations 946
Dataset Operations 946
Dataset Toolbar 946
Go to Row Number 947
Get Row Count 947
Data Grids 948
Toad Grids 948
Toad for Oracle User Guide
Table of Contents
66
Sort Data in Grid 948
Export Data to Flat File 949
Customizing Grid Views 949
Troubleshooting 950
Highlighting columns populated with a trigger/sequence pair 951
Filtering Results 953
Schema Browser Filters 953
IN clause 954
Filters in the View | Toad Options | Files dialog 954
Viewing and Editing Data 955
Exporting the Dataset 956
Editing LONG and LONG RAW columns 957
Example 960
BLOB Editor Toolbar 961
DBMS Output 963
DBMS Output Window 963
Generating DBMS Output 963
Polling for DBMS Output 964
Editing the DBMS Output Display 964
Using the DBMS Output window for Debugging 964
Finding Data 965
Find in Editor 965
Find in Grid 965
Find In Files 966
Find Next, Find Previous 966
Find and Replace Text 966
Goto Line 967
Object Search 967
Toad for Oracle User Guide
Table of Contents
67
Schemas to Search 968
Search Object Names 968
Search Column Names 968
Source Search 968
Object Search DDL Script Options 968
Regular Expressions 969
Replace with Template 969
Simple Matches 969
Metacharacters 969
Example 971
Generate Test Data 972
Generating Data Overview 972
Data Generation - Options 973
Working with Database Objects 978
Schema Browser Window Overview 978
Object Pane - Left Hand Side Object Tabs 978
Details Pane - Right Hand Side Information 979
Schema Browser Options 979
Right-Click Menus 979
Auto-Refreshing the Datagrid 979
Icon Legend 980
Privileges 980
Troubleshooting 980
Schema Browser Toolbars 981
Objects Pane Toolbars 981
Details Pane Toolbars 981
Statement Processing 982
Create Objects in Another Schema 982
Toad for Oracle User Guide
Table of Contents
68
Personalizing the Schema Browser 982
Personalizing the Schema Browser 982
Changing the Browser Display 983
Configuring Browser Tabs 983
Browser Tabs Order 984
General Schema Browser Actions 985
General Schema Browser Actions 985
Adding Objects to Project Manager 986
Dropping Objects 986
Choosing Columns in Object List 987
Schema Browser: Jump to Object 987
Create Custom Queries 988
Refresh Options 989
Browser Filters 989
Schema Browser Filters 989
Loading and Applying Browser Filters 990
Saving Browser Filters 990
Edit Browser Filter Query 990
Clearing Datagrid Filters 992
Creating Default Browser Filters 992
Filtering by Project Manager file 992
Using the QuickFilter Box 993
Wildcard Characters 993
Examples of Wildcards and Sets 993
Clusters 994
Schema Browser: Clusters 994
Cluster Toolbar 994
Create and Alter Cluster 995
Toad for Oracle User Guide
Table of Contents
69
Constraints 996
Schema Browser: Constraints 996
Create and Alter Constraints 997
Renaming Constraints 998
Contexts 999
Schema Browser: Contexts 999
Database Links Toolbar 999
Create and Alter Context 1000
DB Links 1000
Schema Browser: DB Links 1000
Create and Alter Database Link 1001
Dimensions 1002
Schema Browser: Dimensions 1002
Objects Pane Toolbar 1002
Create Dimension 1003
Directories 1003
Schema Browser: Directories 1003
Directory toolbar 1004
Create and Alter Directory 1004
Favorites 1005
Favorites 1005
Flashback Archives 1006
Flashback Archives 1006
Create and Edit Flashback Archive 1007
Functions 1008
Schema Browser: Functions 1008
Indexes 1010
Schema Browser: Indexes 1010
Toad for Oracle User Guide
Table of Contents
70
Indexes Toolbar 1010
Create and Alter Index 1010
Rebuild Index 1015
Rename Index 1015
Invalid Objects 1016
Schema Browser: Invalid Objects 1016
Invalid objects toolbar 1016
Java 1017
Java 1017
Java Toolbar 1018
Publish Java to PL/SQL SQL Wizard Overview 1019
Java Types and Oracle Return Types 1019
Jobs 1020
Schema Browser: Jobs 1020
Jobs Toolbar 1020
Upper 1021
Lower 1021
Create and Alter Jobs 1022
Libraries 1023
Schema Browser: Libraries 1023
Library Toolbar 1023
Create and Alter Library 1024
Materialized Views (Snapshots) 1025
Schema Browser: Materialized Views 1025
Materialized Views Toolbar 1025
Create and Alter Materialized View 1026
Materialized View (Snapshot) Logs 1027
Schema Browser: Materialized View Logs 1027
Toad for Oracle User Guide
Table of Contents
71
Materialized View Logs Toolbar 1027
Create Materialized View Log 1028
Oracle Scheduler 1028
Schema Browser: Scheduler 1028
Jobs 1029
Objects Pane 1029
Sched:Jobs toolbar 1029
Details Pane 1030
Scheduler Chains 1031
Objects Pane 1031
Sched:Chains toolbar 1031
Details Pane 1031
Job Classes 1032
Objects Pane 1032
Sched.Jobs Classes toolbar 1032
Details Pane 1033
Programs 1033
Objects Pane 1034
Programs toolbar 1034
Details Pane 1034
Schedules 1036
Objects Pane 1036
Schedules toolbar 1036
Details Pane 1036
Windows 1037
Objects Pane 1037
Windows toolbar 1037
Details Pane 1038
Window Groups 1039
Toad for Oracle User Guide
Table of Contents
72
Objects Pane 1039
Window Groups toolbar 1039
Details Pane 1040
Packages 1040
Schema Browser: Packages 1040
Policies 1042
Schema Browser: Policies 1042
Policy Toolbar 1042
Create Policy Definition 1043
Policy Groups 1043
Schema Browser: Policy Groups 1043
Policy Toolbar 1043
Create Policy Group 1044
Procedures 1044
Schema Browser: Procedures 1044
Executing Stored Code from the Schema Browser 1046
Profiles 1046
Schema Browser: Profiles 1046
Profiles Toolbar 1046
Create and Alter Profile 1047
Queue Tables 1047
Queue Tables 1047
Queue Tables toolbar 1048
General 1048
Queues 1048
Statistics 1049
Schedules 1049
Script 1049
Toad for Oracle User Guide
Table of Contents
73
Create and Alter Queue Table 1049
Queues 1052
Schema Browser: Queues 1052
Queues toolbar 1052
Create and Alter Queue 1053
Recycle Bin 1053
Schema Browser: Recycle Bin 1053
Refresh Group Toolbar 1054
Flashback Table 1054
Purging Objects from the Recycle Bin 1054
Refresh Groups 1055
Schema Browser: Refresh Groups 1055
Refresh Group Toolbar 1055
Create and Alter Refresh Group 1056
Resource Consumer Groups 1057
Schema Browser: Resource Groups 1057
Research Consumer Group Toolbar 1058
Create and Alter Resource Consumer Group 1058
Resource Plans 1059
Schema Browser: Resource Plans 1059
Research Plan Toolbar 1059
Create and Alter Resource Plan 1060
Schedule Resource Plans 1060
Roles 1061
Schema Browser: Roles 1061
Roles Toolbar 1061
Create and Alter Role 1062
Rollback Segments 1062
Toad for Oracle User Guide
Table of Contents
74
Schema Browser: Rollback Segments 1062
Rollback toolbar 1063
Create and Alter Rollback Segment 1063
Sequences 1064
Schema Browser: Sequences 1064
Sequences Toolbar 1064
Create and Alter Sequence 1065
Synonyms 1066
Schema Browser: Synonyms 1066
Create Synonym 1066
System Privileges 1067
Schema Browser: System Privileges 1067
Sys Privs Toolbar 1067
Configure Grantees 1068
Tables 1068
Schema Browser: Tables 1068
List of Tables 1068
Tables Toolbar 1068
Tables and Columns Comments 1069
Creating DML Procedures 1070
Creating Tables 1073
Altering Tables 1074
Columns Tab 1076
Hot Keys 1076
Columns Tab 1077
Editing buttons 1077
Hot Keys 1077
External Properties 1077
Toad for Oracle User Guide
Table of Contents
75
Access Driver 1077
Access Type 1077
Default Directory 1077
Reject Limit 1077
Table Details 1078
Build a SQL statement 1079
Multiple Table Details 1079
Single Table Details 1079
Actions on Tables 1080
The Foreign Key Lookup Window 1081
Working with Data 1081
Filter and Sort 1081
Insert Records 1082
Sending Data Query to Editor 1082
Source/Dest and Options 1083
Where Clauses (optional) 1083
Saving and Loading Settings 1084
Scheduling the Copy 1084
Tablespaces 1084
Schema Browser: Tablespaces 1084
Tablespaces toolbar 1084
Create and Alter Tablespace 1085
Create and Alter Tablespace Quota 1087
Drop Tablespace 1088
Drop Datafile 1088
Datafile Definition 1088
Rename 1089
Minimize Size 1089
Autoextend 1089
Toad for Oracle User Guide
Table of Contents
76
Rename/Move Datafile 1089
Triggers 1090
Schema Browser: Triggers 1090
Triggers Toolbar 1090
Create and Alter Trigger 1091
Types 1091
Schema Browser: Types 1091
Types Toolbar 1092
Dependencies tab information 1093
Create Object Type 1093
Attributes 1094
Methods 1094
Edit Object Type 1095
Create and Alter Collection Type 1096
Users 1097
Schema Browser: Users 1097
Users Toolbar 1097
Create and Alter User 1098
Views 1099
Schema Browser: Views 1099
Views Toolbar 1099
Create and Alter View 1100
Views - Data Grids 1101
Appendix:Contact Quest 1103
Contacting Quest Support 1103
Contact Quest Software 1103
About Quest Software 1104
Index 1105
Introduction
New in This Release
In All Toad Editions
Unicode Support
l Toad now supports Unicode. For people already using Unicode-enabled databases, this
should be a seamless transition.
Note:Some Oracle features are not Unicode-enabled, or have specific Unicode
requirements to function. Please see your Oracle documentation for information about
these features.
There is an online video tutorial for this feature. This video opens a new browser window
and requires an internet connection.
l Toad Advisor now checks that NLS_LANGvalue matches client character.
l Default Encoding option added to Options | General to set default encoding for new
Editor tabs and for saving files.
l If you are an upgrading user, you will need to make the following change to your LexLib
for the Editor parser to work correctly with Unicode:
1. From the View menu, select Options.
2. Click the Editor - Behavior node.
3. Set the language dropdown to PL/SQLand then click the Edit Language button.
4. Click the Parser tab and select Any Name.
5. Add (?r) to the beginning of the "Any name" parser rule:
6. Click OK or Apply to save changes.
Actions
l AppDesigner has been renamed to Automation Designer.
l When specifying connections on the command line (toad.exe -c ), these connections will
now be used in the Actions specified afterward ( -a ), instead of the connection currently
bound to the Action.
1
Toad for Oracle User Guide
Introduction
78
l In some actions, you can also specify connections to execute against in the
Automation Designer.
l Action Parameter files
l Actions can now accept parameter files. They are in INI format. Right click on an
Action/App in Automation Designer and choose "Create Parameter file" to build
an INI file based on the current Action properties. It will create property=value
pairs for the things which can be overridden. This parameter file can then be used
in the Automation Designer ('Run with parameter file') or on the command line by
using a pipe to separate the Action/App name from the filename. For example:
toad.exe -a "App->Export Dataset1 | c:\data
files\exportDataset1.ini"
l You will know which Actions can generate/read an INI file by whether or not the
'Create parameter file' popup menu item in Automation Designer is enabled.
Here is a sample section from an INI file which shows an Execute Script Action:
[47]
Name=Execute Script1
Type=Execute Script
ItemCount=2
Item0=c:\try1.sql
Item1=c:\try2.sql
Output=1 {1=SingleFile, 2=SeparateFile, 3=Clipboard, 4=Discard}
Output Location=C:\some folder\output.txt
ConnectionCount=2
[email protected]
[email protected]
[47] is an internal identifier. "Name" and "Type" are only for your use, to find your
Action within a longer App INI file. Each Actions INI section will be unique to
that Action, and in the case of things like enumerated types, will include
explanatory notes embedded within the line itself. In this example of 'Execute
Script,' two connections are specified. This will override the bound connection of
the Action. If that line wasn't there, the bound connection would be used.
The order of precedence for which connections get used:
1. Those specified on command-line always override everything else
Toad for Oracle User Guide
Introduction
79
2. If 1 is not present, those specified in an INI file are considered next
3. Finally, the connection bound to the Action is used if none are in 1 or 2
Application Data Folders
l The default installation directory for new installs enables roaming profile support by
default. In the View | Toad Options |General | Application Data Directory, the Use
Default button now points to the user's main application data folder. The Use Local
Default button points to the user's local application data folder, which does not support
roaming profiles.
l You must restart Toad for a change in this option to become active.
Editor
l New menu item added to the main Toad Editor menu. "Split Size Horizontally" This item
will auto size the Editor so that there is equal space allocated for the edit control and the
bottom docking panels. The default shortcut is CTRL+F2. You will need to manually
add the item to the toolbar or reset your toolbar to see this if upgrading.
ERDiagram
In addition to the following information, there is an online video tutorial for this feature. This
video opens in a new browser window and requires an internet connection.
l The ER Diagram has been expanded in Toad 10. This functionality is based on, and
works with, the Toad Data Modeler. Toad's ER Diagrammer is not meant to be a
modeling tool, but it can help you visualize complicated database structures.
l You can now see the objects included referentially when you add objects using
Referential Integrity:
l In addition, you can now subdivide your diagram into multiple workspaces.
l Separate objects into categories, and color code them, and add Model information to
the diagram.
Grids
In addition to this information, there is also an online video for this feature. This video opens in
a new browser window and requires an internet connection.
l Grids are now consistent throughout Toad. Some new features include:
o
Grids now share a single popup menu.
o
Reset Grid View restores the grid to the original configuration so you can undo
any groupings, bookmarks and so on with one selection.
o
Grids can handle block selection if row select is unchecked and multi-
select is checked.
o
Grids can be grouped by a column header by dragging the header into the Group
Toad for Oracle User Guide
Introduction
80
By area at the top of the grid. This feature can be toggled on the right-click menu.
o
Grids that had special functionality now have an upper toolbar containing that
functionality, as in the Rebuild Multiple Indexes grid.
o
You can check or uncheck all boxes in a grid column by right-clicking in the
column header and selecting the appropriate option.
o
Navigator toolbars have been moved to the bottom of the grid area. If you do not
see a navigator, right-click in the grid and select Toggle Navigator.
o
Single Record View is now part of the Navigator toolbar.
o
You can bookmark one location in the grid and return to it later. Put your
cursor in the row you want to bookmark and click the bookmark button on
Navigator toolbar.
To return to the bookmark, click the Goto Bookmark button on the same toolbar.
o
Show/Hide columns with the Quick Column Customization drop down in the
upper left.
o
All customizations are remembered (column order and size, group header visibility,
and so on).
Licensing Structure
The licensing structure has been changed to support one key for all products in a Toad Edition.
If you are upgrading your version of Toad, old license keys are still supported.
Load DatabaseObject
l Load Database Object now allows incremental searching in both the schema box and the
object grid.
Profiler Analysis
l Show anonymous blocks toggle in right-click menu added. This defaults to the setting
made in the Profiler tab in the Editor.
Project Manager
l AutoConnect mirrors auto-connect property of the login record for Toad as a 2-way
mirror, rather than as an independent auto connection.
Rebuild Table
l Can rebuild tables containing LONGcolumns.
Script Manager
l Has been redesigned for improved support for multiple connections.
Search Functionality
l A quick search bar has been added to the main toolbar. From this toolbar you can:
Toad for Oracle User Guide
Introduction
81
o
Search Toad World online
o
Search Toad World and other Toad-related sites
o
Search AskToad (the Toad wiki)
o
Search Knowledge Xpert
o
Perform keyword searches against the Toad help file.
l You can enable/disable the search bar by right-clicking on the toolbar and selecting
"Online Search".
l You may need to restore the toolbar defaults to have it display initially. To do this, right-
click on the main toolbar and select Restore defaults.
Server Side Object Wizard
l Now a part of Toad instead of a separate application (required for Unicode support).
l Data Generation scripts added.
Setting Parameters
l Setting Parameters now provides lists for parameter selection, and larger editing areas for
large parameters.
Set Sequence
l Set Sequence feature replaced with an auto-increment via sequence and trigger.
1. From the Schema Browser | Tables page, right-click and select Add |
Trigger/Sequence Pair and then enter the required information:
2. Double-check the SQL created, make any required changes, and then click OK.
Once the sequence/trigger pair is set, you can highlight columns populated by it
by doing the following:
From View | Toad Options | Schema Browser - Visual, select Highlight columns
populated by sequence/trigger pair.
TNSNames Editor
An online video tutorial is also available for this feature. This video opens in a new browser
window and requires an internet connection.
l Delete host nodes in Host View mode
l Delete multiple nodes (host or service)
l Retain relative position in the tree view when nodes deleted
User Data Migration on Upgrade
A new migration tab is added to the initial startup wizard to migrate your existing application
data from a previous installation of Toad. Upon startup, Toad will attempt to detect the
application data paths of previously installed versions. If one is found, it will select the most
recent installed version and give you the option of migrating data files from that installation to
Toad for Oracle User Guide
Introduction
82
the current installation. It will also provide the option of specifying a custom location, or the
option to skip the migration and perform a clean install.
Variables
l Variables can now be added within definition filenames in several of the Compare and
Generate windows. For example %DATEFILE% and %TIMEFILE% can be used to stamp
the date and time of creation (These are included in the default filename). Other user-
defined variables may also be added.
In the Professional, Xpert, Development Suite, and DBA
Suite Editions
Code Xpert
l Command line XML output now has an additional tag called comment_count to list the
number of comments in the code being analyzed.
Data Generation
l Enhanced data generation ability can now create more realistic data. Generators were
added to create various address, geographical, personal, and business data formats. Also
included is the ability to reference a foreign field, a hard-coded value, and the ability to
enter a custom SQL statement. Straight random and Unicode data are present.
An online video tutorial is also available for this feature. This video opens in a new
browser window and requires an internet connection.
l Three generator engines are supported:
o
Internal: This will create a script with "n" INSERT statements per table
(depending on the individual table's settings). An option is also available to
commit every "x" rows.
Caution: This will create a very large SQL script, which will take longer to
execute, but does not require any packages installed on the database server.
o
DBMS_RANDOM: This will use the DBMS_RANDOM package to generate
data, and is similar to the behavior in Toad 9.7. DBMS_RANDOM will need to
be installed on the database server for this option to be available.
o
TOAD_DATAGEN: This will use a TOAD-specific package to generate data on
the server. The advantage is that this will generate a much smaller SQL script, and
will perform faster.
Note: You will need to install the TOAD_DATAGEN package through Server
Side Object Wizard in order to use this feature. This package can be installed
locally, or in the global TOAD schema.
l Using Toad 10 you can create more meaningful random data for your tables. One way of
doing this:
Toad for Oracle User Guide
Introduction
83
o
In the Schema Browser, select the tables for which you want to generate data.
o
Right-click and select Generate Data.
o
Set General options, including Data Generation Engine.
o
Click on a table or column node and set options specific for that node. All
options must be set individually, although the actual generation can be done all
at one time.
o
Click ShowSQLto check the code before running it, or click OK to generate data
immediately.
In the DB Admin Module and DBA Suite
Database Browser
l Right-click to execute a Quick Script.
Database Health Check
l Many new health check items. The Database category has been integrated into new
categories: (Config, Alert Log, Storage, and Performance). Settings has been moved to its
own tab. New health check items include:
o
List default initialization parameters
o
List non-default deprecated initialization parameters. (10g+)
o
Verify compatible matches version major.minor
o
Verify optimizer_features_enable matches version major.minor
o
Verify optmizer_index_caching >= 50 (9i+)
o
List incompatible parameters if pga_aggregate_target (10g) or memory_target
(11g) is set
o
Verify pga_aggregate_target >+10MB (10g only)
o
Verify control file count >=2
o
Verify CPUcount - - (let Oracle determine the value)
o
Verify cursor_sharing='SIMILAR' (9i+)
o
Verify cursor_space_for_time='TRUE' (pre 11g)
o
Verify db_cache_size set instead of db_block_buffers (9i+)
o
Verify buffer cache >=200MB
o
Verify Large Pool >=50MB
o
Verify objects using KEEPbuffer pool exist if db_keep_cache_size is set
o
Verify db_keep_cache_size>=50MB if objects exist which use RECYCLE
buffer pool
o
List db_nk_cache_sizes without corresponding tablespaces (9i+)
o
List tablespaces without corresponding db_nk_cache_sizes (9i+)
Toad for Oracle User Guide
Introduction
84
o
Verify db_block_size<=4K for RAC, >=4K for non-RAC
o
Verify multiblock_read_count between 4 and 16
o
Verify disk_asynch_io is TRUE (pre-11g)
o
Verify compatibility of db_writer_processes and dbwr_slaves with disk_
asynch_io setting
o
Verify dml_locks=0 or >=transactions*4
o
Verify filesystemio_options='SETALL'
o
Verify fast_start_mttr_target is set when log_checkpoint_timeout=0 (9i+)
o
Verify max_dump_file+size <=20MB
o
Verify open_cursors >=50
o
Verify query_rewrite_enabled = TRUE(9i+)
o
Verify recyclebin='OFF' (10g+)
o
Verify remote_login_password_file='SHARED'
o
Verify session_cached_cursors >=20
o
Verify sga_target>=200MBand sga_max_size same value (10g+)
o
Verify star_transformation_enabled=TRUE
o
Verify sql_trace = FALSE (pre-11g)
o
Verify timed_os_statistics = FALSE
o
Verify timed_statistics = FALSE
o
Verify trace_enabled = FALSE (9i+)
o
Verify SYS.AUD$ isn't in SYSTEM tablespace
o
Verify AWR collection interval >=30 minutes, retention <=90 days (10g
and newer)
o
List connect time, version info, and a few basic ratios
o
List datafile IOdistribution
o
List objects where number of hash partitions is not a power of two
o
List segments with<1% of extents remaining and >10 maxextents
o
List segments with >1000 extents
Database Monitor
l Alert options have been moved from the main Options window to the Database
Monitor screen.
l You can now run any action (including scripts) when a specified threshold is hit.
l You can configure the monitor to begin collecting data whenever a connection is made.
Then, when the window is opened, all data is displayed.
l Right-click the DBMonitor Tray icon to launch Spotlight for Oracle or just open the
DB Monitor.
l Wait events chart has been expanded and updated for Oracle 10g and 11g.
Toad for Oracle User Guide
Introduction
85
Instance Manager Options
l Options | Instance Manager - has now been integrated into the Instance Manager window.
For example, the grid now includes checkbox columns in each server row to select servers
to monitor or alert when down.
Introduction to Toad
Toad is a powerful application development tool built around an advanced SQL - PL/SQL editor.
Using Toad, you can build and test scripts, PL/SQL packages, procedures, triggers, and functions.
You can create and edit database tables, views, indexes, constraints, and users. The Schema
Browser and Project Manager provide quick access to database objects.
Toad comes in several bundles, each offering different functionality. For more information on the
different bundles, please see the Quest Software website or your Quest Sales Representative.
Toads Editor provides an easy and efficient way to write and test scripts and queries, and its
powerful data grids provide an easy way to view and edit Oracle data.
Each new release of Quest Software's Toad for Oracle product is designed to optimize your
abilities to develop applications for and administer to the Oracle database. If Oracle introduces a
new data item, feature, or parameter, and if the Toad for Oracle user community desires that new
element, you will likely find new functionality within this product to help you with it.
Warning! By default, Oracle installs and enables some features in the database which may
not be covered by your existing license, such as Partitioning, RAC, Advanced Workload
Repository (AWR) and Oracle Tuning Advisor to name a few. Toad for Oracle takes
advantage of these features if found installed in your database, and use of these features
(including use by Toad for Oracle) may increase your Oracle licensing fees. Being properly
licensed by Oracle is your (organization's) responsibility.
Using Toad, you can:
l View the Oracle Dictionary
l Create, browse, or alter objects
l Graphically build, execute, and tune queries
l Edit PL/SQL and profile stored procedures
l Manage your common DB tasks from one central window
l Find and fix database problems with constraints, triggers, extents, indexes,and grants
l Create code from shortcuts and templates
l Create custom code templates
l Control code access and development (with or without a third party version control
product) using Toad's cooperative source control feature.
l Create Projects to more easily manage your work
Toad for Oracle User Guide
Introduction
86
l Step through the code as it executes
l Debug PL/SQL, scripts, and Java.
DB Admin Module
The DB Admin Module adds database administration functionality to Toad. With this module
you can manage space, compare schemas, monitor database performance, create new databases,
maintain redo logs, perform health checks, and more. See "DB Admin Module" (page 86) for
more information.
DB Admin Module
The DB Admin Module is an optional module for Toad for Oracle that adds additional database
administration
Note: Some of these features are also available in the Toad Professional Edition. These features
are marked with an asterisk (*), and are noted as available in both places in their descriptions.
In addition to this list, the same list with screenshots is available on the Toadsoft website. (This
will open a new browser window and requires an internet connection.)
Show all
ADDM/AWR Report Generator
Create performance analysis reports from Oracles Automatic Workload Repository. Also manage
snapshots and baselines.
Analyze All Objects
This window is available in the base version of Toad, but when the DB Admin module is added,
statisticscan be easily exported, imported, or copied to another schema or database.
ASM Manager
Use to manage the Oracle DB file system from within the Oracle database. Create, alter, view
contents of, and drop, Disks and Disk Groups.
Audit Objects
Display the audit monitoring options for selected database objects. Quickly define auditing
options for single or multiple objects.
Audit SQL/Sys Privs
Display the audit monitoring options for SQL Statement Objects, Reserved Words and System
Privileges in the database.
AWR Browser
View Oracle AWR data in predefined or custom charts and grids. Easily observe trends between
Toad for Oracle User Guide
Introduction
87
snapshots.
Code Road Map and ER diagram
The Create Object scripts button on both of these windows is only available with the DB Admin
Module. See Code Road Map and ER Diagram.
Compare Databases
Compare Database-level objects such as tablespaces, roles, users, etc. between databases or
Database Definition Files.
Compare Schemas
The Compare Schemas screen is available in the base version of Toad, but the DB Admin
module allows you to usethe synchronization script. The DB Admin module also allows Toad
to compare a Schema Defintion File to a liveschema, or another Schema Definition File. A
Schema Definition File is a propriety, binary file, which storesthe metadata of a live schema.
Control Files
The control file contains information about the associated database that is required for the
database to be accessed by an instance, both at startup and during normal operation. A control
file's information can be modified only by Oracle; no database administrator or end-user can edit
a database's control file. This option allows you to view them.
Database Browser
Browse databases from server level all the way down to the object level. View aggregated
information about multiple databases on the same server. The Database Browser serves as an
organization tool and launch point for many tuning/troubleshooting windows within Toad.
Database Health Check
The Database Health Check performs a series of checks on a selected databaseand displays the
results. Includes a Vulnerability Assessment to help findplaces where your database could be
vulnerable to hackers. Includes a differencesreport to see what has changed since Health Check
was last run. Results can be saved to HTML and sent by email.
Database Monitor
Allows you to monitor database performance with nine charts: Logical IO, Physical IO, Event
Waits, Sessions, Call Rates, Miss Rates, SGA Memory Usage, Shared Pool, and Indexed Queries
%. There is a horizontal scroll bar to allow you to see all the charts.
Database Probe
This real-time monitoring window offers a large collection of alerts. You can also create your
own alerts.
DataPump Import/Export Wizards*
This feature is available in either Toad Professional Editions or the DB Admin Module. The
Toad for Oracle User Guide
Introduction
88
Oracle data pump is an import/export utility added in Oracle 10g. It is significantly faster and
more efficient at loading large volumes of data than the standard import/export utilities. Toad's
Data Pump import/export wizards make using it even easier. In addition, Toad has a data pump
job manager to help you manage import/export tasks.
DBMS_FLASHBACK
Use this window to look back in time in your database, using Oracles DBMS_FLASHBACK
package on Oracle version 9i and up.
DBMS_REDEFINITION Wizard
Use this wizard to rebuild tables online using Oracles DBMS_REDEFINITION package on
Oracle version 10 and up.
Flat File Export
The SQL*Loader tab is only available with the DB Admin Module.
Generate Database Script
Generate DDL for all (or some) non-schema objects such as tablespaces, roles, profiles, etc. Script
can be dependency-sorted. Extract from a live database or Database Definition File.
Generate Schema Script
Generate DDL for all (or some) objects in a schema. Script can be dependency-sorted. Extract
from a live schema or Schema Definition File.
Identify Space Deficits
This displays tables that do not have enough free disk space to allocate their next extent.
Index Monitoring
Monitor indexes to determine whether or not they are being used. You can then drop unused
indexes to eliminate unnecessary overhead.
Instance Manager
The Instance Manager is designed to let you check on the status your database instances. The
Instance Manager can send email alerts when the status of an instance changes. The Instance
Manager can start, stop, and alter your database instances.
Log Switch Frequency Map
This screen shows when your database performs a log switch. You can use this window to judge
the balance of log switches.
LogMiner
If a System Change Number (SCN) caused a corruption problem, LogMiner lets you easily
analyze a database and recover to the transaction exactly before the corruption.
Toad for Oracle User Guide
Introduction
89
New Database Wizard
The Toad Database Wizard provides a rapid way for DBAs to create Oracle databases. It offers
an easy wizard-style interface consisting of 5 screens prompting the user to select parameter
values for the construction of the database parameter file (INIT.ORA) as well as values used in
the construction of a SQL file that can then later be executed by either a batch file (Windows) or
a script (UNIX) the wizard generates.
NLS (National Language Support) Parameters
View the Session, Instance, and Database parameter settings, and change the Session and/or
Instance parameters.
Operating System Utilities
l Unix Monitor - You can monitor database performance with three charts and a grid:CPU
Usage, Process Queues, Disk IO in Kb/Sec (for the top 10 devices), and a process list grid
that breaks the information down by user. The process list displays the top 20 CPU usage
processes, sorted by %CPU as a default.
l Unix Job Scheduler - You can schedule jobs to a Unix machine.
l Unix Kernel Parms - You can easily set Unix Kernel parameters to make Toad and Oracle
run more efficiently.
l Windows Registry Parms - You can easily set Windows Registry parameters to make
Toad and Oracle run more efficiently.
l Service Manager - You can start, stop, and check status of services on local or remote PCs
running Windows.
Oracle Parameters
Although you can view Oracle Parameters with Base Toad, the DB Admin Module allows you
to Alter Parameters.
Pinned Code
Pin code into the memory buffer so that it is always accessible and not overwritten by new data.
Redo Log Manager
Understand your redo log configuration at a glance. Redo log groups and members can be
created or dropped. Clear log groups, force a log switch, or perform various "alter system archive
log" commands.
Resource Plan Scheduling
Easily schedule and change schedules for resource plans.
Schema Browser and Database|Create Menu
Create, alter, compare, drop, view information about, and manage the following object types:
l Contexts
l Dimensions
l Directories
Toad for Oracle User Guide
Introduction
90
l Flashback Archives
l Libraries
l 10g Scheduler Objects
o
Chains
o
Jobs
o
Job Classes
o
Programs
o
Schedules
o
Windows
o
Window Groups
l Policies
l Policy Groups
l Profiles
l Refresh Groups
l Resource Consumer Groups
l Resource Plans
l Roles
l Rollback Segments
l System Privileges
l Tablespaces
Segment Advisor
Examine tables, indexes, and partitions to determine if and how much, space can be reclaimed in
them with the SHRINK command.
Statspack Browser
View Oracle Statspack data in predefined or custom charts and grids. Easily observe trends
between snapshots.
Tablespace Map
This map provides a graphical view of the contents of your tablespaces.
Top Session Finder
You can find the sessions in the database that are consuming the most resources. Oracle tracks
hundreds of statistics for each session in the database, and the Top Session Finder lets you easily
sort the sessions by their usage of any combination of parameters.
Trace File Browser
Quickly and easily view the contents of an Oracle Trace File in an interactive utility.
Undo Advisor
The Undo Advisor provides advice and helps to automate the establishment of the database undo
Toad for Oracle User Guide
Introduction
91
environment. The advisor can inform you about the health of the current undo configuration,
either overall or within a given time range.
View Tablespaces
The Space, Space History, and IO History tabs are only available in the commercial version of
Toad with the optional DB Admin Module.
History and Compatibility of Toad and Oracle
Toad has a rich history. Over its development cycles it has grown with Oracle. As new Oracle
versions have added functionality, new Toad versions have added functionality and
compatibility as well. Because of this, however, some older versions of Toad for Oracle will not
work properly with newer versions of Oracle. In addition, as Oracle versions have added
functionality, some older versions of the Oracle client will not work with newer versions of the
Database. The following chart describe this history.
Toad History
The following timeline describes the various features that have been added to Toad for Oracle
since version 8.0.
Toad for Oracle User Guide
Introduction
92
Oracle History
The following chart describes the growth of Oracle's Client/Server features:
Version Terminal
Patch
Release Date De-support Date
7.3 7.3.4.5 FEB-1996 21-DEC-2000
8.0 8.0.6.3 JUN-1997 30-SEP-2001
8.1 8.1.7.4 FEB-1999 31-DEC-2003
9.0 9.0.1.4 JUN-2001 31-DEC-2003
9.2 9.2.0.8 MAY-2002 31-JUL-2007
10.1 10.1.0.5 JAN-2004 31-JAN-2009
10.2 10.2.0.4 SEP-2005 31-JUL-2010
11.1 11.1.0.6 AUG-2007 31-AUG-2012
Client/Server Compatibility
If the version of the Oracle client you are currently using is not compatible with the version of
the Oracle server where your database resides, the incompatibilities may cause errors within
Toad. For more detailed information about possible compatibility issues, see Oracle's Metalink
article 207303.1 "Client / Server / Interoperability Support Between Different Oracle Versions".
Toad and Oracle Enterprise Manager
Toad for Oracle offers optional features in the DB Admin module (Toad 8.5 and higher) which
access the Oracle OEM Diagnostics Pack such as :
l ADDM/AWR Report Generator enables snapshot management and shows both AWR
and ASH reports
l AWR Browser graphical representation of data collected from AWR
l ASM Manager enables management of ASM disk groups and clients
l Segment Advisor determines space that can be reclaimed
Toad does offer alternate ways to determine performance bottlenecks without the use of
ADDM/AWR. These include, but are not limited to: the StatsPack Browser, TK Prof interface,
Database Monitor, Session Browser and the Quest SQL Optimizers SQL Inspector. However, if
you are already licensed to use the OEM Diagnostics Pack and you wish to get additional value
from it, you can use the functionality we offer in Toad.
If you are using Oracle database 10g and above, you can use the Oracle Tuning Advisor feature
in all Toad editions (8.6 and higher), which accesses both the Oracle OEM Tuning Pack and
Diagnostics Pack.
Toad for Oracle User Guide
Introduction
93
Alternatively, if you have Toad Xpert, Development Suite or DBA Suite Editions you could use
the Quest SQL Optimizer, which does not access any of the Oracle OEM Packs at all. In
addition, Quest SQL Optimizer offers a unique way to rewrite your SQL code for maximum
performance.
NOTE: It is your (organization's) responsibility to ensure you have the appropriate Oracle
OEM license.
However, there are some steps you can take to mitigate possible risks of using functionality you
are not licensed to use.
NOTE: The following techniques are mitigation methods only. Oracle licensing can change at
any moment, so it is important to know exactly what your license allows and what you are not
licensed to use. All of these methods within Toad are easily reversed, and, in some cases, can be
ignored by any user invested in using the features regardless of license issues.
Disabling Access to OEM Functionality in Toad
You can:
l Customize your toolbar to hide buttons to Toad functionality.
l Use the Toad Options window to hide entire Toad windows.
l Use Toad Group Policy Manager to control Toad Use from a centralized location.
Customizing Your Toolbar
You can remove items from the toolbar by opening the customize window and removing the
buttons that open the Toad features in question.
To remove items from the toolbar
1. Right-click over the toolbar and select Customize.
2. Drag the buttons and menu items you want to remove off of the toolbar and drop them.
Using Toad Options to Hide Windows
You can hide Toad functionality from the Options window. For more details about the Toad
Options | Windows screen, see the Toad help file.
To hide Toad windows
1. From the View | Toad Options window, select Windows in the left hand pane.
2. In the Windows grid, clear the checkbox in the Available? column for the windows you
want to hide.
Toad for Oracle User Guide
Introduction
94
Using Toad Group Policy Manager
You can also push these settings onto a group by using the Toad Group Policy Manager. See
"Group Policy Management" (page 151) for more informationabout details for doing this.
To restrict usage from the Group Policy Editor
1. Install Toad Group Policy Editor and the Toad Group Policy Server as described in
appropriate documentation.
2. Create groups, and then add users to groups.
3. Create restrictions to be associated with each group.
4. Publish the policy file and other associated files to the policy server.
5. Make sure your windows startup is designed to push the toad.pdl file out to users
on login.
Getting Help
Online Resources
There are several online resources available to help you enhance your experience with Toad.
With an internet connection, you can easily access these resources from within Toad and also
from your internet browser.
Note: Links in this help topic direct you to external websites and open a new browser window.
Toad Online
The Toad Online window includes a small web browser so you can access some of these
resources directly from Toad.
To access Toad Online through Toad
From the Help menu, select Toad Online.
Online resources available from Toad Online include:
What's New Tab
The New in this Release page is located on the Toadsoft website. It provides an overview of
new features in the current version of Toad for Oracle and some information on how you can use
them to make working with Toad easier.
Join Mailing Lists Tab
This tab lets you easily join the Toad and Toad beta mailing lists. Click one of the buttons and
your email editor opens a new email with the appropriate boxes filled in. Simply send the
message and you will be subscribed to the mailing lists.
Note: Accuracy of answers and solutions posted on the mailing lists are not monitored by Quest
Support. These lists provide peer-to-peer support only.
Release Notes Tab
Click the release notes tab to display the release notes for Toad.
2
Toad for Oracle User Guide
Getting Help
96
Online Resources Tab
ToadWorld.com
The Toad World site provides discussion forums, education opportunities, updates and
announcements of new Toad products. Share code snippets with your fellow users, and learn
valuable tips and tricks for using Toad.
ToadWorld (http://toadworld.com)
ToadWorld's Tutorial videos.
Toadsoft.com
Toadsoft.com is the website to search to find information about Toad:
l Toad downloads
l Toad How-To videos
l Links to Quest resources
l And more
To access Toadsoft, go to http://toadsoft.com
AskToad.com
AskToad is a user-driven knowledgebase, running on Wiki technology. It is designed to provide
answers, tips and hints about using Toad for Oracle.
Quest Support
Quest Support is available to customers who have a trial version of a Quest product or who have
purchased a commercial version and have a valid maintenance contract. Quest Support provides
around the clock coverage with SupportLink, our web self-service. Visit SupportLink at
http://support.quest.com
From SupportLink, you can do the following:
l Quickly find thousands of solutions (Knowledgebase articles/documents).
l Download patches and upgrades.
l Seek help from a Support engineer.
l Log and update your case, and check its status.
View the Global Support Guide for a detailed explanation of support programs, online services,
contact information, and policy and procedures. The guide is available at:
http://support.quest.com/pdfs/Global Support Guide.pdf
Toad for Oracle User Guide
Getting Help
97
Help File
To access help
Do one of the following:
l Press F1 anywhere in Toad for context-sensitive help.
l From the Help menu, select Contents to access the main help page.
Quick Search Bar
You can find help about Toad quickly from various locations in Quest using the Quick Search
Bar on the Main Toolbar.
To search for Toad resources
1. Click the drop down arrow and select the locations you want to search:
l ToadWorld online
l ToadWorld and other Toad-related sites
l AskToad (Toad wiki)
l Knowledge Xpert
l Toad Help Index
2. Enter a search term in the box.
3. Press Enter or click to search.
Check for Updates
If you have an internet connection, you can use the Check for Updates command to check for
more recent versions of Toad for Oracle.
Toad for Oracle User Guide
Getting Help
98
To check for updates
1. From the Help menu, select Check for Updates.
2. Click OK to close the message box.
Download Toad Tips
Toad provides the ability to update the Tips for your Toad tips window. If you have an internet
connection, Toad can check for new tips and download them at any point.
To download Toad Tips
Select Download Toad Tips from the Help menu.
Frequently Asked Questions (FAQ)
If what you need to know is not in this help file, a user-driven database of FAQs is located on
the web at AskToad.com.
You can also search the Toad email lists from this site.
See the Toad Support site for more information.
Show Tips
Toad provides a tips window where you can both find tips to better get the most out of Toad,
and also leave notes for yourself about how you best use Toad.
The Tips window is window-specific: a new tips window is displayed when you open a new
window within Toad. Because of this, you can enter notes for a specific window and have it
visible only when you are using that window.
The tips window consists of a small browser window (can be resized) containing two or three
tabs. If there are tips for the window, the following tabs are displayed:
l Tips - displays tips for the selected Toad window.
l Notes - displays notes you can enter for the selected Toad window.
If there are no tips for the selected window, the Tips tab does not appear, but you can still enter
your own Notes and view all the tips for the window.
To show the tips window
Do one of the following:
l
On the main menu, click .
l From the Help menu, check Show Tips.
Toad for Oracle User Guide
Getting Help
99
Navigating the tips window
You can navigate through the tips for various windows by activating the tips list.
To navigate through tips
1. Click the Show tips list button beside the browse buttons.
2. Click a window name in the left hand list to display tips for it.
Notes tab
Use the notes tab to enter your own notes for the Toad window you have active. Toad saves
these notes between sessions, so you can use the Notes tab as a type of scratch pad: bits of code,
hints on processes you use, and so on can be stored in this box.
Hiding the tips window
To hide the tips window
Do one of the following:
l On the tips window, select the Do not Show Tips check box and click OK.
l From the Help menu, uncheck Show Tips.
Toad Advisor
Toad is self-diagnosing. If you are having difficulties with Toad that you can't iron out, the Toad
Advisor may be able to help you. It offers Warnings, Alerts, Hints and more concerning the
current state of your Toad installation. If you are in a managed environment, it will specify
which features in Toad are managed, and to what extent.
To use Toad Advisor
1. From the Help menu, select Toad Advisor.
2. Check the tree structure for information about how to tweak Toad to work better in your
situation:
Warnings Describe things that should be fixed immediately
Alerts Describe things that may have an impact upon
Toad's functionality
Hints Provide information about your Toad installation
that may affect how Toad works
Performance
suggestions
Describe settings that could be changed to improve
speed of performance
Toad for Oracle User Guide
Getting Help
100
About Toad
This dialog box displays some helpful contact information.
l Note the current version number of Toad. If you contact customer support, they will want
to know what version you are using.
l Clicking on "www.quest.com" opens your default web browser and navigates directly to
the Quest Software, Inc. site.
l Clicking on "[email protected]" opens your default email client software to compose a
new email to Quest for more information. Please note the version number of Toad
in your email.
To access the Help About dialog box
Select Help | About from the menu.
Release Notes
You can easily access the release notes from the Help menu. The release notes detail the changes
made to the current release of Toad for Oracle.
To read the release notes
From the Help menu, select Release Notes.
Support Bundle
Support Bundle Overview
If you havent been able to find the answer to your question in the Users Manual, or the Help
files, you can contact us directly. An easy way to do this is by choosing Help | Support Bundle.
The support bundle window provides information about several aspects of your Oracle and Toad
setups. In addition, the Support Bundle lets you easily report problems to our peer-to-peer
mailing lists or directly to Quest Support. See "Support Bundle Toolbar" (page 101) for more
information.
The information collected can be used to greatly improve troubleshooting of any problems. This
information includes:
l Application Information
l Toad Version
l Toad Registration Information
l Toad Editions Options (Debugger, DBA, Xpert, and so on.)
l Installation Type (Network or Local)
Toad for Oracle User Guide
Getting Help
101
l EXE and Client Directories. Client directory only applies to network installations
l Knowledge Xpert Version and Location
l SPServer.dll Version and Location
l Team Coding Information
l If Team Coding Installed or not
l Team coding settings
l Oracle Client Information
l Client Location
l TNSNAMES.ORA Location
l Oracle Server Information
l Server Version
l Server NLS_CHARACTERSET
l Server NLS_NCHAR_CHARACTERSET
l Connected User and Connect As (Normal, SYSDBA, SYSOPER)
l System Information
l Operating System Version
l Total and Available Memory (Physical, Virtual, and Swap)
l PATH Environment Variable
l TNS_ADMIN Environment Variable
l Oracle Homes Registry Data
l All registry information for each installed home is displayed. This information is found
under HKEY_LOCAL_MACHINE\Software\Oracle
Support Bundle Toolbar
From the toolbar of the support bundle, you can accomplish several things.
Button Command
Copy support bundle to clipboard
Save support bundle to file
Refresh support bundle information
Toad Mailing
List
This opens your email application with a pre-addressed email to the
peer-to-peer Toad mailing list.
See "Join Mailing Lists Tab" (page 95) for more information.
Toad for Oracle User Guide
Getting Help
102
Button Command
Quest Support This opens your email application with a pre-addressed email to our
customer support department.
Attach
TOAD.INI to
email
If checked this attaches the TOAD.INI to any email sent through the
support bundle, whether it is to the peer-to-peer Toad list or to Quest
Support
Attach SQL
Tuning Support
zip to emails
If checked, this attaches the SQL Tuning support zip to any email sent
through the support bundle, to either the peer-to-peer Toad list or to
Quest Support.
Use this
information in
body of email
If checked, Toad will include the support bundle information in the
body of the email sent to either the peer-to-peer Toad list or to Quest
Support
Troubleshooting
Unicode Troubleshooting
Toad now supports Unicode. For people already using Unicode-enabled databases, this should be
a seamless transition.
Note:Some Oracle features are not Unicode-enabled, or have specific Unicode requirements to
function. Please see your Oracle documentation for information about these features.
In addition, Toad Group Policy Manager is not Unicode-compliant.
Squares in Files Instead of Characters
Either the font you are using does not support Unicode, or the character set has not been
installed on your computer.
Question Marks in Files Instead of Characters
Toad attempted to open a file with the wrong encoding setting. This has corrupted the data. Do
not save the file. Close it and reopen using the correct Unicode encoding. See "Options -
General" (page 661) for more information.
Script Output and Compare Files Fonts
In the Editor and the Compare Files, the font now defaults to fixed-width "Courier-New" font
rather than the System font. In addition, you may only select fixed-width fonts in these windows.
Toad for Oracle User Guide
Getting Help
103
Editor not Working correctly
If you are an upgrading user, you may find errors when you attempt to use the Editor in
Unicode. For example: object name highlighting, CTRL+Click, mouse over watch hints. This is
because in order to maintain your custom settings to the Parser library, Toad did not replace the
lexlib.lxl file.
To fix the parser file
1. From the View menu, select Options.
2. Click the Editor - Behavior node.
3.
Set the language dropdown to PL/SQLand then click .
4. Click the Parser tab and select Any Name.
5. Add (?r) to the beginning of the Regular expression test:
6. Click OK or Apply to save changes.
Code Xpert Not Working with Unicode Characters
This is a known issue. Code Xpert does not support Unicode.
FTPCompatability Issues
Toad's FTP feature can be used with Unicode, however, the code pages on the server, file and
client must match.
Known Issues
There are some known issues with Unicode compatibility, both internally to Toad and externally
from Oracle. See the release notes for more information.
Hints and Tips: Connecting To Personal Oracle
If you are having trouble connecting to Personal Oracle or creating a SQL*Net alias for PO7 or
PO8, try one of the following four entries for the database name on the Toad login window:
Toad for Oracle User Guide
Getting Help
104
2:
BEQ-LOCAL
LOCAL
TCP-LOOPBACK
For Schema/Passwords try one of the following pairs:
DEMO/DEMO
SCOTT/TIGER
SYS/CHANGE_ON_INSTALL
SYSTEM/MANAGER
Hints and Tips: Table Does Not Exist Errors
Toad tables are required for recalling previous Explain Plan results, Profiler, Team Coding,
and Toad Security. You do not have to create these tables in order to use Toad, but you will
need them for the functions listed above. To create these tables, run the Server Side Object
Install Wizard.
In addition, many V$ tables are required on other screens. For a list of tables required on a screen
by screen basis, see V$ Tables Required.
Working with other Quest Products
Knowledge Xpert
You can use Quest Software's Knowledge Xpert as a comprehensive technical resource to find
answers to technical questions without the need to search through manuals, books, or internet
sites. Just type a keyword to access technical topics, database specific information, and guidance
from experts that can help you tune, monitor, and manage your environment more efficiently and
develop best practice, high performance database applications.
The information Knowledge Xpert displays gives you the background insights, information
about SQL commands, working examples, and performance considerations you need to make
effective decisions.
Knowledge Xpert integrates seamlessly with other Quest products such as Toad and SQL
Navigator, which means you never have to shut down to look for answers.
Knowledge Xpert is a stand-alone product, and as such has its own help file.
To open Knowledge Xpert help
1. Open Knowledge Xpert.
2. Do one of the following:
l Press F1
l
Click the About dropdown arrow button and select Help Contents.
Using Knowledge Xpert in Toad
Knowledge Xpert is available from several places within Toad. You can use it to look up
information from within the editor, or you can search it from the main toolbar.
To use Knowledge Xpert from the toolbar
1.
Click the Knowledge Xpert button.
2. Enter a term in the Search box and then click OK.
To use Knowledge Xpert within the Editor
1. Select a word or command within the code that you would like information about.
2. Right-click and select Search Knowledge Xpert.
3
Toad for Oracle User Guide
Working with other Quest Products
106
Using SQL Optimizer with Toad
This feature is available only in Toad Editions that include the SQL Optimizer.
Starting with Toad Xpert 9.5, Quest SQL Optimizer 7.x for Oracle is installed in place of SQL
Tuning. SQL Optimizer 7.x is an enhanced version of the previous SQL Tuning for Oracle 6.1.2
(or earlier) with an improved UI, workflow and much more functionality. See "Quest SQL
Optimizer Overview" (page 610) for more information.
To launch Quest SQL Optimizer for Oracle from various places in Toad
l
Editor - Click on the Editor toolbar. See "Missing Toolbars " (page 138) for more
information.
l Create/Alter windows for:
l View
l Trigger
l Snapshot
l Query Builder - Generated Query tab toolbar. See "Query Builder Toolbar" (page 933) for
more information.
l Session Browser - Current Statement Details tab. See "Current Statement Details" (page
561) for more information.
l SGA Trace/Optimization Window - SQL Tab. See "SGA Trace/Optimization" (page 567)
for more information.
l Schema Browser tabs:
l Views | Select a view | Right-click and select Optimize View's SQL.
l Snapshots | Select a view | Right-click and select Optimize Snapshot's SQL.
l Procedures | Details | Code tab | Highlight the SQL you want to tune | Click the
Optimize SQL button on the tab's toolbar.
l Triggers | Details | Code tab | Highlight the SQL you want to tune | Click the
Optimize SQL button on the tab's toolbar.
To launch Quest SQL Optimizer for Oracle standalone
Select Start | All programs | Quest Software | Quest SQL Optimizer for Oracle | Quest
SQL Optimizer 7.x for Oracle.
Note: SQL Tuning for Oracle 6.1.2 (or earlier) can not be launched as a
standalone product.
Switching between versions of SQL Optimizer
You cannot launch both Quest SQL Optimizer (7 or above) and SQL Tuning (6.1.2 or earlier)
simultaneously from Toad since there is only one function that calls the SQL optimization
Toad for Oracle User Guide
Working with other Quest Products
107
program. Therefore, if you have both versions installed you can switch between them by using
the SQL Optimizer Version Selector.
To set the active version
1. Close Toad and SQL Optimizer.
2. Select Start | All Programs | Quest Software | Quest SQL Optimizer for Oracle | SQL
Optimizer Version Selector.
3. Select the version you want active.
4. Click Set Active.
5. Click Close.
If you select SQL Tuning for Oracle (6.1.2 or earlier), you can still run Quest SQL Optimizer
from Start | All programs | Quest Software | Quest SQL Optimizer for Oracle | Quest SQL
Optimizer 7.2 for Oracle. SQL Tuning for Oracle can only be launched from within Toad.
Benchmark Factory
Note: Benchmark Factory is a standalone product. For full information about using Benchmark
Factory, please open Benchmark Factory and see its relevant documentation.
Benchmark Factory is a database performance and code scalability testing tool that simulates
users and transactions on the database and replays production workload in non-production
environments. This enables developers, DBAs, and QA teams to validate that their databases will
scale as user load increases, application changes are made, and platform changes are
implemented. Benchmark Factory is available for Oracle, SQL Server, DB2, Sybase, and MySQL.
You can connect to Benchmark Factory from Toad, set Performance Test Settings and send the
test to Benchmark Factory for further analysis.
Benchmark Factory can be accessed from Toad in several locations:
l Schema Browser pages - Right-click on the object to be tested and select Test
Performance.
l Favorites - See "Favorites" (page 1005) for more information.
l Functions - See "Schema Browser: Functions" (page 1008) for more information.
l Packages - See "Schema Browser: Packages" (page 1040) for more information.
l Procedures - See "Schema Browser: Procedures" (page 1044) for more information.
l Triggers - See "Schema Browser: Triggers" (page 1090) for more information.
l Code Road Map - Right-click on the object to be tested and select Test Performance.
See "Road Map Overview" (page 721) for more information.
l Project Manager - Right-click on the object to be tested and select Test Performance. See
"Project Manager Overview" (page 472) for more information.
Toad for Oracle User Guide
Working with other Quest Products
108
l
Query Builder - In the Generated Query tab, click the Benchmark Factory button.
See "Query Builder Overview" (page 933) for more information.
l TKPROF Wizard - In the Local Options area of the Wizard, select Send trace files to
Benchmark Factory. See "TKProf Interface Wizard" (page 276) for more information.
l Trace File Browser - With a Trace file open in the browser, click the Benchmark Factory
button on the toolbar. See "Trace File Browser" (page 312) for more information.
Note: Sending a trace file to Benchmark Factory will not open the parameters window
described below.
Setting Benchmark Factory Properties
When you choose to send an object to Benchmark Factory, you will need to set Benchmark
Factory properties in addition to the parameters required by the database object. For full
descriptions of these properties, see the Benchmark Factory documentation.
Option Description
BMF Tests to Perform
Verify Service Level
Agreement or Goal
Pass information through from Toad to Benchmark Factory to
check Service Level Agreement compliance.
Test for Scalability
based upon User
Load
Pass information through from Toad to Benchmark Factory to
run a scalability test based upon user load.
SLA These options apply to the Verify Service Level Agreement or
Goal option.
Rule to apply Select the rule to apply to the Service Level Agreement or goal.
Options include:
l Response time - run test until the response time exceeds
the specified value.
l Throughput - run test until the maximum transactions per
second is discovered.
Maximum response
time (milliseconds)
For response time testing, specify the maximum response time in
milliseconds. If you have chosen Throughput, this box will be
disabled.
Minimum number of
virtual users
Enter the number of virtual users you want to begin the test.
Maximum number of
virtual users
Enter the number of virtual users indicating when the test
should stop.
Toad for Oracle User Guide
Working with other Quest Products
109
Option Description
Step value for virtual
users
Step up this number of virtual users for each test iteration until
you reach the maximum number.
Duration to execute
SQL for each
userload (seconds)
Specify how long each iteration (execution at the above-
specified userload) should take to execute. Enter this number in
seconds.
Scalability These options apply to the Scalability Test based upon User
Load.
Number of virtual
users to execute the
SQL statements
Enter the number of virtual users that will execute the SQL
statements.
Execute Each
statement
Select one of the following options to specify how to time the
scalability test:
l Number of Times - Enter the number of times each
statement should be executed at a specific userload.
l Duration (in seconds) - Enter the length of time each
iteration should take to execute.
Latency Think Time l Duration Model - Select the latency model you want to
use. The default is Absolute.
l Duration - Enter the duration of think time in
milliseconds. The default is 100.
Quest Code Tester Integration
Quest Code Tester for Oracle automates the process of testing PL/SQL programs, making it
possible for you to identify bugs and verify program correctness in a fraction of the time it has
taken previously. Rather than write (and maintain) thousands of lines of test code, PL/SQL
programmers describe the expected behavior of their programs through a graphical interface.
Code Tester then generates the required test code, and runs it whenever you request (either
through the interface or via command line execution).
If you have a license for the Quest Code Tester and have previously set up your tests, you
can launch them from your code in the Toad Editor or from a right-click menu in the
Schema Browser.
l If you are running Code Tester 1.8 or higher, and have saved your passwords, Toad will
automatically log in for you and simply open the results window.
l If you are running Code Tester 1.6 or below, Toad will open the login window and you
will need to login before the results are displayed.
Toad for Oracle User Guide
Working with other Quest Products
110
For more information about the Quest Code Tester, please see your Code Tester documentation
or press F1 from within Code Tester.
To launch Quest Code Tester from the Editor
1. Open the code you want to test in the Toad Editor.
2.
Click .
3. Click Code Tester to open the full application (Close returns to Toad).
To launch Quest Code Tester from the Schema Browser
1. Select the code you want to test in the Schema Browser.
2.
Right click in the Source tab and select Code Tester .
3. Click Code Tester to open the full application (Close returns to Toad).
Toad Basics
Toad Tips
ToadTips contains easy to follow tips for various windows within Toad. These tips are dynamic,
and Toad can check automatically to see if there are new tips. See "Download Toad Tips" (page
98) for more information.
To show tips for all windows
From the Help menu, select Show Tips.
To hide all tips but the current tip
In the tip window, select both Hide All and Except this check boxes.
To display the entire tip file
Click the All tab in a tip window.
Errors
Toad Error
If a command fails, the Toad Error dialog box appears.
l Use the Clipboard button to copy the error. You can then Paste it into an email for
customer support. See "Support Bundle Overview" (page 100) for more information.
l If the error dialog box contains an ORA-number, as the example above does, click Help.
Toad calls the Oracle Helpfile and displays the error message topic in a new window.
From this window you can print the topic or move to the index or table of contents for
Oracle help.
4
Toad for Oracle User Guide
Toad Basics
112
l If you have the Knowledge Xpert installed, click Details for more technical information
about the error.
l Click OK to close the Toad Error dialog box.
Application Error
If Toad itself fails, the Error dialog box appears.
This type of an error creates a log, saved as toad.elf. This Eureka LogFile (.elf) contains both the
application information and the callstack of the error created, and can be very helpful to Quest
Support in solving issues you are having with Toad. The elf is displayed when you click as
directed. You can copy this file to the clipboard and send it to support. Alternately, it is
automatically saved in the Support Bundle, which you can use in various ways to get help. See
"Support Bundle Overview" (page 100) for more information.
You can copy this file to the clipboard and send it to support. Alternately, it is automatically
saved in the Support Bundle
Toad for Oracle User Guide
Toad Basics
113
RAC Support
Toad supports Oracle's support for RAC systems. If you have multiple database server boxes,
Oracle RAC lets you start an Oracle instance on each server, and have all those instances open
the same shared database (or shared set of data files). In this way, you can scale the size of your
database server by adding more computers as you add users. Multiple computers, one database.
Additional Information for RAC Connections
When you log in to a RAC connection, Toad notes this fact and makes additional information
available in some of its windows to help you manage that connection.
Caption
If a RAC connection is in effect, the caption of the Toad Main window will reflect this by
showing: TOAD: RAC[n], where n is the session id.
Connection bar
In the connection bar, RAC connections are listed as SCHEMA@RAC[n], where n is the instance
number of the connection.
Database Monitor
Within the database monitor, all information is provided as per a single connection. However, it
is summarized or aggregated for all the instances that compose the RAC cluster. For example,
looking at SGA memory - if each RAC instance is 150 MB, and you have two RAC instances,
this column will display 300MB. See "Toad Database Monitor" (page 535) for more information.
Oracle Parameters Screen
RAC database single grid view - The Single Grid checkbox above the grid and to the right of
the toolbar toggles whether Toad displays a single grid or a multi-grid. Toad sorts first by default
on the option and then by the instance name for easier readability.
RAC database multi-grid view - If you choose the multi-grid view, Toad displays a separate tab
for each RAC instance.
See "Oracle Parameters" (page 357) for more information.
Drag-and-Drop
You can Drag-and-Drop objects between many Toad windows, and between Toad and some
external applications.
These possible Drag-and-Drop combinations include:
Toad for Oracle User Guide
Toad Basics
114
From To Action Applicable Objects
Project
Manager
Query
Builder
Objects added to
table model area
Tables/Views/Synonyms
ER Diagram Objects added to
table model area
and LHS list
Tables/Views/Synonyms
Editor Object name
added to editor
All Objects
Editor File loaded in
editor, or just file
contents loaded in
editor
Files
Editor Object name
added to editor
All Objects besides PL/SQL
Objects and Types
Editor Objects loaded
into Editor
PL/SQL Objects and Types
Editor File loaded in
Editor
Files
Text Editor Object name
added to editor
All Objects
Text Editor File loaded in text
editor
Files
Schema
Browser -
Favorites Tab
Objects added to
Folder in
Favorites tab
All Objects supported in Schema
Browser besides Synonyms and
Types
Script
Manager
File Reference
added to Script
Manager
Files
Object Search Query
Builder
Objects added to
table model area
Tables/Views/Synonym
ER Diagram Objects added to
table model area
and LHS list
Tables/Views/Synonym
Editor Object name
added to editor
All Objects
Toad for Oracle User Guide
Toad Basics
115
From To Action Applicable Objects
Editor Object name
added to editor
All Objects besides PL/SQL
Objects and Types
Editor Objects loaded
into Editor
PL/SQL Objects and Types
Text Editor Object name
added to editor
All Objects
Project
Manager
Objects added to
Project Manager
Project
All Objects supported in Object
Search
Schema
Browser -
Favorites Tab
Objects added to
Folder in
Favorites tab
All Objects supported in Schama
Browser besides Synonyms and
Types
Object Palette Query
Builder
Objects added to
table model area
Tables/Views/Synonyms
ER Diagram Objects added to
table model area
and LHS list
Tables/Views/Synonyms
Editor Object name
added to editor
Tables/Views/Synonyms/Columns
Editor Object name
added to editor
Tables/Views/Synonyms/Columns
Text Editor Object name
added to editor
Tables/Views/Synonyms/Columns
Project
Manager
Objects added to
Project Manager
Project
Tables/Views/Synonyms
Schema
Browser -
Favorites Tab
Objects added to
Folder in
Favorites tab
Tables/Views
Schema
Browser
Query
Builder
Objects added to
table model area
Tables/Views/Synonyms
ER Diagram Objects added to
table model area
and LHS list
Tables/Views/Synonyms
Toad for Oracle User Guide
Toad Basics
116
From To Action Applicable Objects
Editor Object name
added to editor
All Objects
Editor Object name
added to editor
All Objects besides PL/SQL
Objects and Types
Editor Objects loaded
into Editor
PL/SQL Objects and Types
Text Editor Object name
added to editor
All Objects
Project
Manager
Objects added to
Project Manager
Project
All Objects supported in Project
Manager
Schema
Browser -
Favorites Tab
Objects added to
Folder in
Favorites tab
All Objects supported in Schema
Browser besides Synonyms and
Types
Output
Window/Find
In Files
Project
Manager -
Project node
File reference
added to Project
Manager
Project Files
Project
Manager -
Folder node
Reference added Files
Project
Manager -
FTP node
File upload to
FTP server
Files
Editor Files loaded in
Editor. File name
appears in new
tab
Files
Editor Files loaded in
Editor. File name
appears in new
tab
Files
Text Editor Files loaded in
Text Editor. File
name appears in
new tab
Files
Toad for Oracle User Guide
Toad Basics
117
From To Action Applicable Objects
Script
Manager
File Reference
added to Script
Manager
Files
Windows
Explorer
Project
Manager
File reference
added to Project
Manager
Files
Editor File loaded in
Editor
Files
Editor File loaded in
Editor
Files
Text Editor File loaded in
Text Editor
Files
Code
Snippets
Editor Snippet added to
Editor
Code Snippet from list
Editor Snippet added to
Editor
Code Snippet from list
Text Editor Snippet added to
Text Editor
Code Snippet from list
Archive
Window
Project
Manager -
Folder node
File unzipped and
added to folder.
Prompts to add to
PM
Files inside zip archive
Project
Manager -
FTP node
File unzipped and
uploaded. Prompts
to add to PM
Files inside zip archive
Toad Task
Scheduler
Interface
Project
Manager
Windows task
node added to
Project Manager
Scheduled Tasks
Task Bar & Status Bar
Task Bar
This feature is activated or deactivated using View | Toad Options | Toolbars/Menus | Show
Connect Strings. See "Show connect strings on Window Bar" (page 685) for more information.
Toad for Oracle User Guide
Toad Basics
118
At the bottom of the main Toad window, Toad displays the various connections currently open.
l Click one of these connections to activate the last window you used in that connection.
l Hover over them to display the following information:
l user
l connection type (sysDBA, sysOPER)
l sysdate on server
l database version
l your session ID
Note: The SID will only display if you have access to V$session and are not
logged in as sysDBA or sysOPER.
l If your SQL windows are maximized, right-click one of these connections
and Toad displays a menu of options.
Status Bar
At the bottom of each individual window within Toad is a status bar. This bar provides
information about the active window.
l The first frame in the status bar is the row and column your cursor is located in the results
grid. If you have not opened a results grid, or your cursor is not in the grid, this frame
will be blank.
l The second frame is the connection used by the active window.
l The last frame is the last displayed error.
You can hover over the information in this bar to see additional information. This includes the
session ID (SID), sysdate, and Oracle version you are using. The SID is displayed only if you
have access to V$Session and are not logged in as SysDBA or SysOper.
Toad for Oracle User Guide
Toad Basics
119
Execution time
When you execute a script or a command in the Editor, the first frame changes to a time. The
timing is the amount of time from the point that Toad sends the query to Oracle and the first
result set returns. It does not describe how long it took to fetch the data.
ASCII Chart
Dec Hex Oct UTS ASCII CharName
0 $00 0000 NUL NUL
1 $01 0001 SOH SOH
2 $02 0002 STX STX
3 $03 0003 ETX ETX
4 $04 0004 EOT EOT
5 $05 0005 ENQ ENQ
6 $06 0006 ACK ACK
7 $07 0007 BEL BEL
8 $08 0010 BS BS
9 $09 0011 HT HT
10 $0A 0012 LF LF
11 $0B 0013 VT VT
12 $0C 0014 FF FF
13 $0D 0015 CR CR
14 $0E 0016 SO SO
15 $0F 0017 SI SI
16 $10 0020 ACK ACK
17 $11 0021 DC1 DC1
18 $12 0022 DC2 DC2
19 $13 0023 DC3 DC3
20 $14 0024 DC4 DC4
21 $15 0025 NAK NAK
22 $16 0026 SYN SYN
23 $17 0027 ETB ETB
24 $18 0030 CAN CAN
25 $19 0031 EM EM
26 $1A 0032 SUB SUB
27 $1B 0033 ESC ESC
28 $1C 0034 FS FS
29 $1D 0035 GS GS
Toad for Oracle User Guide
Toad Basics
120
30 $1E 0036 RS RS
31 $1F 0037 US US
32 $20 0040 1 Space
33 $21 0041 2 ! Exclamation Mark
34 $22 0042 3 " Double Quote
35 $23 0043 4 # Number Sign
36 $24 0044 5 $ Dollar Sign
37 $25 0045 6 % Percent Sign
38 $26 0046 7 & Ampersand
39 $27 0047 8 ' Single Quote
40 $28 0050 9 ( Left Parenthesis
41 $29 0051 10 ) Right Parenthesis
42 $2A 0052 11 * Asterisk
43 $2B 0053 12 + Plus Sign
44 $2C 0054 13 , Comma
45 $2D 0055 14 - Minus Sign
46 $2E 0056 15 . Period
47 $2F 0057 16 / Slash, Virgule
48 $30 0060 17 0 0
49 $31 0061 18 1 1
50 $32 0062 19 2 2
51 $33 0063 20 3 3
52 $34 0064 21 4 4
53 $35 0065 22 5 5
54 $36 0066 23 6 6
55 $37 0067 24 7 7
56 $38 0070 25 8 8
57 $39 0071 26 9 9
58 $3A 0072 27 : Colon
59 $3B 0073 28 ; Semicolon
60 $3C 0074 29 < Less Than Sign
61 $3D 0075 30 = Equals Sign
62 $3E 0076 31 > Greater Than Sign
63 $3F 0077 32 ? Question Mark
64 $40 0100 33 @ At Sign
65 $41 0101 34 A A
66 $42 0102 35 B B
67 $43 0103 36 C C
68 $44 0104 37 D D
69 $45 0105 38 E E
Toad for Oracle User Guide
Toad Basics
121
70 $46 0106 39 F F
71 $47 0107 40 G G
72 $48 0110 41 H H
73 $49 0111 42 I I
74 $4A 0112 43 J J
75 $4B 0113 44 K K
76 $4C 0114 45 L L
77 $4D 0115 46 M M
78 $4E 0116 47 N N
79 $4F 0117 48 O O
80 $50 0120 49 P P
81 $51 0121 50 Q Q
82 $52 0122 51 R R
83 $53 0123 52 S S
84 $54 0124 53 T T
85 $55 0125 54 U U
86 $56 0126 55 V V
87 $57 0127 56 W W
88 $58 0130 57 X X
89 $59 0131 58 Y Y
90 $5A 0132 59 Z Z
91 $5B 0133 60 [ Left Bracket
92 $5C 0134 61 \ Back Slash
93 $5D 0135 62 ] Right Bracket
94 $5E 0136 63 ^ Circumflex
95 $5F 0137 64 _ Underline
96 $60 0140 65 ` Accent
97 $61 0141 66 a a
98 $62 0142 67 b b
99 $63 0143 68 c c
100 $64 0144 69 d d
101 $65 0145 70 e e
102 $66 0146 71 f f
103 $67 0147 72 g g
104 $68 0150 73 h h
105 $69 0151 74 i i
106 $6A 0152 75 j j
107 $6B 0153 76 k k
108 $6C 0154 77 l l
109 $6D 0155 78 m m
Toad for Oracle User Guide
Toad Basics
122
110 $6E 0156 79 n n
111 $6F 0157 80 o o
112 $70 0160 81 p p
113 $71 0161 82 q q
114 $72 0162 83 r r
115 $73 0163 84 s s
116 $74 0164 85 t t
117 $75 0165 86 u u
118 $76 0166 87 v v
119 $77 0167 88 w w
120 $78 0170 89 x x
121 $79 0171 90 y y
122 $7A 0172 91 z z
123 $7B 0173 92 { Left Brace
124 $7C 0174 93 | Vertical Bar
125 $7D 0175 94 } Right Brace
126 $7E 0176 95 ~ Tilde
127 $7F 0177 96 DEL DEL
Toolbars, Menus and Shortcut Keys
Configurable Toolbars and Menus - Overview
The main Toad toolbar and menu bar is configurable, as are the Editor toolbar and keyboard
shortcuts. This lets you arrange Toad to best reflect how you want to work.
If you are using a custom configuration, new commands will not be added to your custom
toolbars when you upgrade Toad. However, you can see both new commands and commands
that have been completely removed from the toolbars and menus.
Note: Commands that have been removed from the toolbar and not the menu bar (or the other
way around) will not appear in the Unused area. Because of this, it may not be obvious that you
have removed a command from one location and not the other.
To view and add new/removed commands
1. Right-click over the toolbar and select Customize.
2. Click the Commands tab.
3. Select [New] or [Unused].
4. Drag a command to the toolbar/menu of your choosing.
5. Click Close.
Toad for Oracle User Guide
Toad Basics
123
Restoring Toolbar Defaults
To restore toolbar defaults
Right-click over the toolbar and select Restore defaults.
Usage Configuration
In addition, Toad menu bars can configure themselves to how you work with Toad. As you
work, Toad collects usage data on the commands you use most often. Menus personalize
themselves to your work habits, moving the most used commands closer to the top of the list,
and hiding commands that you use rarely. See "Personalized Menus and Toolbars" (page 130) for
more information.
You can:
l Alter toolbars, including the menu bar.See "Altering Toolbars" (page 131) for more
information.
l Display and hide toolbars. You cannot hide the menu bar.See "Show/hide toolbar" (page
134) for more information.
l Create a new, custom toolbar. See "Creating Toolbars" (page 131) for more information.
l Restore the default toolbar. See "Restoring Lost Toolbars" (page 134) for more
information.
l Change and add shortcuts for menu commands.See "Menu hotkeys" (page 129) for more
information.
l Adjust how toolbars display and dock. See "Toolbars/Menus" (page 685) for more
information.
Shortcut Keys
General Shortcut Keys
The following is a list of general Toad Shortcut Keys. In addition, there are specific shortcut
keys for the Debugger, and Editor.
You can also edit your shortcut keys. See "Menu hotkeys" (page 129) for more information.
Note: If you have configured your shortcuts, shortcuts added in Toad upgrades will need to be
added. You can also revert your customizations to the default to gain access to all shortcuts and
new features. See "Toolbars/Menus" (page 685) for more information.
Shortcut Key Function
F1 Windows Help File
F2 Toggle Full screen Editor
Toad for Oracle User Guide
Toad Basics
124
Shortcut Key Function
SHIFT+F2 Toggle Full screen grid
F3 Find Next Occurrence
SHIFT+F3 Find Previous Occurrence
F4 Describe Table, View, Procedure, Function, or Package in popup
window
F5 Editor: Sets or Deletes a Breakpoint in the Editor for PL/SQL
debugging
Editor: Execute as script
F6 Toggle between Editor and Results panel
F7 Clear All Text, Trace Into in the Editor
F8 Recall previous SQL statement in the Editor, Step Over in the Editor
for PL/SQL debugging
F9 Execute statement in the SQL editor, Compile in the Editor
CTRL+F9 Verify statement without execution (parse) in the Editor, Set Parameters
in the Editor for PL/SQL debugging
SHIFT+F9 Execute current statement at cursor in the Editor, Execute Current
Source in the Editor without PL/SQL debugging
F10 Popup Menu
F11 Run (continue execution) in the Procedure Editor for PL/SQL
debugging
F12 Run to cursor in the Editor for PL/SQL debugging.
CTRL+F12 Pass the SQL or Editor contents to the specified External Editor
(Specified in Options > Editors).
CTRL+A Select All Text
CTRL+ALT+B Display the PL/SQL Debugger Breakpoints window
CTRL+C Copy
CTRL+D Display procedure parameters
CTRL+ALT+D Display the PL/SQL Debugger DBMS Output window
Toad for Oracle User Guide
Toad Basics
125
Shortcut Key Function
CTRL+E Execute Explain Plan on the Current Statement
CTRL+ALT+E Display the PL/SQL Debugger Evaluate/Modify window
CTRL+F Find Text
CTRL+G Goto Line
CTRL+L Convert Text to Lowercase
CTRL+M Make Code Statement. See "Strip Code Statement and Make Code
Statement Functions" (page 893) for more information.
CTRL+N Recall Named SQL Statement
CTRL+O Opens a Text File
CTRL+P Strip Code Statement. See "Strip Code Statement and Make Code
Statement Functions" (page 893) for more information.
CTRL+R Find and Replace
SHIFT+CTRL+R Uses the ALIASES.TXT file to substitute the alias with the associated
table name
CTRL+S Saves File
SHIFT+CTRL+S Save File As
CTRL+ALT+S Display the PL/SQL Debugger Call Stack window
CTRL+ T Columns Dropdown
CTRL+U Converts Text to Uppercase
CTRL+V Paste
CTRL+ALT+W Display the PL/SQL Debugger Watches window
CTRL+X Cut
CTRL+Z Undo Last Change
SHIFT+CTRL+Z Redo Last Undo
ALT+UP Display Previous Statement
ALT+DOWN Display Next Statement (after ALT+UP)
Toad for Oracle User Guide
Toad Basics
126
Shortcut Key Function
CTRL+HOME In the data grids, goes to the top of the recordset
CTRL+END In the data grids, goes to the end of the recordset
CTRL+TAB Cycles through the collection of MDI Child windows
CTRL+ENTER Execute current SQL (same as SHIFT+F9)
CTRL+. (period) Autocompletes tablenames
Editor Shortcut Keys
Below is a list of Shortcut keys used in the Editor. See "Shortcut Keys" (page 123) for more
information about shortcut keys in other areas.
Note: If you have configured your shortcuts, shortcuts added in Toad upgrades will need to be
added. You can also revert your customizations to the default to gain access to all shortcuts and
new features. See "Toolbars/Menus - Shortcuts" (page 686) for more information.
Shortcut Key Function
F1 Windows Help File
F2 Toggle Full screen Editor
F3 Find Next Occurrence
SHIFT+F3 Find Previous Occurrence
F4 Describe Object at cursor. Describe Table, View, Procedure,
Function, or Package in popup window
F5 Execute as Script
F6 Toggle between Editor and Results tabs
F7 Clear All Text
F8 Toggle Recall SQL statement panel
F9 Execute statement
CTRL+ F9 Describes statement at cursor
SHIFT+ F9 Execute snippet at cursor
F10 Popup (right-click) Menu
Toad for Oracle User Guide
Toad Basics
127
Shortcut Key Function
F11 Execute code without using the Debugger
CTRL+ A Select All Text
CTRL+ C Copy
CTRL+E Execute Explain Plan on the Current Statement
CTRL+F Find Text
CTRL+G Goto Line
CTRL+H Highlight snippet
CTRL+I Init caps for highlighted code.
CTRL+L Converts Text to Lowercase
CTRL+M Make Code Statement
CTRL+N Recall Named SQL Statement
CTRL+O Opens File
CTRL+P Strip Code Statement
CTRL+R Find and Replace
CTRL+S Save File
SHIFT+CTRL+S Save File As
CTRL+T Columns Dropdown
CTRL+U Converts Text to Uppercase
CTRL+V Paste
CTRL+X Cut
CTRL+Z Undo Last Change
CTRL+. (period) Display popup list of matching tablenames
SHIFT+CTRL+Z Redo Last Undo
ALT+UP+ Display Previous Statement
ALT+DOWN Display Next Statement (after ALT+UP)
Toad for Oracle User Guide
Toad Basics
128
Shortcut Key Function
ALT+PageUP Navigate to the previous tab in the editor
ALT+PageDOWN Navigate to the next tab in the editor
CTRL+ALT+PAGEUP Navigate to the previous results panel tab
CTRL+ALT+PAGEDOWN Navigate to the next results panel tab
CTRL+HOME In the data grids, goes to the top of the recordset
CTRL+END In the data grids, goes to the end of the recordset
CTRL+SPACE Display the code template pick list
CTRL+TAB Cycles through the collection of MDI Child windows
Debugger Shortcut Keys
This is a list of keyboard shortcuts used in the Debugger. See "Shortcut Keys" (page 123) for
more information about shortcut keys in other areas.
Note: If you have configured your shortcuts, shortcuts added in Toad upgrades will need to be
added. You can also revert your customizations to the default to gain access to all shortcuts and
new features. See "Toolbars/Menus" (page 685) for more information.
Shortcut Key Function
SHIFT+F5 Set or Delete a Breakpoint on the current line.
CTRL+F5 Add watch at cursor.
SHIFT+F7 Trace Into.
SHIFT+F8 Step Over.
SHIFT+F10 Trace Out.
SHIFT+CTRL+F9 Set Parameters.
F10 Display Right-Click Menu.
F11 Run statement using the method appropriate for the debugger
selection:
l Script debugger - execute as script.
l DBMS or JDWP debugger - execute as PL/SQL.
F12 Run to Cursor.
Toad for Oracle User Guide
Toad Basics
129
Shortcut Key Function
CTRL+ALT+B Display Breakpoints.
CTRL+ALT+D Display DBMS_Output.
CTRL+ALT+E Evaluate/Modify.
CTRL+ALT+S Display Call Stack.
CTRL+ALT+W Display Watches.
CTRL+PAGE UP Move up in the Navigator Tree.
CTRL+PAGE
DOWN
Move down in the Navigator Tree.
CTRL+MouseClick Load source into Editor for object at cursor.
Configure Menu Shortcuts
You can also configure both types of menu shortcuts: menu hotkeys and shortcut keys. See
Configure Menu Shortcuts for more information.See "Shortcut Keys" (page 123) for more
information about default shortcut keys in other areas.
Note: If you have configured your shortcuts, shortcuts added in Toad upgrades will need to be
added. You can also revert your customizations to the default to gain access to all shortcuts
and new features. See "Restoring Toolbar Defaults" (page 123) for more information about
restoring defaults.
Menu hotkeys
Menu hotkeys are the keys that you access by pressing the ALT key and then the character in
the menu item that is underlined to open that menu or command.
You can configure the underlined character.
To change the hotkey
1. Right-click over the toolbar and select Customize.
2. Right-click the menu item you want to change. In the name box, notice that the character
underlined has an ampersand (&) before it.
3. You can change the underlined character by changing the location of the ampersand. For
example, &Tools, underlines the T, while T&ools underlines the o.
Shortcut keys
Shortcut keys are the keys you type to access a command directly, without going through the
menu. For example, you can use CTRL+S to save a file.
Toad lets you configure these keys so that you can access commands more easily.
Toad for Oracle User Guide
Toad Basics
130
To configure shortcut keys
1. From the toolbar area, right-click and select Menu Shortcuts.
2. Click the command you want to set a shortcut key for. Type the keystrokes you want
to use. This option only allows you to use one keystroke after a control key (such as
CTRL or ALT).
3. The shortcut key is changed as you type. If there is a conflict with another shortcut
key, an asterisk (*) appears in the Conflict column. You can then find the conflict
and remove it.
Toolbars
Customize Toolbar Options
You can customize your display from the Options tab of the Customize dialog box. Toolbars can
also be altered. See "Altering Toolbars" (page 131) for more information.
An online video tutorial is also available for this feature. This video opens in a new browser
window and requires an internet connection.
To customize the toolbar options
1. Right click over the toolbar and select Customize.
2. Click the Options tab.
Personalized Menus and Toolbars
Toad menu bars can configure themselves to how you work with Toad. As you work, Toad
collects usage data on the commands you use most often. Menus personalize themselves to your
work habits, moving the most used commands closer to the top of the list, and hiding commands
that you use rarely.
l From the Options tab, select Menus show recently used commands first.
l To turn this option off, clear Menus show recently used commands first.
Alternatively, hidden commands can be displayed when you select a menu and wait a few
seconds, the remainder of the menu appears. This option can be selected or deselected. If it is
deselected, you can display the remainder of the menu by clicking the arrow that is the last
option on the menu:
Other
Other customizations you can make to your toolbars are:
l Large icons
l Show/Hide tooltips on toolbars
Toad for Oracle User Guide
Toad Basics
131
l Show/hide shortcut keys in tooltips
l Menu animation, including unfolding menus, sliding menus, random animation, or none
Creating Toolbars
If you want your Main toolbar to look much different from the Toad default toolbar, it may be
easier to create your own custom toolbar than to customize the default toolbar.
To create a custom toolbar
1. Right-click over the toolbar and select Customize.
2. Click New.
3. Name your new toolbar, and click OK.
4. Click the Commands tab.
5. Click a category.
Note: Commands are separated into Categories. Each Category listed in the left panel
corresponds to a menu item in the menu bar, with the exception of Menus, which lets you
put an entire menu into your new toolbar.
6. Click and drag the command into the new toolbar.
By default, if there is an icon for that command, the icon will display in the toolbar.
To display the text instead of the icon, or vice versa, right-click the icon in your toolbar
and select the appropriate option. (See Alter Toolbar for more information.)
7. Continue adding and moving commands until the menu is organized as you want it.
l Move the commands around in different orders on the toolbar by clicking and
dragging the icon or text.
l Add a separator between groups of commands, just click one of the commands and
drag it slightly to the right. Depending on how your toolbar is organized, the
separator will be placed either above the moved command or to the left.
l Resize the toolbar by clicking and dragging a side of it.
8. Toolbars can be docked at any side of the screen, or left as floating palettes. Floating
palettes remain on top of all Toad windows.
Altering Toolbars
To change toolbars
1. Right-click the toolbar, and then select Customize.
2. Change commands as desired.
Toad for Oracle User Guide
Toad Basics
132
To change the order of commands
Click and drag the item on the toolbar to where you want it. An I-bar pointer marks
where the command will be dropped.
Note: You can do this within the menus and submenus as well. See "Rearrange
Commands" (page 143) for more information.
To add commands
Drag a command from the right panel of the Customize dialog box to the toolbar. An I-
bar pointer marks where the command will be dropped.
To change icons to text or text to icons
1. Right-click the command you want to change.
2. Select the appropriate option:
Default This is the default choice. In toolbars, if there
is an icon, the icon will be displayed. If there
is no icon attached to the command, the text
will be displayed. In menu bars, both the icon
and the text will be displayed.
Text only
(always)
This changes the option to display only the
text of the command. Icons are hidden.
Text only (in
menus)
This displays only the text of the command if
the toolbar is a menu bar. If the command is
listed in a toolbar, the default still applies.
Image and text This option displays both the icon and the
text, whether the command is located in a
toolbar or as part of a menu.
To change the text on the toolbar
Note: This is not the same as the tooltip hints that pop up when you hover your mouse above an
icon or command.
1. Right-click the icon or text you want to change.
2. Rename the command in the Name box. If you want a hotkey defined, include an
ampersand (&) before the letter you want to define.
Note: These are not the same as Toad shortcut keys, but rather the underlined letter for
keyboard navigation. See "Menu hotkeys" (page 129) for more information.
To remove a command from the toolbar
Click on a command and drag it off of the toolbar.
Toad for Oracle User Guide
Toad Basics
133
To see what has been removed
Select [Removed] in the commands list.
To restore commands
Do one of the following:
l From the [Removed] list, drag the command back to the toolbar or menu.
l From the Toolbars tab, select the toolbar you want to restore and
click Restore.
Locking Toolbars
Once you have customized your toolbars in the manner you want, you can lock the toolbars so
that it is more difficult to inadvertently change your customizations. You can also lock them to
the default.
To lock toolbars
Right-click over the toolbars and select Lock Toolbars.
Window Bar
The window bar in the main window displays the windows currently open in Toad. The window
bar is, by default, located just below the connection bar. Tooltips on the window bar display the
full window caption.
Options for the window bar appear under Toad Options | Toolbars/Menus. See "Toolbars/Menus"
(page 685) for more information.
To turn off the window bar
Right-click over it and clear the Window Bar check box.
Note: If you are using a read only toolbar configuration and you want the window
Toad for Oracle User Guide
Toad Basics
134
bar to remain turned off, check Options | Toolbars/Menus| Allow docking/hiding
of read only toolbars.
To turn on the window bar
Right-click over the main toolbar and check Window Bar.
To change windows
In the window bar, click the window name you want to activate.
Show/hide toolbar
Once you have created several custom toolbars, you may find that you want to hide or display a
specific toolbar.
Note: You cannot hide the menu.
To change the toolbars you display
1. Right-click in the toolbar area.
2. Check the toolbars you want to display, and uncheck the toolbars you want to hide. You
must do this one toolbar at a time.
Note: If you want to show or hide many toolbars, you can right-click in the toolbar area,
select Customize, and then check and uncheck toolbars from the Customize dialog box.
Reset Default Toolbars
To restore default toolbars
1. Right-click the menu bar and select Customize.
2. Click Reset Defaults.
3. Click OK.
Restoring Lost Toolbars
It is possible to remove all the toolbars from the Editor. If this happens, you can restore the
toolbars to your windows without resetting all the default settings.
Toad for Oracle User Guide
Toad Basics
135
To restore lost toolbars from the Editor only
1. Right-click in the Desktop panels tab area.
2. Select Desktop Panels | Customize Toolbar.
3. Click on the Toolbars tab and select the Editor toolbars you want to display.
Merging Toolbars
With Toad 9.6, the merged toolbar feature has been deprecated. Merged toolbars were designed
to display the most commonly-used commands while leaving you room to work in the active
Toad window, and to disable customization so that buttons could not be removed or moved
accidentally.
If you liked the merged toolbar feature, you can set your toolbar to mimic this behavior.
Note: Locking the toolbars as described in this procedure will lock ALL toolbars, not just the
editor toolbar.
To mimic merged toolbars
1. Right-click over the Editor toolbar and select Restore Defaults.
2. Right-click over the Editor toolbar and hide the Macro toolbar by clicking on it so it is
no longer checked.
3. Right-click over the Editor toolbar and select Lock Toolbars.
Standard Toolbars
Default Toolbar
The default toolbar on the main Toad window is configurable. If your toolbar appears
different from that below, it may have been personalized. See "Configurable Toolbars and
Menus - Overview" (page 122) for more information on configuring the toolbar and restoring
default settings.
Button Command
Open a new Editor window with the current active connection.See "Toad
Editor" (page 854) for more information.
Open a new Schema Browser window with the current active connection. See
"Schema Browser Window Overview" (page 978) for more information.
Open a new Database Browser window. See "Database Browser" (page 532) for
more information.
Open a new Session Browser window. See "Session Browser Overview" (page
551) for more information.
Open a new Query Builder window with the current active connection. See
"Query Builder Overview" (page 933) for more information.
Toad for Oracle User Guide
Toad Basics
136
Open a new Master/Detail browser window. See "Master/Detail Browser" (page
728) for more information.
Open a new Project Manager window. See "Project Manager Overview" (page
472) for more information.
Open an Output window for the current active connection. See "Various Tabs"
(page 879) for more information.
Open the Toad Automation Designer. See "Managing Projects" (page 433) for
more information.
Open a new Object Search window with the current active connection. See
"Object Search" (page 967) for more information.
Open integrated Knowledge Xpert. See "Knowledge Xpert" (page 105) for more
information.
Open a new Script Manager window with the current connection. See "Script
Manager Overview" (page 503) for more information.
Configure or execute an external tool. See "Configure Toad Tools" (page 747)
for more information.
This icon changes if tools have been recently executed. See "Execute Toad
Tools" (page 750) for more information.
Open the Toad Optionswindow. See "Toad Options" (page 623) for more
information.
Save all options normally saved when exiting Toad.
Toggle PL/SQL Profiling. See "Using DBMS_PROFILER" (page 602) for more
information.
Toggle Compiling with Debug.
Commit any changes to this schema.
Rollback any changes to this schema.
Open a new Oracle Connection to the database.
l Main button - open Server Login window.
l >Arrow - select a previously used connection.
See "Server Login Window" (page 177) for more information.
End a current active Oracle connection.
l Main button - open Select Session dialog.
l Arrow - select an active connection.
See "Select Session" (page 268) for more information.
Toggle the tip windows. See "Show Tips" (page 98) for more information.
Desktop Toolbar
The desktop toolbar is available from the Editor and the main Toad toolbar.
Toad for Oracle User Guide
Toad Basics
137
Button Command
Select desktop dropdown
Save current desktop
Delete current desktop
Saving the desktop
When you click the Save current desktop button, the Save Desktop dialog appears. If you find
you no longer need the saved desktop, you can delete it.
To save the desktop
1.
Click .
2. Enter a name for your new desktop and click OK.
To delete the current desktop
1.
Click .
2. Click OK to confirm the deletion.
Editor Toolbars
The toolbars in the Toad editor can be arranged and configured in a way that works for you.
The standard toolbars for the editor contain minimal commands. There are many other commands
available, however, and you can add them to any of the toolbars . See "Altering Toolbars" (page
131) for more information.
The standard toolbars found on the editor include:
l Standard Editor Toolbar (page 138)
l Saving the desktop (page 137)
l Current Schema Toolbar (page 139)
l Execute Toolbar (page 140)
l Edit Toolbar (page 139)
l Source Control Toolbar (page 782)
l Macro Toolbar (page 141)
Toad for Oracle User Guide
Toad Basics
138
Missing Toolbars
See "Restoring Lost Toolbars" (page 134) for more information.
Standard Editor Toolbar
Button Command
Change active session. In the drop down list, the active session is denoted by a
check mark.
Open new editor tab. Click the button to use the default tab type, click the drop
down list to select a tab type.
Close the current active editor tab.
Load from file.
Load from database.
Save.
Save current file as.
Save all files.
Reload file from disk.
Reload from database.
Print tab contents.
Tune code using the SQL Tuning Optimization module.
Profile the selected code.
Send tab contents to Quest Code Tester.
Make code.
Toad for Oracle User Guide
Toad Basics
139
Button Command
Strip code.
Navigate back.
Navigate forward.
Recall previously saved SQL.
Create new PL/SQL Object.
Current Schema Toolbar
The Current Schema toolbar lets you work with a schema other than the one where you are
connected. This can be useful if, for example you have tested a SQL statement in your test
schema and now want to execute it on several other schemas without disconnecting and
reconnecting. To use this feature, you must have the ALTER SESSION privilege.
By default, the current schema is set to your current connection. When you use this command
Toad follows this procedure:
l Issues an ALTER SESSION SET current_schema command
l You can now execute the sql statement against that schema
l Toad issues the ALTER SESSION SET current_schema command again to return to the
connection schema.
Note: This feature does not work with script execution or debugging commands.
Button Command
Use the dropdown to set the schema.
Edit Toolbar
Button Command
Cut and store on clipboard.
Copy to clipboard.
Toad for Oracle User Guide
Toad Basics
140
Button Command
Paste from clipboard.
Select all text.
Clear all.
Find text.
Find next string.
Replace text.
Undo last modification.
Redo last undo.
Convert to upper case.
Convert to lower case.
Convert to initial caps.
Indent right.
Indent left.
Format the selected code.
Execute Toolbar
Icon Command
Compile.
Halt execution.
Toad for Oracle User Guide
Toad Basics
141
Icon Command
Execute as script. Dropdown allows selection of Execute in QSR or Execute in
SQL*Plus.
Run Explain Plan for current statement. See "Explain Plan Overview" (page 716) for
more information.
Compile Dependent objects.
Execute procedure using existing arguments.
Set Parameters. See "Setting Parameters" (page 909) for more information.
Step over the current line of code.
Trace into.
Trace out.
Run to cursor.
Set breakpoint at cursor. See "Setting a Breakpoint" (page 918) for more
information.
Set watch at cursor. See "Adding a Watch" (page 926) for more information.
Debug External Session. See "External Debugging" (page 929) for more information.
Macro Toolbar
Button Command
Select and play macro
Record macro
Stop recording macro
Cancel recording macro
Edit macros
Toad for Oracle User Guide
Toad Basics
142
Menus
Add a Menu
To add a Toad menu
1. Right-click the menu bar and select Customize.
2. Click the Commands tab.
3. Select the Menus category on the left pane.
4. Click the menu you want to add (for example, Team Coding) in the right pane and drag
it to the menu bar where you want it located. The pointer changes to a vertical I-bar at
the menu bar.
To add a customized menu
1. Right-click the menu bar and select Customize.
2. Click the Commands tab.
3. Select the New Menu category on the left side of the window.
4. Click New Menu in the right pane and drag it to the menu bar where you want it located.
The pointer changes to a vertical I-bar at the menu bar.
5. Rename your menu. See "Rename a Menu" (page 143) for more information.
6. Add commands. See "Adding sub-menus" (page 143) for more information.
Delete a Command
To delete command from a menu
1. Right-click the menu bar and select Customize.
2. Click the menu containing the command.
3. Click and drag the command off the menu.
Add a Command
To add a command
1. Right-click the menu bar and select Customize.
2. Click the Commands tab.
3. Select from any of the categories listed. A list of available commands appears in the
right pane.
4. Click a command in the right pane and drag it to the menu where you want it located.
The pointer changes to a vertical I-bar at the menu, and to a horizontal I-bar when the
menu opens. You can place it anywhere in the menu.
Toad for Oracle User Guide
Toad Basics
143
Adding sub-menus
To add an additional menu
1. Right-click the menu bar and select Customize from the menu.
2. Click the Commands tab.
3. Select the New Menu category.
4. In the Commands pane, select New Menu and drag it into the menu where you want it
located. The pointer changes to a vertical I-bar at the menu bar, and to a horizontal I-bar
when the menu opens. You can place it anywhere in the menu you want.
5. Add commands to the flyout in the same way you would add them to the menu itself.
Rearrange Commands
You can rearrange the commands on your toolbars and menus.
To rearrange commands
1. Open the Customize window: right-click in the menu or toolbar and select Customize.
2. Click and drag the item where you want it in any of the menus. An I-bar pointer marks
where the command will be dropped.
Rename a Menu
If you are using customizable toolbars/menus, you can rename menus to suit your needs.
To rename a menu
1. In the toolbar area, right-click and select Customize. Alternately, from the Tools menu,
select Customize. The Customize dialog box appears.
2. Right-click the menu or menu item you want to change. Enter a new name for the Menu
or Menu item. Note that the menu hotkey can be changed or removed at the same time.
See "Menu hotkeys" (page 129) for more information.
Delete a Menu
To delete a menu
1. Right-click in the menu bar and select Customize to display the customize window.
2. Right-click the menu you want to remove. Select Delete from the menu. The
menu is removed.
Installation and Administration of Toad
Window Privileges and Toad
At a minimum, in order to install and run Toad, make a connection, and do basic operations, you
must be a Power User and have read/write privileges on the Oracle homes directories that you
use for your connections. If you are a Power User, you will additionally require read access to
the Oracle client folder.
If you are running Windows Vista, and your account is under UAC (user account control) with
Data Redirection enabled, Toad should be run with administrative privileges.
Toad for Oracle, Read-Only
Toad can be made read only using the two license files: READONLY.LIC and FULLToad.LIC.
What is Toad Read Only?
Toad Read Only is a way to allow users to view data and SQL through Toad without making
changes to the database.
Why use Toad Read Only?
Toad Read Only allows administrators to give their users a powerful tool without worrying
about a user committing a change to a sensitive production instance.
While Toad honors privileges granted to the Oracle user, Toad Read Only will not allow the
user to do anything which changes the content of the database.
Where to get Toad Read Only?
You can make any Toad installation read-only, you can use Toad Security to make selected users
or roles read-only, or you can get a special read-only installation that has extra exclusions to
prevent users from making changes.
How to make any Toad installation Read-Only Using License files
Toad can be made read-only using the two license files: READONLY.LIC and FULLToad.LIC
found in the installation directory where Toad is installed.
Toad.EXE only reads Toad.LIC to determine if it is full Toad or read-only. The license file
contains a setting for read only database access. The network administrator can copy
5
Toad for Oracle User Guide
Installation and Administration of Toad
145
READONLY.LIC over the Toad.LIC on an individual workstation to make Toad read-only at
that workstation. Remember, the Toad.LIC file must be in the Toad folder.
This is the least secure method of limiting Toad.
To use read only license files
Copy READONLY.LIC over the TOAD.LIC on an individual workstation.
Toad Security
Using Toad Security you can make Toad read-only to a selected user or role. This is useful if
you have someone who needs to view database objects but does not have the authority to
change them.
Note: This Toad Security option does not apply to the DB Admin Module. To restrict Toad
entirely, you will also need to restrict the DB Admin Module from the appropriate users.
To make Toad read-only using Toad Security
Move the Read-only Override function from the Features Non-menu list to the Restricted
features list in the Toad Security window. This makes Toad read-only to the selected user.
Toad Read Only Installation
Quest Software, Inc. can provide a read only copy of Toad. The Toad Standard Edition - READ
ONLY install is a read only executable designed to prevent its users from changing the database.
For this reason, it does not include Quest ScriptRunner (which lets a user write a script that can
update database objects), SQLMonitor (which logs SQL calls using the OCI layer), and Server
Side Install (which lets users make changes to Toad schemas).
To download the Toad Standard Edition - READ ONLY install
The Toad Standard Edition - READ ONLY install is available for download from the
Quest Software Support Download Site.
Registering Toad
Use the Licensing window to store the Quest Software registration ID. This indicates to Toad
that you are an authorized user.
To register Toad
1. Select Help | Licensing.
2. Click Modify.
3. Enter your license key in the Keyfield
Note: Toad automatically adds the hyphens in the appropriate location.
Toad for Oracle User Guide
Installation and Administration of Toad
146
4. Enter the Site Message in the Site Message Field.
5. Click Apply.
To update a license.
1. Select Help | Licensing.
2. Click Modify.
3. Make changes to the Key or Site Message as necessary.
4. Click Apply.
To delete a license.
1. Select Help | Licensing.
2. Click Delete License.
3. Confirm that you want to remove the license.
4. Click Apply.
Silent Installation
Toad for Oracle features the ability to configure a silent install in the same manner you would
any MSI command line installation. Extract the installers as described in Extracting the MSI
Installer below.
Extracting the MSI Installer
In order to perform a silent install for Toad for Oracle, you must first extract the MSI file from the
Quest Installer. This MSI is then used with the installation variable (ADDLOCAL parameter in
the examples below) to define the type of install you want to perform.
The Quest Installer must be launched in extraction mode from the command line. At this point
you can extract the various MSI installers for use with a silent installation.
To extract the MSI
1. Run your Toad bundle from the command prompt, including the correct path to the
directory where it resides, and the /extract parameter. as the .exe will contain spaces,
remember to include the quotation marks. Example:
c:>\Toad DBA Suite for Oracle 9.7 Commercial.exe/extract
2. Your bundle .exe will be one of the following:
l Toad DBA Suite for Oracle 9.7 Commercial.exe
l Toad Development Suite for Oracle 9.7 Commercial.exe
l Toad for Oracle 9.7 Suite Commercial.exe
l Toad for Oracle 9.7 Commercial.exe
Toad for Oracle User Guide
Installation and Administration of Toad
147
l Toad for Oracle 9.7 Read Only.exe
Note: The Quest installer launches in extract mode, and all references to installing
will be replaced with extracting.
3. Change the path for the extracted files if desired. The default path is the current users
Temp directory:
C:\Documents and Settings\<current user>\Local Settings\Temp\bundle
name.
4. Click Next.
5. Select the products you want to extract. By default, all available products are selected.
Click Next.
6. Review your selections on the Summary and Confirmation screen. If you want to change
a selection, click the Back button and make your changes. Then click Extract.
7. Select one of the two hyperlinks to continue:
l Specified Location - opens the directory where your files have been extracted.
l Readme.txt - opens the extraction log in Notepad.
Note: The extraction log contains verification of the files that have been extracted,
along with the command line parameters needed to perform default installations of
the products.
Full Installation
The Windows internal command msiexec.exe launches the MSI and passes command line
parameters set by the user. A typical command line might look like this:
msiexec /i "<path to msi file, including file name>"INSTALLDIR="<installation
folder, including final \>" ADDLOCAL=Client,Server/q /l*v <path to install
log, including file name>
Note: INSTALLDIR must include the final \ in order for a silent installation to be performed.
For example:
msiexec /i "C:\Documents and
Settings\johndoe\desktop\ToadforOracle97.exe"INSTALLDIR="C:\Programs\Quest
Software\Toad for Oracle" ADDLOCAL=Client,Server/q /l*v "C:\install.log"
Network Installation
For a silent network install, you would first extract the MSI from the Quest Installer then install
the server side with a command similar to:
msiexec /i "<path to msi file, including file name>"INSTALLDIR="<installation
folder, including final \>" ADDLOCAL=Server /q /l*v <path to install log,
including file name>
For example:
Toad for Oracle User Guide
Installation and Administration of Toad
148
msiexec /i "C:\Documents and
Settings\johndoe\desktop\ToadforOracle97.exe"INSTALLDIR="Z:\Programs\Quest
Software\Toad for Oracle" ADDLOCAL=Server/q /l*v "C:\install.log"
Then install the client side by running a command line that looks like the following:
msiexec /i "<path to msi file, including file
name>"INSTALLDIR="<installation folder, including final \>" ADDLOCAL=Client
SERVERDIR="<path to server folder, including final \>" /q /l*v <path to
install log, including file name>
Where SERVERDIR is the same as INSTALLDIR from the previous command that silently
installed the server side.
For example:
msiexec /i "C:\Documents and
Settings\johndoe\desktop\ToadforOracle97.exe"INSTALLDIR="C:\Programs\Quest
Software\Toad for Oracle" ADDLOCAL=Client SERVERDIR="Z:\Programs\Quest
Softare\Toad for Oracle" /q /l*v "C:\install.log"
Note: Both INSTALLDIR and SERVERDIR must include the final \ in order for a silent
installation to be performed.
Citrix Installation
For a silent Citrix installation, use the Full Installation instructions.
Silent Uninstall
Uninstalling the MSI is similar. Use an "x" in place of the "i" and do not include the
INSTALLDIR property, i.e.:
msiexec /x "C:\Documents and
Settings\johndoe\Desktop\ToadforOracle91SetupFull.msi" /q
Toad for Oracle User Guide
Installation and Administration of Toad
149
Options, Parameters and Meanings
Option Parameter Meaning
ADDLOCAL Client, Server Determines the type of install. Parameters denote:
l Client - client install only
l Server - server install only
l client, server - full install
/i Package |
ProductCode
Installs or configures a product.
/f [p | o | e | d | c | a | u
| m | s | v]
Package |
ProductCode
Repairs a product. This option ignores any
property values entered on the command line.
The default argument list for this option is 'omus.'
p - Reinstalls only if file is missing.
o - Reinstalls if file is missing or an older version
is installed.
e - Reinstalls if file is missing or an equal or
older version is installed.
d - Reinstalls if file is missing or a different
version is installed.
c - Reinstalls if file is missing or the stored
checksum does not match the calculated value.
Only repairs files that have
msidbFileAttributesChecksum in the Attributes
column of the File table.
a - Forces all files to be reinstalled.
u - Rewrites all required user-specific registry
entries.
m - Rewrites all required computer-specific
registry entries.
s - Overwrites all existing shortcuts.
v - Runs from source and re-caches the local
package. Do not use the v reinstall option for the
first installation of an application or feature.
/a Package Administrative installation option. Installs a
product on the network.
/x Package/ProductCode Uninstalls a product.
Toad for Oracle User Guide
Installation and Administration of Toad
150
Option Parameter Meaning
/l [i | w | e | a | r | u | c |
m | o | p | v | x | + | !
| *]
Logfile
Writes logging information into a logfile at the
specified existing path. The path to the logfile
location must already exist. The installer does
not create the directory structure for the logfile.
Flags indicate which information to log. If no
flags are specified, the default is 'iwearmo.'
i - Status messages.
w - Nonfatal warnings.
e - All error messages.
a - Start up of actions.
r - Action-specific records.
u - User requests.
c - Initial UI parameters.
m - Out-of-memory or fatal exit information.
o - Out-of-disk-space messages.
p - Terminal properties.
v - Verbose output.
x - Extra debugging information. Only available
on Windows Server 2003.
+ - Append to existing file.
! - Flush each line to the log.
"*" - Wildcard, log all information except for the
v and x options. To include the v and x options,
specify "/l*vx".
/q n | b | r | f Sets user interface level.
q , qn - No UI
qb - Basic UI. Use qb! to hide the Cancel button.
qr - Reduced UI with no modal dialog box
displayed at the end of the installation.
qf - Full UI and any authored FatalError,
UserExit, or Exit modal dialog boxes at the end.
qn+ - No UI except for a modal dialog box
displayed at the end.
qb+ - Basic UI with a modal dialog box
displayed at the end. The modal box is not
displayed if the user cancels the installation. Use
qb+! or qb!+ to hide the Cancel button.
qb- - Basic UI with no modal dialog boxes.
Please note that /qb+- is not a supported UI
level. Use qb-! or qb!- to hide the Cancel button.
Toad for Oracle User Guide
Installation and Administration of Toad
151
Option Parameter Meaning
Note that the ! option is available with Windows
Installer 2.0 and works only with basic UI. It is
not valid with full UI.
Group Policy Management
The Toad Group Policy Manager is a free utility which is currently available with a licensed
copy of Toad for Oracle. Quest Software reserves the right to remove, change or alter this utility
at any time. The Toad Group Policy Manager provides a facility by which multiple copies of
Toad within an organization can share the same set of options. It consists of a Windows Service
which runs on a common server and publishes subsets of option data to defined groups of Toad
users via TCP/IP, and an Editor which is used to define option sets and user groups. Users can be
restricted from changing published Toad options or permitted to alter them.
Note: Toad Group Policy Management is not Unicode-compliant.
Using the Toad Group Policy Editor, policies and standards can be distributed throughout a
group environment.
The Group Policy functionality consists of three parts:
l Group Policy Server
l Group Policy Editor
l Toad Policy files
Additional information is provided in the Toad Policy Editor help file, also available as the
GrpPlcyEdtr.pdf file.
Toad
All installations of Toad will have a toad.pdl file in the installation directory. This file is
encrypted, and required to be present and uncorrupt for Toad to function (whether or not Group
Policy Management is enabled).
If you find Toad functionality limited, check the Toad Advisor. Functionality that has been
limited will be noted with a notation of Restricted or Published. See "Toad Advisor" (page 99)
for more information.
Citrix Support
Toad supports installation on Citrix servers.
Toad for Oracle User Guide
Installation and Administration of Toad
152
Installing Toad on a Citrix server
Toad must be installed on the Citrix server by the Citrix administrator. Users then connect to this
instance through their Citrix logon.
Citrix support is enabled with the full installation of Toad. Toad requires write access to the
server registry during installation and read access during run-time to achieve Citrix support.
Full procedures for installing Toad on a Citrix server are located in the Getting Started Guide.
Connecting to Toad through Citrix
To connect through a client
Log into the Citrix Program Neighborhood and execute Toad.
Note: The first time you execute Toad you will be asked to enter a license key.
Your Citrix administrator will provide you with the license key.
User Configuration Files in Citrix
Toad is installed on the Citrix server, and individual user settings are maintained for each
client machine.
Individual user settings and properties files are maintained in the user's settings file:
C:\Documents and Settings\user_name\Application Data\Quest Software\Toad
Script Manager and Citrix
Toad installs packaged SQL Scripts with the Script Manager. When Toad is run in a Citrix
environment, the default paths to these script manager files will be wrong.
To use these, you may need to manually change these paths once.
To change the Script Manager paths for use with Citrix
1. Open Utilities | Script Manager and select the DBA category from the dropdown box.
2. Click the move button and enter your new path: C:\Documents and Settings\User
Name\Application Data\Quest Software\TOAD\ScriptMgr\DBA.
3. Repeat for the Schema Objects category and move to C:\Documents and
Settings\User Name\Application Data\Quest
Software\TOAD\ScriptMgr\Schema Objects.
SQL*Net Versions
Toad does not require any other support libraries beyond the 32 bit Net client itself.
Toad for Oracle User Guide
Installation and Administration of Toad
153
Oracle Version Name of Client
Software
Name of DLL
Oracle 8 and 8i Net8 Oraclient8.dll
Oracle 9i Oracle Net9 Oraclient9.dll
Oracle 10g Standard
Client
Oracle Net10 oraclient10.dll
Oracle 10g Instant Client
(Universal Installer
Version)
Oracle Net10 oraociei10.dll
Oracle 11g Client Oracle Net11 oraclient11.dll
If you have the client above installed and can connect to Oracle using any of Oracle's tools (with
the exception of SQL*Plus), Toad should work properly.
Note: The most frequent cause of problems is the resetting of the PATH environment variable.
To set your default Oracle home, you can use the Oracle Home Selector (provided with Oracle)
to set it accurately. (See your Oracle documentation for more information.)
Configuration Files
V$ Tables Required
Note: This list is always expanding. If you receive a "Table does not Exist" error, you can find
what table is missing by spooling SQL to screen to see the code Toad is using. See "Spool SQL"
(page 744) for more information.
Access to V$ synonyms required on some common Toad windows are:
AutoTrace (Editor/Query Builder)
V_$Sesstat
V$Statname
V$Session
Optimization & Session Info screens
The following public synonyms must be present.
v$rowcache
v$sysstat
v$system_event
Toad for Oracle User Guide
Installation and Administration of Toad
154
v$librarycache
v$STATNAME
v$SESSTAT
v$sess_io
v$session
v$process
v$latch
Database Browser
The following public synonyms must be present.
V$DATABASE
v$datafile
v$filestat
V$INSTANCE
v$latch
v$librarycache
V$OPTION
V$PARAMETER
v$rollname
v$rollstat
v$sess_io
v$session
v$sesstat
v$sgastat
v$sqlarea
v$statname
v$sysstat
v$system_event
v$tablespace
Database Probe
The following public synonyms must be present.
Toad for Oracle User Guide
Installation and Administration of Toad
155
V$ARCHIVE_PROCESSES
V$BH
v$buffer_pool
V$buffer_pool_statistics
v$database
v$dispatcher
V$INSTANCE
v$librarycache
v$library_cache_memory
V$LOG
V$LOG_history
V$PARAMETER
v$pq_slave
v$process
V$ROWCACHE
v$session
V$SESSTAT
v$sga
v$sgastat
V$STATNAME
v$sysstat
v$version
Database | Monitor | Database Monitor
The following public synonyms must be present.
v$sysstat
v$system_event
v$session
v$librarycache
x$ksllt
v$sgastat
Toad for Oracle User Guide
Installation and Administration of Toad
156
Database | Diagnose | Database Health Check
The following public synonyms must be present.
v$version
v$instance
v$sysstat
v$librarycache
v$rowcache
v$sgastat
v$parameter
v$database
v$log_history
v$filestat
v$datafile
v$tablespace
Database | Monitor |Index Monitor
To see indexes other than your own you must have access to the following:
sys.ob$
sys.ind$
sys.user$
sys.object_usage
You must also have the ALTER ANY INDEX privilege.
Database | Administer | Oracle Parameters
The following public synonym must be present:
v$parameter
Database | Diagnose | LogMiner
The following public synonyms must be present.
v$logmnr_contents
v$logmnr_logs
You must also have:
Toad for Oracle User Guide
Installation and Administration of Toad
157
l Execute privileges on DBMS_logmnr
l Execute privileges on DBMS_logmnr_d
l the Parameter UTL_FILE_DIR set in init.ora (Oracle 8i only)
Database | Monitor | SGA Trace
The following public synonyms must be present.
v$sqlarea
v$sqltext_with_newlines
You must also have:
access to the V$ Oracle Dictionary views
Debugging
No special public synonyms required. However:
DBMS_DEBUG must be valid
On 10g databases:
Debug Connect Session privileges must be granted
Instance Manager | Shutdown
The following public synonym must be present.
v$parameter
V$INSTANCE
Toad Server Statistics | Analysis
The following public synonyms must be present.
V$SESS_IO
V$SESSION
V$PROCESS
V$STATNAME
V$ROWCACHE
V$SYSSTAT
V$SYSTEM_EVENT
V$LIBRARYCACHE
V$SESSION_PRIVS
Toad for Oracle User Guide
Installation and Administration of Toad
158
Toad Server Statistics | Waits
The following public synonym must be present.
V$SYSTEM_EVENT
Toad Server Statistics | Latches
The following public synonym must be present.
V$LATCH
Toad Server Statistics | Sessions
The following public synonyms must be present.
V$SESS_IO
V$SESSION
V$PROCESS
V$STATNAME
Toad Server Statistics | Instance Summary
The following public synonym must be present.
V$SYSSTAT
Toad Session Browser
The following public synonyms must be present:
V$SESSION
V$PROCESS
V$SESS_IO
V$SESSION_WAIT
V$SESSION_EVENT
V$ACCESS
V$SESSSTAT
V$STATNAME
V$OPEN_CURSOR
V$SQL
V$LOCK
Toad for Oracle User Guide
Installation and Administration of Toad
159
V$SESSION_LONGOPS
V$SQLTEXT_WITH_NEWLINES
In addition, you must have access to the following:
SYS.V_$TRANSACTION
SYS.V_$ROLLNAME
Space Manager Setup
The following public synonym must be present.
V$SYSSTAT
The Toad schema must have the privileges to create and alter jobs, create and drop its own tables
and procedures, and must have SELECT access on the following:
DBA_DATA_FILES
DBA_FREE_SPACE
DBA_JOBS
DBA_TABLESPACES
V_$FILESTAT
The Toad INI file
There are only a few settings that require a manual edit of the TOAD.INI file. For all other
settings, use the appropriate GUI.
SQL Results panel splitter
[SETTINGS]
SLIDER_TOP=200
If you cannot see the SQL Results panel because of resizing the MDI child window too small,
you can quit Toad, edit this value to a low number, like 150 or 200, and restart Toad. There is
no default value.
Keep users from dropping or truncating tables
[SETTINGS]
ALLOW_DROP_TBL=0
By default, Toad permits the user to drop tables and truncate tables. If you do not want to give a
Toad user this power, put in ALLOW_DROP_TBL=0 into their TOAD.INI file. The default is 1.
Put lines of comments between identifier and name of procedure
The default to this is not included automatically in the TOAD.INI file. You can add it:
Toad for Oracle User Guide
Installation and Administration of Toad
160
[SETTINGS]
PELineOffsetOverride=1
On is 1, set it to 0 to turn it off without deleting it.
You should only set this if you want to put lines of comments between the identifier and the
name of the procedure, as in:
create or replace procedure
-- xx
-- yy
aaa
as
begin
raise no_data_found ;
end ;
/
For Toad to use the correct line number in the above example, this setting must be on (
PELineOffsetOverride=1).
However, if this is on (PELineOffsetOverride=1), you will then get the wrong line # for cases
where you do this:
create or replace procedure aaa
-- xx
-- yy
as
begin
raise no_data_found ;
end ;
/
How to create your ToadStats.ini file
On the Toad Server Statistics window, Analysis tab, if you do not have the Documents and
Settings\username\Toad for Oracle\ToadStats.ini threshold file, these are the default threshold
values used. See "Toad Server Statistics" (page 517) for more information.
INI
Entry
Min
Value
Warn
Value
Max
Value
Description Warning
Message
dg_
row
-9999 -9999 -
9999
dictionary
gets
n/a
dm_
row
98 -
9999
-
9999
dictionary
misses
n/a
dcr_
row
-
9999
-
9999
-
9999
dictionary
cache hit
rate
high
dictionary
cache
miss
bcr_
row
90 -
9999
-
9999
buffer cache
hit ratio
may need
to increase
Toad for Oracle User Guide
Installation and Administration of Toad
161
db_block_
buffers
dsr_
row
-
9999
-
9999
10 disk sort
ratio
increase
SORT_
AREA_
SIZE or
tune the
SQL
bbw_
row
-
9999
-
9999
1 buffer busy
wait ratio
tables with
insufficient
free lists or
too few
rollback
segments
or extents
fbw_
row
-
9999
-
9999
1 free buffer
wait ratio
too many
disk sorts?
lchr_
row
85 -
9999
-
9999
library cache
get hit ratio
dynamic or
unsharable
SQL?
lcpr_
row
-
9999
-
9999
1 redo space
wait ratio
n/a
lcpr_
row
90 -
9999
-
9999
library cache
pin hit ratio
Shared
Pool area
too small
rswr_
row
-
9999
-
9999
1 redo space
wait ratio
n/a
cfr_
row
-
9999
-
9999
0.01 chained fetch
ratio
PCTFREE
too low for
a table
per_
row
-
9999
-
9999
20 parse/execute
ratio
high parse
to execute
ratio
cpo_
row
-
9999
-
9999
15 cpu parse
overhead
high parse
cpu
overhead
tsr_row -
9999
-
9999
-
9999
ratio of rows
from
idx/total
rows
low ratios
indicate
too many
full
dbwra_
row
-
9999
-
9999
255 DBWR avg
scan depth
# DB_
FILES too
high?
dbwrs_
row
-
9999
-
9999
-
9999
DBWR avg
buffers
n/a
Toad for Oracle User Guide
Installation and Administration of Toad
162
scanned
-9999 = No value
To set your own custom thresholds, create an ini file, called ToadStats.ini. Place this file into
your Toad for Oracle\User Files folder.
For each "INI Entry" above, you can set Minimum values, Warning values, and Maximum
values. Also, you can specify a custom Title and Set the warning message when the warning
value is exceeded.
When the warning value is exceeded, the circle is pink. When the maximum value is exceeded,
the circle is red.
As in standard Windows .ini format, place the "INI Entry" string within left and right brackets.
This becomes the section. Then, you can place Min, Warn, Max, Title, and ErrorMsg items into
each section.
For example:
[dm_row]
Min=98
[bcr_row]
Min=90
[dsr_row]
Max=10
[bbw_row]
Max=1
[fbw_row]
Max=1
[lchr_row]
Min=85
Warn=90
ErrorMsg=Dynamic or Unsharable SQL?
[lcpr_row]
Max=190
Toad for Oracle User Guide
Installation and Administration of Toad
163
Warn=80
Title=library cache pin hit ratio
[rswr_row]
Max=1
[cfr_row]
Max=0.01
[per_row]
Warn=17
Max=20
Title=Parse to Execute Ratio
ErrorMsg=High parse to execute ratio
[cpo_row]
Max=15
[dbwra_row]
Max=255
Properties Files
Options settings for Toad are stored in several different locations. We maintain them this way so
that it is easier to reset or share only a small set of options.
Location Options file Function
Toad for Oracle directory/docs 3rdprtylic.txt Contains copies of our 3rd party license
agreements
Toad.chm, Toad.pdf,
ReleaseNotes.htm, Tips Folder
Help files, User Guides, Release Notes, and
Tips folder.
Toad for Oracle directory
beef.dat Export File Browser
chc.rev CodeXpert
Toad for Oracle User Guide
Installation and Administration of Toad
164
Location Options file Function
CMDLineCEGrid.xslt CodeXpert Command Line - Grid
CMDLineCEScripts.xslt CodeXpert Command Line - Scripts
CMDLineCETrees.xslt CodeXpert Command Line - Trees
cvs.ini Holds options and logins for CVS
integration.
DatabaseProbe.txt Stores the settings and alerts for the Database
Probe.
FmtPlus.opt, FmtOptions.ini Contain options for code formatting.
install.txt Contains start and end times for Toad
installation.
install.log Detailed log file for Toad installation
qexplainplan2full.msi Explain plan install file
QSR.ini Stores settings for Quest ScriptRunner
(qsr.exe).
releasenotes.html Toad Release notes
rolelog.txt Stores previously created Team Coding roles.
RNetPin.ini This stores the full path to the file CHC.rev
This is setup by the installer and only needs
modification if you copy your Toad
directory to another location.
RuleUniverse.xml Stores CodeXpert rules.
SBQueries.dat Stores Custom Queries for the Schema
Browser.
SettingsLocations.ini Stores the path of the /User Files folder
SilentInstallNotes90 Stores the instructions for Silent Install.
TNSLoad.xslt TNSNames Editor
TNSSave.xslt TNSNames Editor
Toad for Oracle User Guide
Installation and Administration of Toad
165
Location Options file Function
TNSValidate.xslt TNSNames Editor
unidbmon.cfg Stores settings for Quest SQL Monitor
(SQLMonitor.exe).
Documents and Settings\username
\User Files
aliases.txt Stores your previously used table aliases.
AWRCharts.ini Stores your configurations for displaying
charts in the AWR browser. See
"ADDM/AWR (OEM)" (page 520) for more
information.
codemap.ini Stores colors for objects in the Code Road
Map. See "Road Map Overview" (page 721)
for more information.
CodeXpert.ini Stores locations and names of all rule sets
used by CodeXpert. It also stores window
sizing and position for a modal window that
CodeXpert uses.
coloring.txt Script Engine (QSE.exe) syntax highlighting.
coloring1.txt Script Engine (QSE.exe) syntax highlighting.
Connectionpwds.ini Stores your server information, and any
passwords that you choose to have Toad
save. These are tied to a single machine.
Passwords are not observed if you migrate
Toad settings from one machine to another.
connections.ini Stores connect info for the server login
window. See "Server Login Window" (page
177) for more information.
DatabaseBrowser.tdb Stores the treeview for the left hand side of
the Database Browser.
DatabaseProbe.ini Stores customization and alerts for the
Database Probe. See "Database Probe
Overview" (page 538) for more information.
Toad for Oracle User Guide
Installation and Administration of Toad
166
Location Options file Function
DataModeler.ini Stores configuration for the Query Builder
<dbname>\DefSchema.txt Holds the name of the default schema for
that database.
<dbname>\<username>_
tablefilters.xml
Store filters for the schema browser right
hand side grids for the specified connection.
<dbname>\<username>\
DefSchema.txt
Holds the name of the default schema for
that user\database combination
DBWizSettings.ini Stores saved settings for the Database
Creation wizard.
desktops.xml Holds Toad desktop configurations.
Editor_toolbars.ini Stores custom toolbar configurations of the
Editor.
Editor_toolbars_Default.ini Stores the default toolbar configurations for
the Editor.
EditorFooter.txt
EditorHeader.txt
EditorLayout_hex.lay
EditorLayout_PLSQL.lay
EditorLayout_Text.lay
EditorLayout_XML.lay
EditorMacros.bin
Explainplancolumndefs.xml Stores Default column settings for Explain
Plan.
ExplainPlanGlobalPrefs.xml Stores explain plan text colors and fonts.
ExplainPlanUserPrefs.XML Stores explain plan column visibility
information, widths, and order.
ExportWizSettings.ini Stores saved settings for the Export Utility
wizard.
Toad for Oracle User Guide
Installation and Administration of Toad
167
Location Options file Function
Filters.txt Stores previous filters for the Filter Data
window. See "Filter Condition" (page 954)
for more information.
Filecompare.ini Holds options for the Differences Viewer.See
"Viewing File Differences" (page 257) for
more information.
Files with a .FLT extension Store filters for the schema browser left hand
side.
Files with an SDF extension Store your Categories for the Script Manager.
Files with a .TMD extension Store configuration info for the Master/Detail
Browser.
FindDirs.txt Stores find dialog directory saves.
ftp.ini Stores user FTP information.
Healthcheck.htm DB Health Check File. See "DB Health
Check" (page 287) for more information.
htmlsub.txt Stores html editor autocorrect settings.
ImportWizSettings.ini Stores saved settings for the Import Utility
wizard
jobdates.txt Not editable through Toad, but users can
alter it to change the drop down menus in
the Create/Alter job window. See "Create
and Alter Jobs" (page 1022) for more
information.
LexLib.lxl The lexicon library for the Editor formatting
component.
LoginGrd.ini Stores the configuration of the grid in the
Server Login window. See "Server Login
Window" (page 177) for more information.
MainFormLayout_default.lay
MenuShortcuts.ini Custom shortcut keys for the main Toad
menu.
NewEditorBarItems.ini
Toad for Oracle User Guide
Installation and Administration of Toad
168
Location Options file Function
NewMainFormBarItems.ini
NewCompoundTrig.sql,Newfunc.sql,
Newproc.sql, Newpackage.sql,
NewPackageBody.sql,
NewPkgFunc.sql, NewPkgProc.sql,
Newtrig.sql, Newtype.sql,
Newtypebody.sql, NewTypefunc.sql,
NewTypeproc.sql
Your default templates for creating new
objects in the Editor.
Oracle Data Dictionary.sdf Pre-created Script Manager datafile
containing Oracle 8i data dictionary scripts.
See "Script Manager Overview" (page 503)
for more information.
OriginalEditorLayout_Hex.lay
Original EditorLayout.PLSQL.lay
Original EditorLayout.SQL.lay
Original EditorLayout.Text.lay
Original EditorLayout.XML.lay
OriginalMainFormLayout_
default.lay
Params.txt Parameters for single line queries in the SQL
editor.
Project.tpr Holds information for the Project Manager
window.
Project_bak.tpr Holds information for the Project Manager
window as a backup.
ProjectConfig.txt Holds information for the Project Manager
Window.
REVWORDS.TXT
SavedSQL.dat Stores your Named SQL, Personal SQL and
SQL history.
SBFilterList.xml Schema Browser filter list.
SBProjManFilterList.xml Stores Schema Browser filter list for the
Project Manager.
Toad for Oracle User Guide
Installation and Administration of Toad
169
Location Options file Function
SchemaCompSummary Stores summary information for the Schema
Compare feature. See "Compare Schemas"
(page 260) for more information.
SchemaObjects.sdf Script manager datafile containing pre-
created Schema objects.
Services.ini Stores the list of services for the Service
Manager window. See "Service Manager"
(page 746) for more information.
SGATrace.ini Saves the layout of your SGA Trace
window's grid. See "SGA
Trace/Optimization" (page 567) for more
information.
SQLFILES.TXT
SQLLoaderSettings.ini Stores saved settings for the SQL*Loader
wizard. See "Troubleshooting" (page 420) for
more information.
StatsPackCharts.ini Stores configuration information for the
Chart area of the Statspack Browser. See
"StatsPack Browser Overview" (page 571) for
more information.
Sysviews.txt Preserves system view names.
templates.xml Stores MakeCode and CodeSnippets
templates.
temptxt.txt Stores temporary text for Schema Compare.
Terr.sql Contains export grants. If you lose your
connection while attempting to save, this file
is created.
TOAD.INI Stores many of the basic Toad options,
including most items from View | Toad
Options.
Toad_GUI.ini Stores Toad Session Browser GUI settings.
Toad for Oracle User Guide
Installation and Administration of Toad
170
Location Options file Function
Toad_GUI2.ini Stores GUI settings for other Toad windows.
Toad_SessBrowFilters.ini Stores the filters for the Session Browser.
ToadActions.dat Contains saved ToadActions
ToadActions.log Contains the logfile for used ToadActions
and their results.
ToadMAIL.ini Stores settings from View | Toad Options |
Email Settings
ToadMONITORS.ini Stores settings from View | Toad Options |
Monitors and View | Toad Options | Instance
Manager.
ToadParams.ini Stores the parameters you have previously
entered for the Debugger.
ToadRun.txt Toad command-line run file.
Toad_SessBrowFilters.ini Stores the filters for the Session Browser.
toadstats.ini Not editable through Toad, but users can
change it to affect the DBA | Server
Statistics window.
ToadTips.dat Contains any information you have entered
into the note field of the ToadTips window.
toolbars.ini Toolbar and menu configuration for the main
Toad window.
Toolbars_Default.ini Default toolbar and menu configuration for
the main Toad window.
TopSess.ini Holds your list of profiles for the Top
Session Finder.
views.txt Preserves user views.
\<servicename>\
<username>Syns.txt
Holds the lists of synonyms for syntax
highlighting.
Toad for Oracle User Guide
Installation and Administration of Toad
171
Location Options file Function
\<servicename>\
<username>Views.txt
Holds the lists of synonyms and views for
syntax highlighting.
\<servicename>\ projects.lst Holds the configurations of the Favorites tab
on the Schema Browser.
Documents and Settings\username
\ATResults
ressume.res
Documents and Settings\username
\RMAN Templates
.rcv files RMAN Template files:
Default provided with Toad:
l RMANDBHotBackup.rcv
l RMANDBHotBackupIncr0.rcv
l RMANDBHotBackupIncr1.rcv
l RMANSetup.rcv
l RMANTSHotBackup.rcv
See "RMAN Scripts in Toad" (page 244) for
more information.
Documents and Settings\username
\RuleSets
Contains RuleSets for CodeXpert. These
should not be modified except through the
RuleSets dialog box in Toad. See
"Configuring RuleSets" (page 327) for more
information.
Documents and Settings\username
\ScriptMgr
DBA folder
Schema Objects folder
Documents and Settings\username
\Unixjobs
Files with a .JDF extension Store information for the Unix Scheduler.
Transferring Configuration files
If you are installing Toad on a new computer, you may want to move your settings, personal
SQL, SQL History and Named SQL Statements to the new machine. This will save you the
trouble of recreating all of these settings.
Toad for Oracle User Guide
Installation and Administration of Toad
172
To transfer all personalized settings
1. Install Toad on the new machine.
2. Copy the Documents & Settings\username\User Files folder from your old machine to
the new machine, making sure the file structure remains the same.
Server Side Objects Installation
Installing Server Side objects
Several Toad features require objects installed on the server side of the Oracle instance. These
objects can be installed into the Toad schema, an individual schema, or a third, publicly
accessible schema. They may not be installed into more than one of these choices, or problems
can occur.
Features with server side objects Schemas where the features can be installed
Toad Individual Publicly
Accessible
CodeXpert X X
Data Generation X X X
Explain Plan

X X X
Profiler X X X
Team Coding X X
Space Manager
*
X
Security X
The Explain Plan Server Side Objects can be installed and edited from within Toad itself. They
are not included in the Server Side Objects wizard.
* The Space Manager wizard helps you set up the privileges for Toad, but the View Tablespaces
window will install and administer the objects. See "View Tablespaces" (page 359) for more
information.
Note: These server side objects apply only to their corresponding features, and Toad's other
features will run successfully without the server side objects.
Caution: Explain Plan tables and Toad Profiler objects should be installed into EITHER the
Toad schema or an individual user schema, not both.
Toad for Oracle User Guide
Installation and Administration of Toad
173
The Server Side Objects Install wizard makes installing and administering these objects easier. It
runs when you install Toad, and you can access it from within Toad to create or administer
additional objects after installation.
Note: The order of steps in the Server Side Objects Install wizard depends upon your choices in
each step. Because of this, the descriptions are not numbered as steps in the help file. It is
recommended that you use the F1 key to open the appropriate help topic for the step of the
wizard where you are located.
When the install wizard opens, it looks for an existing TOAD.INI file. If found, the wizard will
use the connection options from the Server Login window (Toad Home, Force SQLNet, etc).
Using the Server Side Install Wizard
In order to install server side objects, you will need to have access to either the account for the
Toad user, the account for the schema where you are installing them, or an account with the
DBA role.
To install server side objects
1. From the Database | Administer menu, select Server Side Objects Wizard. The wizard
appears.
Toad for Oracle User Guide
Installation and Administration of Toad
174
2. Select what you want to do:
Install, upgrade or remove
objects for all users to share
Use this to create and
administer a special schema
called TOAD. This schema
gives you a central location
from which to maintain the
tables needed to run the above-
mentioned portions of Toad.
You could create some of these
objects (Explain Plan and
Profiler) in every schema in
which you intend to use them
(in other words, every schema
would have these same tables,
see below) but if you have a
large number of users, using the
Toad schema is more efficient.
In addition, Toad Security,
ObjectName, and Team Coding
must reside in the Toad
schema.
Install, upgrade or remove
objects for an individual
schema to use
If you do not want to create the
Toad user, you can create and
administer certain objects in
the schemas where you intend
to use them. This may be more
efficient if you have a small
number of users for these
special features and you do not
want all of your users to have
access.
Create setup scripts without a
database connection
You can create the scripts to
set up the Toad schema, and so
on without access to the
database connection you need.
Then you can log in later and
run the scripts.
3. Refer to the following for more information:
Administer TOADschema
Logon information Whether you are using a TNS
file or an LDAP server, servers
Toad for Oracle User Guide
Installation and Administration of Toad
175
will be listed in the database
list.
Dropping the TOADschema The Toad user and associated
public synonyms will be
dropped. If you previously set
up Team Coding, you will also
be prompted to drop any roles
created for Team Coding.
Administer Private Schema If you choose to administer
server side objects on an
individual basis, remember that
each user will need to have
setup done individually.
Server Side Objects
Code Xpert Allows reports to be saved and
retrieved in the database.
Toad Security Set up Security administrator
who can restrict user access to
features of Toad.
Caution:Users who have
not been granted direct
rights to Security
Administration may still be
able to administer Toad
Security if they have been
granted the appropriate
rights through a role or
through system privileges.
This can be avoided by
maintaining strict control
over rights and privileges
granted to users.
Toad Profiler
Caution:Toad Profiler
objects should be installed
into either the TOAD
schema or an individual
user schema, but not both.
Space Manager From the wizard, you can:
l Drop the Space
Toad for Oracle User Guide
Installation and Administration of Toad
176
Manager job and
objects, removing the
ability to use Toad
Space Manager.
l Grant Toad the
necessary privileges to
configure Space
Manager.
Note:Space Manager must be
set up while connected to the
Toad Schema.
Team Coding Roles This feature must be installed
in either the Toad schema, or
another publicly accessible
schema, such as SQLNAV. See
"Using Team Coding in SQL
Navigator Environments" (page
785) for more information.
Roles must be set for the Team
Coding environment. The
standard roles are:
l Administrator:TC_
Administrator
l Project Manager:TC_
ProjectManager
l Team Leader:TC_
TeamLeader
Creating Scripts without a
Database Connection
When completed, you can load
the script into the Toad Editor
and create the necessary
objects.
4. Complete the wizard.
Connecting to Oracle
Server Login Window
To access the Server Login window
From the Session menu, select New Connection.
Troubleshoot the Server Login Window
Problem Possible Solution
There's an X beside TNSNames
Editor or SQLNet Editor.
Toad can't find the TNSNames.ora file or the
appropriate SQLNet file. Make sure they are in the
appropriate directory, and that your path points to
them.
Toad is connecting with the wrong
Oracle Home
The default home that Toad uses matches the one
you have chosen in the Oracle Home Selector,
unless you have previously selected the check
box: Make this the Toad default home.
All of my past connections are not
visible in the grid.
Check that the Show favorites only box is not
selected.
Toad is/is not saving the password for
a connection.
Make sure the Save Password column is selected
or cleared as appropriate in the row for that
connection. If Toad is saving all passwords and
you do not want them saved, make sure the Save
passwords check box beneath the grid is cleared.
Using the Connection Grid
The connection grid contains connections you have used in the past: User (Schema), Oracle
Home, Server (database alias), and Last Connect (date and time). You can define connection
options in the grid as well, for example:
l auto connect
l save the password
l connect mode
6
Toad for Oracle User Guide
Connecting to Oracle
178
If you have added connections to your favorites list, you can view only those connections by
clicking the Favorites checkbox at the bottom of the screen.
l Sort any one of the first three columns in Ascending or Descending order by clicking the
column header.
l Column widths are automatically adjusted to display entire contents.
l Toad saves the grid sort column; order; and the size and placement of the Server Login
window between Toad sessions.
To connect to a previous connection
Double-click on the connection in the grid.
Showing only selected columns in the connection grid
If you have a small screen area, you can hide some of the columns that display in the
connection grid.
To hide or show columns
1.
Click in the left hand side of the grid headers.
2. Select the columns you want visible, or clear the check box for columns you
want to hide.
Showing only connections using the selected Oracle home
If you have many connections using different Oracle homes, you may want to display only those
using a particular home in the grid.
To limit connections to one Oracle home
1. On the right of the login window, select the Oracle home you want to display.
2. Click the Show selected home only check box at the bottom of the window.
Refreshing Oracle information
At the bottom of the window is a Refresh button. Clicking this will:
Toad for Oracle User Guide
Connecting to Oracle
179
l rebuild your Oracle alias list
l refresh your client information with the information stored in the registry and on disk
Create New Connection
Create a new connection in one of several methods. See "Server Login Window" (page 177) for
more information login options.
TNSNAMES file
Toad can connect using the listings in your Oracle TNSNames file. Toad will populate the
database box with the entries from the TNSNames file and let you select the connection you
want to use.
To create a new connection using the TNS Names file
1. From the Server Login Window, enter the username in the User/Schema box.
2. Enter the password in the password box.
Note: For added security, characters will not appear as you type; asterisks will
appear instead.
3. Click the TNS tab if it is not active, and select the name of the database from the
Database list.
Note: If you do not enter a database name in the database box, then Toad will use the
ORACLE_SID for the selected home. If there is no ORACLE_SID value, and you do not
specify a database, then no connection can take place.
4. Use the Connect As list to connect as either SYSDBA or SYSOPER if you have the
appropriate permissions. The default for this box is Normal.
5. If you want to color-code this connection, select a color from the Color box drop down.
See "Selecting Connection Color" (page 181) for more information.
6. Click OK.
Easy Connect Strings
To connect using an easy connect string
Simply enter the string in the database box. (Easy connect strings are formatted:
host:port\service_name)
Connecting directly to the database
To create a new connection directly to the database
1. Enter the name of the user in the box labeled User/Schema.
2. Enter the password for this user in the box labeled Password
Toad for Oracle User Guide
Connecting to Oracle
180
3. Click the Direct tab.
4. Enter the Host, Port and either the Service Name or SID of the database to which you
want to connect.
5. The Connect As dropdown allows you to connect as either SYSDBA or SYSOPER if you
have the appropriate permissions. The default for this box is Normal.
6. If you want to color-code this connection, select a color from the Color box drop down.
See "Selecting Connection Color" (page 181) for more information.
7. Click OK.
LDAP
Toad officially supports Oracle names directory services. This support includes both Oracle OID
and Microsoft Active Directory servers.
Oracle Instant Client LDAP support
l Instant Client LDAP support is dependant on specific LDAP DLL which Oracle does not
install by default. The ORALDAPCLNT10.DLL must be located in the same location as
oci.dll file.
l TNSNAMES.ora, LDAP.ora, SQLNET.ora must exist in the same location specified by the
TNS_ADMIN system variable.
l The LDAP dropdown list in the Logon Dialog will not be populated, but connection
can be carried out by manually enter the DB name into the Database field on the
logon screen.
To create a new connection using LDAP
1. Enter the name of the user in the box labeled User/Schema.
2. Enter the password for this user in the box labeled Password.
3. Click the LDAP tab.
4. Select the LDAP Descriptor of the database you to which you want to connect.
5. The Connect As dropdown allows you to connect as either SYSDBA or SYSOPER if you
have the appropriate permissions. The default for this box is Normal.
6. If you want to color-code this connection, select a color from the Color box drop down.
See "Selecting Connection Color" (page 181) for more information.
7. Click OK.
Troubleshooting
OCI/DLL Not Found
If you get this or a similar error when attempting to connect to Oracle, make sure that the Oracle
BIN directory is in your system path. This directory will be ORAWIN\BIN or ORANT\BIN or
Toad for Oracle User Guide
Connecting to Oracle
181
something similar.
To check your path
Open a command line window, type PATH and then press ENTER.
Cannot connect to Oracle Hints
You must have a full install of a 32 bit version of SQL*Net. Connecting by SQL*Plus is NOT
verification that SQL*Net is installed. If you cannot connect to Oracle using Toad, your Oracle
client software is not installed correctly. Re-install the SQL*Net client from the Oracle setup
disks or CD ROMs. Or, if you have installed OEM, NetAssist, Oracle Lite, or any other Oracle
software recently, remove that software and see if you can connect using Toad.
Also make sure that SQL*Net is attempting to use the correct TNSNames files by confirming
that the registry setting:
HKEY_LOCAL_MACHINE\Software\Oracle\TNS_ADMIN
specifies the correct folder where your TNSNAMES.ORA file lives.
Selecting Connection Color
When working with Toad you may have multiple connections open at once. Trying to keep
track of which open window is related to which connection can be difficult. Color coding the
connections can help.
When a color is assigned to a particular connection, any open window related to that
connection, the window bar buttons and the status bars are outlined with that color. This makes
it easy to see at a glance if your SQL editor, for example, is connected to your Test database or
your Production database.
To select a connection color for a new connection
When creating a connection from the server login window, select the color you want to
associate with that connection in the Color box.
To change a connection color
1. In the Server Login window connection grid, click in the Color column of the
connection you want to color.
2. Select the color you want to use from the list.
SET ROLE
You can configure Toad to issue a SET ROLE command immediately upon connection, before it
checks any privileges. This can be done either by making a manual entry in the toad.ini file,
Toad for Oracle User Guide
Connecting to Oracle
182
Toad for Oracle User Guide
Connecting to Oracle
183
To manually edit the toad.ini file
1. Using Notepad, or another text editor, open toad.ini.
2. Add the following line:
[SET ROLE]
3. Enter as many specific SET ROLE entries under this line as needed. The syntax for these
parameters is:
Entry#=<DB>db_name</DB><USER>User_name</USER><ROLE>role_
name</ROLE><ONFAIL>Fail_action</ONFAIL>
Where:
Variable Meaning
# An identification number that keeps the entries unique. You can have as many entries as you want.
db_name Corresponds to the database alias in your tnsnames.ora file (or LDAP entry). An asterisk (*) can be used to specify "any database."
User_
name
Logon user name. An asterisk (*) can be used to specify "any user."
Role_
name
Any valid argument to the SET ROLE command. See your Oracle documentation.
Fail_
action
One of the following: Abort, Message, or ignore.
Abort - don't allow the connection
Message - display an error message and then allow the connection
Ignore -silently ignore the error message
Auto Connect
Toad can connect to a connection of your choice whenever you start Toad.
To create an automatic connection
1. From the Session menu, select New Connection.
2. In the connection grid, select the checkbox in the Auto Connect? column.
Note: You can cancel after Toad has begun to auto connect, if you have multiple
connections. Toad will finish the current one and abort all that have not yet occurred.
To remove an automatic connection
1. From the Server Login window, find the connection in the list of previous connections.
2. Clear the check box in the "Auto Connect?" column.
Toad for Oracle User Guide
Connecting to Oracle
184
Save Passwords for Connections
Passwords are saved in an encrypted file called connectionpwds.ini. The encryption is tied to the
currently logged in user profile and supports roaming profiles, and Citrix installations.
Passwords can be saved as a group or individually, using the Save Pwd column in the
connection grid of the Server Login window. See "Server Login Window" (page 177) for more
information.
Save Pwd? Column
A column called Save Pwd? appears in the previously used connections grid.
Use this to save the password for the connection in that row.
Note: This column is only visible if the option "Save passwords for all Oracle connections" is
unchecked. This option can be changed using the check box at the bottom of the window.
Save Passwords Check Box
The Save Passwords check box at the bottom of the Server Login window directly relates to the
Save passwords for all Oracle connections option. If you check it here, that option will be
checked. If you uncheck it, the option will be unchecked. See "Passwords" (page 664) for more
information.
Password Options
Two password options are available from the Toad Options | Oracle-General page. All saved
passwords are automatically encrypted.
See "Passwords" (page 664) for more information.
Select and View Favorite Connections
If you have a long list of connections you use, but have a relative few that you use consistently,
you can select them as favorites and Toad displays only these connections for you, but you can
still view the complete list. These can be managed from the Server Login window.
To select favorite connections
In the connection grid, select the Favorite check box of the connection you want to
make a favorite.
To view favorites in the grid
Below the connection grid, select the Show Favorites Only check box.
Toad for Oracle User Guide
Connecting to Oracle
185
To view all connections in the grid
Below the connection grid, clear the Show Favorites Only check box.
Organize your login display
You can organize how you view visible login information. In addition to limiting it to Favorite
connections, you can choose to display the visible connections in grid, dropdown, or tab format,
and you can choose to group connections by a single column. You can also add columns to the
connection information that you can then use to group connections.
To select a view for your connections
1.
Click in the Server Login window.
2. Select the type of display you want to use:
Grid All connections are listed in the data grid
Drop-down Databases or users are provided in a drop-down
list: select one to view the connection options in
the data grid. Switch between Users or Database
by clicking the Options button
Tabs Databases are separated into tabs: select one to
view the connection options in the data grid.
Switch between Users or Database by clicking
the Options button
To group connections in the data grid
1. In the Server Login window, drag a column header into the grey area above the grid.
2. Repeat this to create a tree structure in the order you want.
To add or edit a custom column name
1. In the Server Login window, right-click and select Custom.
2. Click Add or Edit.
3. Enter or change the name for your custom field and then click OK.
4. Add data to the column by clicking in the appropriate cell in the data grid.
Use Existing Connection
Select an existing connection from the Server Login window to make it active. See "Server Login
Window" (page 177) for more information.
Toad for Oracle User Guide
Connecting to Oracle
186
To use a previous connection
1. Do one of the following:
l Select a User/Database combination from the dropdown combo box
l Double-click the previous connection from the list in the left panel.
2. If the PASSWORD is not the same as the USER, type the PASSWORD. (schemas are
often created with the password = schema, for example, DEMO/DEMO. Toad is making a
guess at the password, but you can type over it.) If a password has expired and returns a
Password Expired error, Toad prompts for a new password and attempts to change it.
3. Click OK.
Toad saves the USER/DATABASE combinations between Toad sessions but does NOT save the
password by default.
Caution: The option View | Options | General | Save passwords for Oracle connections
saves passwords on your machine. DO NOT ENABLE THIS OPTION UNLESS YOU
HAVE A SECURE ENVIRONMENT.
SQLNET Editor
From the SQLNET editor you can easily edit your SQLNET.ORA parameters. These are standard
Oracle parameters. If you need further information, please see the Oracle documentation for
SQLNET.ORA Profile Parameters.
To edit your SQLNET connection file
1. From the Server Login window, click SQLNET Editor.
2. Make any necessary changes to your parameters and then click OK.
Note: If you are using a multi-threaded server and plan to use the PL/SQL Debugger,
make sure you check the USE_DEDICATED_SERVER check box. This allows the
PL/SQL Debugger to work.
To view the SQLNET.ORA file
1. From the Server Login window, click SQLNET Editor.
2. Click View File as modified
Backing up your SQLNET File
It is recommended that you create a backup file of your SQLNET.ORA file before you make any
changes to it. This assures that if something goes wrong you can restore the original settings.
To create a backup copy of the SQLNET.ORA file
1. From the Server Login window,click SQLNET Editor.
2. Click the Create Backup File button.
Toad for Oracle User Guide
Connecting to Oracle
187
3. Note where the backup file was created and click OK.
To restore a backup copy of the SQLNET.ORA file
1. From the Server Login window, in the Installed Clients area, click SQLNET Editor. The
editor opens in a new window.
2. Click the Restore Backup File button.
3. Select the backup file you want to restore from the Open file dialog that appears.
4. Click Open.
5. Click OK to confirm.
LDAP Editor
You can use the LDAP editor to edit your LDAP parameters. Toad supports both Oracle LDAP
and Windows LDAP servers.
To access the LDAP Editor
From the Server Login window, click LDAP Editor. See "Server Login Window" (page
177) for more information.
Backing up your LDAP File
It is recommended that you create a backup file of your LDAP file before you make any changes
to it. This assures that if something goes wrong you can restore the original settings.
To create a backup file
Open the editor and click Create Backup File.
To restore from backup
Open the editor and click Restore Backup File.
Using the LDAP Editor
The top of the editor contains the path for the file you are editing. Below this is an editable list
of directory servers, and the default administration context.
To add a directory server
1. In the Directory Servers area, click Add.
2. Enter the Host, Port and SSL Port information.
3. Click OK.
To set default administration contexts
Note: The default administration contexts apply to all servers listed in the Directory Servers area.
Toad for Oracle User Guide
Connecting to Oracle
188
In the Default Admin Context area, enter the contexts you want to use.
For more information about Admin contexts and Default admin contexts, please
see your Oracle documentation.
To set server type
Note: The directory server types apply to all servers listed in the Directory Servers area.
In the Directory Server Type box, click the dropdown and select the server type you want
to use (either Microsoft Active Directory or Oracle Internet Directory).
Oracle Homes
Selecting the Oracle Home
You can change your Oracle Home from the Server Login window. Only one Oracle home can
be in use at one time. This means that once a connection is made, all future connections will
automatically be made using the same Oracle home, regardless of default home.
Oracle homes can be assigned for each connection, or for Toad overall. See "Selecting a Default
Oracle Home" (page 189) for more information on default Oracle Homes.
Selecting the Oracle Home
With no connections made previously, select an Oracle Home by using the dropdown list of
Oracle Homes.
To see more information about the home you have selected or change the SID, NLS_LANG, or
SQLPATH, click the drilldown button to open the Oracle Home Editor. See "Oracle Home
Editor" (page 190) for more information.
Note: You must restart Toad to have changes made here take effect.
How Toad Finds the Oracle Client DLL
1. Toad first looks in the Toad command line for OCIDLL.
2. If this is not found, Toad looks for the path for the Oracle home as follows:
3. If the command line argument "ORACLEHOME" was passed in, then Toad will use
that home.
4. If there is no Toad home defined then Toad will display the home that is set as the
default home using Oracles Home Selector application as the default in the dropdown.
Toad will use the home that is active in the dropdown.
5. To populate the dropdown, Toad searches the registry as follows:
Toad for Oracle User Guide
Connecting to Oracle
189
l First, Toad reads the list of Oracle home names from the keysunder HKEY_
LOCAL_MACHINE\SOFTWARE\ORACLE\ALL_HOMES
l If no Oracle homes are found there, then the Oracle home is set to HKEY_
LOCAL_MACHINE\SOFTWARE\ORACLE
l Otherwise, Toad finds the ORACLE_HOME value for each Oracle home, if it
exists. Then Toad checks the system environment variable called PATH to see
whether it contains the "bin" folder under ORACLE_HOME. Toad selects the
Oracle home whose path appears first in PATH.
l If Toad still hasn't found an Oracle home, it uses HKEY_LOCAL_
MACHINE\SOFTWARE\ORACLE.
6. Toad looks for the client DLL in the "Bin" folder under the path found for the
Oracle home
l If that fails, Toad looks for the ORACLE_HOME key under HKEY_LOCAL_
MACHINE\ORACLE\SOFTWARE, and look for the client dll in the "Bin" folder
under that.
l If that also fails, Toad looks for the client dll in every \bin directory in PATH.
Selecting a Default Oracle Home
You can select the default Oracle home in much the same way as you would select the
connection color. Default homes can be assigned for a connection, or for Toad.
When a default Oracle home is assigned to a particular connection, any time you make that
connection from the connection grid, Toad will automatically use that Oracle home. When a
default Oracle home is assigned to Toad, Toad will automatically use that Oracle home any time
you create a connection to a new database.
Note: Only one Oracle Home can be in use at one time. All default Oracle homes revert to the
home used in the currently active connection.
To select an Oracle home for a new connection
In the Server Login window, when no connections have been made, select the Oracle
home you want to use with the current connection from the Connect Using dropdown.
See "Server Login Window" (page 177) for more information.
Note: This Oracle home will now be associated with the selected connection and
listed in the home column of the connection grid.
To select the Toad default Oracle home
1. In the Server Login window connection grid, with no active connections, select the
Oracle home from the Connect Using dropdown.
2. Select the Make this the Toad Default Home checkbox.
Note: When you change databases, this connection will be entered in the Oracle
home dropdown.
Toad for Oracle User Guide
Connecting to Oracle
190
Oracle Home Editor
To use the Oracle Home Editor
1.
Click beside the Connect Using box on the Server Login window. See "Server
Login Window" (page 177) for more information.
2. Select an Oracle Home by clicking on its node. You can then:
l Click Clipboard. This will copy the selected information to the clipboard so you
can past it into an email, or another document.
l Click Advice. This will tell you if you have a proper SQL*Net installation for this
home, or suggest changes to your installation.
l Right-click and choose to edit one of the following:
l SID for the selected Home
l NLS_LANG for the selected Home
l SQLPATH for the selected Home
Toad for Oracle User Guide
Connecting to Oracle
191
TNSNames Editor
TNSNames Editor Overview
From the TNSNames Editor, you can easily edit your TNSNames files. You can add a new
service, edit a service, delete a service, or work with two files and transfer services back and forth
between the two.
There is an online video tutorial for this feature. This opens a new browser window and requires
an internet connection.
From this window you can:
l Load and View TNSNAMES Files (page 192)
l Add Service and Details (page 194)
l Edit Service (page 196)
l Delete Service or Details (page 196)
l Testing a Connection (page 197)
l Working with Two Files (page 197)
NOTE: You can add a UR tag to a CONNECT_DATA tag of a TNS entry. This is available
ONLY through the text edit area of the editor, not the Edit Service window. This tag is
supported as a patch to Oracle 10g and is no longer necessary in Oracle 11+.
To access the TNSNames Editor
Access this window from the Utilities menu | TNSNames Editor.
Limitations of the TNSNames Editor
The TNSNames Editor supports much of the standard Oracle syntax. See "TNSNames Editor
Overview" (page 191) for more information.
There are, however, certain old or advanced features that it does not support.
Features Toad TNSNames Editor does not support include:
l Multiple Description Lists
Note: Multiple Description entries are supported, and a DESCRIPTION_LIST will be
created automatically to encompass them.
l Multiple Address Lists
l No ADDRESS_LIST keyword (The editor parses it correctly, but it adds the ADDRESS_
LIST parameter back in to the entry, which produces a completely equivalent
Toad for Oracle User Guide
Connecting to Oracle
192
configuration. Existing entries with multiple ADDRESS_LIST tags are preserved, even if
edited in the Editor window. )
In all of these cases, the TNSNames Editor will not change the entry unless the user chooses to
edit that particular entry. If you do not try to change a non-supported entry, the file will remain
useable.
If you do try to edit a service name with one of these unsupported features, the editor does its
best to parse the entry into the Edit Service dialog box. It will write the entry into a structure it
does support, if you click OK in the Edit Service dialog box and then save the file.
Whenever the TNSNames Editor overwrites a file, it first makes a backup of that file in the same
directory. So if you do accidentally cause problems to your file, you can revert to the backup.
Load and View TNSNAMES Files
To load the active TNSNames file
1. Open the TNSNames Editor. See "TNSNames Editor Overview" (page 191) for more
information.
2.
Click .
To load a saved file
You can load and view your TNSNames files and specific services within those files.
1. Open the TNSNames Editor. See "TNSNames Editor Overview" (page 191) for more
information.
2.
Click .
3. Browse to the directory where your TNSNames file is located, and select it.
To view a file
Do one of the following:
l a particular service entry - click on the entry in the tree view.
l the text of the entire TNSNames file - click the Text Editor tab.
Switching Views
The tree view of the TNSNames Editor can be organized either by Service Name or by Host
Name. In either view, selecting the Host node displays the entry for that host in the Text tab.
When viewing by Service Name, selecting the Service node displays all host entries for that
Service in the Text tab.
To switch tree views
Do one of the following:
Toad for Oracle User Guide
Connecting to Oracle
193
l
Click .
l
Click the drop-down arrow next to and select either the View By Host
or View By Service option.
Pasting Entries into the TNSNames File
You can paste entries directly into either side of the TNSNames Editor from either the Project
Manager or from a text file. This lets you receive new entries by email, or update from a
current project.
Copying and Pasting from the Project Manager
You can copy connection information from the Project Manager.
To copy connections from the Project Manager to the Names Editor
1. Open the Project Manager.
2. In the navigation panel, click on the Sessions tab.
3. Select the connections you want to copy.
4. Right-click and select TNSNames information to clipboard.
5. Open the TNSnames Editor.
6.
Click in the pane containing the tnsnames.ora where you want the information.
Note: You can past into either tab: Tree View or Text Editor.
To copy connections from a text file or email
1. From the text file or email, copy the text of the connection information.
2. Open the TNSnames Editor.
3. Click the Paste button on the side of the window where you want to paste the
information. You can past into either tab: Tree View or Text Editor.
Checking Syntax
At any time you can check the syntax of your TNSNames file from the editor. If there are errors,
Toad will list them and suggest ways to fix them. If there are no errors, the message "TNS file is
valid" displays in the Message tab.
To check syntax
Click on the TNSNames Editor toolbar.
Note: Messages about the state of the syntax for the TNS names file are displayed
Toad for Oracle User Guide
Connecting to Oracle
194
in the Messages tab at the bottom of the window.
Add Service and Details
The TNSNames Editor makes it easy to add a new service entry, or to add details to an entry you
have already created. See "TNSNames Editor Overview" (page 191) for more information.
This topic only covers unfamiliar information. It does not include all step and field descriptions.
To add a service
1.
Load your tnsnames.ora file into one side of the editor, and click .
2. Enter the Service Name you want to use for the service.
3. Enter the appropriate information for Address configuration. See "Address Configuration"
(page 194) for more information.
4. Enter the appropriate information for Service information. See "Service Information" (page
195) for more information.
Address Configuration
You can enter the information manually in the box, or click Clone to copy information from the
active entry to a new entry in your file.
Add additional addresses for this service name by clicking Add.
Toad for Oracle User Guide
Connecting to Oracle
195
Configuration Notes
Field Note
Address Information
Protocol Changing this value will change the information
required for the rest of the host address configuration.
Port (TCP/IP, TCP/IP with SSL,
and SDP)
Valid port numbers have values between 1 and 65535.
Advanced Options Apply to additional addresses.
Enable Failover Instructs Oracle Net to fail over to a different address if
the first protocol address fails.
Enable Load Balance Instructs Oracle Net to progress through the list of
addresses in random sequence to balance the load
between the various listener or Oracle connection
Manager protocol addresses.
Enable Source Route Instructs Oracle Net to use each address in order until
the destination is reached.
Use options compatible with
Net8 8.0 clients
If this is checked you can only select options
compatible with Net8 clients. If unchecked, all options
are available.
Service Information
Enter the Service Name and Connection type in the appropriate boxes. In addition, you can
check the box to use Oracle 8 and previous identification (SID) rather than a more current format.
Cloning a Service
To clone a service
1. In the TNSNames Editor, select the service you want to clone on your service list.
2. Right-click and select Clone Service from the context menu.
Note: When you clone a service, the new service entry will have a blank Net Service
Name and will be located at the top of the service list.
3.
Select the new service and click to make necessary modifications.
Toad for Oracle User Guide
Connecting to Oracle
196
Delete Service or Details
In the TNSNames Editor, you can easily drop a service or details from your TNSNames file. See
"TNSNames Editor Overview" (page 191) for more information.
Note: When you select a node to delete, all nodes beneath it will also be deleted.
To delete a service
1. Select the service you want to delete on your service list.
2.
Click on the toolbar (DELETE).
Deleting details
You can delete details such as entire entries under descriptions, additional addresses, and so on.
To delete details
1. In the service list, select the node containing the details.
2.
Click (F2).
3. Click the Description tab for the detail you want to delete.
4. Do one of the following:
To delete the description and
everything below it
Click Delete at the bottom of
the window.
To delete a specific address
within the service
Click the Address tab of the
address you want to delete and
then click Delete within the
Address Configuration area.
Edit Service
You can change service information for an existing service in your TNSNames file from the
TNSNames Editor. See "TNSNames Editor Overview" (page 191) for more information.
To edit a service
1.
Select the service node you want to edit and then click (F2).
Note: If you select an address node, the edit window will open with that address selected.
2. Make changes to the Service. See "Add Service and Details" (page 194) for more
information about address configurations and service information.
3. Click OK to save changes.
Toad for Oracle User Guide
Connecting to Oracle
197
Caution: This only saves changes to the temporary file. To be sure your changes are
saved to your TNSNames file, see Saving Changes to TNSnames Files.
Saving Changes to TNSNames Files
The OK button at the bottom of the screen saves the file and closes the TNSNames Editor. See
"TNSNames Editor Overview" (page 191) for more information.
Whenever the TNSnames editor overwrites a file, it first makes a backup of that file in the same
directory. So if you do accidentally cause problems to your file, you can revert to the backup.
To save your file without closing the editor
Do one of the following:
l
Click on the toolbar to save the file with the current file name
l
Click the Save as button, to change the file name
To cancel without saving
Click Cancel to cancel any edits you have made to the file since it was last saved and
close the editor.
Testing a Connection
From the TNSNames Editor you can test a new connection or changes you have made, using the
TNSPing facility.
To test a connection
1. Save the file to the location where your TNSping executable reads files.
2. Select one connection in the connection list to test.
3.
Click on the toolbar.
Working with Two Files
You may have two TNSNames files that you want to compare and copy services between. The
TNSNames Editor lets you do this easily. These files can be the same file or different ones.
Loading the same file into both sides of the editor will allow you to easily duplicate service
names before you edit them.
To work with two TNSNames files
1. Load one of the TNSNames files in the left hand side of the Editor.
2. Load the other into the right hand side.
Toad for Oracle User Guide
Connecting to Oracle
198
3. You can now select services from either side and copy them to the other using the
buttons in the center.
Note: The TNSNames Editor does not prevent duplicate entries in the tnsnames.ora file.
This allows you to copy a service and then edit it.
Icon Action
> Move selected service from left side file to right
side file.
< Move selected service from right side to left side.
>> Move all services from left side to right side.
<< Move all services from right side to left side.
Tutorials
CodeXpert
Using the CodeXpert Tutorial
Use the CodeXpert to compare your code to specific rules and standards. CodeXpert analyzes the
PL/SQL against a set of rules for best practices. These rules are stored in a ruleset. You can
define your own rulesets if desired. (See CodeXpert Tutorials | Creating a Ruleset for more
information.)
In this tutorial, we will take a simple procedure and try out some of the features of the
CodeXpert. There are many options and settings you can use to customize how CodeXpert
analyzes your code. For more information on these, see the CodeXpert section of the help.
Note: If you do not have the Xpert Edition of Toad, just ignore the SQL Scanning portions of
this tutorial.
1. If is not already open, open Toad and then open an Editor window.
2. Past the following code into the Editor:
CREATE OR REPLACE PROCEDURE loopproc (inval NUMBER)
IS
tmpvar NUMBER;
tmpvar2 NUMBER;
total NUMBER;
BEGIN
tmpvar := 0;
tmpvar2 := 0;
total := 0;
FOR lcv IN 1 .. inval
LOOP
total := 2 * total + 1 - tmpvar2;
tmpvar2 := tmpvar;
tmpvar := total;
7
Toad for Oracle User Guide
Tutorials
200
END LOOP;
DBMS_OUTPUT.put_line ('TOTAL IS: ' | | total);
END loopproc;
/
3. In the area below the editor, click the CodeXpert tab. If this is not visible, right-click and
choose Desktop Panels | CodeXpert to make it visible.
4.
In the CodeXpert tab, make sure the Scan toggle is unselected and then either click
the Perform Review button or press F9. Toad analyzed the contents of the editor in
its entirety. If part of the code is selected, Toad will review only the selected code.
5. Look at the results. They should appear as follows:
6. Expand the Efficiency Node. Notice that there are three occurrences of the DATA
TYPE - 2829 rule. If you expand this node as well, you will see each instance where
the rule was violated. The numbers before them correspond to the row and column
number of the violation.
7. Click on one of the occurrences. The editor scrolls to that instance, highlighting the line
of code in question.
8. Double-click the occurrence and the rule description displays.
9. Click the Reports tab. At the bottom of the panel are tabs for Rules Summary, Crud
Matrix, or Code Metrics for this analysis. Click the Rules Summary tab.
10. Notice that the Print icon in the CodeXpert toolbar is now active. You can print these
reports with the click of a button, or click the Save button and save them to an html file.
Creating a Ruleset Tutorial
If the provided rulesets do not meet your needs, you can create your own rulesets.
We will create a ruleset from scratch. You can also select an existing ruleset to use as a template.
Toad for Oracle User Guide
Tutorials
201
1. Open the CodeXpert window. Click Database | Diagnose | CodeXpert.
2.
Click the Configure Ruleset button. The configuration window opens with a
ruleset selected.
3. Click the Rule Sets node to activate it.
4.
Click the New Rule Set button.
5. Enter Sample Tutorial Ruleset in the Rule Set Title box. This is the title that will
display in the rule set navigator.
6. Toad creates a filename for you based on your title and stores it in the Rulesets folder.
You can change this if desired.
7. The author is automatically filled in from your computer information. If this is not correct,
change it now.
8. Enter any comments about your ruleset. For this test, enter the following:
This is a sample ruleset to learn functionality.
9. Click Next.
10. We will leave the sort order at the default: Severity, then Objective. If you want to view
violations of your ruleset in a different way, this dropdown list is where to do it.
11. Select the rules you want to enforce. In this case, open the WARNING node and select
the following rules:
l VARIABLE - 6411
l VARIABLE - 6413
l GOTO - 4002
12. Click Finished. The ruleset is now listed at the bottom of the navigation panel, with the
User-created icon identifying it.
PL/SQL Debugger
Debugging a Procedure or Function
Debugging a Procedure or Function Tutorial
Debugging a procedure or function is the most straightforward debugging procedure. Yet there
are several ways to go about it. This tutorial will walk you through some of the most common
commands and methods. It is not designed to teach you to code in PL/SQL, but it will show you
the basic features of the Toad Debugger.
Toad for Oracle User Guide
Tutorials
202
Enter the code in the Editor
1. Open a new Editor tab for PL/SQL:
Right-click in the Editor and select New Tab | PL/SQL.
2. In the Desktops toolbar, your desktop should be set to PL/SQL. This will enable the tabs
at the bottom of the Editor that are debugger-specific.
Enter the following code into the Editor:
CREATE OR REPLACE PROCEDURE loopproc (inval NUMBER)
IS
tmpvar NUMBER;
tmpvar2 NUMBER;
total NUMBER;
BEGIN
tmpvar := 0;
tmpvar2 := 0;
total := 0;
FOR lcv IN 1 .. inval
LOOP
total := 2 * total + 1 - tmpvar2;
tmpvar2 := tmpvar;
tmpvar := total;
END LOOP;
DBMS_OUTPUT.put_line ('TOTAL IS: ' | | total);
END loopproc;
/
3. From the File menu, select Save As to save this procedure. The tab at the top now
displays "Loopproc.prc".
Click the Compile with Debug button into the depressed position to turn on the
debug information.
Note: If the compile buttons or the debug menu options are disabled check one of
the following:
Toad for Oracle User Guide
Tutorials
203
l Double check that you are connected to a database that allows debugging - you
must have access to the DBMS_DEBUG Oracle package.
l Make sure that the editor window is associated with the appropriate database
connection: click the Change Active Connection button and select the
correct database if it is not.
4.
Click the Compile button . The code compiles and is now ready to run. The code
must be compiled before you can set parameters.
Working with Watches
Add Watches - Debugging Tutorial
There are several ways to add a Watch. In the following steps you will add three watches, each
one by a different method. Later, you can choose the method that works best for you.
1. You can only watch variables. Click in the second line of code, in the word TMPVAR
and click the Add Watch icon on the Debug toolbar above the Editor window (not
the watches tab toolbar). The Watches window becomes active at the bottom of the
screen, and a watch is added.
2. Add a watch to TMPVAR2. This time, press <CTRL><F5> to add the watch
at the cursor.
Note: To watch all variables automatically, select the Smart Watches box on the Watch
window. This may not be a good option if your procedure has a large number of
variables. However, you can drag watches from the Smart Watches panel to the Watch
panel and then close Smart Watches. See "Configuring the Smart Watch window" (page
923) for more information.
3. And finally, add a watch to the TOTAL variable. Click in the TOTAL variable, and then
from the Debug menu, select Add Watch at Cursor.
Go back to Enter the code in the Editor (page 202)
Continue to Set Parameters- Debugging Tutorial (page 203)
Set Parameters- Debugging Tutorial
Some PL/SQL has variable parameters that need to be set before you can run the code. If values
for these variables are not set, running the code will result in an Oracle error. In the Loopproc
procedure, the INVAL variable needs to be set.
1.
Click button.
Note: If you have parameters that need to be set, when you choose to RUN the code, the
Set Parameters window will display automatically. There are many more parameters
Toad for Oracle User Guide
Tutorials
204
Toad for Oracle User Guide
Tutorials
205
2. Set parameters appears because there is a user-defined parameter set in the code. In this
case, INVAL defines the number of times to run the code. Click in the Value Field for
the INVAL variable. NULL is highlighted.
3. Set the value at ten. Enter 10 in the value field.
4. Click OK. The value is set and the Set Parameters window closes.
Continue on to Run Code and Display Output - Debugging Tutorial (page 205)
Go back to Add Watches - Debugging Tutorial (page 203)
Run Code and Display Output - Debugging Tutorial
1.
Click the Execute PLSQL with debugger button. A confirmation dialog box appears
asking if you want to compile the referenced objects with Debug information. Click Yes.
If the Set Parameters dialog appears again, click Execute. The code compiles and then
runs, but too quickly to see the watches.
2. Click OK in the termination dialog.
To confirm that the code has run, click the DBMS Output tab in the Desktop
tabs area. The window should display the following:
Change Watch Properties - Debugging Tutorial
1. Change the watch properties for Tmpvar2 to scientific format. Click the Watches tab. In
the Watches window, double-click Tmpvar2. The Watch Properties window appears.
2. In the Format area, click Scientific. Click OK to save your changes and close
the window.
Go back to Run Code and Display Output - Debugging Tutorial (page 205)
Continue on to Disable a Watch - Debugging Tutorial (page 205)
Disable a Watch - Debugging Tutorial
You can disable a watch you do not want to follow. Disable the watch on Tmpvar.
1. In the Watches window, double-click tmpvar. The Watch Properties dialog box appears.
2. Click the Enabled check box. The checkmark disappears.
Click OK. The Watch Properties dialog box closes. Tmpvar is now disabled in the
Watch window.
Note: You can also disable a watch by:
Toad for Oracle User Guide
Tutorials
206
l Selecting the watch and clicking the disable button.
l Right-clicking on the watch and selecting Disable Watch.
To enable a watch you have disabled, simply reverse one of the above methods.
Step Through the Code - Debugging Tutorial
1. To actually see the watches you have set, you will need to step through the code line by
line. Press SHIFT+F7 several times to step through the code. Notice how the values for
the watches change each time you press SHIFT+F7.
2. The values for the variables you have marked with watches display in the Watches
window. However, you may decide you want to check the value for a variable that is not
currently being watched.
Hover the mouse pointer over the INVAL variable. In a moment, a small popup
containing the value of the variable appears.
Working with Breakpoints
Add Breakpoints - Debugging Tutorial
The next sections of this tutorial focus on breakpoints. They assume you have completed the
Introductory and Watches sections.
Breakpoints cause the execution of your procedure to stop at the specified location. In the
breakpoints tab, you will see two different breakpoints column. One is "line" and the other is
"Editor line." Line refers to the line within the procedure block you are working with (excluding
comments and blank lines from the count), and Editor line refers to the line number within the
editor. This is because you can have more than one procedure open in the same tab at the same
time. For this tutorial, however, we only have one procedure open.
1. In the desktop tabs area, click the Breakpoints tab. This allows you to see the
breakpoints you set.
2. If line numbers are not displayed to the left of your procedure, turn on Display line
numbers in gutter as follows:
a. From the Edit menu, select Editor Options. The Editor Options PLSQL
window appears.
b. In the left panel, click General Options. In the right panel, double-click Display
Options. The list of display options appears.
c. If the check box beside Display line numbers in Gutter is empty, click it to turn
the option on.
d. If the check box beside Show Gutter is empty, click it to turn the option on as
well. Click OK. Line numbers should now display in the gray gutter beside your
procedure.
3. Add a breakpoint to the line containing: FORLCV IN 1...INVAL. In my editor, it is line
12. Click in the gutter beside the line. The line of code is highlighted, and a breakpoint
icon appears in the gutter. The breakpoint has been applied. The Editor Line and
Toad for Oracle User Guide
Tutorials
207
Line columns in the breakpoint window may or may not display the same number,
depending on how your code is formatted.
4. Add a breakpoint to the line containing TOTAL:=2 * TOTAL +1-TMPVAR2. This time,
click in the line of code, and then press Shift+F5.
5.
Click . The code stops the line containing the first breakpoint. Click run again, and
the code stops at the next breakpoint.
Disable Breakpoints - Debugging Tutorial
As with watches, you can temporarily disable breakpoints.
1. Disable the second Breakpoint. In the Breakpoints window, double-click the breakpoint.
The Breakpoint Properties dialog box appears.
2. Click the Enabled check box. The checkmark disappears.
Click OK. The Breakpoint Properties dialog box closes. The second breakpoint is now
disabled in the Breakpoints window.
Note: You can also disable a watch by:
l Selecting the watch and clicking the disable button.
l Right-clicking on the watch and selecting Disable Watch.
To enable a watch you have disabled, simply reverse one of the above methods.
3. You can delete the breakpoint entirely instead of just disabling it. In the Editor, click the
Breakpoint icon in the margin by the first.
Edit Line Number
Rather than creating a new breakpoint and deleting an old one, you can change the line number
for an existing breakpoint.
1. In the Breakpoints window, double-click the line 12 breakpoint.
2. Double-click in the Line number box. The line number is highlighted. Change the
number to 11. Enable the Breakpoint.
3. Click OK. The dialog box closes, and the breakpoint moves to line 11.
Use Passcount - Debugging Tutorial
You can set a breakpoint to only break after a certain number of iterations through the loop. This
can be useful when you are working with extremely long loops of code, because you can set it
to stop after, for example, seven passes.
1. Replace the first breakpoint.
2. In the Breakpoints window, double-click the breakpoint.
3. Double-click in the Passcount field. Type 7. Click OK.
Toad for Oracle User Guide
Tutorials
208
4.
Click the Run icon. The Procedure runs through 6 iterations of the loop and stops
just before it reaches line 11 for the 7
th
time.
5. Click the Call Stack tab. It should say LOOPPROC(11). This marks the line where you
stopped execution.
6. Click the Watches tab. Your watches are still set, and since execution has not completed,
they will have values.
7. Click the Run icon again. A dialog box appears stating "Execution terminated." This
indicates that the Procedure has completed its run. Click OK.
Use Conditional Breakpoint - Debugging Tutorial
You can set a condition on a breakpoint, so that the execution will not stop until it meets this
condition.
1. In the Breakpoints window, double-click the breakpoint that is still enabled.
2. Double-click the Passcount field, and replace the 7 with 0.
3. In the Condition field, add LCV>=7. Execution will now break at this line when LCV is
greater or equal to 7.
4. Click OK.
5. Click the Run icon. Execution stops at line 11. Hover the pointer over the variable LCV.
The value should be 7.
6. Click the Run icon again. LCV is now 8, which is greater than 7, so execution has
stopped again.
7. Disable the breakpoint without deleting it. In the Breakpoints window, select the
breakpoint, right-click and select Disable breakpoint. The stop sign icon is unavailable.
8. Click the Run icon to complete execution. When the dialog box appears stating that
execution has terminated, click OK.
Use Passcount and Conditions together - Debugging Tutorial
You can combine passcounts and conditions on breakpoints. When doing this, remember that the
passcount counts the number of times the condition is met, not the number of times the code
passes the line number.
1. Click the Set Parameters button. Change the value for INVAL to 17 and then click OK.
2. In the Breakpoints window, double-click the breakpoint with the condition added.
3. Check the enabled box to enable the breakpoint.
Leave the condition on the breakpoint, but add a passcount of 9. Click OK. The
Breakpoints properties window closes.
The breakpoint now has a passcount of nine and a condition of LCV>=7.
4. Run the code again. Execution stops at pass 9 of 9. When you hover the curser over LCV,
notice that it has a value of 15. This is the 9
th
time that LCV>=7.
5. Click Run one last time to end the debugging.
Toad for Oracle User Guide
Tutorials
209
Debugging a Package
Debugging a Package - Debugging Tutorial
Debugging a package works in a similar manner to debugging a procedure or function. You are
debugging a group of procedures or functions, however, and how they work together, so it is a
little different. This tutorial assumes that you are comfortable with watches and breakpoints, and
the features described in the Debugging a Procedure or Function Tutorial.
1. Open a new PL/SQL Editor tab.
Enter the code below into the Editor. This is the package we will use.
CREATE OR REPLACE PACKAGE trigonometry
IS
FUNCTION sine (
opposite IN NUMBER,
hypotenuse IN NUMBER,
MESSAGE OUT VARCHAR2
)
RETURN NUMBER;
FUNCTION cosine (
adjacent IN NUMBER,
hypotenuse IN NUMBER,
MESSAGE OUT VARCHAR2
)
RETURN NUMBER;
FUNCTION tangent (
opposite IN NUMBER,
adjacent IN NUMBER,
MESSAGE OUT VARCHAR2
)
RETURN NUMBER;
numcalls NUMBER := 0;
END trigonometry;
Toad for Oracle User Guide
Tutorials
210
/
CREATE OR REPLACE PACKAGE BODY trigonometry
AS
FUNCTION sine (
opposite IN NUMBER,
hypotenuse IN NUMBER,
MESSAGE OUT VARCHAR2
)
RETURN NUMBER
IS
tmpsine NUMBER;
BEGIN
numcalls := numcalls + 1;
IF (opposite <= 0)
OR (hypotenuse <= 0)
OR (opposite IS NULL)
OR (hypotenuse IS NULL)
THEN
MESSAGE := 'Opposite and Hypotenuse must be numbers > 0';
RETURN NULL;
ELSE
/*Calculate the sine*/
tmpsine := opposite / hypotenuse;
IF tmpsine BETWEEN -1 AND 1
THEN
MESSAGE := 'Success';
RETURN tmpsine;
ELSE
MESSAGE := 'Unreasonable Sine: ' | | tmpsine;
RETURN NULL;
END IF;
Toad for Oracle User Guide
Tutorials
211
END IF;
END sine;
FUNCTION cosine (
adjacent IN NUMBER,
hypotenuse IN NUMBER,
MESSAGE OUT VARCHAR2
)
RETURN NUMBER
IS
tmpcosine NUMBER;
BEGIN
numcalls := numcalls + 1;
IF (adjacent <= 0)
OR (hypotenuse <= 0)
OR (adjacent IS NULL)
OR (hypotenuse IS NULL)
THEN
MESSAGE := 'Adjacent and Hypotenuse must be numbers > 0';
RETURN NULL;
ELSE
/*Calculate the Cosine*/
tmpcosine := adjacent / hypotenuse;
IF tmpcosine BETWEEN -1 AND 1
THEN
MESSAGE := 'Success';
RETURN tmpcosine;
ELSE
MESSAGE := 'Unreasonable Cosine: ' | | tmpcosine;
RETURN NULL;
END IF;
END IF;
Toad for Oracle User Guide
Tutorials
212
END cosine;
FUNCTION tangent (
opposite IN NUMBER,
adjacent IN NUMBER,
MESSAGE OUT VARCHAR2
)
RETURN NUMBER
IS
BEGIN
numcalls := numcalls + 1;
IF (adjacent <= 0)
OR (opposite <= 0)
OR (adjacent IS NULL)
OR (opposite IS NULL)
THEN
MESSAGE := 'Opposite and Adjacent must be numbers > 0';
RETURN NULL;
ELSE
/*Return the value of the tangent*/
MESSAGE := 'Success';
RETURN opposite / adjacent;
END IF;
END tangent;
END trigonometry;
/
2.
Click on the toolbar. The code is formatted to the default format, and a comment to
this effect is added to the beginning.
3.
Compile the package by clicking . The name Trigonometry appears on the tab above
the package, and the structure of the package appears in the left panel.
4. Save the file. Close the file and open it again. Toad will ask you if you want to split the
file. Select Yes. Now the package body and the package spec are in separate tabs in the
Toad for Oracle User Guide
Tutorials
213
editor. In addition, the comments at the beginning of the code specify that each tab is a
"Toad Chunk" of one file.
Set Appropriate Options - Debugging Tutorial
Before you debug this example package, you need to set the Debugger Options.
Note: This may not be necessary when debugging your own packages, or you can set the options
at different stages in your debugging procedure.
1. From the View menu, select Toad Options.
2. In the left panel, select Editor | Debug. The debugging options panel appears in the
right panel.
3. Make sure Step through package initialization is checked. This specifies that when you
step through the code it will also step through the initialization. If it is not checked, Toad
will run the initialization and only step through the procedure you have chosen to debug.
This defaults to off, so it is a good idea to check it before you start debugging.
4. Click OK to close the Options window.
Set Watches and Breakpoints - Debugging Tutorial
Set any breakpoints or watches.
1. In the body tab, set a breakpoint at Line 25 (tmpsine := opposite / hypotenuse;).
2. Set a watch on the variable Numcalls in line 14. This is a package variable. In order to
watch it, you will have to change the properties.
3. In the Watches window, double-click the watch on Numcalls.
Click in the Package Variable check box. Notice that the OK button is now disabled.
You must choose a package to activate this option.
Note: This may not be available if you are connecting on a RAC. See "Debugging on a
RAC" (page 908) for more information.
4. The Owner name is automatically filled in with the current schema owner. Change it
using the dropdown menu if necessary. For now, it should be correct. From the dropdown
Package menu, select Trigonometry and then click OK. This creates a watch on a
package variable.
5. Add a watch on the variable tmpSine on line 25.
Select Procedure or Function to Run - Debugging Tutorial
When debugging a package, you can only debug one procedure or function at a time. The
package will run through its initialization process (or step through it if that option is checked in
the Options window).
Toad for Oracle User Guide
Tutorials
214
1. Click within the SINE function.
2.
Click the Set Parameters icon on the toolbar. The Set Parameters window appears.
3. In the left pane, click Sine. This selects this procedure. Notice how the arguments in the
right pane change.
4. Click in the value field for opposite. Enter 15.
5. Click in the value field for hypotenuse. Enter 20.
6. Click OK. The Set Parameters window closes.
Step through Package - Debugging Tutorial
1. Press SHIFT+F7. If the parameters window opens, set variables for the other procedures
as desired, or leave them NULL, and then click OK. Toad steps into the Package
initialization, opening it in another tab. The watch for the Numcalls shows as NULL.
2. Press SHIFT+F7 again. Toad moves into the SINE procedure. The watch for Numcalls
is now 0.
3. Press SHIFT+F7 again. The Numcalls watch moves up to 1, and Toad steps to line 14.
4.
Click (Run). Toad stops at the breakpoint at line 22.
5. Click Run again. Toad completes running the SINE procedure, and notifies you that
execution has terminated. All watches are returned to "process not accessible".
In order to debug the other procedures in the package, set watches and variables as desired and
select the appropriate procedure from the left pane in the Parameters window. Then repeat the
stepping through the code and making changes until you are satisfied.
Debugging an INSERT Trigger
Debugging an INSERT Trigger - Debugging Tutorial
Debugging a trigger works in a similar manner to debugging procedures, functions and packages.
As with debugging packages, most of the changes occur when you are setting trigger parameters.
This tutorial assumes that you are comfortable with watches and breakpoints, and the features
described in the Enter the code in the Editor (page 202).
1. Triggers always need a table to act upon. For this exercise, create a table called
TESTTAB. (See "Altering Tables" (page 1074) for more information.)Include the
following columns:
l ID - VARCHAR2(3)
l FIRST_NAME - VARCHAR2(10)
l LAST_NAME - VARCHAR2(30)
2. Open a new PL/SQL Editor tab.
Toad for Oracle User Guide
Tutorials
215
Enter the code below into the Editor. This is the trigger we will use. It simply assigns and
declares a variable when you perform an INSERT on the TESTTAB table.
CREATE OR REPLACE TRIGGER testtrig
BEFORE INSERT ON TESTTAB
DECLARE
tmpVar NUMBER;
BEGIN
tmpVar := 0;
EXCEPTION
WHEN OTHERS THEN
NULL;
END testtrig;
/
3.
Make sure the Compile with Debug button is selected. Click the Compile
button to compile the trigger.
Set INSERT Trigger Parameters - Debugging Tutorial
Now that you have a trigger in the editor, you can set parameters for the variables and begin the
debugging procedure.
Note: Usually, when debugging, you are not going to want to change the data in your database.
However, you must act on that data in order to step through a trigger: the trigger must be
activated to debug it. In order to prevent data from changing, you may want to change the
commit options in View | Toad Options | Debugger | Transaction Control to Rollback or
Prompt to keep from altering data. For this tutorial, go ahead and commit the data, as it will be
used in the DELETE and UPDATE tutorials later.
1.
Press SHIFT+CTRL+F9 or the parameters button on the toolbar.
2. If a dialog asking you to compile with debug information appears, click OK.
3. In the Set Parameters window, Column Values grid, modify the anonymous block so
that the trigger will fire. In this case, we are adding values that will be inserted into the
table. Notice how as you add these values, the anonymous block in the Code area of the
dialog changes.
Column Name Value
ID 13b
Toad for Oracle User Guide
Tutorials
216
Column Name Value
FIRST_NAME JOE
LAST_NAME SMITH
Entering a value in the WHERE clause for an INSERT trigger will produce no results, so
don't make any changes to that column.
4. Click OK.
Set INSERT Trigger Watches - Debugging Tutorial
Set any watches or breakpoints you want to use for debugging. In this case, we are going to set a
watch on the variable TMPVAR.
1. Click in line 4 (tmpVar NUMBER).
2.
Click on the toolbar. The watch is displayed in the Watch window.
Step through the INSERT trigger - Debugging Tutorial
At this point you can proceed with debugging.
l Press SHIFT+F7 to step through the code. Note how the TMPVAL watch changes values
when you reach line 7.
Debugging an UPDATE Trigger
Debugging an UPDATE Trigger - Debugging Tutorial
For this tutorial, we assume you have already gone through the INSERT tutorial. The UPDATE
trigger we will be using acts upon the same TESTTAB table, and looks for the data you inserted
in the INSERT Tutorial.
The steps for debugging an UPDATE trigger are the same as for an INSERT trigger, but
triggering requires different parameters to be included.
1. Triggers always need a table to act upon. For this exercise, we will be using the table we
created in the Debugging an INSERT Trigger (page 214), and the data we inserted into it.
2. Open a new PL/SQL Editor tab.
Enter the code below into the Editor. This is the trigger we will use. It simply assigns and
declares a variable when you perform an DELETE on the TESTTAB table.
CREATE OR REPLACE TRIGGER testtrig
BEFORE UPDATE ON TESTTAB
DECLARE
Toad for Oracle User Guide
Tutorials
217
tmpVar NUMBER;
BEGIN
tmpVar := 7;
EXCEPTION
WHEN OTHERS THEN
NULL;
END testtrig;
/
3.
Make sure the Compile with Debug button is selected. Click the Compile
button to compile the trigger.
Set UPDATE Trigger Parameters - Debugging Tutorial
Now that you have a trigger in the editor, you can set parameters for the variables and begin the
debugging procedure.
Note: Usually, when debugging, you are not going to want to change the data in your database.
However, you must act on that data in order to step through a trigger: the trigger must be
activated to debug it. In order to prevent data from changing, you may want to change the
commit options in View | Toad Options | Debugger | Transaction Control to Rollback or
Prompt to keep from altering data. For this tutorial, go ahead and commit the data, as it will be
used in the DELETE and UPDATE tutorials later.
1.
Click on the toolbar(SHIFT+CTRL+F9).
2. If a dialog asking you to compile with debug information appears, click OK.
3. In the Set Parameters window, Column Values grid, modify the anonymous block so
that the trigger will fire. In this case, we are adding values that will be changedin the
table. As such, we need to specify both an identifier (a WHERE clause) to find the record
we want to change, and the value in the column we want to change. We will change
"JOE SMITH" to "FRED SMITH".
Name Value WHERE Value
ID NULL 13b
FIRST_NAME FRED NULL
LAST_NAME NULL NULL
Toad for Oracle User Guide
Tutorials
218
Set UPDATE Trigger Watches - Debugging Tutorial
Set any watches or breakpoints you want to use for debugging. In this case, we are going to set a
watch on the variable TMPVAR.
1. Click in line 4 (tmpVar NUMBER).
2.
Click the Watch button on the toolbar. The watch is displayed in the
Watch window.
Step through the UPDATE Trigger - Debugging Tutorial
At this point you can proceed with debugging.
l Press SHIFT+F7 to step through the code. Note how the TMPVAL watch changes values
when you reach line 7.
Debugging a DELETE Trigger
Debugging a DELETE Trigger - Debugging Tutorial
For this tutorial, we assume you have already gone through the INSERT tutorial. The DELETE
trigger we will be using acts upon the same TESTTAB table. The steps for debugging a
DELETE trigger are the same as for an INSERT trigger, but triggering requires different
parameters to be included.
1. Triggers always need a table to act upon. For this exercise, we will be using the table we
created in the Debugging an INSERT Trigger (page 214), and the data we inserted into it.
2. Open a new PL/SQL Editor tab.
3. Enter the code below into the Editor. This is the trigger we will use. It assigns and
declares a variable when you perform an DELETE on the TESTTAB table.
CREATE OR REPLACE TRIGGER testtrig
BEFORE INSERT ON TESTTAB
DECLARE
tmpVar NUMBER;
BEGIN
tmpVar := 0;
EXCEPTION
WHEN OTHERS THEN
NULL;
END testtrig;
Toad for Oracle User Guide
Tutorials
219
/
4.
Make sure the Compile with Debug button is selected. Click the Compile
button to compile the trigger.
Set DELETE Trigger Parameters - Debugging Tutorial
Now that you have a trigger in the editor, you can set parameters for the variables and begin the
debugging procedure.
Note: Usually, when debugging, you are not going to want to change the data in your database.
However, you must act on that data in order to step through a trigger: the trigger must be
activated to debug it. In order to prevent data from changing, you may want to change the
commit options in View | Toad Options | Debugger | Transaction Control to Rollback or
Prompt to keep from altering data.
1.
Click on the toolbar SHIFT+CTRL+F9).
2. If a dialog asking you to compile with debug information appears, click OK.
3. In the Set Parameters window, Column Values grid, modify the anonymous block so
that the trigger will fire. In this case, we are going to delete rows of the table that have an
employee last name of SMITH. The value sections of the grid are irrelevant to the trigger,
so we need to modify the WHERE values:
Column Name WHERE Value
ID NULL
FIRST_NAME NULL
LAST_NAME SMITH
Set DELETE Trigger Watches - Debugging Tutorial
Set any watches or breakpoints you want to use for debugging. In this case, we are going to set a
watch on the variable TMPVAR.
1. Click in line 4 (tmpVar NUMBER).
2.
Click the Watch button on the toolbar. The watch is displayed in the
Watch window.
Step through the DELETE Trigger - Debugging Tutorial
At this point you can proceed with debugging.
l Press SHIFT+F7 to step through the code. Note how the TMPVAL watch changes values
when you reach line 7.
Toad for Oracle User Guide
Tutorials
220
SQL*Loader
SQLLoader Tutorials
Learning to use the SQL*Loader functionality is something best done by trying it out. These
tutorials for using the SQL*Loader are designed to let you do just that in a small steps.
Basic SQL*Loader Tutorial
Start by creating an Input file, and then move on to telling Toad how to load your data and
execute the import. See "Basic SQL*LoaderTutorial" (page 220) for more information.
Intermediate Tutorials
Move on to some of the more advanced features:
l Intermediate SQL*Loader Tutorials (page 228)
l Conditional Loads into Partitions - Intermediate SQL*Loader Tutorial (page 230)
l Load from Several Files of Different Formats - Intermediate SQL*Loader Tutorial
(page 231)
Advanced Tutorial
Learn about more of the Advanced Features of the SQL*Loader interface. See "Advanced
SQL*Loader Tutorial" (page 233) for more information.
Basic SQL*LoaderTutorial
Create Input File - Basic SQL*Loader Tutorial
For this tutorial we will need to create an file containing the data we'll insert into a table, and
the table where it will be inserted.
1. Create and populate a sample table. Copy and paste the following script into
Toad's editor:
create);number Rank ),30(varchar2 Name( MarksFavoriteFoods table
insert);1 ,'Tuna'(values MarksFavoriteFoods into
insert);2 ,'Salmon'(values MarksFavoriteFoods into
insert);3 ,'Broccoli'(values MarksFavoriteFoods into
insert);4 ,'Asparagus'(values MarksFavoriteFoods into
insert);5 ,'Bell peppers'(values MarksFavoriteFoods into
Toad for Oracle User Guide
Tutorials
221
insert);6 ,'Chicken'(values MarksFavoriteFoods into
insert);7 ,'Yogurt'(values MarksFavoriteFoods into
insert);8 ,'Brown rice'(values MarksFavoriteFoods into
insert);9 ,'Carrots'(values MarksFavoriteFoods into
insert);10 ,'Lean ground beef'(values MarksFavoriteFoods into
2. Execute the script.
3. Save the new table as an ASCII file.
4. Open the Schema Browser. Click the Tables tab and then MARKSFAVORITEFOODS.
5. In the right panel, select the Data tab.
6. Right-click, select Save As, choose Delimited Text, enter a filename in the Output area,
and set Comma as the delimiter.
7. Click OK. You have now created the data, or input, file.
Empty the table by running this small script in the Editor:
delete from MarksFavoriteFoods;
commit;
You can verify in Schema Browser that it is empty.
From the Start menu, open the Notepad application and load the data file you just
created. You are going to edit the first line to intentionally create "bad" data.
Here is how the first three lines from the data file appear:
Name,Rank
Tuna,1
Salmon,2
8. Remove the first line from the file.
9. In the second line, replace the comma with a tab. The first line should now appear
as follows:
Tuna 1
10. Save the file and close Notepad.
Add Input File - Basic SQL*Loader Tutorial
You must add an input file. The input file is the actual data file that is loaded using the
SQL*Loader Wizard.
Toad for Oracle User Guide
Tutorials
222
To add an input file
1. From the Database menu, select Import | SQL*Loader Wizard. The first window lets
you select, "What would you like to do?" Select Build Control File. ;Leave the Specify
Fields box selected and then click Next.
2. The second window is where you enter the list of the data files you want to load into one
or more tables. At least one input file is required. Click Add to add a file.
3. In the Add input file dialog, click the drilldown button next to Input filename and
choose the data file. In this case, choose the MarksData.txt file that you created in
the previous step. The following filenames will be created based on the input file
name you enter:
l Bad file name This file will contain rejected records. By default, it gets named
the same as the input file, with a .BAD extension. In our example, this file should
contain our bad Tuna record because it does not conform to the parameters you
will specify.
l Discard file name The discard file contains records that were not inserted during
the load because they did not match any of the selection criteria. You will see in a
later example that you can actually tell SQL*Loader WHEN you want a record
inserted it must match criteria you specify.
Note: When the pointer passes over each field in the Add Input dialog box,
"MicroHelp" is displayed in the status bar.
4. Records can be in one of three formats:
l Stream - This is the default format. Lines are read until an end-of-record marker is
found (end of line character, by default).
Streamrecord format, end-of-line character default: Tuna,1
Fixed -- each record must be a fixed number of bytes in length.
Fixed record format - all data records must be same length
Variable -- each record may be a different length, as specified by a special field
the first field in each record. The user must specify the length of this field.
Variable record format, specifier field is 3 bytes long:
006Tuna,1
Stream is chosen by default. Leave the end of record string box empty, taking the
end of line character as the default.
5. The Discard field indicates the maximum number of records to put into the discard file.
Leave this empty also, indicating that you want all discarded records.
Click OK.
Toad for Oracle User Guide
Tutorials
223
At this point you could choose as many different input files as you want as long as
they all had the same record layout (i.e. they all contained the same fields, in the same
order). However, as you will see in a later example, they can have different formats.
6. Click Next. The wizard moves to Set Delimiters.
SQL*Loader Tutorial Set Delimiters for Field Mapping - Basic
SQL*Loader Tutorial
The third window of the SQL*Loader Wizard lets you set the delimiter for the data file.
Note: If you have cleared the Specify Fields box on the Add Input File page, this window will
not display.
1. Select String and enter a comma as the delimiter (this is the default).
2. The grid below lists the data and separates it by the selected delimiter. You can change
the number of lines displayed in this grid.
In places where the comma was replaced with a tab, the data does not fit the selection.
3. Click Next.
Choose Destination Table - Basic SQL*Loader Tutorial
The fourth window of the SQL*Loader Wizard lets you choose your destination tables. If you
have selected Specify Fields on the first screen, you can also map fields to columns. These
settings are displayed in the upper and lower grids in this window.
Toad for Oracle User Guide
Tutorials
224
1. In the upper area, add a destination table. Click Add.
2. Select MarksFavoriteFoods from the table list, and leave the other settings as
defaults. Click OK.
3. Skip the Columns area for now, and in the Field Mapping area, click the Auto Map
button. The field numbers are mapped to the columns from the tables.
Click the Preview tab to see how the data maps to the columns. Notice that the error we
included when creating the input file is reflected in the preview data. You may have to
scroll to the top of the data to see this.
4. Click Next to move to the Global options window and set parameters.
Toad for Oracle User Guide
Tutorials
225
Set Parameters - Basic SQL*Loader Tutorial
The next window of the Wizard lets you Specify global options and default values.
For this tutorial, you are going to use the defaults.
Click Next to specify control file and log file names.
Control File
At the bottom of all of the previous windows (and this one) is a preview of your control file.
It should appear similar to the following (the paths to the various files will reflect where you
saved the original input file:
LOAD DATA
INFILE 'C:\marksdata.txt'
BADFILE 'C:\marksdata.bad'
DISCARDFILE 'C:\marksdata.dsc'
INTO TABLE "MARKSFAVORITEFOODS"
FIELDS TERMINATED BY ','
(NAME,
RANK)
SQL*Loader Specify Control and Log Files - Basic SQL*Loader Tutorial
This window lets you enter a name for a control file.
1. Enter a name that you want to use as a control file in the Control file name box. We
used c:\confile.ctl; you can name it whatever you want. Press <Tab>.
2. The control file name is entered into the log file box with the extension .log. If you want
to use a different name for your log file, you can change this now.
3. Click Save Settings. Save these settings as MarksFood. You can now Load them
at any time.
4. Click Next to go to the next step and execute SQL*Loader.
Execute SQL*Loader - Basic SQL*Loader Tutorial
1. The last window of the wizard lets you choose how to execute your load. Select Execute
Now. Be sure the Watch progress option is selected.
Click Finish. The SQL*Loader Watch dialog box appears as follows:
Toad for Oracle User Guide
Tutorials
226
The first tab is the output tab, and provides the standard output from running the loader.
If any errors occurred when running the loader itself, they would be displayed here.
l The first thing listed on the Output tab is some information about SQL*Loader
itself its version and the date and time it was executed.
l The last line indicates that 10 rows were inserted into the table. You can verify
this with the Schema Browser.
2. Click the Log tab.
The log tab contains the text of the log file and presents detailed information about
what occurred. The log file contents are loaded into this tab after the SQL*Loader is
finished running.
The log file contains a lot of data about what happened as the data was loaded. Scroll
down in the window to see that one record was rejected and why.
Toad for Oracle User Guide
Tutorials
227
From your Windows Start menu, open Windows Explorer. You will see that the file
named "MarksDiet.bad" was created in the same directory as your data file. Open it. It
contains one row:
Tuna 1
This row did not match the criteria you specified for the load: that each record should be
comma delimited.
Execute SQL*Loader on a Populated table - Basic SQL*Loader Tutorial
Executing the SQL*Loader when the table is populated will generate errors, unless you choose a
"load method" of Replace, Append, or Truncate in the global options screen of the wizard. To
see this in action, do the following procedure after you have run the SQL*Loader tutorial:
To Load data into a Populated Table
1. Close the SQL Loader Watch window.
2. From the Database menu, select Import | SQL*Loader Wizard. In the first window, click
Load Settings.
3. Open MarksFood from the dropdown menu. Click OK. The wizard moves to the
final stage.
Select Execute Now and click Finish. The watch window reopens, containing the line:
Toad for Oracle User Guide
Tutorials
228
SQL*Loader-601: For INSERT option, table must be empty. Error on table
"MARKSFAVORITEFOODS"
Unless otherwise specified, the SQL*Loader performs the load in INSERT mode and does
not load data into a table that already contains rows.
4. You can solve this problem by changing the load method. Return to the SQL*Loader
window and open MarksFood as described above, but this time uncheck Proceed to
Finish after loading.
5. Click Next three times to get to the Destination table and columns screen. The load
method field of the grid is blank, indicating the default of INSERT.
6. Select the Load Method cell, click the dropdown arrow and select Append from the
dropdown list.
7. Click Next | Next | Next, Execute Now and Finish.
8. You can read the Messages and Log file (or simply look in Schema Browser) to see that
all 9 records (remember that 1 is still bad) were successfully appended into the table.
Intermediate SQL*Loader Tutorials
Load Logical Records into Multiple Tables - Intermediate
SQL*Loader Tutorial
This tutorial will demonstrate how you can load data from one data file into multiple tables
by using logical records. What is different about this data is that each line of the data file
corresponds to more than one physical record (row of a table). There are two logical records
in each line.
1. Create an input file identical to the one described in Create Input File. See "Basic
SQL*LoaderTutorial" (page 220) for more information.
2. Create another table identical to the MarksFavoriteFoods table. Name it TESTTHIS.
Make sure both tables are empty.
3. Edit the input file to make it look like this:
Toad for Oracle User Guide
Tutorials
229
It is important that the data be lined up exactly. Use spaces no tabs. The first column of
numbers should line up as the 14
th
character. The second column of foods should line up
at the 18
th
character. The second column of numbers should be located at the 35
th
character.
4. Open the SQL*Loader Wizard, and then select Build control file. Uncheck the Specify
Files box. Click Next.
5. Add the new data file as your input file. Click Next.
6. From the Destination Tables grid, add both the MarksFavoriteFoods, and TestThis
tables. Clear the Terminated by field.
7. Select MARKSFAVORITEFOODS in the tables grid.
In the Columns grid, in the From/To column fields, Name row, enter 1 and 12
respectively.
Note: This tells the table to read the first 12 columns in our data file to extract the
Name field.
8. In the Rank row, enter 14 and 14 for the From/To. That is where the Rank data resides in
our input file for that field.
9. You can also select the column positions graphically. Select TESTTHIS in the tables
grid and select its Name column.
10. Click Edit and then click the Position tab.
11. Click in front of the S in Salmon, and then after the f in beef. If you click in the wrong
location, you can also drag the marker. Click OK.
The From/To columns now contain the numbers 18 and 33.
12. Finally, select the last Rank column, click Edit and then Position, and set the column
boundaries around the rank in the second set of data.
13. Click Next twice.
Toad for Oracle User Guide
Tutorials
230
14.
Click and select a control file from the Open dialog box, or enter a new name for your
control file. Click OK.
15. Click Next.
16. Select Execute Now and Watch Progress and then click Finish. If you open the Schema
Browser and check the tables, you will see that the foods ranked 1, 3, 5, 7 and 9 went
into the first table, while those ranked 2, 4, 6, 8 and 10 went into the second table.
Conditional Loads into Partitions - Intermediate SQL*Loader Tutorial
This tutorial demonstrates loading into a partition with conditions.
Note: At this time when you select a table the subpartitions field does not get populated with
the available subpartitions (as the partitions field does with the tables partitions); you must enter
the name directly.
1. Drop and recreate your first table with range partitions. Run the following code:
DROP TABLE MARKSFAVORITEFOODS;
CREATE (MARKSFAVORITEFOODS TABLE
NAME ).30(VARCHAR2
RANK )NUMBER
PARTITION)RANK(RANGE BY
(PARTITION).5(LESS THAN VALUES FoodRank1
PARTITION(MAXVALUE)); LESS THAN VALUES FoodRank2
If you were to re-run the first tutorial on this table, foods with a
ranking up through and including four would go into the partition named
FoodRank1, and all the rest would go into the partition named
FoodRank2. Try it, and verify the contents through the following SQL:
SELECT * from MarksFavoriteFoods partition (FoodRank1)
SELECT * from MarksFavoriteFoods partition (FoodRank2)
For this example, however, you will attempt to load all our data into
partition FoodRank1. If you ran the first tutorial again to try out the
Note above, empty the table now.
2. Open the SQL*Loader wizard.
3. Select Build control file. Leave the Specify Fields box checked and click Next.
4. Select the original, comma delimited file from the beginning of example 1 and add it to
the input file list. Click Next.
5. Click the Add button in the tables area. Select MarksFavoriteFoods from the
Table dropdown.
Toad for Oracle User Guide
Tutorials
231
6. Check the Partition box. Click the drop down partition list and you will see the two
partitions listed that you created. Choose FOODRANK1.
Make sure that the Terminated by box contains a comma (,).
NOTE: If the data were tab delimited, you would choose TAB from the dropdown.
On the lower right side of the add table window is the Load Rec Condition When area.
This means "load the record into the table when the following conditions are present". In
this field, enter the following:
RANK != "1"
This says that you only want records whose RANK field is not equal to the character "1".
NOTE: All character data is interpreted automatically by Oracle. If you wanted to enforce
certain data types for special conditions you could do so under the Column Parameters
data type field.
7. Click OK and then click Next.
8. Leave global options and defaults blank. Click Next.
9. Enter a control file name to create. Click Next.
10. Select Execute Now and Watch progress and then click Finish. The status
window opens.
Click the Log File tab. Scroll down and you should come to these lines:
Record 1: Discarded - failed all WHEN clauses.
Record 5: Rejected - Error on table "MARKSFAVORITEFOODS",
partition FOODRANK1.
ORA-14401: inserted partition key is outside specified partition
[and so on for the rest of the records]
This says that the first record failed the WHEN clause. It certainly did it had a rank of 1
and we told Toad not to load any records with that rank. The rest of the rejection lines
state that the inserted partition key is outside the partition bounds. This is because records
with a rank of 5 and above exceed the partition bounds you chose for FOODRANK1.
Look in Schema Browser and you should find the foods ranked 2 through 4 in the data.
Load from Several Files of Different Formats - Intermediate
SQL*Loader Tutorial
This example will use three different data files and demonstrate the three supported format types:
stream, fixed and variable.
1. Use the MarksData.txt data file from the previous tutorial. Use Notepad (this is
important) as an editor.
Toad for Oracle User Guide
Tutorials
232
2. Split the original file, creating three files, MarksDiet1.dat, MarksDiet2.dat and
MarksDiet3.dat.
3. Edit the first file (MarksDiet1.dat). It should look as follows:
Tuna,1*Salmon,2*Broccoli,3*
Note: There are no extra spaces or new line characters at the end of that line. This sample
demonstrates using an asterisk as an end of record marker. Up until now, you have been
using the carriage return/new line character combo to designate physical records.
4. Edit MarksDiet2.dat as follows:
Asparagus, 4,Bell peppers,5,Chicken, 6,
Once again, use no spaces or new line characters at the end of the line. This is going to
be our fixed record length file. Each record is fixed at precisely 15 characters.
5. The third file should be named MarksDiet3.dat and look like this:
0009Yogurt,7,0015Brown rice,8,
0010Carrots,9,0019Lean ground beef,10
Note: On SQL*Loader versions prior to 8 (7.3, for example), a space is required after the
record length field
This is the variable format file. At the beginning of each record is a field that designates
how long that record is. Notice Brown Rice on the first line. You may count 13
characters. But Notepad also adds two more characters a carriage return/line feed pair,
so they have to be added into the total.
Note: Other editors may only add one line feed character.
Once again, make sure there are no extra spaces or carriage returns at the end of the
second line.
6. Open the SQL*Loader Wizard and select Build control file. Uncheck the Specify Files
check box. Click Next.
7. Add files as follows:
File Parameters
MarksDiet1.dat Select Stream format, and enter an asterisk into
the end of record string field.
MarksDiet2.dat Select Fixed format, with a length of 15.
MarksDiet3.dat Select Variable format, with a length of 4 bytes
long (enter a 4 in the length field).
After adding these, your Source Files tab should look like:
Toad for Oracle User Guide
Tutorials
233
8. Click Next. Select the same Destination table.
Note: Remember that the table must be empty before you attempt to Execute the
command. If your table is not empty, save the settings, empty it and load the settings
back into the wizard.
9. Click Next. Leave the global options blank.
10. Click Next. Add a control file.
11. Click Next. Select Execute Now and click Finish.
If your table is still partitioned, as mine was, you can use these lines to see the data
in each one:
select * from MarksFavoriteFoods partition (FoodRank1)
select * from MarksFavoriteFoods partition (FoodRank2)
Advanced SQL*Loader Tutorial
Advanced Features - SQL*Loader Tutorial
This final tutorial will demonstrate specifying input data delimiters at the column level,
capturing constraint errors and some of the command line options available.
For this example, you are going to create a foreign key to a table containing all of our
food ranks.
2. In the Editor, execute the following as script:
CREATE TABLE FOODRANK (RANK NUMBER PRIMARY KEY);
DECLARE
I INTEGER;
BEGIN
I := 1;
LOOP
INSERT INTO FOODRANK
VALUES (I);
Toad for Oracle User Guide
Tutorials
234
I := I + 1;
IF I > 10
THEN
EXIT;
END IF;
END LOOP;
END;
/
CREATE TABLE MARKSFAVORITEFOODS (NAME VARCHAR2 (20), RANK NUMBER);
CREATE TABLE LOADEREXCEPTIONS (ROW_ID UROWID,
OWNER VARCHAR2 (30),
TABLE_NAME VARCHAR2 (30),
CONSTRAINT VARCHAR2 (30));
ALTER TABLE MARKSFAVORITEFOODS ADD CONSTRAINT CHECK_RANK FOREIGN KEY
(RANK) REFERENCES FOODRANK(RANK)
EXCEPTIONS INTO LOADEREXCEPTIONS;
3. Create the input data file as follows. Be very careful about copying and pasting into an
editor. Make sure you dont get an empty line at the end.
"Grease^#1
"Tuna^#1
"Salmon^#02
"Broccoli^#3
"Asparagus^#4
"Bell peppers^#5
"Chicken^#6
"Yogurt^7
"Brown rice^#8
"Carrots^#9
Lean ground beef#10
"Egg whites^#11
Toad for Oracle User Guide
Tutorials
235
"Congealed Fat^#99
Look at this input file briefly. It is clear that the first field, Food Name, has a double-
quote as its first delimiter. Its closing delimiter is a caret. And its ending field specifier is
a # character. The Rank field is not delimited. Or is it? Copy and paste that data into an
editor and again, make sure there are no hidden characters anywhere. (Incidentally, how
did Grease and Congealed Fat make it into the list? You will fix that later.)
4. Save the data file and run the SQL*Loader Wizard, choosing Build control file on the
first screen and leaving Specify fields checked.
5. Select the datafile you just created as the input file, leaving all other defaults. Click OK
and then click Next.
6. Click Next to skip the Delimiter screen.
7. Add MarksFavoriteFoods as the destination table:
8. In the Exception Table area, enter or pick LOADEREXCEPTIONS as the
Exceptions table.
Remove any entries in the Terminated By: box.
This indicates that you want any constraint exceptions to go into
LOADEREXCEPTIONS. The exceptions table must be in the format as shown above. The
RowID of the rows that violate the constraint go into this table.
In the options area in the upper right area of the Add Table dialog, check Reenable
Constraints. This tells the SQL*Loader to re-enable constraints when the load is finished.
When the constraints are re-enabled, the referential integrity checks fire, causing some of
the data to fail and the row to be marked in our exceptions table.
Look back at the data. It is pretty clear that Congealed Fat with a food rank of 99, will
violate our referential integrity constraint. You only have ten ranks in our FOODRANK
table - 1 through 10, so anything else will not be allowed.
9. In the Columns area grid, select the Name column and click Edit.
10. Enter # in the Terminated by: field.
11. The Field is enclosed by " and ^,so enter those characters in the appropriate
fields as well.
12. Not all of the food name fields are delimited, so you will check the Optionally
check box.
13. Move to the Null If field. Null If tells the SQL*Loader: "set character columns to null,
and number columns to zero, upon this condition". Enter RANK="3" in the Null If field.
This will blank out the Food Name column when Rank is 3. The food for that rank is
Broccoli, so it will never appear.
14. Move to the Default if field. Enter NAME="Bell peppers". This will set the Food Name
column to null whenever the Name is "Bell peppers".
The screen should look like this:
Toad for Oracle User Guide
Tutorials
236
15. Click OK.
16. Click NEXT. The command line options are options that can be specified on the
executable command line. Enter a 1 into Skip. This tells Toad to skip 1 record. The
Grease field will be skipped.
17. Enter 11 into the Load field. This tells Toad to load 11 records from our data file. So the
first line will be skipped and the next 11 loaded. The Congealed Fat record will not be
loaded. Even if it was, it has a Rank of 99, so it would fail the constraint check.
18. Select the Direct check box, since you want to do a Direct Path Load (a very different
style of loading, and does not perform standard SQL Inserts but rather uses buffers. This
will permit the constraint to be turned off).
Finally, under Silent, check the All check box. This tells loader to suppress all output
messages (the log file will still be created).
Note: These options are not mutually exclusive you can disable Feedback and Errors,
but not Discards, and so on.
19. Click Next. Enter a control file name (we used D:\confile.ctl, but you can name it
anything). Click Next.
20. Click Save Settings and save these settings. Well want them again later.
21. Select Execute now and Watch progress. Click Finish.
Since you suppressed all messages, the Messages tab shows only these lines:
SQL*Loader: Release 8.1.6.0.0 - Production on Fri Oct 27 13:57:14 2000
(c) Copyright 1999 Oracle Corporation. All rights reserved.
"Yogurt^7
Whats wrong with that line? It has no field termination character - #. Notice that the lean
ground beef line:
Lean ground beef#10
Toad for Oracle User Guide
Tutorials
237
made it in, even though it does not have delimiters. Thats because you said they
were optional.
22. The Log file states that 10 rows were loaded; 1 row was not, due to data errors. Which
row was that? Open MarksDiet.bad (or whatever you named the data file, plus the .bad
extension). You will find this line:
Now, open Schema Browser and look at the Data tab for MarksFavoriteFoods. It
looks like this:
Broccoli and Bell Peppers were blanked out, as specified. Grease was skipped and
Congealed Fat was not loaded because it was beyond our "Loaded" limit. Yogurt was not
loaded due to bad data. But Egg Whites had a Rank of 11. Why didnt the constraint
fail? And whats up with the Rank of 0 for Salmon? It had a rank of 2.
Open the log file to find out. Whatever you named the control file, but with a .LOG
extension, and in the same directory as the control file is your log file. Near the bottom
you will find the following:
Column Name Position Len Term Encl Datatype
-----------------------------------------------------------------------
------------------------------
NAME FIRST * # O(")
CHARACTER
O(^)
NULL if RANK = 0X33(character '3')
DEFAULT if NAME = 0X42656c6c2070657070657273(character 'Bell peppers')
RANK NEXT 1
Toad for Oracle User Guide
Tutorials
238
CHARACTER
Len means length. You see a length of * for Name, meaning read to the end of field
marker, (# - the Terminator character). But Rank has a length of 1. Thats why only 1
character was loaded. But why? Well, you never specified a field terminator for Rank.
You did for Name, but not Rank.
Open an Editor window and remove the records from MarksFavoriteFoods by entering:
delete from marksfavoritefoods
23. Open the SQL*Loader Wizard. Load the settings you saved previously (uncheck the
Proceed to finish box). Click next until you get to the Destination Tables.
24. Select Rank and change the Field is terminated by field, by selecting WHITESPACE
from the dropdown.
25. Execute the SQL*Loader wizard once more. Notice in Schema Browser that all the
numeric data is entered properly. In examining the log file, you see that our constraint
was disabled, the records loaded, and an attempt was made to re-enable the constraint.
But the particular constraint you used a foreign key constraint could not be re-
enabled because there were orphaned records the Egg White. Look in the
LOADEREXCEPTIONS table and you will find the RowID of the offending record.
Team Coding
Team Coding Tutorials
Team Coding is a cooperative source control feature. You can use Team Coding alone or in
conjunction with a third party version control system. Team Coding works with the Editor to
control access and development of functions, procedures, packages, triggers and types.
There are several ways to use Team Coding, and these tutorials will help you set the feature up
in the best way for your situation.
Installing Team Coding Database Objects - Team Coding Tutorial (page 238)Team
Coding Roles (page 239)Steps (page 241)
Installing Team Coding Database Objects - Team Coding
Tutorial
Before you can use Team Coding as a basis for source control, it must be set up and configured
on your Toad instance. This tutorial will walk you through the most basic Team Coding
configuration, using only Toad and no external version control software.
In order to use Team Coding, a repository must be set up on the database (usually in the TOAD
schema), and Team Coding must be configured on your machine.
1. If you haven't already, open Toad.
2. From the Database menu, select Administer | Server Side Objects wizard.
Toad for Oracle User Guide
Tutorials
239
3. On the first page of the wizard, select Install, upgrade or remove objects for all users to
share and then click Next.
4. Enter login information for either the TOAD schema or a DBA user (you must have DBA
privileges on your account to do this) information and click Next. Toad logs in to the
selected schema.
5. The Server Side Objects wizard checks to see if Team Coding has been installed and that
all components are valid. If they are, the Team Coding area will display "Found and OK."
If they are not there, it will display "Team Coding not Found". Click Add and then Next
to install them.
6. Click Next to skip the Space Manager features.
7. Create the Team Coding roles. It is recommended that you create new roles for Team
Coding, but you can also assign the team coding privileges to an existing role. When you
have selected the options for these roles, click Next.
8. Select the tablespaces where you want to create the Team Coding Objects. Click Next.
9. Click Run Script to create the Team Coding Objects. When the wizard displays "Update
of TOAD complete," review the output and click Next.
10. The Server Side Objects wizard checks for other necessary objects and reports on the
status. Click Close to finish.
Setting up and Enabling TC without Version Control Software
Setting up Team Coding without Version Control Software - Team
Coding Tutorial
Team Coding Roles
Grant Users the Team Coding roles as desired. These roles are:
Administrator (TC_ADMIN_ROLE)
Can configure the instance to define how Team Coding operates, which VCS (if any) is used,
and so on. This role is automatically assigned to the Toad user.
Project Manager (TC_MGR_ROLE)
Can create and delete code control groups (CCGs) and relate them to a VCS project.
Team Leader (TC_LDR_ROLE)
Can modify CCGs, define the objects or scripts are included in the group, and freeze objects. Can
also delete rows from the Team Coding Viewer.
Users without a role granted
Users not granted one of the three Team Coding Roles hold the default role of developer. They
can view the status of objects within the Team Coding Viewer, and check items in and out of
source control.
1. Grant Roles as follows:
Toad for Oracle User Guide
Tutorials
240
1. From the Schema Browser | Users tab
2. Select a user in the left panel
3. Click the Alter User button.
4. Do one of the following:
l Click the Roles tab. Add or remove roles as desired.
You can also grant roles from the Editor. Enter the appropriate SQL and execute it.
For example:
grant TC_ADMIN_ROLE to ARTHUR
grant TC_LDR_ROLE to SUSAN
Enabling Team Coding in the Database - No VCS - Team Coding Tutorial
1.
On the Team Coding Toolbar, click the View Team Coding Status for this session
button. The Team Coding Status dialog box displays, with the connection information in
the title bar.
If Team Coding is enabled, the Permissions area will display a green check mark beside
Team Coding Available and the permissions the current user has.
2. Click Settings to see and edit Team Coding status for this connection.
3. Check Enable Team Coding.
Setting up and Enabling Team Coding with Version
Control Software
Setting up Team Coding using Version Control Software - Team
Coding Tutorial
The first step is to grant users the Team Coding roles as desired. These roles are:
l Administrator (TC_ADMIN_ROLE)
l Can configure the instance to define how Team Coding operates, which VCS (if any) is
used, and so on. This role is automatically assigned to the Toad user.
l Project Manager (TC_MGR_ROLE)
l Can create and delete code control groups (CCGs) and relate them to a VCS project.
l Team Leader (TC_LDR_ROLE)
l Can modify CCGs, define the objects or scripts are included in the group, and freeze
objects. Can also delete rows from the Team Coding Viewer.
l Users without a role granted
Toad for Oracle User Guide
Tutorials
241
l Users not granted one of the three Team Coding Roles hold the default role of developer.
They can view the status of objects within the Team Coding Viewer, and check items in
and out of source control.
Steps
1. Grant Roles as follows:
1. From the Schema Browser | Users tab
2. Select a user in the left panel
3. Click the Alter User button.
4. Do one of the following:
l Click the Roles tab. Add or remove roles as desired.
You can also grant roles from the Editor. Enter the appropriate SQL and execute it.
For example:
grant TC_ADMIN_ROLE to ARTHUR
grant TC_LDR_ROLE to SUSAN
5. From View | Toad Options | Team Coding, set the appropriate Team Coding options. See
"Source Control Options" (page 682) for more information and descriptions. At the very
least you will need to set:
l Default Working directory - Enter the full path of the working directory for your
Version Control Software. You can browse and select it if necessaryby clicking
the drilldown button.
6. If you are using CVS, click VCS Provider Options and use CVS_Configurations_
Options to specify the options you want to use for that provider. Other supported
providers do not require these options.
Enabling Team Coding in the Database - VCS - Team Coding Tutorial
1.
On the Team Coding Toolbar, click the View Team Coding Status for this session
button. The Team Coding Status dialog box displays, with the connection information in
the title bar.
If Team Coding is enabled, the Permissions area will display a green check mark beside
Team Coding Available and the permissions the current user has.
2. Click Settings to see and edit Team Coding status for this connection. The Configuration
tab is active.
3. Check Enable Team Coding.
4. You must use code control groups if you are using 3rd party VCS. Check Use Code
Control Groups and Use 3rd party version control.
5. Select your Version Control Provider from the list provided.
Toad for Oracle User Guide
Tutorials
242
6. Click the File extension tab to change default file types associated with using Team
Coding, and the General tab to set defaults such as automatic generation of new version
numbers.
7. Click OK to save your settings and enable Team Coding.
Setting up Code Control Groups - Team Coding Tutorial
When Team Coding is enabled and your VCS has been set up, you will need to set up your
Code Control Groups.
Code Control Groups are like buckets that you can use to separate your code projects. You can
put some code into one or more buckets that will be under source control, and you can put some
code into a bucket that won't be controlled. In addition, you can sort the code within those
buckets into smaller containers using filters. These filters can be applied depending on the
developer using the code, as well as globally.
Create a code control group as follows:
1. From the Toad menu bar, choose Team Coding | Code Control Groups, or on the Team
Coding toolbar, click the Code Control Groups button.
2.
In the Code Control Groups toolbar, click the Add Group button.
3. If a login window appears, provide the needed information.
4. In the New Group dialog box, enter a descriptive name for the Group.
5. If you are using a third party Version Control System (VCS), select a VCS project by
following the prompts in the dialog boxes that appear. This will vary depending on the
product in use. The Code Control Group window appears.
6. If you are not using a VCS, the Code Control Group window appears immediately.
7. In the Code Control Group window, create New Object and script mask definitions for
the current CCG.
Setting up New Object and Script Masks - Team Coding Tutorial
1. From the Code Control Group window, select the group where you want to add masks
and then click the Open Group button.
2.
Click the New Database Mask button.
3. Select from the following options:
l Object Type - Choose from View, Procedure, Function, Package, Package
Body or All.
l Schema - Pick a user from the list, or type a schema name. You can use the %
wildcard character.
Toad for Oracle User Guide
Tutorials
243
l Object Name - You can type an object name, including the % wildcard.
Alternatively, you can launch the Open DB Object dialog box to choose an object
matching the Object Type and Schema settings.
l Excluded - Select Excluded to exclude any objects matching this object mask from
the CCG.
Mapping Users to CCGs - Team Coding Tutorial
You must be logged in as the user you want to map.
1. From the Team Coding menu, select Code Control Groups.
2. Select the appropriate CCG.
3.
Click the Map Current User button on the toolbar.
4. If the CCG contains object masks for multiple schemas, follow the prompts to select the
schema you want.
5. If required, perform an Import to update the objects in your schema.
RMAN Templates
RMAN Scripts in Toad
This feature is only available in the commercial version of Toad with the optional DB
Admin module.
You can execute RMAN scripts from Toad.
l Edit templates
l Add templates to the listing
l ExecuteRMAN scripts
See "Working with RMAN Templates" (page 244) for more information.
There is an online video tutorial for this feature. This opens a new browser window and requires
an internet connection.
Templates are edited and created from the Toad Options window. Execution takes place from the
Database Browser. RMAN executes outside of Toad and automatically closes when finished.
Working with RMAN Templates
RMAN templates are stored in a property file within the User Files directory. See "Properties
Files" (page 163) for more information and more specific location information.
From the Toad Options window, you can add your own files, edit existing ones, and remove
them from the listing.
To view the RMAN files listing
From the View | Toad Options window, select RMAN templates.
To add files to the RMAN files listing
1. From the View | Toad Options | RMAN Templates page, click Add.
2. Enter the name you want displayed in the listing.
3. Do one of the following:
l Enter the filename and path in the Filename box
l
Browse to the file using the drilldown button.
4. Click OK.
8
Toad for Oracle User Guide
RMAN Templates
245
To edit an RMAN file
1. From the Options | RMAN Templates page, select the file you want to edit.
2. Click Edit.
3. Edit the file in the external editor, save it and close the editor.
To remove files from the RMAN files listing
1. From the Options | RMAN Templates page, select the file you want to remove.
2. Click Delete.
3. Click Yes when prompted.
Executing RMAN Scripts from Toad
This feature is only available in the commercial version of Toad with the optional DB
Admin module.
You can execute RMAN scripts from the Toad Database Browser.
To run an RMAN script
1. From the Database Browser, right-click on the target database. See "Database Browser"
(page 532) for more information.
2. Select Generate RMAN script and then select the script you want to run.
3. Enter the variables that are not defined automatically, and select the ones you want to
apply. Click OK to send the script to the editor.
Note: If there are no variables to be defined, the script will be sent directly to the editor.
4. Press F9 to run the script.
5. RMAN opens and runs outside of Toad and then closes independently.
Comparing
Data Duplicates
Use this dialog box to view record duplicates based on user input.
To view record duplicates
1. Select Database | Compare | Data Duplicates
2. Select the Owner, Object Type and Object from the dropdown lists. A list of columns is
displayed below. Now, you can either:
Find duplicates on all columns Check the Find duplicates on all columns option button.
Do not select any columns in the list.
Find duplicates on just selected
columns
Check the Find dupes of selected columns option button.
Select one or more columns in the column list.
On the Duplicate Data tabs, an additional column called Occurences is added to the end of the grid to
display the number of resulting duplicates.
To edit duplicate data
1. From the Table Data Duplicates window, select Owner and Table from the
dropdown lists.
2. Click the Duplicate Data (Editable) tab.
3. Click the cell you want to edit and make your changes.
4.
Click on the toolbar.
Compare Single Objects
You can compare single objects from the Schema Browser. All objects accessible from the
Schema Browser can be compared.
To compare objects
1. In the Schema Browser, right-click on an object.
2. Select Compare with another object.
Note: Reference source information will be filled in for you.
9
Toad for Oracle User Guide
Comparing
247
3. Enter comparison source information (a text file or an object in a live schema).
Select options to apply:
Compare columns only Applies only to tables, views,
and materialized views.
Alphabetical Arranges columns
alphabetically before
comparing.
Format before comparing Formats both files consistently
so that cosmetic differences do
not impact your results.
4. If you are using Toad with the optional DB Admin Module, you can choose to view your
results in one of two ways:
Results as File Compare Use the Differences Viewer to
compare the two selected
objects. For more information
about the differences viewer,
see Compare Files.
Results as Sync Script Only available if the objects
chosen have the same name,
and are in different schemas,
this option the objects and
creates a sync script.
Comparing Databases
Compare Databases
Note: This Toad feature is only available in the commercial version of Toad with the optional
DB Admin Module.
An online video tutorial is also available for this feature. This video opens in a new browser
window and requires an internet connection.
To compare databases manually
1. From the Database menu, select Compare | Compare Databases.
2. Make your selections on the Databases and Objects & Options tabs, and then click
Compare to display the results tabs.
3. Click the Object Set tab to specify an object set if wanted.
Toad for Oracle User Guide
Comparing
248
To compare databases from the Command line
l From the Options tab, you can click the Save all settings to file button and then run the
comparison from the command line later. (See "Run Compare Databases from Command
Prompt" (page 839) for more information.)
Compare Databases - Database Tab
Note: This Toad feature is only available in the commercial version of Toad with the optional
DB Admin Module.
After you have opened the Compare Databases window, click the Database tab to set
the following:
Option Notes
Reference Source The reference source is the source that will not change if you use
the sync script.
Comparison Source The comparison source is the source that will be changed by the
sync script.
Database Select the Connection. You can also choose to create a definition
file for either source from either source.
Definition File Choose definition file to make a comparison with a saved
definition file. This option is useful if you have an unchanging
database, or you want your various databases to conform to a
template.
When you create a definition file, you can use variables in the
filename. By default, Toad includes the %DATEFILE% and
%TIMEFILE% variables, which inserts the current date and time
into the filename when the definition file is created. (This ensures
that the date and time are inserted accurately if you are creating
the definition file from an Action.See "Creating a new action from
a Toad window" (page 437) for more information.)
Note: Comparing Definition files is only available in the
commercial version of Toad with the optional DB Admin Module.
See "Generate Schema Script" (page 429) for more information
about creating definition files.
Switching Comparison and Reference Databases
Switching comparison and reference databases is performed within memory, so if you have
previously run a compare, Toad can switch without querying the database again.
Clicking Switch before you have run the comparison will run the new comparison.
Toad for Oracle User Guide
Comparing
249
Changing options requires an additional query, and you will need to click compare again after
making any such changes.
To switch comparison and reference schemas
Click the Switch button.
Compare Databases - Options Tab
Note: This Toad feature is only available in the commercial version of Toad with the optional
DB Admin Module.
On the options tab of the Compare Databases window, check boxes let you select options and
what object types will be compared. (See "Compare Databases" (page 247) for more
information about comparing databases.) You can right-click the options tab to check or
uncheck all object types.
The options tab contains an additional two tabs:
Tab Options
Object Types to Compare Select the object types you want to compare. By
limiting what you are comparing, you can speed up a
schema compare. To select a set of options, click the
Options tab. See Compare Databases - Options Tab for
more information.
Options Check boxes let you select options, and you can enter a
filename for the Synchronization file in the box at the
bottom. Most of the options are self-explanatory, or
Oracle related.
Toad for Oracle User Guide
Comparing
250
"Safe Drop" Option
If "Safe Drop" on users, tblspaces
and profiles is checked:
A DROP USER statement will not include the
CASCADE keyword.
l If CASCADE is not included, then the script
will only be able to drop the user if the user
owns no objects.
A DROP PROFILE statement will not include the
CASCADE keyword.
l If CASCADE is not included, then the script
will only be able to drop the profile if no users
have that profile.
DROP TABLESPACE statements will not include the
INCLUDING CONTENTS keywords, or, if 9i or
above, the AND DATAFILES keyword.
l If INCLUDING CONTENTS is not included,
then the script will only be able to drop a
tablespace if the tablespace contains no
objects.
If "Safe Drop" on users, tblspaces
and profiles is unchecked:
A DROP USER statement in the migration script will
include the CASCADE keyword.
A DROP PROFILE statement in the migration script
will include the CASCADE keyword.
l If CASCADE is included, then any users with
the dropped profile will be reassigned to the
DEFAULT profile.
A DROP TABLESPACE statement in the migration
script will include the INCLUDING CONTENTS
keywords, plus, if 9i or above, the AND DATAFILES
keyword.
Compare Databases - Object Set Tab
Note: This Toad feature is only available in the commercial version of Toad with the optional
DB Admin Module.
You can use the Object Set tab of the Compare Databases window to select a specific object set
to compare. This lets you limit your comparison even more than the options. You can also
specify an object set and save it for later use.
This topic only covers unfamiliar information. It does not include all step and field descriptions.
See "Compare Databases" (page 247) for more information about comparing databases.
Toad for Oracle User Guide
Comparing
251
To specify an object set
1. In the Database Compare window, click the Object Set tab.
2. Select the Specify Object Set check box. Options with special features include:
(Add
object)
If you already have objects loaded, a
confirmation dialog will ask you if you want
to clear the grid before loading the new
objects. Choose Yes to start over, or No to
append the new objects into the grid
Like box If you leave it unchecked, all objects of the
selected type will be loaded.
Auto-check the
grid rows
Use this if you know you want to compare
everything that loads.
Select view/edit
query
Use the view dialog to check the query and
alter it if necessary.
(Save As)
Save the object set so you can use it later.
Loading a Saved Object Set
If you have saved an object set, you can load it into this window instead of creating a new set.
To load a saved object set
1. From the Database Compare window, click the Object Set tab.
2.
Click the Load Object Set from File button.
3. Select the object set you want to load and click Open.
Compare Databases - Results
Note: This Toad feature is only available in the commercial version of Toad with the optional
DB Admin Module.
Results of comparing databases can be viewed in several different ways. See "Compare
Databases" (page 247) for more information about comparing databases.
Results of a compare database display the changes required to make the second database look
like the reference database. Therefore, if you reverse the order of the databases, there may be
differences in the number of objects reported as "missing."
You can switch the order of the databases by clicking in the middle of the
Compare Database window, Databases tab.
Toad for Oracle User Guide
Comparing
252
The results grid details the differences between the databases in an interactive format. Differences
are separated into three groups. Each type of item has an icon assigned to it, making it easy to
see at a glance what object it is.
Icon Meaning
Objects Which Differ
Objects in Reference Source not in Comparison Source
Objects in Comparison Source not in Reference Source
Results Toolbar
The toolbar allows easy access to several formatting options, as well as a print preview screen
and the migration SQL dialog box. These are also available from the right-click menu.
Icon Meaning
Expand all
Expand to First Level
Collapse all
Show Sync Script for selected items.
Show difference details for one selected and supported object type
(for example a table or a directory). See "Viewing File
Differences" (page 257) for more information.
You can save your comparison to a file. You can choose text,
html, or rtf file from the Save As window.
NOTE: When you create a results file, you can use variables in
the filename.
Send to Excel.
Display summary view.
Print results.
Group by Object Type Items within groups can be grouped according to type. Each type
of item has an icon assigned to it.
Toad for Oracle User Guide
Comparing
253
Compare Databases - Sync Script
Note: This Toad feature is only available in the commercial version of Toad with the optional
DB Admin Module.
Sync Script tab
The Sync Script tab displays the migration SQL for the entire comparison. Running this SQL
will change everything in the comparison database.
Caution: You will lose data whenever a table is truncated or dropped, so check this script
thoroughly before executing it.
Sync Script toolbar
Icon Meaning
Save Sync Script as a text file.
Print the Sync Script.
Load the Sync Script in the Toad Editor. See "Toad Editor" (page 854) for
more information.
Execute the Sync Script immediately.
Caution: Remember that this SQL is designed to change the
comparison schema. Be sure you wont lose any important data before
you execute it.
Schedule the Sync Script to run at a later time using Windows Task
Scheduler. See "Task Scheduler" (page 762) for more information.
Scheduling Compare Databases as Windows Task
Note: This Toad feature is only available in the commercial version of Toad with the optional
DB Admin Module.
You can schedule a Windows task for comparing databases. You can also save your settings to a
file and load them at a later time.
To schedule a database compare task
1. Set up your options to Compare Databases. See "Compare Databases" (page 247) for more
information.
Toad for Oracle User Guide
Comparing
254
2.
From the Options tab, click the Schedule button.
3. Select your settings and output options and click Schedule to continue to the Schedule
Windows Task wizard. See "Task Scheduler" (page 762) for more information.
Saving and Loading Settings
You can save your settings to a file and then later reload them from the file. This makes it easier
to compare with the same settings in the future.
In addition, if you save your settings to a file you can later choose to run the Copy function from
the command line. See "Run Compare Databases from Command Prompt" (page 839) for more
information.
To save settings
Options tab Save All Settings
Object Set tab Save Object Set
To load settings
Options tab Load All Settings
Object Set tab Load Object Set
Comparing Data
Comparing Data
You can use Toad's Compare Data wizard to compare data between tables within different
schemas, or different databases. This can be useful for comparing the data in a production and
test environment, for example.
This topic only covers unfamiliar information. It does not include all step and field descriptions
To access the Compare Data wizard
1. From the Database menu, select Compare | Data.
2. Review the following for additional information:
Select data
sources page
Description
Toad for Oracle User Guide
Comparing
255
Use DB Link
box
If your first data source is remote, select an
existing DB Link.
If your first data source is local, leave this box
blank.
Object Type Tables, Views and Snapshots are supported.
Select
Performance
Options Page
Description
Sort Area Size This only affects queries going through a
Database Link.
When selected:
l The default area size is 10 MB
l You can select to set another sort area
size when the first window closes. The
default for this is also 10MB.
Optimizer
Hints - Use
parallel hint
The default is unchecked.
When selected, you can set the amount of
parallelism you want. The default amount when
checked is 4.
Select Columns
to Compare
Description
Column colors Black - Columns appear in both sources and
can be compared.
Red - Columns cannot be compared.
Purple - Columns appear only in Source 1.
Teal - Columns appear only in Source 2.
Reviewing Differences
From the last three windows of the Compare Data wizard you are now ready to view the
differences between your data sources. See "Comparing Data" (page 254) for more information.
l The first window reviews rows in Source 1 that are not in Source 2.
l The second window reviews rows in Source 2 that are not in Source 1.
l The last window reviews all differences.
You must run the SQL code for each window as described below.
Toad for Oracle User Guide
Comparing
256
Editable Datasets
You can edit the dataset from within the grid. In some editions of Toad, you can delete rows
from one table, and insert them into the other directly in the grid.
To make dataset editable
On the Review Differences page, select the Editable Dataset checkbox.
To review rows
1. Perform any desired optional steps:
l Click the View/Edit SQL button to view or edit the SQL used to compare
differences. You can make changes in the Edit SQL dialog box.
l Click Check to verify that the query parses correctly.
l Click OK to apply changes to your query.
l Click Execute to find differences in the columns you want to compare.
To delete selected rows
1. Select the rows you want to delete.
2. Right-click and select Delete Selected Rows.
To delete all rows
Right-click and select Delete All Rows.
Compare Files (Difference Viewer)
Compare Files and Objects
You can use the compare files window (File Differences Viewer) to compare the contents of two
files from a disk, or an object to a file or to another object.
You can access the Differences Viewer from three different areas. Each uses it to compare
different objects.
To compare two files on disk
1. From the Utilities menu, select Compare Files.
2. Select one or two files.
3. Click OK.
Toad for Oracle User Guide
Comparing
257
To compare objects in the Schema Browser
From either the Proceduresor Views page, right-click on an object and select Compare
with another object. See "Compare Single Objects " (page 246) for more information.
To compare differing objects from a schema compare
From the Schemas | Results (Interactive) tab, right-click an object listed as differing
between schemas and select Show Difference Details to compare the scripts of the two
objects. See "Compare Schemas" (page 260) for more information.
Viewing File Differences
When you have specified the objects you want to compare, whether they are files, database
objects, or scripts, you can use the Differences Viewer. See "Compare Files and Objects" (page
256) for more information.
The Differences Viewer lets you compare database objects in a split window. Differences
between the objects are highlighted and the toolbar gives you access to controls for customizing
the view and creating reports.
File Comparison Rules and Options let you specify the way Toad displays the similarities and
differences between two files, or two versions of a file.
Differences Viewer Toolbar
Button Command
Reload files and execute the comparison
Open a file
Paste contents of clipboard into selected side of viewer
Switch sides
Go to Previous difference
Go to Next difference
Show all lines of compared objects
Show only lines with differences
Show only lines with major differences. See "File Comparison Rules" (page 258)
for more information.
Show only matching lines
Find a text string
Find next text string
Go to a specific line number
Copy to right
Copy to left
Delete text to left
Toad for Oracle User Guide
Comparing
258
Delete Text to right
Undo
Generate a report of differences
Generate a comparison summary
Show space characters using tilde (~) characters
Toggle line numbers on or off
Show a thumbnail view of the file. See "Thumbnail view" (page 258) for more
information.
Set file comparison rules. See "File Comparison Rules" (page 258) for more
information.
Display and set options. See "Difference Viewer Options" (page 260) for more
information.
Thumbnail view
This lets you quickly change sections of the file. The thumbnail view (to the left of the
viewing window) is a visual summary of differences. Colored lines show the relative position of
line mismatches. A white rectangle represents the part of the text currently visible in the
Differences Viewer window. You can click the thumbnail view to position the viewer at that
point in the documents.
File Comparison Rules
To access file comparison rules
Click on the differenced viewer toolbar. See "Compare Files and Objects" (page 256)
for more information.
Available Rules
This topic only covers unfamiliar information. It does not include all step and field descriptions.
General Tab
Synchronization Settings Synchronization Settings control the
comparison engine that reports differences and
similarities between files. Unless you are
experienced in manipulating comparison
synchronization algorithms, you will probably
find that the default settings work well enough
for most situations. In general, the following
principles apply:
l Set the synchronization parameters low -
Allows more efficient searches for small
differences.
l Set the synchronization parameters
Toad for Oracle User Guide
Comparing
259
higher - Handle larger files or files with
large differences.
l Initial Match Requirement - The
minimum number of lines that need to
match in order for text synchronization
to occur.
l Skew Tolerance - The number of lines
the Differences Viewer will search
forward or backward when searching for
matches. Smaller numbers improve
performance.
l Suppress Recursion - Refers to the
method used to scan for matches.
Recursion improves the ability to match
up larger as well as smaller sections of
text, but it can take longer.
Minor Differences Use the Ignore Minor Differences check box to
activate or deactivate the highlighting of minor
differences in the Differences Viewer window.
(As explained below, you specify what
constitutes minor differences in the Rules
options under Define Minor Differences.)
Define Minor tab You can have the comparison engine either
highlight or ignore minor differencessuch as
comments, or spacing characters and tabs. This
gives you the option of focusing only on
significant differences, or, alternatively,
reviewing even minor differences between
versions. Place a checkmark next to the items
that you want to classify as minor differences.
Then, under the General category, you can
select or clear the Ignore Minor Differences
check box.
Line Weights tab The Line Weights tab lets you assign
synchronization priorities to the lines that
match. You can use the values listed in the tab,
or you can create your own.
Miscellaneous tab Use the Miscellaneous tab to make choices
about line termination.
You can also limit comparisons to specific
columns by entering a column range in the
comparison boxes.
Toad for Oracle User Guide
Comparing
260
Difference Viewer Options
To access options
Click in the Differences Viewer. See "Compare Files and Objects" (page 256) for more
information.
From this dialog box, you can set the colors and other visual characteristics used to highlight the
following elements in the Differences Viewer:
l Matching text
l Similar text
l Different text
l Missing text
l Horizontal lines between mismatches
You can also set Find Next difference to use position only (so as not to obscure color coding), or
normal line selection.
Comparing Schemas
Compare Schemas
Use this window to compare two schemas and ascertain what has changed from the original
reference source to the comparison source. You can set various options, including choosing
schemas, setting options, and selecting object sets.
An online video tutorial is also available for this feature. This video opens in a new browser
window and requires an internet connection.
Note: You can compare schemas in the base Toad editions, but definition files and sync scripts
are available only in the commercial version of Toad with the optional DB Admin Module.
To compare schemas
1. From the Database menu, select Compare | Compare Schemas.
2. Make your selections on the Schema, Options, and Object Set tabs, and then click
Compare to display the results tabs.
You can also create an Action and then run the comparison later from within Toad or from the
command line. See "Compare Schemas Action" (page 447) for more information.
Compare Schemas - Schemas Tab
After you have opened the Compare Schemas window, select the Reference Source and the
Comparison Source (Target).
Toad for Oracle User Guide
Comparing
261
Radio buttons let you choose either Schema or Definition File.
Option Notes
Reference Schema (Source) The reference source is the source that Toad will use as
the basis for comparison.
Schema If you choose Schema, you must select both a
connection and a schema.
Create Schema Definition File When you create a definition file, you can use variables
in the filename. By default, Toad includes the
%DATEFILE% and %TIMEFILE% variables, which
inserts the current date and time into the filename when
the definition file is created. (This ensures that the date
and time are inserted accurately if you are creating the
definition file from an Action.)
Note: Comparing Definition files is only available in the
commercial version of Toad with the optional DB
Admin Module. See "Generate Schema Script" (page
429) for more information about creating definition files.
Target and Output The targets are the schemas that will be compared to the
reference. If you run a created sync script, these are the
schemas that will be changed. Each target can have a
separate output file.
To add targets, click +.
Toad for Oracle User Guide
Comparing
262
Defining Targets and Output
Option Notes
Target Schema Choose one of the following:
l Connection - If you choose Connection, enter
both a connection and a schema.
l Schema Definition File - Choose definition file to
make a comparison with a saved definition file.
This option is useful if you have an unchanging
schema or you want your various schemas to
conform to a template.
Note: Comparing Definition files is only available in the
commercial version of Toad with the optional DB
Admin Module. See "Generate Schema Script" (page
429) for more information about creating definition files.
Output Output can be created in several ways:
l Auto-Complete output File Names - Toad create
output filenames for you.
l Enter the filenames and paths for output files
manually in the appropriate boxes.
l Select the Email boxes if you want the output
sent by email to the settings specified in the
Email Options page. See "Email Settings" (page
652) for more information.
Switching Comparison and Reference Schemas
Switching comparison and reference schemas is performed within memory, so if you have
previously run a compare, Toad can switch the schemas for you without querying the database
again. Clicking Switch before you have run the comparison will run the comparison.
Changing options requires an additional query, and you will need to click compare again after
making any such changes.
To switch comparison and reference schemas
Select a schema in the Targets and Output area and select Switch with
Reference Schema.
Compare Schemas - Options Tab
On the options tab of the Compare Schemas window check boxes let you select options and
what object types will be compared. You can right-click the options tab to check or uncheck all
Toad for Oracle User Guide
Comparing
263
object types.
The options tab contains an additional three tabs:
Tab Options
Object Types to Compare Select the object types you want to compare. By
limiting what you are comparing, you can speed up a
schema compare.
Object Type Specific Options Use these options to limit how you compare specific
objects.
Misc Options Select how you want to create your script and what you
want to include.
Storage Clause Options Use these options to limit the objects based on storage
clauses.
Compare Schemas - Object Set Tab
You can use the Object Set tab of the Compare Schemas window to select a specific object set to
compare. This lets you limit your comparison even more than the options. You can also specify
an object set and save it for later use.
This topic only covers unfamiliar information. It does not include all step and field descriptions.
To specify an object set
1. In the Schema Compare window, click the Object Set tab.
Select the Specify Object Set check box. Options with special features include:
(Add
object)
If you already have objects loaded, a
confirmation dialog will ask you if you want to
clear the grid before loading the new objects.
Choose Yes to start over, or No to append the
new objects into the grid
Like box If you leave it unchecked, all objects of the
selected type will be loaded.
Auto-check
the grid rows
Use this if you know you want to compare
everything that loads.
Select
view/edit
query
Use the view dialog to check the query and alter
it if necessary.
Toad for Oracle User Guide
Comparing
264
(Save
As)
Save the object set so you can use it later.
Loading a Saved Object Set
If you have saved an object set, you can load it into this window instead of creating a new set.
To load a saved object set
1. From the Database Compare window, click the Object Set tab.
2.
Click the Load Object Set from File button.
3. Select the object set you want to load and click Open.
Compare Schemas - Results
Results of comparing schemas display the changes required to make the second schema look like
the reference schema. Therefore, if you reverse the order of the schemas, there may be differences
in the number of objects reported as "missing."
For example:
Schema A contains 2 tables; one of them has a PK constraint.
Schema B contains 1 table that matches the unconstrained table in A.
l If A is the reference schema, then the migration script would attempt to change B to make
it look like A. In that case, two objects are needed - a table and a constraint.
l But if B is the reference schema, then the migration script would attempt to change A to
make it look like B. In that case, one object needs to be dropped - the table. The
constraint will be dropped automatically with the table.
You can switch the order of the schemas by clicking the Switch button in the
middle of the Compare Schema window.
Results
The tree view details the differences between the schemas in an interactive format.
Each item has a check box. By default, all items are checked. Clearing a checkbox will remove
that item from the main Sync Script. See "Compare Schemas - Sync Script" (page 266) for more
information about sync scripts.
Differences are separated into three main node groups:
Toad for Oracle User Guide
Comparing
265
Icon Meaning
Objects in Comparison Source not in Reference Source
Objects in Reference Source not in Comparison Source
Objects that Differ
Each type of item has an icon assigned to it, making it easy to see at a glance what object it is.
Results Toolbar
The toolbar allows easy access to several formatting options, as well as a print preview screen
and the migration SQL dialog box. These are also available from the right-click menu.
Icon Meaning
Expand all
Expand to First Level
Collapse all
Show Sync Script for selected items.
Show difference details for one selected and supported object type (for
example a table or a directory). See "Viewing File Differences" (page 257) for
more information.
You can save your comparison to a file. You can choose text, html, or rtf file
from the Save As window.
NOTE: When you create a results file, you can use variables in the filename.
Send to Excel.
Display summary view.
Print results.
Group by
Object
Type
Items within groups can be grouped according to type. Each type of item has
an icon assigned to it.
Toad for Oracle User Guide
Comparing
266
Compare Schemas - Sync Script
Note: This Toad feature is only available in the commercial version of Toad with the optional
DB Admin Module.
You can create and execute migration SQL (a sync script) for all of the differences in the
comparison, or only selected objects.
Sync Script tab
The Sync Script tab displays the migration SQL for the entire comparison. Running this SQL
will change everything in the target schema.
Sync Script toolbar
Icon Meaning
Save Sync Script as a text file.
Print the Sync Script.
Load the Sync Script in the Toad Editor. See "Toad Editor" (page 854) for more
information.
Execute the Sync Script immediately.
Caution: Remember that this SQL is designed to change the comparison
schema. Be sure you will not lose any important data before you execute it.
Schedule the Sync Script to run at a later time using Windows Task Scheduler. See
"Task Scheduler" (page 762) for more information.
Sync Script for Selected Objects
You can also display a sync script for one or more selected objects. This does not use the Sync
Script tab.
To show migration SQL (Sync Script)
You can show the migration SQL (Sync Script) for a selected object or objects.
Caution: Remember that this SQL is designed to change the comparison schema. Be sure
you will not lose any important data before you execute it.
Toad for Oracle User Guide
Comparing
267
1. In the Results tab, select the objects by clicking on them. Multi-select by holding down
either CTRL or SHIFT while clicking.
Note: You must select objects individually rather than by node to use this feature.
2. Right-click and select Show Sync Script for selected items. The SQL Statement dialog
box displays the SQL to migrate only the selected items. You can copy this to the
clipboard or save directly to a file.
Scheduling Compare Schemas as a Windows Task
Note: This Toad feature is only available in the commercial version of Toad with the optional
DB Admin Module.
You can schedule a Windows task for comparing schemas. You can also save your settings to a
file and load them at a later time.
Scheduling the Compare
You can add your compare schemas task to the task scheduler.
To schedule a schema compare task
1. Open the Compare Schemas window and set up your options. See "Compare Schemas"
(page 260) for more information.
2.
From the Status bar, click the Schedule button to open the Schedule Task wizard.
Enter the information requested and Click OK.
Saving and Loading Settings
You can save your settings as an action, and then later reload them from the file. This makes it
easier to compare with the same settings in the future.
In addition, if you create an action from your settings, you can later choose to run the Compare
function from the command line. See "Run Compare Schemas from a Command Prompt" (page
842) for more information.
Controlling Sessions
Select Session
Use this dialog box to select a current session to end.
Note: All windows connected to this session will close.
To access Select Session
From the Session menu, select End Connection.
End Connections
You can choose to end connections without closing Toad. You can also use this dialog to
change sessions. See "Select Session" (page 268) for more information.
To end one connection
Select Session | End Connection.
To end several, but not all, connections
1. Select Session | End Connection.
2. Select the connections you want to end.
To end all connections
Select Session | End All Connections.
Test Connections
This command reconnects if Oracle has dropped the session.
To test connections
Select Session | Test Connections (Reconnect)
Configure User Lists
Many databases have hundreds of users, most of which own no database objects and exist only
for secure access to the database. You can remove these unwanted users from the dropdown user
lists on many screens in Toad by using the Oracle Users List window to select users.
10
Toad for Oracle User Guide
Controlling Sessions
269
The Oracle Users List displays a list of all users for the current database connection. You can
select users or groups of users from this window by clicking in the check boxes. Click OK, and
Toad will restrict all dropdown user lists to the users you have selected.
The user list is stored in an ASCII file, SCHEMA_DATABASE.LST, where SCHEMA is the
schema in use, and DATABASE is the current database alias.
There is another option to only show users that own objects in the database. See "Schema
Browser - Data" (page 674) for more information.
To access configure user lists
Select Session | Oracle Users Lists.
Session Information
This general-purpose utility window displays information about the current Oracle user as well
as information on the Oracle connection itself.
This window displays:
l Session Rights for the current user
l Roles assigned to the current user
l Access assigned by roles to the current user
l Version information for the core Oracle processes
l The registry settings for Oracle
To view session info
Select the Session | Session Info menu item.
Toad for Oracle User Guide
Controlling Sessions
270
Change Password
To change your password for the active Oracle schema
1. Select Session | Change Password.
2. Your old password is entered, but displays only asterisks for security purposes. Enter your
new password in the New Password field.
3. Enter it again in the Verify Password field.
4. Click Execute.
Commit & Rollback
You can commit or rollback recent changes to the database from the Session menu at any time
while working with Toad. In addition, there are options to either auto-commit or to prompt to
commit on exit
To commit your changes
l Select Session | Commit.
To rollback your changes
l Select Session | Rollback.
Transaction Processing with Auto-commit
You can configure Toad to either Auto Commit or prompt to commit on exit when Auto Commit
is disabled. See "Oracle - Transactions" (page 669) for more information.
When enabled, Toad will check for the current user's access to DBMS_TRANSACTION. If the
user has access, Toad can determine whether there are actual transactions pending and prompt
on exit only when necessary. If the user does not have access, the other "Prompt on exit"
options are followed.
Toad for Oracle User Guide
Controlling Sessions
271
Checking for system views is optional because of the additional time required at Login
time to check for access. You may prefer to commit manually when needed and not have
Toad prompt you.
Connect and Disconnect
Use the connect and disconnect menu items to easily choose to connect or disconnect from a
previously-used schema. The schema must be listed in your connection list. See "Server Login
Window" (page 177) for more information.
To connect to a schema
From the Session menu, select Connect |schema you want to connect.
To disconnect from a schema
From the Session menu, select Disconnect | schema you want to disconnect.
DBMS_Flashback
Note: This Toad feature is only available in the commercial version of Toad with the optional
DB Admin Module.
Using Oracle's DBMS_FLASHBACK, you can revert to a version of the database at a specified
wall-clock time or a specified system change number (SCN). When enabled, the user session uses
the Flashback version of the database, and applications execute against the Flashback version of
the database.
You can use the DBMS_FLASHBACK functionality to restore data to your sessions. You may
want to use DBMS_FLASHBACK for the following reasons:
l Self-service repair. If you accidentally delete rows from a table, you can recover the
deleted rows.
l Packaged applications such as email and voicemail. You can use Flashback to restore
deleted e-mail by re-inserting the deleted message into the current message box.
l Decision support system (DSS) and online analytical processing (OLAP) applications.
You can perform data analysis or data modeling to track seasonal demand, for example.
DBMS_FLASHBACK is turned off automatically when the session ends, whether by
disconnection or by starting another connection.
Requirements
l You must have EXECUTE privileges for DBMS_FLASHBACK.
l This Toad feature is only available in commercial versions of Toad with the DB
Admin Module.
Toad for Oracle User Guide
Controlling Sessions
272
Using Wall-Clock time
When enabling Flashback using a wall-clock time, the database chooses an SCN that was
generated within five minutes of the time specified.
Using an SCN
You can enable an SCN for finer control of the flashback. An SCN identifies the exact version of
the database, and therefor allows you to specify the exact moment you want to flashback.
Using Flashback
PL/SQL cursors opened in Flashback mode return rows as of the flashback time or SCN, letting
you recover data. These cursors will remain open when you disable the Flashback session so that
you can transfer the data to the current session.
Different concurrent sessions (connections) in the database can perform Flashback to different
wall-clock times or SCNs.
DML and DDL operations and distributed operations are not allowed while a session is running
in Flashback mode.
You can use PL/SQL cursors opened before disabling Flashback to perform DML.
Note: In a Flashback-enabled session, SYSDATE will not be affected; it will continue to provide
the current time.
Additional information about DBMS_FLASHBACK, please see your Oracle documentation.
To use Toad's Flashback functionality
1. From the Session menu, select DBMS Flashback.
2.
If necessary, change the session for the window by selecting the active session .
3.
Click .
4. Select either:
l >Enable at Timestamp
l Enable at System Change Number
5. Enter the timestamp or SCN in the appropriate box.
6. Click OK.
Diagnosing Problems
View Extents
To view extents
1. From the Database menu, select Diagnose | Extents.
2. Select the desired Object Type: All Objects, Tables, Indexes, Rollback, or Cluster.
3.
Click to fetch results.
To see extents for objects owned by SYS
Select SYS from the Owner list.
Note: If you have access to the DBA_views, make sure the View | Toad Options |
Startup | Check for DBA Views check box is checked. If it is checked, the Owner
dropdown list will become active, and a DBA user can select a specific schema
owner. Click GO to fetch the results.
Identify Space Deficits
Note: This Toad feature is only available in the commercial version of Toad with the optional
DB Admin Module.
You get to this window from Database | Diagnose | Identify Space Deficits.
This displays tables that do not have enough free disk space to allocate their next extent.
Select tablespaces and act upon them:
Option For more Information
Alter Tablespace See "Create and Alter Tablespace" (page 1085) for more
information.
Rebuild See "Rebuild Multiple Objects Overview" (page 612) for more
information.
Alter Table See "Altering Tables" (page 1074) for more information.
11
Toad for Oracle User Guide
Diagnosing Problems
274
Log Switch Frequency Map
Note: This Toad feature is only available in the commercial version of Toad with the optional
DB Admin Module.
This screen displays log switch records. Many DBAs try to size their redo logs so that there are
few log switches per hour. Frequent log switches can drastically decrease performance, and
infrequent log switches can increase database startup times. Use this window to judge the
balance of log switches.
An online video tutorial is also available for this feature. This video opens in a new browser
window and requires an internet connection.
To access the Log Switch Frequency Map
From the Database menu, select Diagnose | Log Switch Frequency Map.
The database schema for the active connection is shown in the grid.
Note: Log switches in each hour of the day begin with Midnight to 1:00 a.m. A cell is left
empty if there were no log switches during that hour, and days with no log switches do not
appear in the grid at all. Every log switch that is recorded in the control file for the database
is displayed.
To see log switch details
Double-click in any cell for details:
l Hour column - Just the selected hour.
l Date, day or total column - Details for the entire day.
To export the grid
Right-click and choose Save As from the menu. See "Export Dataset" (page 390) for more
information.
Tablespace Map
Note: This Toad feature is only available in the commercial version of Toad with the optional
DB Admin Module.
Access this window from Database | Diagnose | Tablespace Map on the menu.
This map provides a graphic view of how space is allocated to objects in the tablespaces in your
database. This lets you view Segment Fragmentation by tablespace.
As you move the pointer over cells in the map, Toad displays the segments that consume data
blocks represented by that cell. However, if this is a large tablespace that cell might represent
hundreds of actual data blocks. Thus they may not overlap at all. Keep in mind that red cells
Toad for Oracle User Guide
Diagnosing Problems
275
really represent segments that consume a high percentage of blocks for their overall size. Thus
they may be candidates for object rebuilds.
To view tablespace graphically
1. Select a tablespace.
Click to fetch the data for the map.
Green Areas used by selected Tablespace
Red Areas that equal or exceed fragmentation limits (set in
View | Toad Options | DBA).
Note: Toad measures Internal Fragmentation, a measure
of the fragmentation of the object within the tablespace.
The actual SQL Toad uses to measure this can be found
in the Toad FAQ, under the question "How does the
Tablespace Map Work?"
To coalesce a fragmented chart
1. Select a tablespace.
2.
Click to coalesce and analyze the tablespace.
To view segments and extents
1. Click either the Segments or Extents tab.
View details for segments and extents as follows:
Hover the
pointer over the
tablespace map.
Segments display beside the pointer.
Click in a grid
cell
All segments containing those in the clicked
cell display in yellow.
Click
Now when you hover the pointer, details
display in the Segments dialog, along with
percentage of fragmentation.
To filter the tablespace map
1. Select a tablespace.
2.
Click to fetch the data. Cells representing occupied blocks are highlighted in green.
Click . Filters are arranged in categories:
Toad for Oracle User Guide
Diagnosing Problems
276
Note: Selected filters are cumulative, whether on the same tab or on multiple tabs. They
remain in effect until you clear them.
3. Select the filters you want to see.
4. You can select multiple filters by holding down CTRL while selecting.
5. You can also select filters on multiple tabs. The spaces covered by thefilters you choose
turn yellow on the Tablespace map.
To clear highlighting from View settings and Filters
Click .
To restore window size
Click .
To Display Tablespace Legend
Click .
Quest Space Manager
Space Manager can only be launched if you have it installed and licensed.
To launch space manager
On the Tablespace Map toolbar, click .
TKProf Interface Wizard
The TKProf Interface wizard lets you easily use the TKPROF feature of Oracle, creating the
necessary scripts to set parameters and options. For details about parameters and options, see your
Oracle documentation.
This topic only covers unfamiliar information. It does not include all step and field descriptions.
To use this wizard
1. Select Database | Diagnose | TKProf Interface.
Enter the parameters and options in appropriate fields. Review the following for
additional information:
Some Helpful information This section displays Ora.ini
parameter information. In order to
see this information you will need
select privileges on v_$parameter.
Define Input and Output Description
Toad for Oracle User Guide
Diagnosing Problems
277
Files
Input Files These are the trace files that were
produced by Oracle when you
enabled tracing. Oracle places them
in the directory specified by the
script USER_DUMP_DEST, also
known as the "udump directory".
Add Input files Click the drilldown button beside
Files at the top right of the Input
Files field.
l Browse Windows files -
select a file from a Windows
OS.
l Open files with FTP - this
lets you select files on a
UNIX based server.
l UNIX File name Browse (no
file transfer) - This lets you
select files on a UNIX server
without transferring them. If
you want to run TKProf
against trace files that are
still on the server, you will
need to copy the code and
run it server side. See
"TKProf Interface Wizard"
(page 276) for more
information.
Output File Extension The output files are placed in the
same directory as the input files. The
filenames are the same, but the
extension is different. You can
change the extension if necessary.
Insert File Extension Inserts the results of the trace file
into a database table
Record Files The record file is a script produced
by TKPROF. It records the SQL
statements issued by the traced
session
Sort Options Description
Sort Options You can choose more than one sort
option, and sort results are
cumulative from the top of the list to
the bottom.
Other Options Description
Toad for Oracle User Guide
Diagnosing Problems
278
Use this table for Explain
Plan
You must also choose Connect to
DB to perform Explain Plan to use
this option.
Execution Options Description
Execute Locally Use the instance of TKPROF located
on your computer. If you do not
connect to the database to perform
explain plans, you can copy files
from any Oracle database of the
same or earlier version to your
machine to run TKPROF.
This works as file parsing, with no
database activity. Define where your
TKPROF is located in Toad Options
| Executables. See "Executables"
(page 654) for more information.
View Output Files When
Finished
Output files open in your external
editor.
Just copy the commands
to the clipboard
Copies all generated commands into
the clipboard. You might use this
option if you run TKPROF on a
Unix machine by telnet. Toads
TKPROF interface lets you just
paste the code in, saving you the
time spent typing.
Note: If you have not selected at least one input file, clicking finish
will do nothing. If you have selected all pertinent options and click
Finish, a confirmation dialog box appears.
2. Complete the wizard.
Undo Advisor
Undo Advisor (OEM) Overview
Note: This Toad feature is only available in the commercial version of Toad with the optional
DB Admin Module.
The Undo Advisor in Oracle versions 10g and above provides advice and helps to automate the
establishment of the database undo environment.
Note:By default, unless you have instructed Toad to make this window accessible, this
functionality is disabled. You can restore functionality from View|ToadOptions|Windows and
clicking the Available checkbox in the appropriate row of the grid.
To access the Undo Advisor
From the Database menu, select Diagnose | Undo Advisor.
Toad for Oracle User Guide
Diagnosing Problems
279
Use the advisor to analyze the health of the current undo configuration, either overall or within a
given time range. From this baseline, you can then:
l Alter the Undo tablespace
l Switch to another Undo tablespace
l Adjust the database's retention time
l Create projections of required undo space given a retention time that you define
The Undo Advisor Toolbar
The Undo Advisor toolbar provides an easy way for you to alter undo tablespaces, and
manipulate the undo environment.
Button Command
Alter current undo tablespace
Alter undo retention
Switch current tablespace
Refresh date in screen
Altering the Undo Tablespace
Note: This Toad feature is only available in the commercial version of Toad with the optional
DB Admin Module.
The Undo Advisor lets you alter the current Undo Tablespace. You can change some of the basic
information options, and also add, edit or remove data files.
This topic only covers unfamiliar information. It does not include all step and field descriptions.
To alter the undo tablespace
1. Confirm that the current tablespace is the one you want to alter. If not, switch to the
correct tablespace before continuing. See "Switching Tablespaces" (page 280) for more
information.
2.
On the Undo Advisor toolbar, click .
Toad for Oracle User Guide
Diagnosing Problems
280
Altering Undo Retention
Note: This Toad feature is only available in the commercial version of Toad with the optional
DB Admin Module.
Altering the undo retrention time frame may require additional tablespace. Because of this, Toad
also provides an estimate of required tablespace so that you can gauge what to add. See "Undo
Advisor (OEM) Overview" (page 278) for more information
This topic only covers unfamiliar information. It does not include all step and field descriptions.
To estimate required tablespace
Enter the desired retention in the For this amount of retention box.
Note: The required undo size for the selected options is displayed beneath it.
To alter the undo retention
1.
Click .
2. Enter the desired retention in the box.
Switching Tablespaces
Note: This Toad feature is only available in the commercial version of Toad with the optional
DB Admin Module.
If you have multiple undo tablespaces, you can switch between them from the Undo Advisor.
See "Undo Advisor (OEM) Overview" (page 278) for more information.
To switch between tablespaces
From the Undo Advisor, click and select a tablespace.
Segment Advisor
Segment Advisor (OEM)
Note: This Toad feature is only available in the commercial version of Toad with the optional
DB Admin Module.
Active with Oracle 10g and above, this screen is an interface to Oracle's segment advisor. It can
examine tables, indexes, and partitions to determine if and how much, space can be reclaimed in
them with the SHRINK command.
Toad for Oracle User Guide
Diagnosing Problems
281
Note:By default, unless you have instructed Toad to make this window accessible, this
functionality is disabled. You can restore functionality from View|ToadOptions|Windows and
clicking the Available checkbox in the appropriate row of the grid.
To Access Segment Advisor
From the Database menu, select Diagnose | Segment Advisor.
The Segment Advisor generates advice at three levels:
Object Level Advice is generated for the entire object, such
as a table. If the object is partitioned, then the
advice is generated on all the partitions of the
object. Advice does not cascade to dependent
objects such as indexes, LOB segments, and so
forth.
Segment Level Advice is generated for a single segment, such
as unpartitioned table, a partition or
subpartition of a partitioned table, or an index
or LOB column.
Tablespace Level Advice is generated for every segment in the
tablespace.
Examining Objects
Note: This Toad feature is only available in the commercial version of Toad with the optional
DB Admin Module.
The heart of the Segment Advisor is its ability to examine objects and give recommendations.
See "Segment Advisor (OEM)" (page 280) for more information. You can view objects by owner,
object type, or tablespace and then select objects to be examined.
To examine objects
1. From the Database menu, select Diagnose | Segment Advisor.
2. Click the Examine Objects tab.
3. Select a schema from the Object Owner drop down menu.
4. Select an object type.
5. From the Tablespace dropdown, select a tablespace (or All tablespaces).
6. In the grid, select the objects you want to submit for advice in the grid.
7.
Click .
8. Select Segment Advisor options.
Toad for Oracle User Guide
Diagnosing Problems
282
9. Click Execute.
10. Enter connection information if necessary, and click Connect.
Advisor Tasks
Note: This Toad feature is only available in the commercial version of Toad with the optional
DB Admin Module.
When you have examined objects, you can view or delete the tasks run by the Segment Advisor.
See "Segment Advisor (OEM)" (page 280) for more information.
To review tasks
Click the Advisor Tasks tab.
To delete tasks
1. Click the Advisor Tasks tab.
2. In the data grid, select the tasks you want to delete.
3.
Click .
4. Click Yes to confirm.
5. Enter connection information if necessary and click Connect.
Advisor Recommendations
Note: This Toad feature is only available in the commercial version of Toad with the optional
DB Admin Module.
Advisor recommendations is the output of a Segment Advisor task. See "Segment Advisor
(OEM)" (page 280) for more information about creating tasks. Toad sorts recommendations into
an easy-to-read grid format.
You can choose to display either only the tasks you have created, or only tasks entered
through Toad.
Recommendation Toolbar
Button Command
Show recommendation script
Execute recommendation script
Toad for Oracle User Guide
Diagnosing Problems
283
Button Command
Schedule Script Execution
Set Status (Accept, Ignore, Implemented, Reject)
Delete selected tasks
Refresh Grid
To act on recommendations
1. Select the recommendation you want to use.
2. Click on one of the toolbar buttons.
3. Complete any required steps.
LogMiner Interface
LogMiner Overview
Note: This Toad feature is only available in the commercial version of Toad with the optional
DB Admin Module.
The Oracle LogMiner packages DBMS_LGMNR and DBMS_LOGMNR_D help you extract
information from the online or archived Oracle redo logs. This information can be used to
analyze where problems occurred. With LogMiner, if a System Change Number (SCN) caused a
corruption problem, you can analyze the database and recover to the transaction exactly before
the corruption.
This package is only available in Oracle 8i and above.
To access the LogMiner Interface
From the Database menu, select Diagnose | LogMiner.
See "Logminer Wizard" (page 284) for more information about the wizard itself.
Requirements
Before Toad starts LogMiner, it checks whether all of the requirements for using the LogMiner
have been satisfied. These include:
l Execute privileges on DBMS_LOGMNR
l Execute privileges on DBMS_LOGMNR_D
l Select privileges on V$LOGMNR_CONTENTS
Toad for Oracle User Guide
Diagnosing Problems
284
l Select privileges on V$LOGMNR_LOGS
l Parameter UTL_FILE_DIR set in init.ora (required for Oracle 8i only)
If any of these parameters are not met, Toad will display a screen listing them, with the missing
requirement displayed in red.
Troubleshooting
l Access to some V$ tables are required to use this option. See "Database | Diagnose |
LogMiner" (page 156) for more information about required tables for LogMiner.
l If you cannot access V$PARAMETER, V$LOGFILE, V$SESSION, V$VERSION, the
screen will still work, but will not do some things automatically for you (such as tell you
if utl_file is not set up, automatically determine where your log files are stored, or so on).
l If you cannot access things that are actually required (like execute privs on dbms_logmnr)
the screen will tell you what is required, and the permissions you are missing will be
highlighted.
Logminer Wizard
Note: This Toad feature is only available in the commercial version of Toad with the optional
DB Admin Module.
This topic only covers unfamiliar information. It does not include all step and field descriptions.
To use the Logminer wizard
1. From the Database menu, select Diagnose | LogMiner.
2. Review the following for additional information:
Dictionary You can choose to use DBMS_LOGMNR_D.BUILD to
create a new dictionary file, or you can specify the location
of an existing file.
This window saves its settings. If you enter a path and
filename, then close the wizard; the path and filename will
still be filled in when you reopen the window. Options vary
depending on what version of Oracle you are using:
Oracle 8i
l Verify UTL_FILE Parameter - This box displays the
value of the UTL_FILE_DIR.
If it is incorrect, you will need to edit your init.ora file and
then shut down and restart the database to make the
parameter change take effect.
l Dictionary File Name and Path - Enter the file name
and directory path of the dictionary. Whether you
build a new file or use an existing one, these paths
Toad for Oracle User Guide
Diagnosing Problems
285
must be entered.
The dictionary file path must be a path accessible by the
database server, and accessible by UTL_FILE.
Oracle 9i & up
Dictionary
l Use Online Data Dictionary - This option is the
fastest, because there is no file building required.
l Use Dictionary in Redo Logs - This option activates
the next area, "Next" button action, letting you
choose to build a new dictionary or use an existing
dictionary.
Files to Mine Click Find Files.
l From the dropdown, select Select from Online redo
logs to open the browse dialog box in the redo log
directory. If you have a network drive mapped to the
server, the browse dialog box will show the redo log
directory; otherwise it will show the last browsed
directory you browsed.
l From the dropdown, select Select from Archive
Logs to open the browse dialog box in the archive
log directory. If you have a network drive mapped to
the server, the browse dialog box shows the archive
log directory; otherwise it shows the last browsed
directory you browsed.
l If your database is on a UNIX server, use the FTP-
style dialog box.
l If you are running Oracle 9i and have written a
dictionary to the redo logs, be sure to include the
redo log containing the dictionary in your file
selection.
Note: If your database is running on a Windows server (but
not your local PC) it is important to make sure that the drive
letters appear as they do on the server when selecting files.
For example, if the Browse window adds this file to your
file list:
\\Car004555\d$\oracle\oradata\CARY9I\REDO01A.LOG
You may want to change it to this:
D:\oracle\oradata\CARY9I\REDO01A.LOG
You can edit directly in the files list window.
3. Complete the wizard.
4. View results in the Logminer Interface grid.
Toad for Oracle User Guide
Diagnosing Problems
286
LogMiner Interface Grid
Note: This Toad feature is only available in the commercial version of Toad with the optional
DB Admin Module.
To view results in the LogMiner interface grid
1.
Click on the toolbar.
2. Select the columns you want displayed.
3. Do one of the following:
Execute the LogMiner SQL
immediately
Click .
Note: This can take some time,
depending on the size of the
LogMiner files.
Copy the SQL into the Editor
to edit, save and execute later
Click
4. Right-click the grid to:
Print Grid Open the Print dialog, where
you can format and print the
grid contents. See "Printing"
(page 705) for more
information.
Save as Export the grids contents to a
file or to the clipboard.
Filter Filter the information retrieved
into a format more suited to
your needs. You can set
Boolean filter conditions and
Apply them to the grid. Click
Cancel or close the dialog box
to continue. The filter remains
on the grid until you open the
filter dialog box and click
Clear.
In the Editor
Alternatively, you can leave this window open and open a Editor window to view your results.
You may need to do this if you want to specify a where clause so you can retrieve a more
Toad for Oracle User Guide
Diagnosing Problems
287
focused dataset from v$logmnr_contents.
To view results in the Editor
1. Leave the Logminer window open and open an Editor window.
2. In the Editor, SELECT data from v$logmnr_contents. This data is only available from
your current session in the database. It will be cleared when you close the LogMiner
interface window or click Back.
Health Check
DB Health Check
Note: This Toad feature is only available in the commercial version of Toad with the optional
DB Admin Module.
The DB Health Check performs a series of checks on a selected database and displays the results.
You can save the results to a color-coded RTF or HTML file, or to a plain text file. You can also
send the results through email in any of these formats.
An online video tutorial is also available for this feature. This video opens in a new browser
window and requires an internet connection.
Health checks utilize optimizer hints as configured in Toad Options | Oracle | Optimizer Hints.
See "Oracle - General" (page 664) for more information.
Health checks require access to the DBA_views and to some of the V$ views. See "V$ Tables
Required" (page 153) for more information.
Note: The DB Health Check opens a separate connection to Oracle, and then closes it after the
check, even if Toad already has a connection open to the selected database. This connection will
show in the Session Browser as a separate session, and could cause difficulties if you have
limited Toad connections.
To run a health check
1. From the Database menu, select Diagnose | DB Health Check.
2. In the left pane, select the databases you want to check.
3. In the Checks and Options tab on the right side of the window, select pre-defined health
checks. See "DB Health Check - Checks and Options" (page 288) for more information.
4. If you want to email the results, make appropriate settings to the Email Settings tab. See
"DB Health Check - Email Results" (page 311) for more information.
5.
When all your options have been set, click on the toolbar.
6. View results on the Report Output tab. See "DB Health Check - Saving Results" (page
311) for more information.
Toad for Oracle User Guide
Diagnosing Problems
288
Scheduling Health Check to run later
To save your settings as an action from the DB Health Check window
Note: See "Managing Projects" (page 433) for more information about ToadApps and Actions.
1. Create your health check as described above in steps 1 through 4.
2.
Click in the status bar at the bottom of the window.
3. Select Create, select the ToadApp where you want it to reside, and give it a name.
4. Click OK.
To create a DB Healthcheck Action from the Automation Designer
1. From the Automation Designer window, select the app you want to contain the
health check.
2.
Click the DB Misc tab, click and then click in the app.
3. Double-click on the action icon and set properties as described inDB Health Check
(page 287).
4. Click Apply, then Cancel to save your settings and close the window.
To schedule your health check
l From the command line: See "Running Actions from the Command Line" (page 835) for
more information about how to schedule or run your health check.
l As a Windows Task: See "Using the Automation Designer to Schedule Actions and
Apps." (page 435) for more information.
DB Health Check - Checks and Options
Note: This Toad feature is only available in the commercial version of Toad with the optional
DB Admin Module.
In the Checks and Options tab of the Health Check window, you can set many different pre-set
conditions. Each of these preset checks represents something that a DBA or Developer should be
aware of in their databases. In addition, some of these conditions are adjustable.
Finding Specific Checks
There are many checks that you can run on your database. Although checks are grouped by
settings, database, and schema checks, you may find that it is difficult to locate every check you
want to make just by looking down the list. Toad provides a search feature that will highlight
the checks that meet your specified criteria.
To search for a specific health check
In the Filter: box, enter the word you want to search for.
Toad for Oracle User Guide
Diagnosing Problems
289
Note: Toad searches for entries as they are typed. You can enter entire words,
multiple or portions of words. For example, you entering data will find checks
containing data, datafile, datatype, and so on. However, if you are using multiple
words, Toad sees everything you enter as one word. Therefore, Toad will only find
the words that are in the order you enter. For example, if you are looking for the
check containing "datafile IO distribution," entering "IO datafile" will not find the
check you want. You must enter "datafile IO."
Adjusting Conditions in Checks
Some of the conditions described in Check Descriptions are adjustable.
To change parameters
1. In the Parameters column, click params.
2. Change the condition and click OK.
Dropping Synonyms
Health check items listing synonyms pointing to nonexistent objects can be dropped using the
script provided within the report. The synonyms will be listed, and a script provided.
DB Health Check - Check Descriptions
Note: This Toad feature is only available in the commercial version of Toad with the optional
DB Admin Module.
The following is a list of checks that the DB Health Check can perform, separated by category. (
See "DB Health Check" (page 287) for more information.)
l Settings tab (page 290)
l Checks tab
l Configuration (page 293)
l Performance (page 297)
l Alert Log (page 299)
l Storage (page 300)
l Schema (page 302)
l Vulnerability Assessment (page 307)
Note: Actions performed on jobs are not viewable to other connections until they are committed.
This means that when it is run the DB Health Check will not catch actions that have been
performed, but not committed.
Toad for Oracle User Guide
Diagnosing Problems
290
Settings tab
Note: Check numbers are for reference only, and may change between releases of Toad. Items
that refer to "item numbers" refer to the check number within the active Toad release.
Check
Number
Check Name Description
1 Show output only for bad conditions If this option is checked,
Toad displays only items
that fail the health check.
If your databases are
generally in good
working order, this can
shorten your reports
dramatically.
2 Suppress header for a database when the report is
empty
If this option is checked,
and your health check ran
on several databases in
one report, then only the
databases that failed the
health check will appear
in the report. While this
can shorten your reports
dramatically, you will not
have a record of the
databases that pass all
aspects of the health
check.
3 Include user comments at top of the report output
4 For items 72, 73, and 74, exclude objects in
"SYSTEM" tablespaces
This option applies to:
l List tablespaces
that are more
than 30%
fragmented,
having more than
50 total extents
l List tablespaces
with less than
10% free space
remaining.
l List segments
that cant extend
because there is
Toad for Oracle User Guide
Diagnosing Problems
291
Check
Number
Check Name Description
not enough room
in the tablespace.
5 Play a custom script at the end of the health
check
This option executes a
user-supplied script at the
end of the health check.
The script output is
included in health check
report.
The file name for the
script to play is
adjustable.
6 Store results in table TOAD.TOAD_HEALTH_
CHECK in database being checked
Use this option to
populate results into a
table on each database
being checked, or results
of all health checks into a
single table in a
repository database. Use
the adjust option to
specify one database, or
many.
If the table specified does
not exist, Toad will
attempt to create it when
the health check runs.
7 Save results to file: This option automatically
saves health check results
to a file at the end of the
health check.
The file name is
adjustable, and the type
of file is determined by
the file extension you
specify.
l If file extension
is "HTM", the
file will be
HTML format.
l If the file
extension is
Toad for Oracle User Guide
Diagnosing Problems
292
Check
Number
Check Name Description
"RTF", the file
will be a rich-
text format.
l All other file
extensions will
result in a non-
color coded
ASCII text file.
8 Archive results for differences report
9 Save differences report to file: This option saves your
differences report to the
file specified. Clicking
Params lets you change
the path to the file
location, and the
filename.
10 Always send results by email as HTML When selected , this
option sets when Toad
emails results, and the file
format of those results.
Click params to change
when and how results are
sent.
Toad for Oracle User Guide
Diagnosing Problems
293
Checks Tab
Check
Number
Check Name Description
Configuration
11 List default initialization parameters
12 List non-default deprecated initialization parameters.
(10g+)
13 Verify compatible matches version major.minor
14 Verify optimizer_features_enable matches version
major.minor
15 Verify optimizer_index_caching >= 50 (9i+) You can set the value
that caching should be
greater than or equal
to.
16 Verify opitmizer_index_cost_adj >=50 (9i+) When selected, Toad
will verify that the
optimizer index cost
adjustment is greater
than or equal to the
value you specify.
17 List incompatible parameters if pga_aggregate_target
(10g) or memory_target (11g) is set.
Lists the following
parameters if pga_
aggregate_target is set
in 10g, or if memory_
target is set in 11g:
l bitmap_merge_
area_size
l create_bitmap_
area_size
l hash_area_size
l sort_area_
retained_size
l sort_area_size
18 Verify pga_aggregate_target >=10MB (10g only) On a 10g database,
verify the pga_
aggregate_target
value.
Toad for Oracle User Guide
Diagnosing Problems
294
Check
Number
Check Name Description
19 Verify control file count >=2 Verify that the control
file count is greater
than or equal to the
value you set.
20 Verify CPUcount - 0 (let Oracle determine the
value)
21 Verify cursor_sharing='SIMILAR' (9i+)
22 Verify cursor_space_for_time='TRUE' (pre 11g) This option is only
valid on pre-11g
databases.
23 Verify db_cache_size set instead of db_block_buffers
(9i+)
24 Verify Buffer Cache >=200MB Verify that the buffer
cache is set to greater
than or equal to the
value you set.
25 Verify Large Pool >=50MB Verify that the Large
Pool is set to greater
than or equal to the
value you set.
26 Verify objects using KEEP buffer pool exist if db_
keep_cache_size is set.
If db_keep_cache_size
parmaeter is set, make
sure there are objects
that actually use it.
27 Verify db_keep_cache_size>=50 MB if objects exist
within the KEEP buffer pool
If objects do not exist
within the KEEP
buffer pool, then this
test is ignored. The
value of the KEEP
buffer pool size is
adjustable.
28 Verify objects using RECYCLE buffer pool exist if
db_recycle_cache_size is set
If db_recycle_cache_
size parmaeter is set,
make sure there are
objects that actually
use it.
Toad for Oracle User Guide
Diagnosing Problems
295
Check
Number
Check Name Description
29 Verify db_recycle_cache_size>=50MB if objects
exist which use RECYCLE buffer pool
If objects do not exist
within the RECYCLE
buffer pool, then this
test is ignored. The
value of the
RECYCLEbuffer pool
size is adjustable.
30 List db_nk_cache_sizes without correspoinding
tablespaces (9i+)
If a db_nk_cache_size
does not have a
corresponding
tablespace, then it will
be listed in the report.
31 List tablespaces without corresponding db_nk_
cache_sizes(9i+)
If a tablespace does
not have a
corresponding db_nk_
cache_size, then it
will be listed in the
report.
32 Verify db_block_size<=4K for RAC, >=4K for non-
RAC
Database block size
should be set
according to type of
database. Values are
not adjustable.
33 Verify multiblock_read_count between 4 and 16 Values are not
adjustable.
34 Verify disk_asynch_io is TRUE (Pre-11g)
35 Verify compatibility of db_writer_processes and
dbwr_slaves with disk_asynch_io setting
If disk_asynch_io is
true, verify that dbwr_
slaves is 0, and db_
writer_processes >=
2.
If disk_asynch_io is
false, verify dbwr_io_
slaves >= 2, and db_
writer_processes = 1.
36 Verify dml_locks=0 or >=transactions *4 DMLlocks should be
either equal to zero, or
greater than or equal
Toad for Oracle User Guide
Diagnosing Problems
296
Check
Number
Check Name Description
to four times the
number of
transactions. These
amounts are not
adjustable.
37 Verify filesystemio_options='SETALL'
38 Verify fast_start_mttr_target is set when log_
checkpoint_timeout=0 (9i+)
39 Verify max_dump_file_size <=20MB The size of the dump
file is adjustable.
40 Verify open_cursors >=50 The number of open
cursors is adjustable.
41 Verify query_rewrite_enabled = TRUE (9i+)
42 Verify recyclebin='OFF' (10g+) On Oracle versions
that have recycle bin
capability, you can
verify that the
capability is on or off.
The choice of ONor
OFFis adjustable.
43 Verify remote_login_password_file='SHARED'
44 Verify session_cached_cursors >=20 The number of cursors
you want to check is
adjustable.
45 Verify sga_target >=200MB and sga_max_size same
value (10g+)
The value is
adjustable.
46 Verify star_transformation_enabled=TRUE
47 Verify sql_trace = FALSE (Pre 11g)
48 Verify timed_os_statistics = FALSE
49 Verify timed_statistics = FALSE
50 Verify trace_enabled = FALSE (9i+)
51 List DB Links which are inaccessible This option displays
Toad for Oracle User Guide
Diagnosing Problems
297
Check
Number
Check Name Description
any DB links that
cannot be accessed,
for whatever reason.
Some (but not all)
possible reasons a link
cannot be accessed
are:
l The linked
database is
down
l The linked
database is
accessible
through the
network
l That the link is
no longer
valid
52 Check redo log sizes and quantities (min. groups: 3;
min. members per group: 2)
Checks for a minimum
number of log groups,
and that each group
has the same size
members.
53 Verify SYS.AUD$ isn't in SYSTEM tablespace Checks that
SYS.AUD$ isn't
located in the
SYSTEM tablespace.
54 Verify AWR collection interval >=30 minutes,
retention <=90 days (10g and newer)
In Oracle 10g or
newer databases,
checks that AWR
collections are set to
perform at more than
30 minute intervals,
and that they are
retained for less than
90 days. Both of these
values are adjustable.
Performance
55 List connect time, version info, and a few basic ratios If this option is
Toad for Oracle User Guide
Diagnosing Problems
298
Check
Number
Check Name Description
checked, the Health
Check report lists the
following:
l the time it took
Toad to
connect to this
database
l database
version
l how long the
database has
been up
l buffer cache hit
ratio
l library cache
miss ratio
l dictionary
cache miss
ratio
56 List SGA usage stats If this option is
checked, the report
lists SGA total size in
MB, amount used,
amount unused, and
percent usage.
57 List archive log info This option controls
display of the
following in the
Health Check Report:
l archiving is
turned on or
not
l average log
switches per
day
l the predicted
amount of disk
space necessary
to store a days
Toad for Oracle User Guide
Diagnosing Problems
299
Check
Number
Check Name Description
worth of
archive logs.
58 List datafile IO distribution Lists all datafiles and
their tablespaces, and
the percentage of the
total reads and writes
from the database for
each datafile.
If your datafiles are on
different disks, this
can show you if you
have them properly
distributed across your
disks. It can also help
you determine if your
objects are properly
distributed across your
tablespaces.
59 List rollback segments with a wait ratio > 1% If the wait ratio is
above the selected
percentage, the
rollback segment is
included on the report.
This percentage is
adjustable.
60 List analyzed SYS and SYSTEM Objects (Pre 10g) This option lists all
SYS and SYSTEM
objects that you have
analyzed.
61 List unanalyzed SYS and SYSTEM Objects (10g+) This option lists all
SYS and SYSTEM
objects that you have
not yet analyzed.
62 Verify sequence sys.audses$ has sufficient cache for
high login rates
Checks that
SYS.AUDSES$ has
enough cache to
handle a high login
rate.
Alert Log
Toad for Oracle User Guide
Diagnosing Problems
300
Check
Number
Check Name Description
63 Alert.Log - check for Ora-600 errors (all alertlog
items require UTL_FILE access)
This shows each error
and the three previous
lines.
64 Alert.Log - list trace files with errors Parses the alert.log
file, and lists lines that
start with "Error in
file." Double-click the
entry in the results to
display the trace file.
65 Alert.Log - show summary This displays a count
of all the 600 errors,
checkpoint not
complete messages,
database startups,
count of each ORA
error found in the file,
and a count of new
trace files reported.
66 Alert.log - Mark file so next Toad Health check
against it examines only new items
Places a bookmark
record in the alert.log
file so that the next
time you run a Health
Check against it, Toad
will only display new
items.
67 Alert.log - Save local copy in User Files dir This saves a copy of
the alert.log file in the
Toad for
Oracle\Temps
directory.
Storage
68 List users with SYSTEM as a temporary tablespace This option displays
any users that are
using SYSTEM as a
temporary tablespace.
69 List users except SYS with SYSTEM as a default
tablespace
This option displays
any users that are
using SYSTEM as a
default tablespace,
Toad for Oracle User Guide
Diagnosing Problems
301
Check
Number
Check Name Description
with the exception of
the SYS user.
70 List users with a non-existent temporary tablespace This option displays
any users that are
using a temporary
tablespace that does
not exist.
71 List users with a non-existent default tablespace This option displays
any users that are
using a temporary
tablespace that does
not exist.
72 List tablespaces > 30% fragmented having > 50 total
extents
This options list
tablespaces that are
more than a stated
percentage fragmented
and have more than
the selected number of
total extents.
Both the percentage
and the number of
extents are adjustable.
73 List tablespaces with < 10% free space remaining This option lists
tablespaces that have
filled. The percentage
of free space
remaining is
adjustable.
74 List segments which can't extend because there is not
enough room in the tablespace, including
autoextend tablespaces
Optionally, using the
Adjust column can
include objects in
autoextend
tablespaces. This
option takes the
maximum size for
autoextend datafiles
into account.
75 List dictionary managed tablespaces (8i+) In Oracle 8i or newer
databases, lists all
Toad for Oracle User Guide
Diagnosing Problems
302
Check
Number
Check Name Description
tablespaces that are
dictionary-managed.
Schema
76 List tables with no primary key Primary keys uniquely
define a record in a
database. Most tables
should have a primary
key.
Check this option to
alert you of tables that
do not have such a
key assigned.
77 List tables with no unique key or index Check this option to
alert you of tables that
do not have a unique
key or index assigned
to them.
78 List non-system tables with > 6 indexes The number of
indexes defined in this
check is adjustable.
79 List tables with > 100 columns The number of tables
defined in this check
is adjustable.
80 List indexes with > 6 columns The number of
indexes defined in this
check is adjustable.
81 List tables with LONG or LONG RAW datatypes This lists all tables
that include LONG or
LONG RAW
datatypes.
82 List partitioned tables with non-partitioned indexes Lists all partitioned
tables with non-
partitioned indexes.
83 List tables with max row size > tablespace (or db)
block size
Lists all tables where
maximum row size
exceeds tablespace (or
database) block size.
Toad for Oracle User Guide
Diagnosing Problems
303
Check
Number
Check Name Description
84 List redundant indexes (same leading columns) Lists objects that have
indexes with the same
leading columns: this
indicates that the
index is redundant.
85 List primary and unique keys using non-unique
indexes (9i+)
Lists primary and
unique key constraints
that are using non-
unique indexes. This
applies to Oracle
versions 9i and newer
only.
86 List foreign keys with non-matching column
definitions (causes poor performance)
This option lists
foreign keys that have
parent table columns
with a different type
as the child table
columns. This
situation causes
performance
degradation.
87 List foreign keys with no matching index on child
table (causes locks)
This option is listed
because without such
an index, deletes and
updates on the parent
table result in table-
level locks on the
child table until the
transaction is
complete.
88 List foreign keys with a mix of nullable and not
nullable columns
Lists all foreign keys
on a mix of nullable
and not nullable
columns.
89 List unique keys with one or more nullable columns Lists all unique key
constrains with one or
more nullable
columns.
90 List objects with mixed-case names Check this option to
Toad for Oracle User Guide
Diagnosing Problems
304
Check
Number
Check Name Description
alert you of tables that
have mixed-case
names.
91 List object type counts by owner and tablespace One reason to use this
option is to see if you
have indexes in your
"tables" tablespace.
Selecting this option
lists object
l owners
l tablespaces
l number of
storage
objects
(tables,
indexes, and
so on) in each
tablespace.
92 List analyzed tables with > 5% chained rows and >
500 total rows
Both the percentage
and the number of
total rows are
adjustable.
Note: To produce
accurate results, you
must have recently
analyzed the tables in
the selected database.
93 List analyzed table partitions with > 5% chained
rows and > 500 total rows
Both the percentage
and the number of
total rows are
adjustable.
Note: To produce
accurate results, you
must have recently
analyzed the tables in
the selected database.
94 List schemas with unanalyzed tables This option excludes
objects owned by
SYS, SYSTEM, and
Toad for Oracle User Guide
Diagnosing Problems
305
Check
Number
Check Name Description
other "built in"
schemas.
95 List schemas with unanalyzed table partitions This option lists table
partitions you have
not analyzed, or that
have had the analyze
statistics deleted.
This option excludes
objects owned by
SYS, SYSTEM, and
other "built in"
schemas.
96 List schemas with unanalyzed indexes This option lists
indexes you have not
analyzed, or that have
had the analyze
statistics deleted.
This option excludes
objects owned by
SYS, SYSTEM, and
other "built in"
schemas.
97 List schemas with unanalyzed index partitions This option lists index
partitions you have
not analyzed, or that
have had the analyze
statistics deleted.
This option excludes
LOB indexes, and
objects owned by
SYS, SYSTEM, and
other "built in"
schemas.
98 List objects where number of hash partitions is not a
power of two
99 List segments with a possible poorly sized next
extent
Lists segments where
the NEXT_EXTENT
is less than 10% or
more than 200% of
the objects total size.
Toad for Oracle User Guide
Diagnosing Problems
306
Check
Number
Check Name Description
These numbers are not
adjustable.
A small NEXT_
EXTENT can lead to
an object with lots of
extents, and a large
NEXT_EXTENT can
lead to an object that
takes up more space
than it needs.
Note: This health
check item does not
necessarily indicate a
problem.
100 List segments with < 1% of extents remaining and >
10 maxextents
Lists segments that are
approaching
maxextents. Both
percentage and
number of maxextents
are adjustable.
101 List segments with > 1000 extents This number is
adjustable. This health
check item can be
used to find
"runaway" segments
due to extent sizes
being too small.
102 List jobs with broken = Y Lists jobs that have
failed with an error.
103 List jobs with Next Date < Sysdate Lists jobs that will
never run again unless
altered.
104 List jobs that have been running longer than 60
minutes
The number of
minutes is adjustable.
105 List objects for which there is a granted privilege but
no corresponding synonym
This option displays
objects that have a
privilege granted to
them, but do not have
a synonym. This can
Toad for Oracle User Guide
Diagnosing Problems
307
Check
Number
Check Name Description
be useful if you need
to check that youve
granted both a
privilege and a
synonym or that
youve dropped both.
106 List unusable indexes This option lists
indexes that are
unusable until they
are rebuilt.
107 List invalid objects This option lists
invalid objects,
allowing you to easily
locate and correct the
problem.
108 List package bodies with no associated packages This option lists
package bodies that
cannot be used
because they have no
associated package
specification.
109 List disabled constraints and triggers This option lists
constraints and
triggers that are
disabled. While there
may be good reason
for a disabled
constraint or trigger,
this health check item
can help find those
that should not be
disabled.
Vulnerability Assessment
110 List redundant object privileges with conflicting
grant options
Lists any duplicate
object privileges that
have conflicting
grants.
111 List public synonyms that point to non-existent
objects
Lists public synonyms
that point to objects
Toad for Oracle User Guide
Diagnosing Problems
308
Check
Number
Check Name Description
that have been
dropped.
112 List private synonyms that point to non-existent
objects
Lists private
synonyms that point
to objects that have
been dropped.
113 List roles not granted to any role or user This option displays
any roles that are not
assigned to roles or
users. This can be
used to decide if a
particular role is
unused and can be
dropped.
114 List profiles not granted to any user This option displays
any profiles that are
not assigned to roles
or users. This can be
used to decide if a
particular profile is
unused and can be
dropped.
115 Check if XML DB is installed Checks to see if
Oracle's XML DB is
installed.
116 List hidden users
117 List nested roles
118 List db links with passwords
119 List operating system authenticated users
120 List powerful system privileges granted directly to
users
121 List powerful roles granted directly to users
122 List object grants granted directly to users with grant
option (follows schema settings)
123 List system privileges granted directly to users with
Toad for Oracle User Guide
Diagnosing Problems
309
Check
Number
Check Name Description
admin option (follows schema settings)
124 List roles granted directly to users with admin option
(follows schema setting)
125 List grants on V$ views granted directly to users
(follows schema settings)
126 List grants on SYS tables granted directly to users
(follows schema settings)
127 List usage of vulnerable profiles
128 List powerful sys packages granted to PUBLIC
129 Check for DBA, RESOURCE, CONNECT roles
130 List insecure initialization parameters
131 List built-in users which are not expired and locked
132 List built-in Oracle or 3rd party users with default
passwords
DB Health Check - Schemas
Note: This Toad feature is only available in the commercial version of Toad with the optional
DB Admin Module.
The Schemas tab on the Database Health Check window provides you with a location to select
the schemas you want to examine.
From this tab, you can:
l Load schemas from the selected database.
l Choose how to include schemas (the default is to include all schemas except for SYS,
SYSTEM, and so on).
Health Check - Differences Since Last Run
Note: This Toad feature is only available in the commercial version of Toad with the optional
DB Admin Module.
Toad's DB Health Check automatically saves health check reports to your user files directory.
When a new healthcheck is run on the same database, you can click the Diffs since last run tab
Toad for Oracle User Guide
Diagnosing Problems
310
to display differences in findings. The differences tab can also be used to compare previously
saved reports, and can be printed or saved.
To view differences since last run
Run a second health check on the same database.
Note: Settings do not need to be identical.
3. Click the Diffs Since Last Run tab.
4. Change any options in the toolbar as desired.
If there are no differences, the differences report will remain blank.
To view differences between two saved reports
1.
Click on the toolbar.
2. Select two files and click OK.
Toad compares the two and provides a difference report in the Diffs Since Last Run tab.
Diffs Since Last Run Toolbar
You can alter how you view your differences report using the toolbar. You can also save or
print the file.
Button Command
Expand all nodes.
Expand to first level.
Collapse all nodes.
Load two reports and run a differences check on them.
Save the differences report to a file.
Print the Differences report.
Group By Choose to group by run or item.
Show
Differences
Only
Show only differences. If there are no differences, the report will be
blank.
Toad for Oracle User Guide
Diagnosing Problems
311
Button Command
'Bad' Results
only
Display only results that fail the health check.
DB Health Check - Email Results
Note: This Toad feature is only available in the commercial version of Toad with the optional
DB Admin Module.
To have email sent when you run a health check you must first set up the email pages. From the
Database Health Check window, click the Checks and Options tab.
You must also have the global Email Options set up with your SMTP server, and recipient
addresses. See "Email Settings" (page 652) for more information.
To set email parameters
1. From the Checks and Options tab, Settings section, find the setting listed as one of
the following:
2. Always send results by email as...
3. Only when "bad" conditions exist send results by email as...
4. Click Params in the Parameters column.
5. Select when and how to send email.
6. Click OK.
DB Health Check - Saving Results
Note: This Toad feature is only available in the commercial version of Toad with the optional
DB Admin Module.
When the Database Health Check report has been executed, you can save the results to a file, in
Rich Text Format (.rtf), web page (.htm), or plain text (.txt) format.
To save the report
1.
From the Report Output tab, click on the toolbar.
2. Enter a name for the report in theFile name: box.
3. Select the type of file format you want to use for your report.
4. Click Save.
Toad for Oracle User Guide
Diagnosing Problems
312
Trace File Browser
Trace File Browser
Note: This Toad feature is only available in the commercial version of Toad with the optional
DB Admin Module.
The Trace File Browser displays the contents of an Oracle trace file so you can easily isolate
problem areas. An online video tutorial is also available for this feature. This video opens in a
new browser window and requires an internet connection.
These tabs consolidate information from the trace file into categories. Each category is accessed
from a separate tab in the browser. The browser displays trace files on four tabs:
l Statement Details (page 314)
l Wait Summary (page 315)
l Query Summary tab (page 316)
l File Header (page 316)
To access the Trace File Browser and load a trace file
1. From the Database menu, select Diagnose | Trace File Browser.
In the Trace File Browser toolbar, click .
Note: If your trace file is still located on the server, you will need to use the FTP feature
to copy it to your machine where Toad can open it. Click and transfer your file. See
"FTP" (page 752) for more information.
2. Select your trace file and click Open.
Troubleshooting the Trace File Browser
Note: This Toad feature is only available in the commercial version of Toad with the optional
DB Admin Module.
There are several issues that can interfere with how you trace files using the Trace File Browser.
Issue Possible Reason
Blank Columns In the last several releases, Oracle has added more
information to trace files. If the Trace File Browser
is displaying a trace file produced by an older
version of Oracle, some columns may be blank.
Slow database Performance Your trace files will be most helpful if you set the
statistics_level initialization parameter to ALL.
Toad for Oracle User Guide
Diagnosing Problems
313
Issue Possible Reason
However, some people in the Oracle community
warn that setting it to ALL has an adverse effect
on performance. You may want to test it and draw
your own conclusions.
Timing and Statistics in Trace Files
are set to ZERO
If you have the statistics level set to BASIC or
NONE then many of the timings and statistics will
be ZERO. Be sure to set statistics level to
TYPICAL or ALL before starting a trace on a
session.
General Functionality
Note: This Toad feature is only available in the commercial version of Toad with the optional
DB Admin Module.
There are several features that can be found throughout the Trace File Browser to make viewing
data easier. See "Trace File Browser" (page 312) for more information.
Hiding and moving columns in column grids
In many of the grids, right-click in the column header to see a listing of all columns. By default,
all columns are visible. If you want to hide certain columns, uncheck them and they will
disappear from the grid. Toad remembers changes to column visibility, not only when you open
the current trace file, but also when you open others.
Change the column order by clicking a column header and dragging the column where you want
it. Column position will be remembered.
Autosize columns
You can also right-click in the column header to manually adjust column sizes. Manually sized
columns will be remembered.
To manually adjust columns
1. Right-click in a column header and clear the Autosize column selection.
2. Manually resize your columns by dragging the edges to the size you want.
To revert to autosize
Right-click in a column header and select Autosize Columns.
Saving, Printing and Sending to Excel
Right-click in any grid to save, print, or send the contents to Microsoft Excel.
Toad for Oracle User Guide
Diagnosing Problems
314
Advice
Toad can provide advice about certain wait events. If a wait event is blue and underlined in the
grid, double-click on it to open an advice window.
Navigating the Trees and Grids
You can use the keyboard to move around in the trees and grids as well as the mouse.
Key Command Navigation
Arrow Up Previous Node
Arrow Down Next Node
Arrow Right Next column to the right
Arrow Left Prior column to the left
HOME Leftmost column
END Rightmost column
SPACE Expand/Collapse
CTRL+HOME First Node, Leftmost column
CTRL+END Last Node, Rightmost column
CTRL+Arrow
Right/Left
Scroll horizontally without changing focused node
CTRL+Arrow
Up/Down
Scroll vertically without changing focused node
SHIFT+Arrow up Jump to parent node
SHIFT+Arrow down Jump to next sibling. If there is no sibling, jump into child nodes
Statement Details
Note: This Toad feature is only available in the commercial version of Toad with the optional
DB Admin Module.
In the Trace File Browser, the Statement details tab displays details of each statement.
Filtering the statement details grid
Within this window, you can filter the statements by wait with a number of predetermined filters.
To filter the grid
l Click on the Filter by Wait box and select one of the following filters from the
drop down list:
l None (Show all statements)
l SQL*Net message from client
l SQL*Net message to client
l SQL*Net more data to client
Toad for Oracle User Guide
Diagnosing Problems
315
Viewing Selected Details
You can select specific statements and see details of that statement. Details available are
displayed on the following tabs in the lower section of the window. In many of these tabs, you
can right-click in the grid to hide the idle events.
Tab Description
SQL Statement Displays the current statement in full, including any bind variables.
Some bind variables may show "n/a" for data type and value. This
occurs if the variable is used more than once in the query.
Explain Plan Displays the execution plan actually used by the query. All timings
and totals of each step include child steps. In this way you can see
the total for the whole query by looking at the top line.
Executions Lists the statistics for each execution of the statement.
Fetches Lists each fetch by query.
Waits Lists each wait by query. If the "filter by wait" filter is active, then
wait types matching the filter are highlighted in blue.
Wait Summary Displays the wait types for the selected statement, including min,
max and average for each wait type.
Transaction Waits Displays each transaction wait by query. If the "filter by wait" filter
is active, then wait types matching the filter are highlighted in
blue.
Raw data Displays the data from the trace file for the selected query. If you
want a particular piece of information that is not otherwise
displayed in the Trace File Browser, it will appear here.
Using these details combined with the aggregate details as provided in the statement grid
above it allows you to focus on and diagnose the trouble spots within the trace file.
Wait Summary
Note: This Toad feature is only available in the commercial version of Toad with the optional
DB Admin Module.
The wait summary tab in the Trace File Browser displays aggregate wait information for the
various types of Wait Events. The summary grid at the top of the window displays each distinct
wait time in the trace file and some statistics. For details about Oracle statistics, please see your
Oracle documentation.
Within this grid, you can right-click to hide idle events.
Toad for Oracle User Guide
Diagnosing Problems
316
Details of wait events
The lower portion of the screen displays all statements with at least one wait of the type selected
in the summary grid at the top of the screen. A statement will be listed in this area if it has the
corresponding wait in the Waits tab, or the Transaction Waits tab of the Statement Details tab.
To view details of the wait events
l Select a Wait Event in the upper data grid to view details of the statements with that
wait in the lower grid.
Query Summary tab
Note: This Toad feature is only available in the commercial version of Toad with the optional
DB Admin Module.
The Query Summary tab in the Trace File Browser displays a summary of queries and statistics
contained in the open trace file.
The Bar graph
In addition, the query summary provides a bar graph that charts the Number of queries against
the combined exec, parse, fetch and wait times.
You can also separate the Recursive queries from the user queries in the bar graph.
To separate query types
l Right-click over the bar graph and select Display User and Recursive Queries
Separately.
To aggregate query types
l Right-click over the bar graph and clear Display User and Recursive Queries
Separately.
File Header
Note: This Toad feature is only available in the commercial version of Toad with the optional
DB Admin Module.
Select the File Header tab to view the file header for the open trace file. This information
includes information about the database, server, and session.
All additional information from the trace file can be found in the other tabs of the Trace
File Browser.
Toad for Oracle User Guide
Diagnosing Problems
317
CodeXpert
CodeXpert Overview
Note: This extended Toad feature is only available in Toad for Oracle Professional
Edition and above.
CodeXpert analyzes the code against a set of rules for best practices. These rules are stored in a
ruleset and can be either user-defined or pre-defined. (See Configuring Rulesets.) CodeXpert can
be accessed from various locations within Toad.
CodeXpert can store reports within the Toad schema on the database. To enable this feature,
CodeXpert objects must be set up using the Server Side Objects window.
An online video tutorial is also available for this feature. This video opens in a new browser
window and requires an internet connection.
Accessing the CodeXpert from the Editor
When run in the Editor, the CodeXpert window opens as a tab within the Output Frame. The
window consists of the CodeXpert toolbars, the Results tab, the CodeXpert Report tab and the
Rules and Statements Totals.
To access the CodeXpert from the Editor
l If the CodeXpert tab is not displayed, right-click and select Desktop Panels | CodeXpert.
Accessing the CodeXpert throughout Toad
You can run the CodeXpert in its own window. Do this from the menu at Database | Diagnose |
CodeXpert, or from various places in Toad via the right-click menu. Running CodeXpert from
these areas allows you work with multiple objects at the same time. When run in areas other than
the editor, the CodeXpert opens in its own window. In addition, you can drag and drop objects
into this window to analyze code as you work.
To access the CodeXpert from the Menu
l From the Database menu, select Diagnose | CodeXpert.
To access the CodeXpert from other windows
l Right-click to run the CodeXpert in:
l Schema Browser
o
- Procedures
o
- Functions
o
- Packages
o
- Triggers
Toad for Oracle User Guide
Diagnosing Problems
318
o
- Views
o
- Users (runs CodeXpert on all objects owned by the selected user)
l Project Manager
l Code Road Map
CodeXpert Icon Legend
Note: This extended Toad feature is only available in Toad for Oracle Professional
Edition and above.
The tree structure of the CodeXpert includes icons to identify the various objects listed.
Toad includes an Icon Legend that you can use to easily decipher these images.
To access the icon legend
On the CodeXpert Toolbars (page 318), click .
CodeXpert Toolbars
Note: This extended Toad feature is only available in Toad for Oracle Professional
Edition and above.
The toolbars at the top of the CodeXpert window let you easily access the features of the
advisor. There are two toolbars. Buttons may be rearranged slightly depending on whether you
are accessing CodeXpert from the Editor desktop tab or from the CodeXpert window. In general,
however, the Main toolbar will be located at the top of the tab or window, and the reports
toolbar will be located on the results tab.
Main Toolbar
Reports Toolbar
Button Command
Change active session. In the drop down list, the active session is
denoted by a check mark.
Run the CodeXpert against the selected code or the code in the Editor
Load code from file
Toad for Oracle User Guide
Diagnosing Problems
319
Button Command
Load code from database
Include the selected ruleset
Scan for SQL Optimization when running the CodeXpert
CodeXpert can store reports within the Toad schema on the database.
To enable this feature, CodeXpert objects must be set up using the
Server Side Objects window. See "Installing Server Side objects" (page
172) for more information.
Schedule a CodeXpert run
Create a command file
Find a rule in the results tree by rule number
View the advice tip for the selected rule
Select ruleset
Launch the RuleSet Window to configure, edit, create or remove
RuleSets
Configure SQL Scanning options
Email results as an XML attachment. See "Email Settings" (page 652)
for more information.
Zoom on summary: opens the summary report in a separate window
Save the CodeXpert Report to a variety of HTML formats
Print Preview
Print
Code Xpert Options
General Options
General options are applicable to all of the CodeXpert.
Toad for Oracle User Guide
Diagnosing Problems
320
Prompt for CodeXpert Run names
When checked, Toad will prompt you for a name to use for the database insert. If not checked,
Toad will insert it with a number followed by the date and time stamp.
The default is checked.
Use Central Repository for DB Inserts
When this option is checked, Toad will use a central database for database inserts.
If not checked, it will use the active connection. The default is unchecked.
To change the repository connection
1. Select Use Central Repository for DB Inserts.
2. Click Change.
3. Do one of the following:
a. Select a connection from the list of current connections.
b. Click New and select a connection from the login window.
4. Click OK.
SQL Scanning Options
Note: This extended Toad feature is only available in Toad for Oracle Xpert edition.
To select SQL Scanning options
Click on the CodeXpert toolbar.
Scanning tab
Scanning options are designed to help you specify how and what the scanner will scan. In this
way, you can choose to ignore duplicate statements, skip some SQL, and so on. See "Scanning
tab" (page 338) for more information.
SQL Classification Options tab
The classification of SQL statements is designed to help you quickly identify the SQL statements
that are likely to be causing performance problems in your database environment. This
classification lets you specify the criteria to analyze your SQL statement. A problematic SQL
statement indicates potential performance problem because the SQL statement has characteristics
that can contribute to poor performance. Optimizing these SQL statements gives you the best
possibility for improving the database performance.
These classification settings are used to set the criteria for Simple, Complex, and Problematic
SQL statements. See "SQL Classification Tab" (page 339) for more information.
Toad for Oracle User Guide
Diagnosing Problems
321
Running CodeXpert
Running CodeXpert in the Editor
By running CodeXpert from the Editor window, you can check your code against the desired
ruleset while you are developing it. This can streamline the optimizing process and allow you to
create better code faster.
To run CodeXpert in the Editor
1. From the editor window, open the code you want to scan in the editor window.
2. From the desktop panels at the bottom of the window, click the CodeXpert tab.
Note: If you do not see the CodeXpert tab, right-click, select Desktop panels and then
select CodeXpert.
3. Select the ruleset you want to use from the ruleset dropdown in the toolbar.
4.
Click .
Running CodeXpert Alone
By running CodeXpert away from the Editor window, you can analyze multiple files (from either
the database or saved files) at one time and schedule CodeXpert runs.
To run CodeXpert in its own window
1. From the Database menu, select Diagnose | CodeXpert.
2. Load the files you want to analyze into the grid by selecting one of the following:
3.
Click the Load Files button to load saved files.
4.
Click the Load my Objects button to load objects from the database.
Note: you can also click the dropdown arrow beside the load my objects button to
choose a group of objects to load.
5. Select the files or objects you want to analyze. You can multi-select using either the <
Shift> or <Control> key.
6. In the Ruleset dropdown, select the ruleset you want to use. See "Configuring RuleSets"
(page 327) for more information.If you have the Toad Xpert Edition, you can toggle the
SQL Scan button on or off as desired. (The default is on.)
7.
Click .
Toad for Oracle User Guide
Diagnosing Problems
322
Working with Results
Results Tab
Note: This extended Toad feature is only available in Toad for Oracle Professional
Edition and above.
The CodeXpert Results tab displays results of the analysis. This is provided in a tree hierarchy.
The main window displays all rules in the selected ruleset, and provides details of the rules that
have been violated and where in the code the problem resides. (See "Rules" (page 322) for more
information.) For a quick review of the state of the analyzed code, you can glance at the Toad
Code Rating line in the tree.
Additional Information
Beneath the tree, there are three more tabs:
l All Rules by Objective (the default display) - lists the results of the rules scan. See
"Rules" (page 322) for more information.
l Properties - Displays the properties of the code analyzed. See "CodeXpert Properties"
(page 324) for more information.
l SQL Scan - This displays the results of running a SQL scan on the code. See "SQL
Scanning" (page 332) for more information.
Note: The SQL Scan tab is visible only if you have run a scan with the review.
Rules
Note: This extended Toad feature is only available in Toad for Oracle Professional
Edition and above.
The contents of the CodeXpert Rules area is sorted according to how the sorting option is
configured on the RuleSet. The two sorting options are:
l Severity, then Objective
l Objective, then Severity
Toad for Oracle User Guide
Diagnosing Problems
323
To view rules
l Select the results tab and then click the Rules tab at the bottom of the window.
The different types of rules issues are represented by icons to the left of the topic. (See Icon
Legend for more information.)
Moving to the right, the information provided in the second level of the Rules node is:
l Icon
l Code Element
l RuleNumber
l (Number of Occurrences)
l Rule Title
For example, the highlighted occurrence in the screen above, is one occurrence of forty-six for
Rule 2609 Consider using a parameter list to reference variables outside of this cursor,
belonging to the 'Cursor' Code Element group.
The numbers in parentheses represent where the occurrence appears in the code:
(453, 38) = Line 453, Column 27 of the code
By observing the icons in the tree, it can be determined that this rule falls under the
Maintainability Objective, and a Warning Severity.
Statistical Analysis
Note: This extended Toad feature is only available in Toad for Oracle Professional
Edition and above.
There is a code metrics column in the stand-alone CodeXpert and a tab in the CodeXpert Results
panel, both within the Editor and the standalone CodeXpert window, that displays a statistical
analysis of your code. See "CodeXpert Overview" (page 317) for more information.
Toad for Oracle User Guide
Diagnosing Problems
324
The code metrics area contains three sections that highlight program units that exceed
criteria for:
l Computational Complexity (Halstead Volume)
l Cyclomatic Complexity (McCabes)
l Maintainability Index
CodeXpert Properties
Note: This extended Toad feature is only available in Toad for Oracle Professional
Edition and above.
The CodeXpert Properties tree contains a profile analysis of the PL/SQL.
To view the Properties tree
At the bottom of the Results tab, click the Properties tab. See "Additional Information"
(page 322) for more information.
Categories include:
l Cursor Analysis
l Declaration Analysis
l DML Analysis
l Exception Handling Analysis
l Flow of Control Analysis
l Module Analysis
l Oracle Version Dependencies
l Procedure/Function Analysis
l Complexity Analysis
Overriding Statements
Note: This extended Toad feature is only available in Toad for Oracle Professional
Edition and above.
You can override specific occurrences in CodeXpert. An overridden occurrence is not counted
against the total statements Flagged.
This feature is only available in a single-user environment and will be overwritten if source
control is used and another user runs an analysis on the code.
Toad will add a comment to your code to mark that you want to override certain rules or
occurrences of rules violations.
Toad for Oracle User Guide
Diagnosing Problems
325
To override a rule
1. In the Results area, select the rule you want to override.
2. Right-click and select Override Rule.
To override an occurrence
1. In the Results area, elect the occurrence of the rule you want to override.
2. Right-click and select Override Occurrence.
Reports Tab
Note: This extended Toad feature is only available in Toad for Oracle Professional
Edition and above.
The Reports tab contains graphical displays of the CodeXpert analysis. These reports can be
saved as HTML documents, printed, or viewed in a separate viewer through the functionality of
the Report Toolbar.
Reports available from this tab include:
Report Description
Rules Summary The Rules Summary displays any best practices rules violated in
a graphic form. See "Configuring RuleSets" (page 327) for more
information.
CRUD Matrix The CRUD (Create (i.e. INSERT), Retrieve (i.e. SELECT),
Update and Delete) matrix, can be used to analyze the
consistency of functional requirements. This analysis helps to
identify performance bottlenecks in the form of unused tables, as
well as tables used heavily.
Code Metrics Code metrics analyze your code for performance issues under
the Halstead Volume (computational complexity), McCabe's
(cyclomatic complexity), number of statements and
Maintainablity Index (MI). For more information on any of these
metric scales, click the appropriate header in the first chart for a
detailed description.
Report Toolbar
Note: This extended Toad feature is only available in Toad for Oracle Professional
Edition and above.
The CodeXpert Report toolbar consists of the last four buttons in the toolbar area, and are only
available when the CodeXpert Report tab is selected. The functions relate specifically to the
Report window.
Toad for Oracle User Guide
Diagnosing Problems
326
Button Command
Zoom on summary: opens the summary report in a separate window
Save the CodeXpert Report to a variety of HTML formats
Print Preview
Print
Toad Code Rating
The Toad Code Rating (TCR) is displayed in the CodeXpert | Results | Rules. It provides a quick
reference for how your code has performed in the analysis.
Toad rates each metric as follows:
Metric Status Value Value
Existing Metrics 4 >=251
2 101-250
1 <101
Halsted Metric 4 <=3001
2 1000-3000
1 <1000
McCabe's Cyclomatic 4 <=51
3 21-50
2 11-20
1 <=10
Maintainability Index 4 <=64
2 65-85
1 >=85
The TCR is derived from the average rating of all the metrics (TCR always rounds up), and then
the numbers are assigned a color as follows:
Toad for Oracle User Guide
Diagnosing Problems
327
l 1 = Green
l 2 = Yellow
l 3 = Orange
l 4 = Red
Email Results
Note: This extended Toad feature is only available in Toad for Oracle Professional
Edition and above.
You can email the results of a CodeXpert run to an email of your choice.
Settings must be set before using the email feature.
To set email settings
1. From the View menu, select Toad Options.
2. On the left hand side, click Email settings.
3. In the Windows area, select CX Results.
4. Enter the settings for to and from, and the global email settings (if they are not
already set).
5. Click OK.
Configuring RuleSets
Configuring RuleSets
Note: This extended Toad feature is only available in Toad for Oracle Professional
Edition and above.
The selected CodeXpert RuleSet determines what rules will or will not be included in a
particular Analysis. How a RuleSet is displayed is configured through the CodeXpert RuleSet
window. See "Left Pane" (page 328) for more information on creating your own rulesets and
otherwise using your ruleset window.
To configure custom rulesets
1.
Click on the CodeXpert General Toolbar.
2. Check and clear the checkboxes for the rules you want to include or exclude.
3. Click Close.
To configure Quest-defined rulesets
1.
Click on the CodeXpert General Toolbar.
2. Check and clear the checkboxes for the rules you want to include or exclude.
Toad for Oracle User Guide
Diagnosing Problems
328
3. Change the Sort Order drop down selection.
4. Click Close.
RuleSet Window
Note: This extended Toad feature is only available in Toad for Oracle Professional
Edition and above.
The CodeXpert RuleSet Window is divided into two panels with the right panel
containing two tabs.
Left Pane
The left pane contains the RuleSet list, a list of all available RuleSets for CodeXpert. Every
RuleSet is uniquely identified by its properties and will be one of two types User-defined or
Quest-defined.
Icon Meaning
Quest-defined RuleSet
User-defined RuleSet
Right Panel
The right panel contains two tabs: Rules and Summary.
Rules Tab
The rules tab contains the Rules List, a list of all available rules for the CodeXpert. Every rule is
identified by a rule number. These can be sorted, and searched from the Rules Tab toolbar. See
"Rules Tab Toolbar" (page 329) for more information.
To view the advice tip for a rule
Double-click the item in the list.
Summary Tab
The Summary tab contains a graphical display of the RuleSets properties and characteristics.
This summary can be saved as an HTML document, printed, or viewed in a separate viewer. See
"Summary Tab Toolbar" (page 330) for more information.
RuleSet Toolbars
RuleSet Toolbar
Note: This extended Toad feature is only available in Toad for Oracle Professional
Edition and above.
Toad for Oracle User Guide
Diagnosing Problems
329
The CodeXpert CommandRuleSet toolbar lets you adjust and optimize RuleSets for the
way you work.
Button Command
Create new RuleSet. Only available if have the RuleSet node active.
Deletes the selected user-defined RuleSet.
Note: Toad RuleSets cannot be deleted.
Load an existing RuleSet.
Save RuleSet.
Save RuleSet with new name.
Save all RuleSets.
Add new folder.
Rules Tab Toolbar
Note: This extended Toad feature is only available in Toad for Oracle Professional
Edition and above.
From the CodeXpert Rules tab toolbar, you can:
l Change the sort order for the selected rule.
l Find a rule by rule number
l View the icon legend
Button Command
Sort Order Select a sort order from the drop down menu.
Find a rule by its number.
View icon legend. See "Icon Legend" (page 980) for more information.
Toad for Oracle User Guide
Diagnosing Problems
330
Button Command
Open CodeXpert Options. See "Code Xpert Options" (page 319) for more
information.
Save Ruleset to Text, CSV, or HTML.
Summary Tab Toolbar
Note: This extended Toad feature is only available in Toad for Oracle Professional
Edition and above.
The CodeXpert Summary tab toolbar provides the means to save or print the summary in various
ways. See "CodeXpert Overview" (page 317) for more information.
Button Command
Zoom in on Summary by launching in a separate viewer
Save the Summary to a variety of HTML formats
Print Preview
Print
Creating RuleSets
Creating a RuleSet
Note: This extended Toad feature is only available in Toad for Oracle Professional
Edition and above.
You can create custom CodeXpert RuleSets that include the rules your company wants code to
follow. RuleSets can be organized into folders under the RuleSets node on the RuleSet tree.
To create a new folder
Right-click in the tree structure and then select New Folder. Name your folder.
To create from a blank RuleSet
1. Select the folder or node where you want your ruleset created.
2.
Click on the Ruleset toolbar.
Toad for Oracle User Guide
Diagnosing Problems
331
To create from a template
1. Select the folder or node where you want your ruleset created.
2.
Near , click the dropdown arrow to the right of the button.
3. Select an existing RuleSet to use as a template. All rules selected in the existing RuleSet
are selected for the new template.
4. Make changes as desired by selecting or clearing boxes in the tree.
Create Ruleset Wizard
If the provided CodeXpert RuleSets do not meet your needs, you can create your own.
1.
Click . The configuration window opens with a RuleSet selected.
2. Click the RuleSets node.
3.
Click .
Note: If you want to base your ruleset on another ruleset, click the dropdown button
beside the New Rule Set button and then select the ruleset you want to use as a template.
Rules will be pre-selected using this method.
4. Enter a title in the Rule Set Title field.
5. Toad creates a filename for you based on your title and stores it in the Rulesets folder.
You can change this if desired.
6. The author is automatically filled in from your computer information. If this is not correct,
change it now.
7. Enter any comments about your ruleset.
8. Click Next.
9. Change the sort order if desired.
10. Select the rules you want to enforce.
11. Click Finished.
The ruleset is now listed at the bottom of the navigation panel, with the User-created icon
identifying it.
RuleSet Properties
Note: This extended Toad feature is only available in Toad for Oracle Professional
Edition and above.
When a CodeXpert RuleSet is newly created, it appears as a generic node on the RuleSet tree,
usually possessing a name such as RuleSet0*. This indicates that the properties have not been set
for this RuleSet and they must be done before a save can be performed.
Toad for Oracle User Guide
Diagnosing Problems
332
When the RuleSet has had properties set, rules selected, and been saved it is available for
selection and use in the RuleSet drop-down found on the CodeXpert General Toolbar.
To select RuleSet properties
1. Right-click the RuleSet and select Properties.
Set the properties:
Rule Set Title The title identifies the RuleSet
in the tree
Author The author of the RuleSet
Comments Comments about the RuleSet
can be entered here
SQL Scanning
SQL Scanning Overview
Note: This extended Toad feature is only available in Toad for Oracle XPert edition.
Including a SQL Scan within your CodeXpert ruleset can find additional ways to improve your
code. You can attach a SQL scan to all rulesets, or you can attach it to limited numbers of them.
To include a SQL Scan
1. Click on the CodeXpert tab at the bottom of the editor.
2.
Toggle into the depressed position.
3.
Click and select any SQL Scanning Options.
4. Run CodeXpert against the chosen code with whatever ruleset, if any, you want to use.
SQL Scanning Results
Note: This extended Toad feature is only available in Toad for Oracle XPert edition.
When you choose a CodeXpert Ruleset that includes SQL Scanning, the results nodes in the
Report tab will include a SQL Scan Results node.
Results are divided into four areas:
l Invalid SQL
l Problematic SQL
l Complex SQL
l Simple SQL
Toad for Oracle User Guide
Diagnosing Problems
333
The numbers in parenthesis refer to the location of the SQL statement in the code. For example,
the notation (10,1) means that the code in question begins at line 10, column 1.
In addition, if Toad has had to convert any code (see SQL Conversion Overview), it will appear
here. The notation Double-click for more information displays. When you double click on that
line, a dialog with details on the conversion appears. Any other pertinent information will
display in the line below the entry.
SQL Scanning Conversions
SQL Conversion Overview
Note: This extended Toad feature is only available in Toad for Oracle XPert edition.
When the SQL Scanning process identifies a SQL statement, it retrieves the execution plan. If it
is unable to retrieve the execution plan, it checks to see if a SQL conversion can be applied to
the SQL statement in order to render the SQL statement as a valid standalone SQL statement.
The following conversions may be applied:
l Indicator Conversion
l External Parameter Conversion
l PL/SQL Conversion
l Date Conversion
l COBOL Conversion
l Local Variable Conversion
If any of the above conversions were applied to the SQL statement during the scanning process,
the results panel shows what conversions were applied and what changes were made to the
SQL text.
Indicator Conversion
Note: This extended Toad feature is only available in Toad for Oracle XPert edition.
Within SQL Scanning, for Pro*C or similar programming languages, every host variable can be
associated with an optional indicator variable. There are two cases in which the Indicator
Conversion is applied by the SQL scanning algorithm.
INDICATOR keyword found in an INTO clause
When the INDICATOR keyword is found in an INTO clause, it is concatenated with the
variable name. For example:
Toad for Oracle User Guide
Diagnosing Problems
334
Original SQL statement
SELECT EMP_ID, EMP_NAME
INTO :v_empid INDICATOR :I_emp_id,
:v_empname INDICATOR :I_empname
FROM EMPLOYEE
WHERE EMP_ID = 100
After conversion
SELECT EMP_ID, EMP_NAME
INTO :v_empid_INDICATOR_:I_emp_id,
:v_empname_INDICATOR_:I_empname
FROM EMPLOYEE
WHERE EMP_ID = 100
TWO Variables found in the INTO clause without a separator
When two variables are found in the INTO clause without a comma separator, it is concatenated
together. For example:
Original SQL statement
SELECT EMP_ID, EMP_NAME
INTO :v_empid :I_emp_id,
:v_empname :I_empname
FROM EMPLOYEE
WHERE EMP_ID = 100
After conversion
SELECT EMP_ID, EMP_NAME
INTO :v_empid_:I_emp_id,
:v_empname_:I_empname
FROM EMPLOYEE
WHERE EMP_ID = 100
Toad for Oracle User Guide
Diagnosing Problems
335
External Parameter Conversion
Note: This extended Toad feature is only available in Toad for Oracle XPert edition.
In some source codes, a question mark (?) is used to define external parameters. In order to make
it possible to use unique referencing for individual parameter, the SQL Scanner adds a number so
that each parameter has a unique name within the SQL statement. For example:
Original SQL statement
SELECT EMP_ID
FROM EMPLOYEE
WHERE EMP_ID = ?
AND EMP_NAME = ?
After conversion
SELECT EMP_ID
FROM EMPLOYEE
WHERE EMP_ID = ?1
AND EMP_NAME = ?2
PL/SQL Conversion
Note: This extended Toad feature is only available in Toad for Oracle XPert edition.
This conversion in SQL Scanning simulates the behavior of PL/SQL by adding a /*+CHOOSE*/
hint when the optimizer_mode is FIRST_ROWS. For example:
Original SQL statement
SELECT EMP_ID
FROM EMPLOYEE
WHERE EMP_ID = 100
After conversion
SELECT /*+CHOOSE*/ EMP_ID
FROM EMPLOYEE
WHERE EMP_ID = 100
Date Conversion
Note: This extended Toad feature is only available in Toad for Oracle XPert edition.
Toad for Oracle User Guide
Diagnosing Problems
336
The Date conversion within SQL Scanning adds the TO_DATE function to a date variable
parameter. See "SQL Scanning" (page 332) for more information.
If there is an "Inconsistent datatype" error returned when the execution plan is retrieved from
your original SQL, then the SQL Scanner checks for a variable calculation using a date (for
example: var_date date_field) and applies the conversion since only a date can perform a
calculation using another date. If there is still an "Inconsistent datatype" error, then the SQL
Scanner checks all remaining variable names for "'%date%" and converts all variables whose
name includes the word "date", (for example datefield lastdateused).
An expression with the pattern date_field var_a, where the variable name is on the right side of
the expression and does not include the word date, is not converted. This is because the
variable can be a date, a number, or even a string. Oracle can perform an implicit conversion on
this variable or on the result of this expression, therefore making it difficult to detect if the
variable on the right-side of the expression is actually a date.
The following are examples when the conversion is applied.
Example 1
Original
SELECT 1 FROM dual WHERE a sysdate = 1
Conversion
SELECT 1 FROM dual WHERE to_date(a) sysdate = 1
Example 2
Original
SELECT 1 FROM dual WHERE sysdate mydate = 1
Conversion
SELECT 1 FROM dual WHERE sysdate to_date(mydate) = 1
Example 3
Original
SELECT 1 FROM dual WHERE sysdate a = 1
Conversion
No conversion
Toad for Oracle User Guide
Diagnosing Problems
337
COBOL Conversion
The COBOL conversion within SQL Scanning searches for three items within the syntax of a
SQL statement that are allowed in the COBOL, but are not valid SQL syntax: 1) a dash or minus
in a variable name, 2) comments in the middle of the SQL statement, and 3) the ]] (double right
square bracket) as the concatenate symbol. See "SQL Scanning" (page 332) for more information.
Conversion for variable name
If a variable name contains "-" minus sign, then it will be replaced with an "_".
Conversion for comment
If the 7th column of the line is an "*" (asterisk) then the complete line will be recognized as a
line comment.
Conversion for concatenate character
If "]]" (two right square brackets) are used to concatenate column names, they will be replaced
with a "+".
For example:
Original SQL statement:
SELECT * FROM EMPLOYEE
* Get the department number
WHERE EMP_ID > :employee-id
AND ENAME]]JOB = :name-job
After conversion:
SELECT *
FROM EMPLOYEE -- * Get the department number
WHERE EMP_ID > @employee_id
AND ENAME | | JOB = @name_job
Note: If your COBOL file has tags at the beginning of the lines of code, you need to use the
"Number of characters to be skipped at the beginning of every line for all files" option found on
the SQL Scanner tab page in the Preferences window.
This conversion is only applied when the Scanner Job is added to the Job Manager window
using the COBOL option under the Source Codes tab in the Add Jobs window.
Local Variable Conversion
Note: This extended Toad feature is only available in Toad for Oracle XPert edition.
Toad for Oracle User Guide
Diagnosing Problems
338
The local variable conversion within SQL Scanning is only applied to the Single Command Line
Dynamic (SCLD) SQL files and database objects. See "SQL Scanning" (page 332) for more
information.
If a local variable is detected in the SQL statement, the SQL Scanner encloses the variable name
with "&[" and "]".
For example:
Original source SQL statement before scanning:
"SELECT " + VEMPID + " FROM EMPLOYEE WHERE EMP_ID > 100"
After conversion:
SELECT &[VEMPID] FROM EMPLOYEE WHERE EMP_ID > 100
Note: The local variables in a scanned SQL statement should be treated as replacement or
substitute variables rather than bind variables. Therefore, you should hard code the values before
you optimize the SQL statement. The reason for hard coding the values is that the local variables
may be literals and when the application is run, these values are replaced before the SQL is sent
to the database. Thats why the SQL Scanner uses "&[" and "]" to differentiate the local variables
from the bind variables.
This conversion is only applied if the SCLD option is selected from the Summary tab page
in the Add Jobs window or from the Modify option from the Pop-up menu in the Job
Manager window.
SQL Scanning Options
Scanning tab
Note: This extended Toad feature is only available in Toad for Oracle XPert edition.
The Scanning tab is part of Code Xpert options.See "Code Xpert Options" (page 319) for more
information.
Skip SQL within comments
Specify that the scanning algorithm ignore any SQL statement within comments using the /* */,
// or - comment format. Otherwise, the scanning algorithm finds SQL statements that are not
currently being executed in the application. It may also attempt to build a SQL statement if it
finds the word SELECT, INSERT, UPDATE, or DELETE within the text of a comment.
Skip SQL that only involves the SYS.DUAL table
Specify to ignore any SQL statement that only references the SYS.DUAL table.
Toad for Oracle User Guide
Diagnosing Problems
339
Ignore duplicate SQL statements
Specify to include a SQL statement only once in the scanning results when it is found multiple
times in the text.
Whole word matching for the first SQL keyword
Specify to search for SELECT, INSERT, UPDATE, or DELETE as a whole word. When this
option is selected, these keywords must be preceded and followed by a space or end of line
character and, therefore, the SQL Scanner will not find the word INSERT in text like
PROCEDUREINSERT and then attempt to build a SQL statement from it.
Maximum scanned word size (Bytes)
Specify the largest size (in bytes) for scanned word. If a word is larger than this size, the SQL is
ignored, and the scan resumes in the next position.
The default is 1024KB. Choose from 30 to 9,999,999.
SQL Classification Tab
Note: This extended Toad feature is only available in Toad for Oracle XPert edition.
SQL Scanning Classification lets you specify the criteria to analyze your SQL statement. A
problematic SQL statement indicates potential performance problem because the SQL statement
has characteristics that can contribute to poor performance. Optimizing these SQL statements
gives you the best possibility for improving the database performance.
To access the SQL Classification options
1.
From the Code Xpert toolbar, click .
2. Click the SQL Scanning tab.
3. Click the SQL Classification tab.
Simple SQL
Number of table scan operations less than
This read-only field indicates the number of table scan operations referenced in the execution
plan. If the total number of table scan operation is less than this value, then this SQL statement is
classified as Simple. This value is the same as the lower limit of the Complex table scan
operations range.
The default is 2.
Toad for Oracle User Guide
Diagnosing Problems
340
Complex SQL
Number of table scan operations
Specify the number of table scan operations referenced in the execution plan for Complex SQL
statements. The default is 2 /3 and the range is 2 to 99.
Including SYS.DUAL table
Select this box to include the SYS.DUAL table when counting the number of tables referenced
by the SQL statement.
With Full Index Scan
Specify whether SQL statements with full index scans are classified as Complex SQL statements.
Problematic SQL
Number of table scan operations greater than
This is a read-only field indicating the number of table scan operations referenced in the
execution plan. If the total number of table scan operation is greater than this value, then the
SQL statement is classified as Problematic. This value is the same as the upper limit of the
Complex table scan operations range.
The default is 3.
With full table scan
Specify to classify, as Problematic, a SQL statement with one or more full table scans when the
table size is greater than or equal to the defined table size (in Kbytes) or the specified number of
rows. For a detailed explanation for setting the table size or number of rows see the Full Table
Scan Threshold topic.
Option Description
Table size The default is 8 and the range available for selection is 8 to
9,999,996. With the Table size (KBytes) option, the unit of
comparison is Kbytes. The value specified for the Table size
(KBytes) option should be divisible by 4.
Number of rows Select either Table size or the Number of rows in the table to
determine how large the table must be before the SQL statement
is classified as Problematic.
The default is 1000.
Note: If a more precise table size calculation is required, then the
use of the Table size (KBytes) is recommended.
Including SYS.DUAL
table
Specify to investigate the full table scans referencing the
SYS.DUAL table.
Toad for Oracle User Guide
Diagnosing Problems
341
With full table scan iterated by nested loop
Specify to classify as Problematic, SQL statements with a full table scan inside a nested loop.
This classification depends upon the size of the table. For a detailed explanation for setting this
table size or number of rows see the Full Table Scan Threshold topic.
Option Description
Table size The default is 8 and the range available for selection is 8 to
9,999,996. With the Table size (KBytes) option, the unit of
comparison is Kbytes. The value specified for the Table size
(KBytes) option should be divisible by 4.
Number of rows Select either Table size or the Number of rows in the table to
determine how large the table must be before the SQL statement
is classified as Problematic.
The default is 1000.
Note: If a more precise table size calculation is required, then the
use of the Table size (KBytes) is recommended.
Including SYS.DUAL
table
Specify to investigate the full table scans referencing the
SYS.DUAL table.
Retrieve table size by counting: SYS.DBA_SEGMENTS
To calculate the table size using SYS.DBA_SEGMENTS, the SQL Scanner counts the total number
of bytes allocated for a table. This information is obtained with the following SQL statement:
SELECT SUM(BYTES)/1024 AS "KB"
FROM SYS.DBA_SEGMENTS
WHERE OWNER = :OWNER
AND SEGMENT_NAME = :TABLE_NAME
AND SEGMENT_TYPE LIKE 'TABLE%'
Retrieve table size by counting: System tables
To calculate the table size the SQL Scanner utilizes the information on table blocks. This
information can be obtained with the following SQL statement:'
SELECT SUM(SEG.BLOCKS * TS.BLOCKSIZE)/1024 AS "KB"
FROM SYS.USER$ USR,
SYS.OBJ$ OBJ,
SYS.TS$ TS,
SYS.SYS_OBJECTS TAB,
Toad for Oracle User Guide
Diagnosing Problems
342
SYS.SEG$ SEG
WHERE SEG.FILE# = TAB.HEADER_FILE
AND SEG.BLOCK# = TAB.HEADER_BLOCK
AND SEG.TS# = TAB.TS_NUMBER
AND SEG.TYPE# = TAB.SEGMENT_TYPE_ID
AND SEG.TS# = TS.TS#
AND TAB.OBJECT_ID = OBJ.OBJ#
AND TAB.OBJECT_TYPE_ID = OBJ.TYPE#
AND OBJ.OWNER# = USR.USER#
AND TAB.OBJECT_TYPE_ID IN (2, 19, 34)
AND USR.NAME = :OWNER
AND OBJ.NAME = :TABLE_NAME
Applying the Classification Options
Note: This extended Toad feature is only available in Toad for Oracle XPert edition.
When performing a SQL Scan, you can specify if full table scans should be analyzed in
execution plans to categorize SQL statements as Problematic.
You can access the classification options from the CodeXpert Options window. Click the SQL
Scanner tab and then the SQL Classification tab.
For more information about these options, see the SQL Classification tab topic.
Full Table Scan Threshold
Since each database environment is unique, you can specify the threshold (size of the table) for
the full table scan to be considered a problematic operation. If the full table scan threshold is
exceeded and the execution plan has a full table scan operation, then the SQL statement is
classified as Problematic.
Default values
The default table size threshold for the full table scan operation is 8 KB. This threshold may be
too low for production systems. It is recommended to review the SQL Classification options
before using the SQL Scanner.
Calculating Table Size
To calculate the table size that is compared against the full table scan threshold, the SQL
Scanner uses one of the following methods depending on your selection in the Retrieving table
size by counting option:
Toad for Oracle User Guide
Diagnosing Problems
343
l Method 1 - Utilizing the table information from SYS.DBA_SEGMENTS system view
l Method 2 - Utilizing the table information from the system tables SYS.SEG$, SYS.OBJ$,
SYS.TS$, SYS.SYS_OBJECTS, and SYS.USER$.
The table size reported by each of these methods may differ according to the information
available in Oracle in the system view or tables utilized. The performance of retrieving the table
information under each method could be different according to the specific database
environment, thereby affecting the time it takes to scan.
To use SYS.DBA_SEGMENTS or system tables, select the corresponding option in the
Problematic SQL section of the SQL Classification Preferences.
Example Determining the Full Table Scan threshold using SYS.DBA_SEGMENTS
This example illustrates how it was determined what number of Kbytes to use for the Full table
scan threshold to classify SQL statements. It was decided that a full table scan on the
EMPLOYEE table was not a performance problem for this database and should not be classified
as Problematic.
First, it was decided that a full table scan on the EMPLOYEE table was not a performance
problem for this database and should not be classified as a Problem.
Second, the table size of the table EMPLOYEE was obtained by running the SQL statement from
Method 1 above using SYS.DBA_SEGMENTS.
SELECT SUM(BYTES)/1024 AS "KB"
FROM SYS.DBA_SEGMENTS
WHERE OWNER = OWNER_NAME
AND SEGMENT_NAME = EMPLOYEE
AND SEGMENT_TYPE LIKE 'TABLE%'
The result of this SELECT statement showed that the table size for the table EMPLOYEE
is 64,804 KB.
Third, in the CodeXpert SQL Classification Options, the SYS.DBA_SEGMENTS option was
selected and the full table scan threshold was set to 64,800 KBytes (or slightly higher to allow
for growth).
Database Administration
Audit SQL/Sys Privs
Note: This Toad feature is only available in the commercial version of Toad with the optional
DB Admin Module.
The Audit SQL/Sys Privs window displays the audit monitoring options for SQL Statement
Objects, Reserved Words and System Privileges in the database.
To access Audit SQL
From the Database menu, select Administer | Audit SQL/Sys Privs.
Note: To use auditing functionality within Toad, AUDIT_TRAIL must be
set to DB.
From this window, you can enter and modify monitoring levels for each type or for groups of
types. You can also view the audit trail records for the selected schemas.
Note: Certain privileges are required to use this screen. These include:
l To audit occurrences of a SQL statement, you must have the AUDIT SYSTEM privilege.
l To audit operations on a schema object, the object you choose for auditing must be in
your own schema or you must have AUDIT ANY system privilege. In addition, if the
object you choose for auditing is a directory object, even if you created it, then you must
have AUDIT ANY system privilege.
Audit SQL/Sys Privileges Toolbar
Button Command
Change active connection
Schema Choose schema
Audit Options View Audit Options
Audit Trail View Audit Trail
12
Toad for Oracle User Guide
Database Administration
345
To view audit details
1. From the Database menu, select Administer | Audit SQL/Sys Privs.
2. From the Schema drop down menu, select the schema you want to audit.
3. Click one of the following:
l Audit Options
l Audit trail
NLS Parameters
Note: This Toad feature is only available in the commercial version of Toad with the optional
DB Admin Module.
This window is used to view the Session, Instance, and Database parameter settings, and to
change the Session and/or Instance parameters.
The window includes tabs for Session, Instance, and Database.
To access NLS Parameters
From the Database menu, select Administer | NLS Parameters.
To change a NLS (National Language Support) setting
Do one of the following:
l Double-click a parameter; enter the new setting.
l
Single-click the parameter line, click ; enter the new setting.
If a parameter cannot be edited, the Edit button will be disabled. Session parameters are all
editable. Other parameters may not be editable.
Notice that changing a value in one cell can cause a change in other cells. For example, if you
change the NLS_TERRITORY from America to Japan, the NLS_CURRENCY symbol changes
from the dollar to the yen.
Toad Features Security
This feature restricts Toad users from having access to specific Toad features. By default users are
granted access to all features of Toad. You can restrict individuals or groups of users from
accessing some Toad features. In addition, you can make Toad read-only for individuals or
groups of users.
Caution: Toad Security Read-only only affects Base Toad. If you have the DB Admin
Module, those module components will remain fully accessible.
Toad for Oracle User Guide
Database Administration
346
To set up the security mechanism
1. Run the Server Side Objects Install Wizard to create the Toad_RESTRICTIONS table in
the Toad schema. This is REQUIRED to be in the Toad schema, not another schema with
synonyms pointing back. See "Installing Server Side objects" (page 172) for more
information.
2. Run Toad, log in as the DBA_USER (as you set it in step 1), and then select the
Administer | Toad Security menu item to bring up the Toad Features Security window.
3. Select the user or role, and then select the features you want to deny to that user or role.
All other Toad Security features will be granted to this user. Since other non-DBA users
only have SELECT privileges to the Toad_RESTRICTIONS table, they cannot make
changes to the security.
4. Click the Grant Select button so that the user or role can see the Toad.Toad_
RESTRICTIONS table.
5. If the user cannot "see" the Toad_RESTRICTIONS table (in other words, they do not have
SELECT access granted to them), then they have FULL access to all Toad features.
6. If the user has SELECT privilege on the Toad_RESTRICTIONS table, then the security
is in effect.
7. Move any commands you do not want the user to have from the Features list to the
Restricted Features list. Not all buttons, menus, or functions in Toad are contained within
this security scheme. If you need to restrict other functionality, please let us know.
8. When you have completed restricting features, click OK to save your changes. You can
also create collections of Toad features using existing Oracle roles. Grant the features to
a role (for example, DEVELOPER_ROLE), then those Toad users will get the collections
of Toad functionality without having to set up the same list of Toad features for
multiple users.
Example
To set up a list of different kinds of Toad Features, and then revoke that list of features from
select groups of users, do the following.
1. Start Toad, log in as user Toad, go to Administer | Toad Security.
2. Select a role, for example "DEVELOPER_ROLE" from the user/role dropdown list. These
are standard Oracle roles. Have your DBA create the roles if necessary.
Caution: DO NOT use the DBA role for users subject to Toad Security. When
Toad starts, if the user has the DBA role, then that overrides everything else,
security included.
3. Ensure that DEVELOPER_ROLE has SELECT privilege to the Toad.Toad_
RESTRICTIONS table. If the Grant Select button caption is "Grant Select", then click it
to execute the grant. If the button caption is "Revoke Select" then the grant already exists.
4. Copy the desired features to the "Restricted Features" list.
Toad for Oracle User Guide
Database Administration
347
5. Click OK. Toad will "grant select on toad_restrictions to developer_role" and write these
records into the Toad_RESTRICTIONS table:
USER_NAME FEATURE
DEVELOPER_
ROLE
CHANGE A
PASSWORD
DEVELOPER_
ROLE
CREATE
ROLLBACK SEG
DEVELOPER_
ROLE
CREATE
SNAPSHOT LOG
DEVELOPER_
ROLE
CREATE USER
6. Ensure that the Oracle Roles have been granted to the user: [grant developer_role
to scott].
7. Have user SCOTT log off/on to Toad. Scotts Toad features should be limited as
specified.
8. Repeat setting up restricted features for the other desired roles, e.g., TUNER_ROLE,
MAINTENANCE_ROLE, and so on.
Toad for Oracle User Guide
Database Administration
348
Disable Saving Oracle Passwords by Toad
This option is in the Features | Non-menu list as Save passwords. Moving it to the Restricted list
lets you disable the ability to save passwords.
Read-only
You can make Toad read-only to a selected user or role. This is useful if you have someone who
needs to view database objects but does not have the authority to change them.
To make Toad read-only, move the Read-only Override function from the Features | Non-menu
list to the Restricted features list. This makes Toad read-only to the selected user.
Note: This Toad Security option does not apply to the DB Admin Module. To restrict Toad
entirely, you will also need to restrict the DB Admin Module from the appropriate users.
ASM Manager
ASM Manager Overview
Note: This Toad feature is only available in the commercial version of Toad with the optional
DB Admin Module.
To access the ASM manager
From the Database menu, select Administer | ASM Manager.
In Oracle 10g and above, Oracle provides a means for managing the Oracle DB file system from
within the Oracle database: Automatic Storage Management (ASM).
In ASM, a standalone Oracle instance collects Raw server disks into disk groups and performs
management functions necessary to make ASM files available to database instances. Oracle
database files are then stored in these disk groups.
A template, or collection of file attributes, is used by ASM during file creation. Templates
simplify file creation by mapping complex file attribute specifications into a single name. A
default template exists for each Oracle file type. You can modify the attributes of the default
templates or create new templates.
For full information about ASM, Raw server disks, and templates, please see your Oracle
documentation.
Toad's ASM Manager gives you an easy interface to the Oracle ASM features, and lets you easily
manage your disk groups.
Note: Connection to the ASM instance is created through the Toad ASM Manager from the
Database | Administer menu. Toad does not support creating a connection to this instance in any
other way.
Toad for Oracle User Guide
Database Administration
349
The ASM Manager window is divided into two pages, accessible by tabs: Disk Groups and
Clients. You can view by database instance or ASM Instance, which opens a new connection to
that instance while you are viewing and working with information. Using the ASM instance will
display more data and allow you to make changes to your disk groups.
From the Disk group tab, you can:
l View disk groups
l Create disk groups
l Alter disk groups
l Drop disk groups
From the Clients tab you can see the client information for the various disk groups.
Viewing Disk Groups
Note: This Toad feature is only available in the commercial version of Toad with the optional
DB Admin Module.
You can view disk groups from Toad's ASM Manager. See "ASM Manager Overview" (page
348) for more information.
Disk group information is divided into summary information and detail information. Summary
information is displayed in the upper grid, and includes the group number and disk group name.
Detail information is provided in the lower grid when you when you select a disk group in the
upper panel.
To view disk groups
1. From the Database menu, select Administer | ASM Manager.
Select either the database instance or the ASM instance you want to use.
Note: The ASM instance provides more data and allows changes.
2. If it is not selected, click on the Disk Groups tab.
In the upper panel, select the disk group you want to view.
Note: Data for that disk group is displayed in the lower pane.
Signing in with an ASM instance
Using an ASM instance instead of a database instance provides more data and allows changes.
To select an ASM instance
When you select ASM instance from the Connected to box, the Connect to ASM
Instance dialog appears.
Note: You must log in as SYS to use the ASM instance. This username cannot be edited.
Toad for Oracle User Guide
Database Administration
350
3. Enter the password.
Select the database.
Note: ASM instances are designated as +databasename and appear near the top
of the list.
4. Host and Connect As information is static and cannot be changed.
5. Click OK.
Summary information
You can view summary information about a particular disk group in the upper area of the grid.
Information provided includes Group number, Disk Group name, sector size, block size,
allocation unit size, state, type, total MB, free MB, Required mirror free MB, and so on.
Using the toolbar, you can create, drop, and alter disk groups if you are connected to the ASM
instance (see related topics).
Disk Group Toolbar
Button Command
Refresh Upper Pane
Create disk group
Alter disk group
Drop disk Group
Detail dropdown
Refresh Lower Pane
Detail information
Detail information is provided in the lower panel grids. Information is separated into five data
grids: Disks; Templates; Operations; Files, Directories, and Aliases; and Usage. If connected by
ASM Instance, changes can be made to the Files, Directories, and Aliases area by use of the
provided toolbar.
Files, Directories and Aliases toolbar
Toad for Oracle User Guide
Database Administration
351
Button Command
Create alias for selected file
Create directory in selected directory
Rename selected object.
Drop selected object.
Creating Disk Groups
Note: This Toad feature is only available in the commercial version of Toad with the optional
DB Admin Module.
If you are connected through an ASM instance, you can create and drop disk groups from the
Disk Groups toolbar.
Creating disk groups
You can create a disk group quickly using the combination of Oracle ASM and Toad's ASM
Manager.
To create a disk group
1. From the Database menu, select Administer | ASM Manager.
2. Select an ASM Instance in the Connected To box.
3.
Click .
4. Enter a Disk Group Name.
5. If it is not already selected, click the Basic Info tab.
6. Select the redundancy of the disk group:
Select an availability from the Status after creation drop down box.
Note: The Alter Actions section will be disabled when creating a disk group. See
"Altering Disk Groups" (page 352) for more information.
7. If you are using Oracle 11g, you can also set several attributes.
8. Click the Disks tab.
9. Click Add Disks and select any disks you want to include in this disk group. Click OK.
10. Click OK to add the disk group.
Toad for Oracle User Guide
Database Administration
352
Dropping Disk Groups
Note: This Toad feature is only available in the commercial version of Toad with the optional
DB Admin Module.
You can drop disk groups from the ASM Manager. See "ASM Manager Overview" (page 348) for
more information.
To drop a disk group
1. From the ASM Manager | Disk Group tab, select the disk group you want to drop.
2.
Click .
In the Confirm ialog, choose to include or exclude contents when you drop the
disk group.
Note: if you are using Oracle 11g or later, you can also apply the FORCE option.
3. Click OK.
Altering Disk Groups
Note: This Toad feature is only available in the commercial version of Toad with the optional
DB Admin Module.
To alter a disk group
1. From the Database menu | Administer | ASM Manager, click the Disk Groups tab.
2. Make sure the ASM instance is selected in the Connected To drop down box.
3. Select the disk group you want to alter and then click.
Make any changes you need to make. You can change disk groups in any one of the
three tabs:
Basic Info
tab
Information
Availablility The availability of the disk group can be
changed with the Alter command. Toad displays
the current status of the disk group and provides
a change to drop down to select a new status
easily.
Alter Actions For detailed information regarding these options,
please see your Oracle documentation):
Check All Disks -
l Repair
Toad for Oracle User Guide
Database Administration
353
Rebalance - can be used alone or with
Add/Drop/Resize disk commands
l Specify power
l Wait
Disks tab Information
Add or Drop Select the disk you want to alter, click Add or
Drop.
Alter Click in the cell you want to alter and make
changes.
Note: You can alter some, but not all data.
Templates
Tab
Information
Add or Drop Select the disk you want to alter, click Add or
Drop.
Alter Click in the cell you want to alter and make
changes.
Note: You can alter some, but not all data.
4. Click OK to commit changes.
Viewing Clients
Note: This Toad feature is only available in the commercial version of Toad with the optional
DB Admin Module.
You can use the ASM Manager to view client information for each disk group.
As for disk groups, if you are connected to an ASM instance you will see more information than
if you are connected via the database instance.
To view client information
1. From the Database menu, select Administer | ASM Manager.
2. From the Connected to drop down, select either the Database instance (default) or an
ASM instance.
3. Click the Clients tab. Information is displayed in the grid.
4.
Refresh the grid if necessary by clicking .
Toad for Oracle User Guide
Database Administration
354
Audit Objects
Audit Objects
Note: This Toad feature is only available in the commercial version of Toad with the optional
DB Admin Module.
To access the Audit Objects window
From the Database menu, select Administer | Audit Objects.
Note: To use auditing functionality within Toad, AUDIT_TRAIL must be
set to DB.
The Audit Objects window displays the audit monitoring options for selected database objects.
You can enter and modify monitoring levels for each individual object or for groups of objects.
Note: Audit parameters for objects are also available in the Schema Browser | Object Page |
RHS Auditing tab.
Audit Objects Toolbar
The audit objects toolbar gives you control of the objects you are auditing.
Button Command
Change active connection
Clear Object List
Load Objects from Database
Object Type Select object type to audit from the drop down menu.
Apply Changes Apply changes you have made to the grid
To populate the audit object data grid
1. From the Database menu, select Administer | Audit Objects.
2. From the Object Type drop down, select the type of object you want to audit.
3.
Click the drop down, and select what you want to load.
Toad for Oracle User Guide
Database Administration
355
Setting an Object Audit
Note: This Toad feature is only available in the commercial version of Toad with the optional
DB Admin Module.
To view the Audit Objects window
From the Database menu, select Administer | Audit Objects.
Audits display in the grid in an abbreviated code. Audit options for when successful come first,
followed by a slash, followed by when not successful.
Option Abbreviation
By Access A
By Session S
No Audit -
Therefore, an audit pattern will display in the grid as follows:
A/S - audit records when successful by access, and when not successful by session
To set audit options
1. Populate the audit object grid.
Note: This must be something other than All Object Types, which is read-only.
2. In the row containing the object you want to audit, click in the column of the audit you
want to perform.
Note: For example, if you want to audit on Alter commands, click in the Alter box.
3.
Click .
4. Select the options you want to audit when the command is successful or when it is not
successful.
5. Click OK.
Multiple Object Privileges
Multiple Object Privileges
You can manage privileges for multiple objects from the Multiple Object privileges screen. You
can grant or revoke privileges on multiple objects at once.
To access multiple object privileges
From the Database | Administer menu, select Multiple Object Privileges.
Toad for Oracle User Guide
Database Administration
356
To grant privileges
Click the Grant tab. See "Granting Multiple Privileges" (page 356) for more information.
To revoke privileges
Click the Revoke tab. See "Revoking Multiple Privileges" (page 356) for more
information.
Granting Multiple Privileges
You can grant multiple privileges at once, either from selected objects, or from all objects on the
screen. See "Multiple Object Privileges" (page 355) for more information.
To grant all objects to selected grantees
1. From the Objects Owned by dropdown, select the schema owning the objects you
want to grant.
2. In the Grantees area, select the users or roles to whom you want to grant privileges.
3.
In the toolbar, click .
4. Choose All or specify privileges you want to grant on the objects.
5. Choose to include Grant or Hierarchy options.
To grant selected objects to selected grantees
1. From the Objects Owned by dropdown, select the schema owning the objects you
want to grant.
2. In the Objects area, select the objects you want to grant.
3. In the Grantees area, select the users or roles to whom you want to grant privileges.
Note: You can select or clear the Users and Roles check boxes to limit the list to one or
the other or both.
4.
In the toolbar, click .
5. Select privileges you want to grant on the objects.
6. Choose to include the Grant or Hierarchy options.
Revoking Multiple Privileges
To revoke privileges
1. From the Multiple Object Privileges screen, select the schema that owns the objects with
privileges you want to revoke. See "Multiple Object Privileges" (page 355) for more
information.
2. Click the Revoke tab.
Toad for Oracle User Guide
Database Administration
357
3. Do one of the following:
l Select All.
l Select Objects I granted.
4. In the grid, select the privileges to revoke.
Note: You can filter the grid by any column by clicking the arrow in the column header.
Select Custom and set the filter.
5. Click Actions.
6. Do one of the following:
l Select either:
l Revoke all
l Revoke selected.
Oracle Parameters
Oracle Parameters
Note: Oracle parameters are available to view in Base Toad editions. To alter them requires the
DB Admin module.
Oracle Parameters allows you to modify or edit the System Modifiable and Session
Modifiable options.
To access the Oracle Parameters window
From the Database menu, select Administer | Oracle Parameters menu item.
The grid provides information about the Oracle parameters in the active session.
Note: Access to some V$ tables are required to use this option. See "Database | Administer |
Oracle Parameters " (page 156) for more informationand a list of these permissions.
When you change a parameter, you are presented with a window listing the current setting and
boxes to change it, adding comments if desired. In addition, if applicable, you can set the scope,
choose where to apply the change, and, if on a RAC, whether to make the change in all
instances, or only the current instance.
Parameters Toolbar
Button Command
Change the active session.
Toad for Oracle User Guide
Database Administration
358
Button Command
Refresh the grid data.
Edit parameter.
Note: Editing parameters is only available in the commercial version of
Toad with the optional DB Admin Module.
See "Changing a Parameter String" (page 359) for more information.
Print the parameter grid.
Export the dataset. See "Export Dataset" (page 390) for more information.
Default Use this dropdown to quickly filter the grid by the Default column
contents to Yes, No or All.
Filter Use the QuickFilter box to filter the grid by contents you specify. See
"Using the QuickFilter Box" (page 993) for more information.
Single Grid Toggles whether Toad displays a single grid or a multi-grid when
connected to an Oracle RAC database.
In single-grid view, Toad sorts first by default on the option and then by
the instance name for easier readability.
If you choose the multi-grid view, Toad displays a separate tab for each
RAC instance.
Viewing Parameter Strings
Viewing a Parameter Setting
If you do not have the DB Admin Module, you can view the parameters but not change them.
To view a parameter setting
Double-click on the parameter you want to view.
Searching for a Parameter Setting
There are several ways to search for a parameter string. For example,
l You can search for a specific Oracle setting in any column of the grid using
incremental search.
l You can use the QuickFilter to filter the grid. See "Using the QuickFilter Box" (page 993)
for more information.
Toad for Oracle User Guide
Database Administration
359
To find a parameter setting using incremental search
1. Click in the column describing the parameter you want to find.
2. Enter the first few characters of the entry you want to find. The cursor will jump to the
entry as you enter characters.
Changing a Parameter String
Note: This Toad feature is only available in the commercial version of Toad with the optional
DB Admin Module.
If a parameter is both session modifiable and system modifiable, Toad modifies at the system
level. You can change Oracle Parameter settings individually.See "Oracle Parameters" (page 357)
for more information.
If you are using a RAC-based database, you will also have the option to choose whether to
apply the change to all instances or only the current instance.
Note: Some parameters may not allow changes. The Change Parameter Setting button will remain
disabled even if you select one of these parameters.
To change a setting using the mouse
1. Do one of the following:
l Double-click the parameter you want to change.
l
Click the parameter you want to change and then click .
2. Make any changes to your setting and click OK.
To change a setting using the keyboard
1. Double click the parameter you want to change.
2. Make any changes to your setting and click OK.
Tablespaces
View Tablespaces
To view tablespace information
From the Database menu, select Administer | Tablespaces.
Note: This feature requires SELECT access to the DBA_ Oracle dictionary views. Without
access, you will get an error dialog box, "This function requires access to: dba_free_space, dba_
data_files, and dba_tablespaces".
Toad for Oracle User Guide
Database Administration
360
From either the Space or Data Files tab, double-click a tablespace to see details. (Note: This
Toad feature is only available in the commercial version of Toad with the optional DBA module.
) See "Tablespace Details" (page 361) for more information.
Tabs
Note: The Space, Space History, and IO History tabs are only available in the commercial
version of Toad with the optional DB Admin Module.
On each of these tabs, to sort the information in ascending order, click the desired column
header. To sort in descending order, click the same column header a second time. Double<