Using Breakpoints

Topics in this section include:

A breakpoint is used to stop a PL/SQL program on the line where the breakpoint is set. You can use breakpoints to control the execution and debug the procedure.

When you run a PL/SQL program, the execution stops on each line with a breakpoint set. In this case, Data Studio retrieves information about the current program state, such as the values of the program variables.

Perform the following steps to debug a PL/SQL program:

  1. Set a breakpoint on the line where PL/SQL program needs to be stopped.
  2. Start the debugging session.

    When a line with a breakpoint set is reached, monitor the program state in the Debugging pane, and continue to execute the program.

  3. Close the debugging session.

Data Studio provides debugging options in the toolbar that help you step through the debugging objects.

Using the Breakpoints Pane

You can view and manage all breakpoints in the Breakpoints pane. Click the breakpoint option at the minimized pane to open the Breakpoints pane.

The Breakpoints pane lists all lines with a breakpoint set and the debugging object names.

You can enable or disable all the breakpoints by clicking in the Breakpoints pane. In the Breakpoints pane, you can select the breakpoint check box and click , , or to enable, disable or remove a specific breakpoint.

In the PL/SQL Viewer pane, double-click the required breakpoint in the Breakpoint Info column to locate the breakpoint.

  • When a breakpoint is disabled, the program will not be stopped at the breakpoint. The breakpoint will be retained and can be enabled later.
  • A removed breakpoint cannot be restored.
  • Press Alt+Y to copy the content of the Breakpoints pane.

Setting or Adding a Breakpoint on a Line

Perform the following steps to set or add a breakpoint on a line:

  1. Open the PL/SQL function on the line where you want to add a breakpoint.
  2. In the PL/SQL Viewer pane, double-click the breakpoint ruler on the left of the line number. If is displayed, the breakpoint has been added.

    If the function is not interrupted or stopped during debugging, the breakpoint set for the function will not be validated.

Enabling or Disabling a Breakpoint on a Line

Once a breakpoint is set, you can temporarily disable it by selecting the corresponding check box in the Breakpoints pane and clicking at the top of Breakpoints. A disabled breakpoint will be grayed out as in PL/SQL Viewer and Breakpoints panes. To enable a disabled breakpoint, select the corresponding check box and click .

Removing a Breakpoint from a Line

You can remove an unused breakpoint using the same method as that for creating a breakpoint.

In the PL/SQL Viewer pane, open the function in which you want to remove the breakpoint. Double-click in PL/SQL Viewer to remove the breakpoint.

You can also enable or disable breakpoints in PL/SQL Viewer using the preceding method.

Changing Source Code

If you debug an object after changing the source code obtained from the server, Data Studio displays an error.

You are advised to refresh the object and debug it again.

If you change the source code obtained from the server and execute or debug the source code without setting a breakpoint, the result of the source code obtained from the server will be displayed on Data Studio. You are advised to refresh the source code before executing or debugging it.

Debugging a PL/SQL Program Using a Breakpoint

Perform the following steps to debug a PL/SQL program using a breakpoint:

  1. Open the PL/SQL program and create a breakpoint on the line to be debugged.

    An example is as follows:

    Lines 11, 12, 13

  2. To start debugging, click or press Ctrl+D, or right-click the selected PL/SQL program in Object Browser and click Debug. In the Debug Function/Procedure dialog box, enter the parameter information.

    If no parameter is entered, the Debug Function/Procedure dialog box will not be displayed.

  3. Enter the information and click OK. Single quotation marks (') are mandatory for the parameters of varchar and date data types, but not mandatory for the parameters of numeric data type.

    To set the parameter to NULL, enter NULL or null.

    After clicking Debug, you will see pointing to the line where the breakpoint is set. This line is the first line where the execution resumes.

    You can terminate debugging by clicking in the toolbar, or pressing F10, or select Terminate Debugging in the Debug menu. After the debugging is complete, the function execution proceeds and will not be stopped at any breakpoint.

    Relevant information will be displayed in Callstack and Variables panes.

    The Variables pane shows the current values of variables. If you hover over the variable of a function/procedure, the current value is also displayed.

    You can step through the code using Step Into, Step Out or Step Over. For details, see Controlling Execution.

  4. Click to continue the execution till the next breakpoint (if any). The result of the executed PL/SQL program is displayed in the Result tab and the Callstack and Variables panes are cleared. You can click in the Result tab to copy the content of the tab.

    Perform the following operations to remove a breakpoint:

    • Double-click a breakpoint to remove it from PL/SQL Viewer.
    • Select the breakpoint in the breakpoint check box and click in the Breakpoints pane.

Rearranging the Variables Pane

You can arrange the Variables pane and its columns to the following positions:

When debugging is complete, the Variables pane will be minimized regardless of its position. If the Variables pane is moved next to the SQL Terminal or Result tab, you need to minimize the pane after debugging is complete. The position of the Variables pane remains unchanged after it is rearranged.

Enabling/Disabling System Variables

System variables are displayed by default in the Variables pane. You can disable the display of system variables if necessary.

  1. Click the button under Variables to disable the display of system variables.

    The button is toggled on by default.

Displaying Cached Parameters

When a PL/SQL function or procedure is debugged or executed, the same parameter values are used for the next debugging or execution.

When a PL/SQL object is executed, the following window is displayed.

The Value column is empty upon the first execution. Enter the values as required.

Click OK. The parameter values will be cached. The cached parameter values will be displayed in the next execution or debugging.

Once a specific connection is removed, all the cached parameter values are cleared.

Displaying Variable in the Monitor Pane

Data Studio displays the variables which are being monitored in the Monitor pane during debugging.

In the Monitor pane, add a variable in the following ways:

The Monitor pane can be dragged to anywhere in the Data Studio window.

Hovering Over a Variable to View Its Information During Debugging

When debugging a PL/SQL function in Data Studio, you can hover over a variable to view its information.

Supporting Rollback/Commit During Debugging

Data Studio allows committing or rolling back the PL/SQL query result after debugging is complete.

Perform the following steps to enable the rollback function:

  1. Check the Debug With Rollback box and enable the rollback function during PL/SQL debugging.

    Or

    Right-click the SQL Terminal pane where the PL/SQL function is executed.

    Select Debug With Rollback to enable the rollback function after the debugging is complete.

    Or

    Right-click any PL/SQL function under Functions/Procedures in Object Browser.

Parent topic: Debugging a PL/SQL Function