Skip to main content

One exception handler for all packaged subprograms?


This question was submitted as a comment in one of my videos today:
Do we have to include an exception section for each individual subprogram or can we have a single handler for all subprograms?
The quick answer is: if you want an exception raised in a procedure or function defined in a package, you need to add an exception to that subprogram.

I can certainly see why this question would come up. A package body can have its own exception handler. Here's an example:
CREATE OR REPLACE PACKAGE pkg
   AUTHID DEFINER
IS
   PROCEDURE proc;
END;
/

CREATE OR REPLACE PACKAGE BODY pkg
IS
   PROCEDURE proc
   IS
   BEGIN
      RAISE NO_DATA_FOUND;
   END;
BEGIN
   NULL;
EXCEPTION
   WHEN NO_DATA_FOUND
   THEN
      DBMS_OUTPUT.put_line ('Was proc executed?');
END;
/
And it kinda, sorta looks like if I execute the following block, I will see "Was proc executed?" on my screen.
BEGIN
   pkg.proc;
END;
/
But I would be wrong. Instead, I will see:
ORA-01403: no data found
ORA-06512: at "QDB_PROD.PKG", line 6
But, but, but....what's going on here? I explicitly handle NO_DATA_FOUND right there at the bottom of the package.

What's going on is that the exception handler only looks like it is a handler for the entire package. In actually, it can only possibly handle exceptions raised by the executable code between the BEGIN and EXCEPTION keywords underneath the proc procedure.

This is called the initialization section of the package.  It is designed - you guessed it - initialize the state of the package (set values, perform QA checks, etc.). It runs once per session to initialize the package.

HOWEVER: in stateless environments like websites, this code may well execute each time a user references a package element (runs a subprogram, gets the value of a variable). So these days, it would be rare to find an initialization section in a package, and probably something to generally avoid.

The bottom line when it comes to exception handling for subprograms in a package is simple: you must include an exception section in each of those subprograms. The code that is executed in each of those subprograms could be shared. And should be. You should use a generic error logging API like the open source Logger, so that everyone handles, logs and re-raises exceptions in the same way.


Labels:

Comments

  1. ErwinApril 3, 2019 at 12:05 AM

    For a moment I thought there was a feature I had actually overlooked all those years and wasn't aware of. Glad to see I've been implementing exception handling in my packages the right way after all. ;-)

    ReplyDelete
  2. iudithApril 3, 2019 at 1:18 PM

    I just watched the recording of yesterday's Office Hours and I understood that the question was also about the alternatives available when having a call stack of several procedures: to handle each exception locally vs to let everything to propagate to the outermost level.
    Maybe a good topic for a deeper insight in one of the upcoming Office Hours sessions :)

    Thanks a lot & Best Regards,
    Iudith Mentzel

    ReplyDelete

Post a Comment

Popular posts from this blog

Why DBMS_OUTPUT.PUT_LINE should not be in your application code

A database developer recently came across my  Bulletproof PL/SQL  presentation, which includes this slide. That first item in the list caught his attention: Never put calls to DBMS_OUTPUT.PUT_LINE in your application code. So he sent me an email asking why I would say that. Well, I suppose that is the problem with publishing slide decks. All the explanatory verbiage is missing. I suppose maybe I should do a video. :-) But in the meantime, allow me to explain. First, what does DBMS_OUTPUT.PUT_LINE do? It writes text out to a buffer, and when your current PL/SQL block terminates, the buffer is displayed on your screen. [Note: there can be more to it than that. For example, you could in your own code call DBMS_OUTPUT.GET_LINE(S) to get the contents of the buffer and do something with it, but I will keep things simple right now.] Second, if I am telling you not to use this built-in, how could text from your program be displayed on your screen? Not without a lot o...
4 comments
Read more

How to Pick the Limit for BULK COLLECT

This question rolled into my In Box today: In the case of using the LIMIT clause of BULK COLLECT, how do we decide what value to use for the limit? First I give the quick answer, then I provide support for that answer Quick Answer Start with 100. That's the default (and only) setting for cursor FOR loop optimizations. It offers a sweet spot of improved performance over row-by-row and not-too-much PGA memory consumption. Test to see if that's fast enough (likely will be for many cases). If not, try higher values until you reach the performance level you need - and you are not consuming too much PGA memory.  Don't hard-code the limit value: make it a parameter to your subprogram or a constant in a package specification. Don't put anything in the collection you don't need. [from Giulio Dottorini] Remember: each session that runs this code will use that amount of memory. Background When you use BULK COLLECT, you retrieve more than row with each fetch, ...
4 comments
Read more

Table Functions, Part 1: Introduction and Exploration

Please do feel encouraged to read this and my other posts on table functions, but you will learn much more about table functions by taking my Get Started with PL/SQL Table Functions class at the Oracle Dev Gym. Videos, tutorials and quizzes - then print a certificate when you are done! Table functions - functions that can be called in the FROM clause of a query from inside the TABLE operator - are fascinating and incredibly helpful constructs. So I've decided to write a series of blog posts on them: how to build them, how to use them, issues you might run into. Of course, I am not the first to do so. I encourage to check out the  documentation , as well as excellent posts from Adrian Billington (search for "table functions") and Tim Hall . Adrian and Tim mostly focus on pipelined table functions, a specialized variant of table functions designed to improve performance and reduce PGA consumption. I will take a look at pipelined table functions in the latter part...
31 comments
Read more