Skip to main content

Watch out for redundant code with WHILE loops

Generally, you should use a simple loop if you always want the body of the loop to execute at least once. You use a WHILE loop if you want to check before executing the body the first time. Since the WHILE loop performs its check “up front,” the variables in the boundary expression must be initialized. The code to initialize is often the same code needed to move to the next iteration in the WHILE loop. This redundancy creates a challenge in both debugging and maintaining the code: how do you remember to look at and update both?

If you find yourself writing and running the same code before the WHILE loop and at end of the WHILE loop body, consider switching to a simple loop.

Here's an example.
I write a procedure to calculate overdue charges for books; the maximum fine to be charged is $10, and I will stop processing when there are no overdue books for a given date. Here is my first attempt at the procedure body:

DECLARE
   l_fine PLS_INTEGER := 0;
   l_date DATE := SYSDATE;
   l_overdue_count NUMBER;
BEGIN
   l_overdue_count :=
      overdue_pkg.countem (
         borrower_id => borrower_in,
         l_date);
  
   WHILE (l_overdue_count > 0 AND l_fine < 10)
   LOOP
      update_fine_info (l_date, l_one_day_fine);

      l_fine := l_fine + l_one_day_fine;
      l_date := l_date + 1;

      l_overdue_count :=
         overdue_pkg.countem (
            borrower_id => borrower_in,
            l_date);
   END LOOP;
END;   

As is readily apparent, I duplicate the assignments of values to l_overdue_count. I would be far better off rewriting this code as follows:

DECLARE
   l_fine PLS_INTEGER := 0;
   l_date DATE := SYSDATE;
   l_overdue_count NUMBER;
BEGIN
   LOOP
      EXIT WHEN
        (l_overdue_count <= 0 OR l_fine >= 10)
     
      update_fine_info (l_date, l_one_day_fine);
     
      l_fine := l_fine + l_one_day_fine;
     
      l_date := l_date + 1;

      l_overdue_count :=
         overdue_pkg.countem (
            borrower_id => borrower_in,
            l_date);
   END LOOP;
END;   


By paying close attention to your loop construction, you can avoid redundant code, always bad news in a program, since it increases maintenance costs and the chance of introducing bugs into your code.

Comments

  1. Great tip Steven!

    There is a subtle difference between the two versions though... In your second example, l_overdue_count = NULL in the first iteration. It requires that one knows how nulls are handled in calculations and boolean evaluations, e.g:

    (null <= 0) evaluates to null
    (null or a) evaluates to a

    But in the case of AND
    (null and false) = false
    (null and true) = false
    This last one can surprise you if you're not paying attention ;)

    ReplyDelete
  2. @Rop, thanks for writing, but I need some clarification. When I execute this block:

    DECLARE
    PROCEDURE bplstr (str IN VARCHAR2, val IN BOOLEAN)
    IS
    BEGIN
    DBMS_OUTPUT.put_line (
    str
    || ' - '
    || CASE val
    WHEN TRUE THEN 'TRUE'
    WHEN FALSE THEN 'FALSE'
    ELSE 'NULL'
    END);
    END bplstr;
    BEGIN
    bplstr ('(NULL AND FALSE)', (NULL AND FALSE));
    bplstr ('(NULL AND TRUE)', (NULL AND TRUE));
    bplstr ('(NULL OR FALSE)', (NULL OR FALSE));
    bplstr ('(NULL OR TRUE)', (NULL OR TRUE));
    END;
    /

    I see:

    (NULL AND FALSE) - FALSE
    (NULL AND TRUE) - NULL
    (NULL OR FALSE) - NULL
    (NULL OR TRUE) - TRUE

    What do you see?

    ReplyDelete
  3. *Sigh* of course you're right... my output is the same as yours. I fell into my own trap while trying to be smart.

    I only used an if/then/else, like this:

    if (null and true) then
    dbms_output.put_line('true');
    else
    dbms_output.put_line('false');
    end if;

    This outputs 'false' when the actual value is null.
    Well... it shows how difficult it is to evaluate null conditions ;)

    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...

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, ...

The future of Oracle PL/SQL: some thoughts on Sten Vesterli's thoughts

Sten Vesterli published a very thought-provoking post on his blog: Please stop reading this post, and read that one. When you are done, come on back here for my thoughts on Sten's thoughts. OK. You read it. Here we go. First, thanks, Sten, for being such an interesting, wise, sometimes provocative voice in our community. Next, Sten writes: Now, on the one hand, I certainly agree that the vast majority of young developers are currently caught up in the modern version of a Gold Rush, which is: "Build an app using JavaScript, pay no attention to that database behind the curtain." But I can assure you that I still do meet young PL/SQL programmers, regularly, when I am at conferences and doing onsite presentations at companies. So, young person who writes PL/SQL: do not be afraid! You are not alone! And you are super-smart to have made the choice you did. :-) Next, Sten offers this advice to managers: I agree that PL/SQL is a "spec...