Toad ™ for Oracle® Tips and Tricks
Dell™ Software
Foreword Introduction I have used Toad™ for 10 years, since I made the leap from Toad™ for Oracle® has been the IT community’s tool of choice Access® to Oracle®. Most of my time is spent in the editor, for more than a decade. With Toad, you are a member of an writing new code or opening and running one of the many elite community of two million plus Oracle professionals. snippets I have saved there over the years. Toad makes me more efficient, the latest version reminds me of errors before Whether you are new to Toad or have been using it for several I even hit compile. Using code review, there is an instructor years, there are several features that you should be familiar with standing over my shoulder every time I hit format. for achieving maximum productivity. This document will step you through some Toad fundamentals and break down the I work in a small IT group and wear many hats. Everything I need features for the following Toad editions and modules: to do in Oracle, I do in Toad. From simple data or whole schema • Toad for Oracle Base Edition imports, exports, and comparisons to building out completely • Toad for Oracle Professional Edition new projects it’s a click or two away. And even while Toad has • Toad for Oracle Xpert Edition, which includes our proprietary SQL and made me more efficient and my job easier to do right, it is the index-optimization technology community around it that makes it more than just software. • Toad for Oracle DB Admin Module, which helps DBAs or development From forums and mailing lists to blogs, users from all over enjoy teams manage their Oracle environments sharing and discussing all that it can do. I’m sure there are some tips in here that I will be trying out real soon. – Jim Graham, Database Developer Most tools offer a single display model
for objects in the If you are already a Toad customer and Schema browser database. Toad do not have access to the features The Schema Browser is your gateway discussed below, please contact your to the database objects in your Oracle offers three! Dell™ Software sales representative and instance. Simply select the user/schema, request an evaluation key. database object type, and database object on your left, then immediately Toad for Oracle Base Edition gain access to all the pertinent Regardless of your responsibility in information for that object on your right. your organization, if you work with Oracle, then you will need a quick Customizing the display and efficient way to access the data Most tools offer a single display model in your database. This section of the for objects in the database. Toad offers document will step you through how three! Toad can display your objects in a to browse the contents of tables, write tree view, a dropdown selector, or a tab/ your own custom queries, and view the page panel. relationships of your database objects. Toad tip: Selecting “Dropdown” will This section also discusses the powerful give you the most real estate for listing features of Toad that help you develop objects and allow you to use the and maintain PL/SQL stored procedures. keyboard to navigate the object type Toad users generally spend most of their list. Selecting “Treeview” will make Toad time in two areas: the Schema Browser look and feel more like SQL Navigator or and the Editor. Oracle® SQL Developer.
Figure 1. Toad’s tree view
2 The Schema Browser allows you to create groups of schemas for each connected database.
Figure 2. Toad builds a historical list of things you’ve viewed in the database.
Basic navigation Hiding Schemas/Users Find your object on the left side. Select The Schema Browser allows you to create it and the meta-data or details for the groups of schemas for each connected selected object will appear on the right database. For example, you could create side. As you click around the database, a group called “Oracle Test Data” that Toad builds a historical list. contained the “SCOTT,” “HR” and “SH” accounts. You can create custom groups Quickly navigate to objects that you’ve to manage your production and test browsed to previously using the “Back” accounts or your different application and “Forward” buttons on the right- schemas. Schemas you access on a side toolbar. limited basis would be “hidden” under the “Other Schemas” category. Filtering By default, Toad will display all objects To get started, right- click on the in the database that you have access schema selector (or a schema node in to. If you are working in a system with the treeview) and select “Customize.” many thousands of objects, this can This will open the Customize Schema quickly become overwhelming and hurt Dropdowns dialog. From here you can your productivity. Therefore, Toad offers assign schemas to as many groups as several levels of filters. you like.
3 Figure 3. Use the Customize Schema Dropdowns dialog to assign schemas to groups (applies to the Object Palette). If you are working on a project that Toad tip: Tell Toad to load only schemas • Project filters – See below. that own objects: right-click on the • Filter dialog – A much more powerful will require frequent schema selector or set in the View > control. Toad Options dialog on the Schema access to specific Browser page. Data grid filters list of objects across You can also filter the data displayed in Filtering object lists any data grid, not just ones found in the object types and Each object type has an independently Schema Browser, as explained in the defined filter. By default Toad will show “Data Grids” section below. schemas, then you all objects for the selected type. may benefit from • Quick filter – A basic pattern matching Organizing objects input box. You can input “C*; D*” for If you are working on a project that will the “Favorites” panel example and have only objects that start require frequent access to specific list of in the Schema with the letter “C” or “D.” This control does objects across object types and schemas, not support regular expressions. In Toad for then you may benefit from the “Favorites” Browser. Oracle v10.5 and higher, the filtering clause panel in the Schema Browser. is applied ONLY to the selected object list. So if you define a filter while the “Tables” object list is active, the filter will not apply to “Views.”
Figure 4. You can load only schemas that own objects by right-clicking on the schema selector or set.
4 Figure 5. Favorites panel Having a project defined also allows Projects Having a project defined also allows If you want to extend the favorites you to filter your object lists in the you to filter your concept beyond database objects, then Schema Browser by project. This can I recommend checking out the Project be handy when you are logged into a object lists in the Manager. To add database objects to a 30,000+ object schema that contains Schema Browser by project, right-click one or more objects tables for 30 different applications and and select “Add to Project Manager.” you want to see only the “Payroll” tables, project. You can also drag and drop the Objects not everything. from Schema Browser into the Project Manager panel. Are you feeling overwhelmed by the Toad Interface? Read this blog on de-cluttering your Toad desktop.
Figure 6. Adding database objects to the Project Manager
5 Many powerful features of Toad Figure 7. Additional details available in the right-click menu are exposed by Additional detail view side. For example, you could add “Num using your mouse. By default, Toad displays all of the detail Rows” for Tables and sort by table size information for your objects on the right stats for an estimated number of rows. Right clicking on a side. You can manually add any of these table in the Schema detail items to the left side by right- Right-click functions clicking in the column header on the left Many powerful features of Toad are Browser will expose exposed by using your mouse. Right clicking on a table in the Schema more than 35 Browser will expose more than 35 different operations. different operations. If you rely on having a button available on the screen, you may be missing out.
Overwhelmed by the Toad interface? Read this blog post on how to simplify Toad.
Toad tips: 1. Multi-select objects and then right-click. 2. Where you right-click determines what you see: grids, toolbars, menus, grid headers, etc.
Figure 9. Editor button on toolbar
Figure 8. Schema Browser’s right-click menu
6 Editor Writing code from scratch Toad now has a single editor for working An empty editor might seem like more of with SQL and PL/SQL objects. Older a “blank screen of panic” for those less versions of Toad had separate editors, comfortable with Oracle’s syntactical but the former SQL Editor, PL/SQL Editor, rules and commands. Toad has many of and offline editors have been condensed these commands built-in and available to a single window for all of your editing to invoke on demand. related to SQL, PL/SQL, anonymous block, SQL*Plus script, etc., as well as for Code templates ad hoc querying on the database. Code templates are commonly written PL/SQL blocks of code that you can The editor is for building and executing have generated on demand. As an your Oracle commands. Anything you example, try typing the following into a can execute via SQL*Plus can also blank editor: Toad now has a be executed via the Toad Editor. This single editor for includes: anon
Figure 10. Code templates list box
7 Figure 11. Pop-up list while scripting in the Toad editor
The default templates can be modified tables in the editor. Code Insight has the by right-clicking in the Editor and ability to see the following object types: choosing “Editing Options.” From there • Tables Toad can help you you will default into the behavior portion • Views of the Editor options. Click the “Code • Aliases write your SQL Templates” button. Templates can be • Functions, procedures and packages extended, modified, removed, and even (with methods) and/ or PL/SQL shared with other Toad users. • Types (with attributes and methods) statements. As you • Java source Toad tip: Make your templates dynamic • Sequences type, Toad can offer by using the & character. • Users • Expected tokens (keywords) to complete the Code insight • Available variables and parameters command or object Toad can help you write your SQL and/ • Collection types or PL/SQL statements. As you type, Toad • Public and private synonyms name for you. can offer to complete the command or object name for you. The Code Insight Toad tips: feature has been remarkably improved 1. You can disable this feature in part or in full. over the past several releases. As you may 2. You can disable support for remember from older versions, Code expected tokens. Insight (
Figure 12. Toad options for code assist
8 For example, suppose I want to command, which gives you a table or query from a schema that starts with view definition. Toad has its own DESC “Matthew.” Toad will recognize that text command that will work on any object and pop up a complete list of accounts in the database. that match that string: To use the Toad DESC, simply put your For performance reasons, not all cursor on an object name you have object types are enabled by default; in typed in the editor and use the F4 key. particular, public synonyms are not. So This will open a pop-up dialog that gives if you are looking for help referencing you all of the same information you a DBMS_ package, you will need to would see in the Schema Browser. preface it with the “SYS” notation or enable the public synonym support. Toad tips: 1. You can DESC as many objects as you want. The DESC All of the Code Insight options can be 2. You can drag column names into the editor. command gives found on the Editor’s Code Assist page 3. You can modify the object from the DESC. in the Options dialog. To disable code you a table or view insight, uncheck the “Enable Code Recall previous SQL Insight pick list” option. You can still Every valid SQL statement you execute definition. Toad invoke the code assistance feature on via F9 is automatically recorded by Toad. has its own DESC demand by using the “CTRL”+ “Period” You can access previously executed SQL key sequence. by using F8. The same panel is available command that will under the View menu. By default, Toad A less drastic approach would be to stores the last 500 executed statements. work on any object increase the timer delay to something in the database. like 5000. This would give you a good Toad tip: five seconds before Toad attempts to You can cycle through your list of auto-complete your text. previously written SQL statements using
Figure 13. Using the Toad DESC command
9 Giving your SQL statements a name allows you to recall Figure 14. Right-click to split the editor
your query by Giving your SQL statements a name statements based on SQL, or strip non- context versus some allows you to recall your query by SQL syntax from a code statement. context versus some obscure SQL you For example, to take a SQL statement and obscure SQL you may have written six months ago. Some automatically format it to be embedded general advice: if you spend more than into a Java program, you can simply may have written six 30 seconds writing a SQL statement, select “Make CODE Statement” from the months ago. give it a name. You can now recall it Editor menu. This will copy the current without using the F8 dialog, giving you window’s statement to the clipboard more room to type in the editor. Use in the language syntax you select. The
Figure 15. Toolbar button to format code
10 Figure 16. Quickly determine which line of code is taking the most time to run.
Working with PLSQL Instead, we will cover a few of my Toad is a full featured IDE that allows a favorite and most-frequently overlooked Toad allows you PL/SQL developer to accomplish the features. You can learn more about the following quickly and easily: other features on Toad World. to profile your PL/ • Create PL/SQL stored procedures SQL executions to • Execute said procedures Execution profiling • Identify syntax errors Toad allows you to profile your PL/SQL determine where • Debug PL/SQL objects executions to determine where any • Perform automated code reviews execution bottlenecks are occurring any execution • Document the PL/SQL objects and answer the question, “Why is my bottlenecks • Identify execution bottlenecks program taking so long to run?” To start • Load test the PL/SQL objects a profiler run, toggle “on” the “stopwatch” are occurring • Unit test the PL/SQL objects button next to the “debug” toggle. Then • Capture REFCURSOR output execute your PL/SQL program from the and answer the • Refactor PL/SQL Editor. After it is finished, pull up the question, “Why is • Control PL/SQL via source control record from the Profiler tab. With Toad for Oracle v9.6 and higher, you can my program taking To cover these topics in detail here automatically pull up the visual chart would make this paper many pages representations of your PL/SQL runs by so long to run?” longer and likely try your patience. clicking on the Details button.
Figure 17. Toggle on the Details view to see a graphical representation.
11 The debugger can be your best friend to figure out Figure 18. Watch panel in the Toad editor why your program If you are on Oracle 11g or higher, are marked by little blue dots in the editor isn’t behaving as then Toad also supports Oracle’s gutter for each line. Non-executable lines expected. It runs hierarchical profiler. will not have their breakpoints honored by Oracle. your program line Debugger • Adding a watch: To add a watch on a The debugger can be your best friend variable, leave the cursor blinking on the by line, stepping to figure out why your program isn’t variable on which the watch is desired and through the code. behaving as expected. It runs your click the eyeglasses icon. Toad allows program line by line, stepping through you to see the values of all your code the code. variables by using the “Enable Smart • Setting breakpoints: To set execution Watches” feature. breaks in the code, leave the cursor on • Modifying variable values while debugging: the line on which you want the code to To artificially change the value of one of break and hit F5. Set conditional breaks by your PL/SQL variables, highlight the variable double clicking the break in the Break and in the watch window and hit the calculator Watch View window” Make sure to only on the icon bar which, once moused over, add breakpoints that are executable; these will read “Evaluate/Modify Watch.”
Figure 19. Auto-extract and execute embedded SQL statements in your PL/SQL code.
12 Figure 20. Filter/Sort button on the Data Grid toolbar
Running SQL inside of PL/SQL Sorting/filtering While most of you know that you Toad makes it easy to apply a sort or filter use F9 to execute a single SQL on your data via the grid. Note that this statement, did you know you can use feature is not available for grids in Toad will extract the
Figure 21. Table Sort/Filter window
13 Figure 22. Applying a filter (the variable value is defined by the active cell)
Figure 23. Filter condition copied to dialog
14 You can now disable a column simply by dragging it away from its current location until you Figure 24. Result set refreshed with active filter see an “X” symbol
A few notes about the filter dialog: column header with your mouse to the and then releasing • Filters can be named for easy recall. desired location in the grid. the mouse button. • The WHERE clause can be input manually. • You can use conditions, such as BETWEEN With Toad, you can now disable a and NOT IN. column simply by dragging it away • Filters are remembered between sessions. If from its current location until you see the funnel control is colored RED, then the an “X” symbol and then releasing the filter is active. mouse button.
Column management Each change will be reflected when You can easily disable a column in a data is copied or exported out of the grid by using the column selector at the grid. You can restore the grid to its top left corner of each grid. Columns original state with the right-click “Reset can also be re-ordered by dragging the columns” command.
Figure 25. Show/hide columns in the data grid
15 Toad lets you apply grouping at the column level.
Figure 26. Grouping makes it easier to drill into specific rows for analysis and reporting.
Toad tip: Fix a column. After a column is simply drag a column to the panel space fixed, as you scroll left and right in a grid to apply a group condition. You can have that column remains fixed. You may fix multiple levels of grouping. as many columns as you like. Toad has a Single Record view that Toad lets you apply grouping at the allows you to view records one a time column level. You will need to activate vertically. Click the “open book” button the Group panel via right-click. Then to start using this feature.
Figure 27. The Single Record View dialog
16 You can now apply a visual color style Figure 28. The Single Record View button to the data grids in Toad. Grid styles millions of rows of data all day long. To You can now apply a visual color style apply a style, open the options and go to to the data grids in Toad. This can the Data Grids, Visual page. lessen eye strain when having to stare at
Figure 29. Toad options for managing visual aspects of the data grid
17 Toad can count, Figure 30. Button on Data Grid toolbar to calculate fields
sum, average, min, Calculated fields Reporting and max selected Toad can count, sum, average, min, and To access the Toad reporting interface, max selected numerical values in a grid. right-click in the Data Grid and select numerical values in You can simply select the cells you want “Report.” You will find a report generation to perform the calculation on, and then wizard to walk you through report a grid. hit the new “Sigma” button on the data creation. Expert Gary Piper has a lot of grid tool bar. great material on doing more with Toad reports on Toad World. Toad tips: 1. You can select values across multiple Handy utilities columns. Once calculated, you can copy ER diagram and paste the data from the bottom panel. To generate an entity relationship 2. The Schema Browser has a new “Show diagram (ERD), select the objects you Detail Dataset” button. This allows you to want diagrammed in the Schema see children records for the selected row. Browser and right-click -> “ER Diagram.”
Figure 31: ER Diagram in Menu – Database- Report
18 Figure 32. ER Diagram window The Code Road Map parses an You can easily export the visual diagram to Any ERD may be exported to a what- a full rendered HTML version, with which you-see-is-what-you-get HTML report. object’s source anyone can interact, even outside of Toad. If you need to alter models and push Code Road Map code and identifies migration DDL scripts or compare models, The Code Road Map is similar to an ER the other Oracle you will need to use Toad™ Data Modeler, Diagram, but from the stored procedure which is free to use for all licensed Toad (PL/SQL) perspective. The Code Road objects on which for Oracle users who are also current on Map parses an object’s source code maintenance. The diagrams are generated and identifies the other Oracle objects it is dependent. If a by reading the foreign key constraints on which it is dependent. If a view view calls from six defined in the database. calls from six different tables, Toad can diagram that. Or, if your PL/SQL function different tables, Toad Toad tip: If you have a database that makes a package call that is dependent does not use foreign keys, you can use on a table and sequence, then Toad can diagram that. Toad Data Modeler to reverse engineer a will diagram that. Choose your trigger, schema and use the “Infer Relationships” procedure, function, or package in feature to guess relationships based on the Schema Browser and right-click common column names between tables. “Code Road Map.”
Figure 33. Code Road Map window
19 Figure 34. Query Builder button on the Toad toolbar
The reporting for the Code Road Map to build WHERE clauses around DATE is identical to ER diagrams. You can values in a table with a value picker – also use the “Create Script” button to much like using the Filter dialog for the generate a DDL script to build a test data grids. The next time you or development sandbox environment where everything to compile and A few key features: need to query from execute your PL/SQL is present, saving • Select tables: Using the Object Palette more than two or you the need to copy an entire Schema (opened automatically), select one or tables to test a single object. or views necessary for your query and drag three tables, try the them into the workspace. Toad tip: You can also use the Code • View joins: If the tables have relationships Query Builder. Who Road Map to build a diagram for defined by referential integrity constraints wants to type out all your views. (foreign keys), Toad will automatically detect these and join your tables/views. the SELECT, FROM, Query builder (formerly SQL Modeler) Double click on a link to view or change Query Builder allows for building queries the Join condition for your query and JOIN clauses? visually. Did you know that this was • Choose columns: Double-click in the the most frequently cited Toad feature check boxes of the columns desired for for saving time in a recent user survey? the query. That’s right: people said this window • Add where clause criteria: Drag a selected saved them more time than any other column from the “SELECT” tree area and feature in Toad. drop it on the “WHERE” area. You can also right-click on a column in the tree and The next time you need to query from select “Include in Where Clause.” This will more than two or three tables, try the open the “Where Definition” window. Click Query Builder. Who wants to type out all on the ellipsis button to see distinct values the SELECT, FROM, and JOIN clauses? for the selected field to help you build a This window also makes it very easy meaningful where condition.
Figure 35. Viewing joins in Query Builder
20 Sometimes, you Figure 36. Sample Data dialogue in the Query Builder where definition feature just want to quickly navigate to the • View generated query: View the SQL by Jump search (new in v12.0) looking at bottom of the screen. This new and enhanced search utility appropriate user • Run generated query: Run the query with may become the most commonly used the F9 key or the green play button to feature. It helps you search through interface in Toad; return a data set. all the Toad windows, menus , and the jump search • Explain plan: View the explain plan by options. Sometimes, you just want to clicking on the ambulance icon on the quickly navigate to the appropriate user feature is very second of the top two icon bars. interface in Toad, and you may find this • Create a model from existing query: From utility very helpful in guiding you within helpful in guiding the Editor, right-click and select “Send to the product. you within the Query Builder” to reverse-engineer your selected query to a Query Builder model. Querying databases other than Oracle product. Introducing Toad™ Data Point Toad tip: Toad can write your joins If you like the Toad for Oracle interface, using ANSI join syntax. This is ideal for you will be pleased to know that a applications supporting both Oracle and similar Toad product is available for SQL Server environments. other databases.
Figure 37. Data Compare across platforms in Toad™ Data Point
21 Toad for Oracle remains your “go-to” tool for Figure 38. MS Excel integration in Toad Data Point anything Oracle. Toad Data Point is With Toad Data Point, you can: Notes regarding this feature: • Connect natively to the following non- • Toad Data Point is available for free for Toad provided here to Oracle databases: for Oracle Suites (DEV and DBA) users. • IBM® DB2 LUW or z/OS • If you need to perform database give you access to • Microsoft® SQL Server® administration or application development the data in sources • MySQL® tasks, then be aware we have a Toad IDE • Sybase® ASE, SQL Anywhere or IQ specifically built for those platforms (e.g., other than Oracle. • Connect via ODBC to other Toad™ for MySQL, Toad™ for IBM® DB2, databases, including: Toad™ for SQL Server®). • Teradata® • Toad for Oracle remains your “go-to” tool • Informix® for anything Oracle. Toad Data Point is • PostreSQL® provided here to give you access to the • Any datasource that supports the ODBC data in sources other than Oracle. v3 protocol • Quickly connect to Microsoft® Access® Base edition summary and Microsoft® Excel® without ODBC As you can see, the Base Edition of Toad configuration for querying, reporting, and is packed full of features. And to be exports/imports honest, we barely covered 10 percent • Build queries visually or use the familiar of them. As you know, Toad is available Toad editor to get to your data in multiple editions. The rest of this • Browse the contents of the database using document discusses premium features a single browser (just like Toad for Oracle) available with the Professional, Xpert, • Compare and synch data between and DB Admin Module upgrades. different databases • With rich Microsoft Excel integration, build pivot tables and ODBC linked queries on the fly
22 Don’t let code
Figure 39. Right-click to generate data reviews become an expensive Toad for Oracle Professional Edition Code analysis and sensitive Automatically generate test data Also included with the Professional Need more and better-looking test data Edition is Code Analysis, our situation for your to drive your applications? Generate revolutionary SQL and PL/SQL development teams. test data for one or more tables automated code review and automatically. Toad can do that in a documentation system. Learn more Toad is the only couple of clicks. about Code Analysis. PL/SQL IDE that Toad tip: Toad for Oracle Professional Don’t let code reviews become an offers best practices edition allows you to select one or expensive and sensitive situation for more tables and generate test data. your development teams. Toad is programming Toad will even honor your foreign key the only PL/SQL IDE that offers best relationships when creating key values. practices programming advice for your advice for your Toad can generate real-looking Oracle developers. Oracle developers. product data.
Figure 40. Code Analysis rules
23 Figure 41. Describe in plain English the behavior of your PL/SQL program, and let Toad generate and manage your test code. Run a regression test any time you make a The Toad change to your program – Integration with Code Tester Development Suite for Oracle Load and functional testing suite for PL/ your unit test. Regression testing is only SQL code a click away. introduces a full The Toad™ Development Suite for Oracle® introduces a full load and functional Test performance load and functional testing suite for your PL/SQL code. You You are only a right-click away from testing suite for can generate functional tests for your PL/ load testing your stored procedures SQL without writing any PL/SQL. in Toad as well. Put your code to your PL/SQL code. the test by spinning up a hundred Toad tip: The run to test function lets concurrent sessions. Find out when your You can generate you run your PL/SQL program and have performance service level agreements functional tests Toad record the observable behavior as fall apart. for your PL/SQL without writing any PL/SQL.
Figure 42. Integration with Benchmark Factory for Databases
24 Figure 43. SQL Optimizer for Oracle button in Toad’s Editor
Toad for Oracle Xpert Edition You will then be prompted to send the SQL code to the Optimize SQL or the Toad for Oracle Xpert Edition includes Batch Optimize screens. I recommend a comprehensive SQL optimization you become comfortable with the solution that will identify problematic Toad for Oracle Optimize SQL, which allows you to SQL, tune statements automatically, manually tune a query, before you use the Xpert Edition suggest index alternatives, and automatic Batch Optimize technology. even provide impact analysis when includes a implementing changes that could Toad tip: When using the stand-alone hurt database performance. Wherever comprehensive SQL Optimizer, right- click on the you encounter SQL in Toad, you can toolbar and select “Show Captions.” SQL optimization also invoke a tuning session for that statement by simply clicking the solution that Optimize SQL “Optimize SQL” button. The Optimize SQL window guides will identify you from analyzing the current Tuning current statement from execution plan to automatically problematic SQL, the editor generating SQL query rewrites that When you find a problematic SQL tune statements will identify better-performing queries. statement in the Toad Editor, it is very Toad can generate and evaluate the easy to move the statement into our automatically, and theoretical execution plan. tuning lab. Just select the SQL you want much more. to tune, and click the “Advanced SQL You can view the plan in several Optimization” button. Click the down different formats and even get detailed arrow at the side of the button with documentation for each plan step—all the yellow beaker with the tuning fork by right-clicking your mouse. (found on the right of the printer button).
Figure 44. SQL Optimizer for Oracle window
25 Generate virtual Figure 45. The SQL Information tab under the plan will let you know if there are indexes and see the any problems with your plan that could impact performance.
new execution plans Tuning options decide which queries you want to test by available before you With your statement in the Optimize SQL executing them. window and SQL Details panel, you have • Index: Ideal for product and application physically create the several options: environments where the SQL statements • Optimize: Ideal for fast-running queries, are not available for rewrites. This will index. this will automatically re-write the SQL generate virtual indexes and allow you and execute each unique execution plan. to see the new execution plans available You will be notified as soon as a faster before you physically create the index. If alternative has been identified. you test these scenarios, the indexes will be • Rewrite: Ideal for long-running queries, created and the original queries executed this will only rewrite the SQL statement to verify the performance has improved. and allow you to evaluate each unique • Rewrite & Index: Does both the Rewrite plan that has been identified. You can then and Index scenarios described above.
Figure 46. Viewing plan details
26 The Toad for Oracle Xpert SQL Optimizer Figure 47. As each scenario is executed, the scenarios are ranked by elapsed time. includes an indexing You can cancel execution at any time, or let it continue through all of the rewrites for a more exhaustive set of scenarios. feature that analyzes a collection of You can easily compare any two scenarios execution plan differences side by side. by seeing both the SQL syntax and SQL statements to see which tables and views are being queried, and then examines the existing set of indexes.
Figure 48. Comparing SQL alternatives in the SQL Optimizer
27 Impact analysis Toad tip: Identify key SQL code, propose Whenever you add one or more indexes a change to the system (a new index?), to the database, the execution plans for and then see how that change affects your applications’ embedded SQL can the execution plans for your SQL code. be dramatically impacted. The Impact Analyzer allows you to model these Optimize current SQL proposed system changes so you can While in the Toad editor, you can now see exactly how your new index affects invoke a tuning session to run inside of everything else in the database. We Toad for the current SQL statement. This generate the new theoretical index interface will automatically generate and the new execution plans for each alternatives and execute them, alerting of your production SQL statements. you to alternatives that generate faster And you can see what the before and execution times. This is ideal for tuning The Impact Analyzer after ramifications are to your system queries that run in minutes or seconds allows you to model whenever you propose a change. versus hours. proposed system changes so you can see exactly how your new index affects everything else in the database.
Figure 49. Analyze Impact window in SQL Optimizer for Oracle
28 With a touch of a single button, Toad can evaluate 60 different execution
Figure 50. You can now generate SQL re-writes and identify more efficient alternatives plans and identify a for your poorly performing SQL directly inside of Toad. plan that takes the
If you are looking for an interactive tuning Plan control response time from environment where you have more It is not always possible to implement a 43 seconds down to control, you should continue to use the query re-write to solve a performance SQL Optimizer. However, if you are new problem, especially in production. Oracle 6 seconds. to tuning SQL, then this feature is much has introduced a new query performance simpler and is definitely worth a look. management feature in 11g to address this, known as SQL Plan Baselines. When launching a tuning session inside of Toad, you’ll be asked to choose With a touch of a single button, in between an OLTP or data warehousing one test, Toad evaluated 60 different environment, specify a search depth execution plans and identified a plan that that determines the number of re-write took the response time from 43 seconds alternatives to investigate, and provide down to 6 seconds! That plan can be an optional time limit for the re-write deployed to the database without making and execution exercise. any changes to the application source or worrying about introducing any schema changes that could affect other parts of the application (like an index).
29 Use Optimize Indexes to analyze and improve indexes for a SQL workload Figure 51. SQL Optimizer’s Optimize SQL Resolution report
or for any group of Optimize indexes (new for v11.0) You can instruct SQL Optimizer to SQL statements. Use Optimize Indexes to analyze and gather a SQL workload from any of the improve indexes for a SQL workload or following sources: for any group of SQL statements. You • Oracle® Automatic Workload can instruct SQL Optimizer to gather Repository (AWR) SQL from an application workload • Foglight™ Performance Analysis during a specified time period. SQL • Oracle® System Global Area (SGA) Optimizer evaluates your SQL workload • Source code and provides you with the best set of indexes to optimize database After collecting the statements, SQL performance for that workload. After this Optimizer provides you with the evaluation process is complete, you can execution plans and run-time statistics. review the results and then select the Select the statements for which you new indexes you want to save and test. want to optimize indexes. After running
Figure 52. Optimize Indexes shows execution plans and run-time statistics.
30 Any copy of Toad can be upgraded to
Figure 53. Health Check window in Toad for Oracle DB Admin Module include advanced database object the evaluation process, review the It gives you visibility into each of your management results to determine the performance managed instances. For example, we improvements. If, after reviewing the can automatically identify ORA-600s in features with the DB results, you choose to add new indexes, your Alert Logs or audit synonyms that you can perform an Index Impact point to non-existent objects. Admin Module. Analysis to determine how creating the indexes will affect database performance. Toad tip: Easily create multiple types of health check scans that run on selected DB admin module instances on given days of the week and Database management made easy email the results to the DBAs responsible Toad is not just for developers; database for those instances or database tasks. administrators also get features tailored to their needs. Any copy of Toad can be The Database Health Check includes 16 upgraded to include advanced database checks for Oracle RAC environments object management features with the and 11 new checks for production DB Admin Module. Whether you need settings and virtualized environments. to create test environments based on existing instances, manage database Database browser (database > monitor > resources, or compare and synchronize database browser) different instances, the DB Admin Most users will rely on the Schema module is right up your alley. Browser for poking around the database, but for DBAs, Toad offers the Database Health check (database > diagnose > Browser for more effective instance health check) management. The Toad Database One of the most important features of Browser allows you to connect to all the Toad DB Admin Module is the Health of your databases and interact at the Check. Wouldn’t it be nice to give each database level (users, roles, tablespaces, of your instances a thorough checkup? system privileges, etc.). You can With the Toad Health Check, you can. select multiple instances and see the parameters set for each side by side, Select the instances you want inspected, or drill down into the objects of the select the scenarios you want evaluated, database, just like you can with the and hit the “play” button. This feature Schema Browser. can be scheduled, and you can have the results automatically emailed to you.
31 The Database Browser serves as
your entry point for Figure 54.The DB Browser window in the Toad for Oracle DB Admin module running most of the database level The Database Browser serves as your show you the tablespaces that were entry point for running most of the most frequently read and written to in utilities in Toad. You database level utilities in Toad. You can the last 24 hours. And Toad gives you start a Health Check, look for the most this information in just a few seconds. can start a Health expensive sessions, start up or shut Additionally, you can use Toad to manage Check, look for the down the instance, all with a single click. the Statspack statistics collection jobs You can set up and run your database and the associated snapshots. most expensive backups with our Recovery Manager (RMAN) integration. Toad tip: Licensed for the Diagnostic sessions, start up Pack? Toad also offers an Automatic or shut down the Statspack browser (database > monitor > Workload Repository (AWR) browser statspack browser) and access to all of your ASH and instance, all with a Statspack allows you to see what was ADDM reports. happening in your database for a specific single click. period of time. For example, it can
Figure 55. Zooming into a chart allows you to highlight chart lines or export the data to Excel.
32 With Toad for Oracle you can visually inspect the contents Figure 56. Click on a query to see the binds variables and the values passed for execution. of your Trace files. This allows you to Trace file browser (database > diagnose > Even more help for DBAs: Toad™ DBA trace file browser) Suite for Oracle® immediately see Are you tired of using TKprof to Ask your Account Manager how you can analyze your trace files and see what get the Toad™ DBA Suite for Oracle® to all of the queries is causing your database performance access our award-winning tools for: captured with degradation? Toad lets you visually • Real-time diagnostics – Toad DBA Suite inspect the contents of your Trace files. for Oracle includes Spotlight® on Oracle® their binds, waits, This allows you to immediately see all (supports Data Guard, RAC, and and performance of the queries captured with their binds, Exadata environments). waits, and performance profiles. • Database activity record and replay – Toad profiles. DBA Suite for Oracle includes Benchmark Factory® for Oracle®.
Figure 57. Toad shows the number of queries that run for specific periods of time. Drill down to an individual statement to see the Execution vs. Parse vs. Fetch vs. Wait times so you know exactly how to approach a tuning scenario.
33 If you want to get data from Oracle to an Excel spreadsheet. There are two popular
ways you can do Figure 58. Export Data dialogue in Toad for Oracle this using Toad. • Reverse-engineering of existing databases What’s wrong with this method? for rich ER diagrams or creating new • You need to make sure Excel is open first. physical or logical models from scratch – • You won’t get any formatting (dates won’t Toad Data Modeler is also included. come over as ‘date’). • If you want to format the data in Excel after Additional tips the fact, there’s no way to automate that Ways to get data from Toad to Excel without creating a macro. You want to get data from Oracle to an Excel spreadsheet. You have Toad. There Export dataset – Delimited text are two popular ways you can do this; This may be your fastest option. The only each has its own advantages. Let’s take a caveat is certain datatypes may not play few moments to explore your options. nice. And of course it won’t be an XLS or XLSX file. This can take just about 25 Copy and paste seconds, not counting the time Excel This is the most popular but least took to load the file. effective option, often used by newer Toad users. Select your data in the grid, Ctrl+A, Ctrl+C, ALT+TAB, Ctrl+V, and voila, your data is now in Excel.
34 Have you ever needed to write a query and filter your results with a WHERE EXISTS or Figure 59. Toad for Oracle Connection dialog a WHERE IN list of
Oracle quick hit: You can Building your Where In () lists values? bypass TNSNames Have you ever needed to write a query Ever spin up a database for some quick and filter your results with a WHERE and dirty work, and you just want to EXISTS or a WHERE IN list of values? connect without going through the Your list will be comma delimited, whole “add the service to your local and you’ll need to quote the strings TNSNames.ORA rigmarole”? The Oracle appropriately. This is not so bad if you Net Configuration Assistant was one of have a few values, but what if you have the first Java-powered GUIs. It has been 42 or 420 or more? You are looking at improved greatly over the past few years, the data in Toad, and you want to just but there are still much faster ways to WISH it into a comma-delimited list (and connect to the database. maybe quoted), to feed into your: SELECT ... Yes, you can manage your TNSNames. FROM X ORA file manually using a text editor. WHERE Y IN ( But sometimes you know where the ‘a’, database is, and you just want to ‘b’, connect to it. Now. ‘c’, ‘d’, EZCONNECT ..., When you just want to connect, you can ‘n’ put all of the connectivity information ); in your connection string—no need to interface with TNS. AskTom was talking Surely there is a way to have Toad about this waaaay back in 2005, and build this list for you. Yes, there is—and Oracle has supported it since at least the you don’t even need to learn regular 8i release. expressions (REGEX – wiki). As an aside, we recommend you learn REGEX; Syntax it is definitely worth the investment of CONNECT username/password@[//] your time. host[:port][/service_name]
35 So what is a custom query? A custom query allows you to build dynamic Figure 60. Toad’s Export Data dialog SQL scripts using the selected list Custom queries second to look at the list for Tables: There are so many little nuggets in Toad there are 36 operations available. The of objects as your that you can take advantage of. To list very last entry is “Custom Queries.” all of them would be a daunting task. WHERE clause. Custom Queries is one that you may So what is a custom query? have overlooked. A custom query allows you to build If you right-click on an object in the dynamic SQL scripts using the selected Schema Browser, you’ll see a list of list of objects as your WHERE clause. operations you can perform. Take a Toad ships with a few of these already
Figure 61. Custom Query right-click menu selection in the Schema Browser
36 written for you. The custom comes into play when you create your own or tweak the defaults to match your needs.
Example If you need a quick inventory of constraints for a list of tables, you could select each table individually, go to the Constraints tab on the right side and create a report, but that would be several steps multiplied by the number of tables you need to audit. Instead, you can use a custom query to do this in just three steps: Toad for Oracle 1. Select your object(s) has more than a 2. Right-click | Custom Queries | Constraint Type Summary decade of feature 3. Execute the query that is pasted into the editor development and investment behind it. Getting more help with Toad Toad for Oracle has more than a decade of feature development and investment behind it. It has features that can’t be adequately covered or discussed, even in this long document. For more help, please consult the following resources: • Your sales representative. We are dedicated to keeping you and your company happy with its investment in the Toad solutions. Your sales rep can get your questions answered, provide insight into our solutions that will address your problems, provide evaluation copies of software, and help you manage your relationship with Dell Support. • Visit the toad-for-oracle product page. • Use www.toadworld.com, your free online resource for education, expertise, and collaboration. • The Toad Idea Pond allows you to vote on and provide your recommendations on what you’d like to see in Toad.
37 For More Information © 2013 Dell, Inc. ALL RIGHTS RESERVED. This document DELL ASSUMES NO LIABILITY WHATSOEVER AND DISCLAIMS contains proprietary information protected by copyright. No ANY EXPRESS, IMPLIED OR STATUTORY WARRANTY RELATING part of this document may be reproduced or transmitted in TO ITS PRODUCTS INCLUDING, BUT NOT LIMITED TO, THE any form or by any means, electronic or mechanical, including IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR photocopying and recording for any purpose without the A PARTICULAR PURPOSE, OR NON-INFRINGEMENT. IN NO written permission of Dell, Inc. (“Dell”). EVENT SHALL DELL BE LIABLE FOR ANY DIRECT, INDIRECT, CONSEQUENTIAL, PUNITIVE, SPECIAL OR INCIDENTAL Dell, Dell Software, the Dell Software logo and products—as DAMAGES (INCLUDING, WITHOUT LIMITATION, DAMAGES identified in this document—are registered trademarks of Dell, FOR LOSS OF PROFITS, BUSINESS INTERRUPTION OR LOSS Inc. in the U.S.A. and/or other countries. All other trademarks OF INFORMATION) ARISING OUT OF THE USE OR INABILITY and registered trademarks are property of their respective TO USE THIS DOCUMENT, EVEN IF DELL HAS BEEN ADVISED owners. OF THE POSSIBILITY OF SUCH DAMAGES. Dell makes no representations or warranties with respect to the accuracy or The information in this document is provided in connection completeness of the contents of this document and reserves with Dell products. No license, express or implied, by estoppel the right to make changes to specifications and product or otherwise, to any intellectual property right is granted by descriptions at any time without notice. Dell does not make this document or in connection with the sale of Dell products. any commitment to update the information contained in this EXCEPT AS SET FORTH IN DELL’S TERMS AND CONDITIONS AS document. SPECIFIED IN THE LICENSE AGREEMENT FOR THIS PRODUCT,
About Dell Dell Inc. (NASDAQ: DELL) listens to customers and delivers worldwide innovative technology, business solutions and services they trust and value. For more information, visit www.dell.com.
If you have any questions regarding your potential use of this material, contact:
Dell Software 5 Polaris Way Aliso Viejo, CA 92656 www.dell.com Refer to our Web site for regional and international office information.
38
TechBrief-Toad4OracleTips-US-KS-2013-07-08