Call (800) 766-1884 for Oracle support & training
Free Oracle Tips


Oracle Consulting Support
Oracle Upgrades
Use New Oracle Features
Oracle Replication Support
Oracle Training
Remote Oracle DBA
System Documentation
Oracle Tips
Oracle Performance
 

Free Oracle Tips


 

HTML Text

BC Oracle tuning

Oracle training

Oracle support

Remote Oracle

 

 

   
 

Documenting Triggers
Oracle Tips by Burleson
 

Documentation for a trigger is quite similar to the documentation for a procedure, function, or package. However, some differences do come into play, such as:

  • Triggers don’t have parameters.

  • Triggers are always public objects.

  • Triggers always fire whenever the conditions are right.

  • Triggers often implement unusual code to work around mutating table errors.

The basics of writing good documentation for your code remain the same, regardless of what type of stored PL/SQL object you’re writing. The proper use of a header, pseudocode, commenting, and meaningfully named identifiers all contribute to communicating the purpose and functionality of your trigger to the person who must maintain the code. The use of commenting, identifier names, and pseudocode are discussed in detail earlier in this book. So, let’s skip those topics here and take a look at the trigger header.

Trigger Header

Your trigger’s header must provide certain information about the trigger. The header for a trigger, like the header for a procedure or function, needs to describe the code and its purpose. These are some of the questions that the header should answer:

  • With which table is the trigger associated?

  • What type(s) of DML statement causes the trigger to fire?

  • If the trigger is an UPDATE trigger, does it fire for any particular columns?

  • What error conditions can be raised from the trigger?

  • Through which hoops does the trigger jump to avoid mutating table errors?

Listing 7.17 shows an example of a header that deals with each of these issues.

Listing 7.17 A sample header for a trigger.

-- ******************************************************************
-- Description: The ENROLLED_CLASSES_ARIU trigger fires whenever a --   
   row is created or modified in the ENROLLED_CLASSES table. The
--   trigger determines the student's current academic level and 
--   the minimum academic level for the course. If the minimum level
--   for the course exceeds the student's academic level, the 
--   exception xSTUDENT_NOT_QUALIFIED is raised and the transaction
--   is aborted.
--
-- Fires: On an INSERT or UPDATE of the ENROLLED_CLASSES table, for
--        every new or modified row
-- 
-- REVISION HISTORY
-- Date         Author      Reason for Change
-- ------------------------------------------------------------------
-- 21 APR 1997  J. Ingram   Trigger created.
-- ******************************************************************

 

               
This is an excerpt from the book "High Performance Oracle Database Automation" by Jonathan Ingram and Donald K. Burleson, Series Editor.

  
 

Oracle performance tuning software 
 
 
 
 

Oracle performance tuning book

 

 
 
 
Oracle performance Tuning 10g reference poster
 
 
 
Oracle training in Linux commands
 
Oracle training Excel
 
Oracle training & performance tuning books
 

 

   

Copyright © 1996 -  2014 by Burleson. All rights reserved.

Oracle® is the registered trademark of Oracle Corporation. 

Hit Counter