Skip to Content

Debugging Stored Procedures

Leveraging SQLScript in stored procedures, user-defined functions, and user-defined libraries.
You will learn
  • How to debug a procedure using the SQLScript debugger
rich-heilmanRich HeilmanJanuary 24, 2022
Created by
rich-heilman
February 11, 2021
Contributors
rich-heilman

Prerequisites

The debugging shown in this tutorial includes setting breakpoints, evaluating expressions and intermediate results.

  • Step 1
    1. Go to the Database Explorer page and right-click on the procedure called get_po_header_data and choose Open for Debugging.

      DBX
    2. Make sure the configuration is set as shown here and click OK.

      apply
  • Step 2
    1. Set breakpoints at the lines shown here by simply clicking on the line number.

      breakpoints
    2. Right click on the procedure and choose Generate Call Statement

      invoke
    3. A new SQL tab will be opened. Click on the Run button.

      SQL tab
  • Step 3
    1. Execution of the procedure has started, and a debugger pane is now visible which is displayed on the right. You can see all of the variables and parameters for this procedure. You might notice that this pane is currently not showing the intermediate table variables at this point.

      execute procedure
    2. Click the Step Over button.

      step over
    3. You will notice that execution has continued to the next statement. In the debugger pane, a new local variable has been added. This is because it is not defined explicitly and will be implicitly declared at runtime during first usage.

      next step
    4. To see the data for this intermediate table variable, select it and click Display Content

      display content
    5. A new window is then opened showing the data in the table. Review the data and close the window by clicking Close

      review data
  • Step 4
    1. Click the Expression tab and click + button.

      toggle expression editor
    2. In the following window, enter a SELECT statement as shown here and hit Add.

      expressions
    3. You will notice the expression is then added to the “Expressions” section. Select the expression and click Display Content.

      display content
    4. Review the results and close the window.

      review results
  • Step 5
    1. Once again click the Step Over button. Notice the next intermediate table variables is also added. You can review the data in this table as well.

      step over
    2. Continue to step through the code and when execution stops at the END statement of the procedure, display the contents of the output parameter the same way you did for the intermediate table variables. Finally, close the window by clicking the Close.

      continue steps
    3. Click the Resume button.

      resume
    4. Execution of the procedure is now completed. Return to the SQL tab and check the results.

      results
Back to top