yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
a41a4e0331fbc0beff63bb28fa59228cc9a751df
doc-exports/docs/dws/tool/DWS_DS_015.html
luhuayi a5e3903f6b DWS TG 910.211 version 
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com>
Co-authored-by: luhuayi <luhuayi@huawei.com>
Co-committed-by: luhuayi <luhuayi@huawei.com>
2025-04-23 13:53:01 +00:00

193 lines
43 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0000001860318801"></a><a name="EN-US_TOPIC_0000001860318801"></a>
<h1 class="topictitle1">Function/Procedure Management</h1>
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000001860318801__section68711411151818"><h4 class="sectiontitle">Creating a Function/Procedure</h4><ol id="EN-US_TOPIC_0000001860318801__ol88661720111813"><li id="EN-US_TOPIC_0000001860318801__li286632010187"><span>In the <strong id="EN-US_TOPIC_0000001860318801__b19197163151712">Object Browser </strong>pane, right-click <strong id="EN-US_TOPIC_0000001860318801__b51978315174">Functions/Procedures</strong> under the schema where you want to create the function/procedure. Then select <strong id="EN-US_TOPIC_0000001860318801__b181971731161716">Create Function</strong>, <strong id="EN-US_TOPIC_0000001860318801__b151971631141716">Create SQL Function</strong>, <strong id="EN-US_TOPIC_0000001860318801__b121981931151720">Create Procedure</strong>, or <strong id="EN-US_TOPIC_0000001860318801__b16198331201719">Create C Function</strong> as required.</span><p><p id="EN-US_TOPIC_0000001860318801__p15975113214327">Right-click <strong id="EN-US_TOPIC_0000001860318801__b193694912222848">Functions/Procedures</strong> and a menu is displayed.</p>
<p id="EN-US_TOPIC_0000001860318801__p1362114341327"><span><img id="EN-US_TOPIC_0000001860318801__image1470631164018" src="figure/en-us_image_0000001813439448.png"></span></p>
<p id="EN-US_TOPIC_0000001860318801__p1103736142418"></p>
</p></li><li id="EN-US_TOPIC_0000001860318801__li258232183112"><span>The selected template is displayed in the new tab of Data Studio.</span><p><p id="EN-US_TOPIC_0000001860318801__p199791447779"><span><img id="EN-US_TOPIC_0000001860318801__image149229546134" src="figure/en-us_image_0000001813599232.png" width="455.988239" height="227.353259" title="Click to enlarge" class="imgResize"></span></p>
<p id="EN-US_TOPIC_0000001860318801__p6248838175"></p>
</p></li><li id="EN-US_TOPIC_0000001860318801__li17866120181818"><span>After adding a function or procedure, you can choose <strong id="EN-US_TOPIC_0000001860318801__b1728018212514">Run</strong> &gt; <strong id="EN-US_TOPIC_0000001860318801__b3134206102515">Compile/Execute Statement</strong> from the main menu or right-click the tab and select <strong id="EN-US_TOPIC_0000001860318801__b7130163013246">Compile</strong> to compile the function or procedure.</span><p><p id="EN-US_TOPIC_0000001860318801__p9700954159"><span><img id="EN-US_TOPIC_0000001860318801__image13612136201514" src="figure/en-us_image_0000001813439468.png" width="420.060151" height="385.65544500000004" title="Click to enlarge" class="imgResize"></span></p>
<p id="EN-US_TOPIC_0000001860318801__p1617815558387"></p>
</p></li><li id="EN-US_TOPIC_0000001860318801__li13507115881415"><span>The new function/procedure is displayed under <strong id="EN-US_TOPIC_0000001860318801__b9594171702611">Object Browser</strong>.</span><p><div class="note" id="EN-US_TOPIC_0000001860318801__note1486742013188"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="EN-US_TOPIC_0000001860318801__ul198676204189"><li id="EN-US_TOPIC_0000001860318801__li13631535182916">The asterisk (*) next to the procedure name indicates that the procedure is not compiled or added to <strong id="EN-US_TOPIC_0000001860318801__b2679144112618">Object Browser</strong>.</li><li id="EN-US_TOPIC_0000001860318801__li4583941162919">Refresh <strong id="EN-US_TOPIC_0000001860318801__b1491035072616">Object Browser</strong> by pressing <strong id="EN-US_TOPIC_0000001860318801__b391117502269">F5</strong> to view the newly added debugging object.</li><li id="EN-US_TOPIC_0000001860318801__li19867152031815">C functions do not support debugging operations.</li><li id="EN-US_TOPIC_0000001860318801__li1786782017181">A pop-up message displays the status of the completed operation, which is not displayed in the status bar.</li></ul>
</div></div>
</p></li></ol>
</div>
<div class="section" id="EN-US_TOPIC_0000001860318801__section256355715401"><h4 class="sectiontitle">Editing a Function/Procedure</h4><ol id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264881_ol8840353"><li id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264881_li12454319"><span>In the <strong id="EN-US_TOPIC_0000001860318801__b156152752720">Object Browser</strong> pane, double-click or right-click the required function/procedure or SQL function and select <strong id="EN-US_TOPIC_0000001860318801__b56112702720">View Source</strong>.</span><p><p id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264881_p57488204114123">The selected function/procedure or SQL function is displayed in the <strong id="EN-US_TOPIC_0000001860318801__b167473362275">PL/SQL Viewer</strong> tab page.</p>
<p id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264881_p3659812114134"><span><img id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264881_image51440871175957" src="figure/en-us_image_0000001813439436.jpg" width="384.0375" height="160.5975" title="Click to enlarge" class="imgResize"></span></p>
<div class="note" id="EN-US_TOPIC_0000001860318801__note8574819104019"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="EN-US_TOPIC_0000001860318801__ul3352133004020"><li id="EN-US_TOPIC_0000001860318801__li835214302407">You must refresh <strong id="EN-US_TOPIC_0000001860318801__b9607552132712">Object Browser</strong> to view the latest DDL.</li><li id="EN-US_TOPIC_0000001860318801__li1622263234013">If multiple functions/procedures or SQL functions have the same schema, name, and input parameters, only one of them can be opened at a time.</li></ul>
</div></div>
</p></li><li id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264881_ole_link54"><span>After editing or updating, compile and execute the PL/SQL program or SQL function.</span><p><p id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264881_p28404845155628">If you execute the function/procedure or SQL function before compilation, the <strong id="EN-US_TOPIC_0000001860318801__b185996591296">Source Code Change</strong> dialog box is displayed.</p>
</p></li><li id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264881_li33374275155648"><span>Click <strong id="EN-US_TOPIC_0000001860318801__b326782812309">Yes</strong> to compile and execute the PL/SQL function/procedure. The status of the completed operation is displayed in the <strong id="EN-US_TOPIC_0000001860318801__b146733883019">Message</strong> tab page.</span></li><li id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264881_li6053677"><span>After compiling the function/procedure or SQL function, press <strong id="EN-US_TOPIC_0000001860318801__b14597444113018">F5</strong> to refresh <strong id="EN-US_TOPIC_0000001860318801__b8597444123015">Object Browser</strong> to view the updated code.</span></li></ol>
</div>
<div class="section" id="EN-US_TOPIC_0000001860318801__section5412151215416"><h4 class="sectiontitle">Granting or Revoking a Permission</h4><ol id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264844_ol54022224212"><li id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264844_li222516181158"><span>Right-click <strong id="EN-US_TOPIC_0000001860318801__b711252711311">Function/Procedure Group</strong> and select <strong id="EN-US_TOPIC_0000001860318801__b151131627123113">Grant/Revoke</strong>. The <strong id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264844_b16941119553">Grant/Revoke</strong> dialog box is displayed.</span></li><li id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264844_li1851919178165"><span>Open the <strong id="EN-US_TOPIC_0000001860318801__b62051151103113">Object Selection</strong> tab to select the desired objects, and click <strong id="EN-US_TOPIC_0000001860318801__b920515517313">Next</strong>.</span></li><li id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264907_li1285194971613"><span>The <strong id="EN-US_TOPIC_0000001860318801__b162891754401">Privilege Selection</strong> tab is displayed. Select the role from the <strong id="EN-US_TOPIC_0000001860318801__b7191322403">Role</strong> drop-down list.</span></li><li id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264907_li1366271912272"><span>On the <strong id="EN-US_TOPIC_0000001860318801__b67251424174012">SQL Preview</strong> tab, you can check the automatically generated SQL query. If the result does not meet the expectation, return to the previous step until the result meets the expectation.</span></li><li id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264844_li88071635142816"><span>Click <strong id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264844_b104559431358">Finish</strong>.</span></li></ol>
</div>
<div class="section" id="EN-US_TOPIC_0000001860318801__section13152122917440"><h4 class="sectiontitle">Debugging a Function/Procedure</h4><p id="EN-US_TOPIC_0000001860318801__p10476193019448">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 a line with a breakpoint set is reached, the PL/SQL program on this line will be stopped, and you can perform other debugging operations.</p>
<ul id="EN-US_TOPIC_0000001860318801__ul156491848104718"><li id="EN-US_TOPIC_0000001860318801__li14725174395518">Setting or Adding a Breakpoint on a Line<p id="EN-US_TOPIC_0000001860318801__p1243617146562"><a name="EN-US_TOPIC_0000001860318801__li14725174395518"></a><a name="li14725174395518"></a>Data Studio allows you to set or add breakpoints on a line.</p>
<p id="EN-US_TOPIC_0000001860318801__p194031328125610">Open the function or procedure for which you want to add a breakpoint, double-click the breakpoint ruler on the left of the line number field, and set a breakpoint. If the breakpoint is enabled, the operation is successful. If the function is not interrupted or stopped during debugging, the breakpoint set for the function is not validated.</p>
</li><li id="EN-US_TOPIC_0000001860318801__li56491848194720">Using the Breakpoints Pane<p id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264940_p63140893165612"><a name="EN-US_TOPIC_0000001860318801__li56491848194720"></a><a name="li56491848194720"></a>You can view and manage all breakpoints in the <strong id="EN-US_TOPIC_0000001860318801__b4574850112920">Breakpoints</strong> pane. Click the breakpoint option at the minimized pane to open the <strong id="EN-US_TOPIC_0000001860318801__b2688182514305">Breakpoints</strong> pane.</p>
<p id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264940_p39478833165612">You can enable, disable or remove a specific breakpoint by selecting the breakpoint check box and clicking the enabling, disabling, and removing icon in the <strong id="EN-US_TOPIC_0000001860318801__b84811853143217">Breakpoints</strong> pane. You can also double-click the breakpoint ruler on the left of the line number field to set a breakpoint or double-click the breakpoint icon to delete the breakpoint.</p>
<p id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264940_p15266149165612">In the <strong id="EN-US_TOPIC_0000001860318801__b18470152393715">PL/SQL Viewer</strong> pane, double-click the required breakpoint in the <strong id="EN-US_TOPIC_0000001860318801__b1747118231377">Breakpoint Info</strong> column to locate the breakpoint.</p>
<p id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264940_p1479162016284"><span><img id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264940_image6793207287" src="figure/en-us_image_0000001813439456.jpg"></span></p>
<p id="EN-US_TOPIC_0000001860318801__p1526164717490"></p>
<div class="note" id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264940_note43179391165632"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264940_ul7521634165643"><li id="EN-US_TOPIC_0000001860318801__li17444258548">The <strong id="EN-US_TOPIC_0000001860318801__b101094973815">Breakpoints</strong> pane lists each breakpoint with the row number and the debug object name.</li><li id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264940_li585842165643">When a breakpoint is disabled, the program will not be stopped at the breakpoint. The breakpoint will be retained and can be enabled later.</li><li id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264940_li5272584165643">A removed breakpoint cannot be restored.</li><li id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264940_li31697881165648">Press <strong id="EN-US_TOPIC_0000001860318801__b6304181353915">Alt+Y</strong> to copy the content of the <strong id="EN-US_TOPIC_0000001860318801__b183051413133915">Breakpoints</strong> pane.</li></ul>
</div></div>
</li></ul>
<ul id="EN-US_TOPIC_0000001860318801__ul635472714507"><li id="EN-US_TOPIC_0000001860318801__li5354182715015">Changing Source Code<p id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264940_p368116841743"><a name="EN-US_TOPIC_0000001860318801__li5354182715015"></a><a name="li5354182715015"></a>During debugging, if the source code is changed after it is fetched from the server and the debugging is continued, Data Studio displays an error. You are advised to refresh the object and perform the debug operation again.</p>
<p id="EN-US_TOPIC_0000001860318801__p10450163018220">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.</p>
</li><li id="EN-US_TOPIC_0000001860318801__li13354172719504">Using Breakpoints to Debug Functions/Procedures<p id="EN-US_TOPIC_0000001860318801__p745017226315"><a name="EN-US_TOPIC_0000001860318801__li13354172719504"></a><a name="li13354172719504"></a>After adding a breakpoint in the row you want to debug, click the debug icon or right-click the selected function in <strong id="EN-US_TOPIC_0000001860318801__b34704522502">Object Browser</strong> and select <strong id="EN-US_TOPIC_0000001860318801__b24832114518">Debug</strong>. In the <strong id="EN-US_TOPIC_0000001860318801__b4287151818444">Debug Function/Procedure</strong> dialog box, enter the parameter information.</p>
<p id="EN-US_TOPIC_0000001860318801__p2824744152416"><span><img id="EN-US_TOPIC_0000001860318801__image1524115456248" width="446.67757400000005" src="figure/en-us_image_0000001813599220.png" height="220.27593000000002" title="Click to enlarge" class="imgResize"></span></p>
<p id="EN-US_TOPIC_0000001860318801__p16530135063318"></p>
<div class="note" id="EN-US_TOPIC_0000001860318801__note1385818457819"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="EN-US_TOPIC_0000001860318801__ul413324014113"><li id="EN-US_TOPIC_0000001860318801__li19134104021112">If no parameter is entered, the <strong id="EN-US_TOPIC_0000001860318801__b19676108184514">Debug Function/Procedure</strong> dialog box will not be displayed.</li><li id="EN-US_TOPIC_0000001860318801__li10511241201112">Single quotation marks (') are mandatory for the parameters of <strong id="EN-US_TOPIC_0000001860318801__b4803121584519">varchar</strong> and <strong id="EN-US_TOPIC_0000001860318801__b980371510456">date</strong> data types, but not mandatory for the parameters of <strong id="EN-US_TOPIC_0000001860318801__b380431515455">numeric</strong> data type. To set the parameter to <strong id="EN-US_TOPIC_0000001860318801__b1073883113458">NULL</strong>, enter <strong id="EN-US_TOPIC_0000001860318801__b973833116454">NULL</strong> or <strong id="EN-US_TOPIC_0000001860318801__b137398319458">null</strong>.</li><li id="EN-US_TOPIC_0000001860318801__li732914982510">When a function or procedure is debugged or executed, the same parameter values are used for the next debugging or execution. The <strong id="EN-US_TOPIC_0000001860318801__b69612528513">Value</strong> column is empty upon the first execution. Enter the values as required. Click <strong id="EN-US_TOPIC_0000001860318801__b1253226135220">OK</strong>. 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.</li></ul>
</div></div>
<ul id="EN-US_TOPIC_0000001860318801__ul20334165420199"><li id="EN-US_TOPIC_0000001860318801__li540448121920">The <strong id="EN-US_TOPIC_0000001860318801__b19999146195512">Callstack</strong> pane is populated.<p id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264940_p6112518917822"><span><img id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264940_image1434216617823" width="332.46675" src="figure/en-us_image_0000001860199297.jpg" height="309.624" title="Click to enlarge" class="imgResize"></span></p>
</li><li id="EN-US_TOPIC_0000001860318801__li58081574193">The <strong id="EN-US_TOPIC_0000001860318801__b19364134110564">Variables</strong> pane shows the current value of variables. If you hover over the variable of a function/procedure, the current value is also displayed. System variables are displayed by default in the <strong id="EN-US_TOPIC_0000001860318801__b0994207175716">Variables</strong> pane. You can disable the display of system variables if necessary. The button is toggled on by default.<p id="EN-US_TOPIC_0000001860318801__p7253207101420"><span><img id="EN-US_TOPIC_0000001860318801__image3140185714206" src="figure/en-us_image_0000001860199321.png" width="465.5" height="257.1023" title="Click to enlarge" class="imgResize"></span></p>
<p id="EN-US_TOPIC_0000001860318801__p41192202317"></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264399_table43039893194712" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264399_row47355305194712"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.4.4.2.5.2.5.1.3.1.1"><p id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264399_p51166987194723"><strong id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264399_b439114455517">Setting/Displaying Variables</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="70%" id="mcps1.3.4.4.2.5.2.5.1.3.1.2"><p id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264399_p50885316194723"><strong id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264399_b186161988556">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264399_row55623333194712"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.4.4.2.5.2.5.1.3.1.1 "><p id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264399_p51302847194723">Setting a variable to <strong id="EN-US_TOPIC_0000001860318801__b12135535319">NULL</strong></p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.4.4.2.5.2.5.1.3.1.2 "><ol id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264399_ol59724911257"><li id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264399_li557912148110">Double-click a variable value in the <strong id="EN-US_TOPIC_0000001860318801__b72541815319">Variables</strong> pane.<p id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264399_p17610182561115">A dialog box is displayed.</p>
</li><li id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264399_li4235539191111">Set the variable to an empty value.</li></ol>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264399_row60174080194712"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.4.4.2.5.2.5.1.3.1.1 "><p id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264399_p51284837194723">Setting a string value</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.4.4.2.5.2.5.1.3.1.2 "><p id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264399_p60431150194723">Some examples are as follows:</p>
<ul id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264399_ul7009439194723"><li id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264399_li9607368194723">To set the value to <strong id="EN-US_TOPIC_0000001860318801__b63018541941">abc</strong>, enter <strong id="EN-US_TOPIC_0000001860318801__b13305541144">abc</strong>.</li><li id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264399_li19357451194723">To set the value to <strong id="EN-US_TOPIC_0000001860318801__b1357153319718">Master's Degree</strong>, enter <strong id="EN-US_TOPIC_0000001860318801__b125716334711">Master's Degree</strong>.</li><li id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264399_li195471811191220">To set the value as text (<strong id="EN-US_TOPIC_0000001860318801__b96839917515">NULL</strong>), set it to <strong id="EN-US_TOPIC_0000001860318801__b86833920514">NULL</strong> in the <strong id="EN-US_TOPIC_0000001860318801__b168411910512">Variables</strong> pane.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264399_row6237976194712"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.4.4.2.5.2.5.1.3.1.1 "><p id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264399_p18720932194723">Setting a <strong id="EN-US_TOPIC_0000001860318801__b9240182010519">BOOLEAN</strong> value</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.4.4.2.5.2.5.1.3.1.2 "><p id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264399_p40000543194723">Enclose the <strong id="EN-US_TOPIC_0000001860318801__b208085251511">BOOLEAN</strong> value <strong id="EN-US_TOPIC_0000001860318801__b168091825157">t</strong> or <strong id="EN-US_TOPIC_0000001860318801__b6809102516510">f</strong> within single quotation marks ('). For example, to set <strong id="EN-US_TOPIC_0000001860318801__b043923815516">t</strong> to a <strong id="EN-US_TOPIC_0000001860318801__b114401387519">BOOLEAN</strong> variable, enter <strong id="EN-US_TOPIC_0000001860318801__b14403381511">'t'</strong> in the <strong id="EN-US_TOPIC_0000001860318801__b744012382512">Value</strong> column.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264399_row52821450194712"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.4.4.2.5.2.5.1.3.1.1 "><p id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264399_p28524206194723">Displaying a variable value</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.4.4.2.5.2.5.1.3.1.2 "><p id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264399_p28759358194723">If the variable value is <strong id="EN-US_TOPIC_0000001860318801__b898712873311">NULL</strong>, it will be displayed as <strong id="EN-US_TOPIC_0000001860318801__b098714286337">NULL</strong>.</p>
<p id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264399_p47806642194723">If the variable value is <strong id="EN-US_TOPIC_0000001860318801__b6465141865">NULL</strong>, it will be displayed as empty.</p>
<p id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264399_p47132787194723">If the variable value is set to a string, for example, <strong id="EN-US_TOPIC_0000001860318801__b1989216131564">abc</strong>, it will be displayed as <strong id="EN-US_TOPIC_0000001860318801__b108921413166">abc</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0000001860318801__li1430164011285">During function/procedure debugging, right-click the variable to be added in the editor and choose <strong id="EN-US_TOPIC_0000001860318801__b567018375610">Add Variable To Monitor</strong> in the menu displayed. If the variable is monitored, its value in the <strong id="EN-US_TOPIC_0000001860318801__b1246545418617">Monitor</strong> pane will always be the same as that in the <strong id="EN-US_TOPIC_0000001860318801__b1546519541763">Variables</strong> pane.</li><li id="EN-US_TOPIC_0000001860318801__li1457785152611">In Data Studio, variable information is displayed if the cursor is hovered over that variable during the debugging of PL/SQL functions.</li></ul>
</li><li id="EN-US_TOPIC_0000001860318801__li1535412718503">Terminating Debugging<p id="EN-US_TOPIC_0000001860318801__p111481333111310"><a name="EN-US_TOPIC_0000001860318801__li1535412718503"></a><a name="li1535412718503"></a>Click the terminating debugging button on the toolbar or choose <strong id="EN-US_TOPIC_0000001860318801__b1446855711013">Debug</strong> &gt; <strong id="EN-US_TOPIC_0000001860318801__b1147514119010">Terminate Debugging</strong>. After the debugging is complete, the function execution proceeds and will not be stopped at any breakpoint.</p>
<p id="EN-US_TOPIC_0000001860318801__p1720182410188">After the debugging is complete, the result tab page displays the function execution result, and the <strong id="EN-US_TOPIC_0000001860318801__b716164181613">Callstack</strong> and <strong id="EN-US_TOPIC_0000001860318801__b5353154513161">Variables</strong> panes are cleared. </p>
</li><li id="EN-US_TOPIC_0000001860318801__li1644232417334">Data Studio provides the option to commit/rollback the query execution result after debugging is finished. Right-click the <strong id="EN-US_TOPIC_0000001860318801__b20412123412224">SQL Terminal</strong> window where the function is executed. Select <strong id="EN-US_TOPIC_0000001860318801__b2678172432220">Debug With Rollback</strong> to enable the rollback function after the debugging is complete.<ul id="EN-US_TOPIC_0000001860318801__ul351415376330"><li id="EN-US_TOPIC_0000001860318801__li20514937103315">If <strong id="EN-US_TOPIC_0000001860318801__b1035715392214">Debug With Rollback</strong> option is enabled, the function execution result after debugging is not saved to the database.</li><li id="EN-US_TOPIC_0000001860318801__li35141237173314">If <strong id="EN-US_TOPIC_0000001860318801__b2516171115235">Debug With Rollback</strong> option is disabled, the function execution result after debugging is submitted to the database.</li></ul>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001860318801__section53008321810"><h4 class="sectiontitle">Controlling Execution</h4><ul id="EN-US_TOPIC_0000001860318801__ul9117457482"><li id="EN-US_TOPIC_0000001860318801__li81175577810">Single Stepping a PL/SQL Function<p id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264594_p45527359"><a name="EN-US_TOPIC_0000001860318801__li81175577810"></a><a name="li81175577810"></a>You can run the command for single stepping in the toolbar to debug a function. This allows you to debug the program line by line. When a breakpoint occurs during the operation of single stepping, the operation will be suspended and the program will be stopped.</p>
<p id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264594_p3770133983420">Single stepping means executing one statement at a time. Once a statement is executed, you can see the execution result in other debugging tabs.</p>
<div class="note" id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264594_note63837475"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p class="text" id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264594_p37666363">A maximum of 100 <strong id="EN-US_TOPIC_0000001860318801__b20479739266">PL/SQL Viewer</strong> tabs can be displayed at a time. If more than 100 tabs are opened, the tabs of function calls will be closed. For example, if 100 tabs are opened and a new debugging object is called, Data Studio will close the tabs of function calls and open the tab of the new debugging object.</p>
</div></div>
</li><li id="EN-US_TOPIC_0000001860318801__li25738211100">Step into<p id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264594_p012893682011"><a name="EN-US_TOPIC_0000001860318801__li25738211100"></a><a name="li25738211100"></a>To step through code one statement at a time, select <strong id="EN-US_TOPIC_0000001860318801__b0178163723613">Step Into</strong> from the <strong id="EN-US_TOPIC_0000001860318801__b8312639173617">Debug</strong> menu.</p>
<p id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264594_p1763915407369">When stepping into a function, Data Studio executes the current statement and then enters the break mode. The debug position will be indicated by an arrow <span><img id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264594_image1863904083618" width="14.9625" height="12.967500000000001" src="figure/en-us_image_0000001813439464.jpg" title="Click to enlarge" class="imgResize"></span> on the left ruler pane. If the execution statement calls another function, Data Studio will step into that function. Once you have stepped through all the statements in that function, Data Studio jumps to the next statement of the function it was called from.</p>
<p id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264594_p12639640123615">Press <strong id="EN-US_TOPIC_0000001860318801__b16283131010396">F7</strong> to go to the next statement. If you click <strong id="EN-US_TOPIC_0000001860318801__b1528311023919">Continue</strong>, PL/SQL code execution will continue.</p>
<p id="EN-US_TOPIC_0000001860318801__p105204713130"><span><img id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264594_image03021743153918" src="figure/en-us_image_0000001860199325.jpg" height="208.4509" width="497.42" title="Click to enlarge" class="imgResize"></span></p>
</li><li id="EN-US_TOPIC_0000001860318801__li10955142891318">Step Over<p id="EN-US_TOPIC_0000001860318801__p6681024161412"><a name="EN-US_TOPIC_0000001860318801__li10955142891318"></a><a name="li10955142891318"></a><strong id="EN-US_TOPIC_0000001860318801__b187971420403">Step Over</strong> is the same as <strong id="EN-US_TOPIC_0000001860318801__b47921454019">Step Into</strong>. Unless another function is called, it will not step into the function. The function will run, and the next statement in the current function is executed. <strong id="EN-US_TOPIC_0000001860318801__b18826191688107">F8</strong> is the shortcut key for <strong id="EN-US_TOPIC_0000001860318801__b1574924808107">Step Over</strong>. However, if there is a breakpoint set inside the called function, <strong id="EN-US_TOPIC_0000001860318801__b188717714218">Step Over</strong> will enter the function, and hit the set breakpoint.</p>
</li><li id="EN-US_TOPIC_0000001860318801__li189048196146">Step Out<p id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264594_p8612165912015"><a name="EN-US_TOPIC_0000001860318801__li189048196146"></a><a name="li189048196146"></a>Stepping out of a sub-program continues the execution of the function and then suspends the execution after the function returns to its function call. You can step out this function when the rest of the function does not need to debug. However, if a breakpoint is set in the remaining part of the function, then that breakpoint will be hit before returning to the function call.</p>
<p id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264594_p1364084016361">A function will be executed when you step over or step out of it. <strong id="EN-US_TOPIC_0000001860318801__b1129905915482">Shift+F7</strong> is the shortcut key for <strong id="EN-US_TOPIC_0000001860318801__b1129905984814">Step Out</strong>.</p>
<p id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264594_p653231517409"><span><img id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264594_image3532141544010" src="figure/en-us_image_0000001860199317.jpg" height="218.8648" width="497.42" title="Click to enlarge" class="imgResize"></span></p>
</li><li id="EN-US_TOPIC_0000001860318801__li141024411146">Continuing the Debugging<p id="EN-US_TOPIC_0000001860318801__p1975251417157"><a name="EN-US_TOPIC_0000001860318801__li141024411146"></a><a name="li141024411146"></a>When the debugging process stops at a specific location, you can select <strong id="EN-US_TOPIC_0000001860318801__b3863183917498">Continue</strong> (or press <strong id="EN-US_TOPIC_0000001860318801__b0864739114910">F9</strong>) from the <strong id="EN-US_TOPIC_0000001860318801__b7864143934918">Debug</strong> menu to continue the PL/SQL function execution.</p>
</li><li id="EN-US_TOPIC_0000001860318801__li1844414801517">Viewing Callstack<p id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264594_p52581080"><a name="EN-US_TOPIC_0000001860318801__li1844414801517"></a><a name="li1844414801517"></a>The <strong id="EN-US_TOPIC_0000001860318801__b7441117154113">Callstack</strong> pane displays the chain of functions as they are called. The <strong id="EN-US_TOPIC_0000001860318801__b192614413515">Callstack</strong> pane can be opened from the minimized window. The most recent functions are listed at the top, and the least recent at the bottom. At the end of each function name is the current line number in that function.</p>
<p id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264594_p12446250">You can double-click the function names in the <strong id="EN-US_TOPIC_0000001860318801__b458962875219">Callstack</strong> pane to open panes of different functions.</p>
<p id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264594_p29493756"><span><img id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264594_image57075007" src="figure/en-us_image_0000001813439440.jpg" width="332.46675" height="135.16125" title="Click to enlarge" class="imgResize"></span></p>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001860318801__section105891556309"><h4 class="sectiontitle">Exporting a Function or Procedure DDL</h4><p id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264706_p62435929">Follow the steps below to export the function/procedure DDL:</p>
<ol id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264706_ol24145451"><li id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264706_li41061555"><span>In the <strong id="EN-US_TOPIC_0000001860318801__b890812398542">Object Browser</strong> pane, right-click the selected function or procedure and select <strong id="EN-US_TOPIC_0000001860318801__b290823916547">Export DDL</strong>.</span><p><p id="EN-US_TOPIC_0000001860318801__p14770144218374">You need to customize the export path. To compress data, select <strong id="EN-US_TOPIC_0000001860318801__b8988105545419">.zip</strong>.</p>
<p id="EN-US_TOPIC_0000001860318801__p623194023315"><span><img id="EN-US_TOPIC_0000001860318801__image1021016599340" src="figure/en-us_image_0000001860199329.png" width="518.7" height="253.43150000000003" title="Click to enlarge" class="imgResize"></span></p>
<p id="EN-US_TOPIC_0000001860318801__p186741512306"></p>
<p id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264706_p559426">You must select <strong id="EN-US_TOPIC_0000001860318801__b1236813571017">I agree</strong> under <strong id="EN-US_TOPIC_0000001860318801__b524711011214">Security Disclaimer</strong>, then click <strong id="EN-US_TOPIC_0000001860318801__b1163318210215">OK</strong>. You can disable the security disclaimer. After the disclaimer is disabled, it will not be displayed when you export the DDL. For details, see <a href="DWS_DS_005.html#EN-US_TOPIC_0000001813438860__table1510418570339">Table 1</a>.</p>
</p></li><li id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264706_li25693751192755"><span>Click <strong id="EN-US_TOPIC_0000001860318801__b1916217263413">OK</strong>. The operation progress is displayed on the status bar in the lower right corner. </span><p><div class="note" id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264706_note4325055192916"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264706_ul182591732164816"><li id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264706_li9982918172613">If the file name contains characters that are not supported by Windows, the file name will be different from the schema name.</li><li id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264706_li17561433124816">MS Visual C runtime file (msvcrt100.dll) is required to complete this operation. For details, see <a href="DWS_DS_039.html">Troubleshooting</a>.</li></ul>
</div></div>
<p id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264706_p40980350192916">The <strong id="EN-US_TOPIC_0000001860318801__b161591702516">Data Exported Successfully</strong> dialog box and status bar display the status of the completed operation.</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264706_table20789124652911" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Supported DDL encoding formats</caption><thead align="left"><tr id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264706_row485915510434"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.6.3.2.2.3.2.4.1.1"><p id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264706_p18658615191019"><strong id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264706_b196581215101019">Database Encoding</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.6.3.2.2.3.2.4.1.2"><p id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264706_p13658131510105"><strong id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264706_b8658111518105">File Encoding</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.6.3.2.2.3.2.4.1.3"><p id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264706_p1765821511101"><strong id="EN-US_TOPIC_0000001860318801__b124158714722848">Support for Exporting a DDL</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264706_row1465193611592"><td class="cellrowborder" rowspan="3" valign="top" width="33.33333333333333%" headers="mcps1.3.6.3.2.2.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264706_p11711124110594">UTF-8</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.3.2.2.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264706_p6562114412591">UTF-8</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.3.2.2.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264706_p946516361597">Yes</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264706_row6450163418591"><td class="cellrowborder" valign="top" headers="mcps1.3.6.3.2.2.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264706_p15452183425919">GBK</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.6.3.2.2.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264706_p94521734115915">Yes</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264706_row12402232195917"><td class="cellrowborder" valign="top" headers="mcps1.3.6.3.2.2.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264706_p19402632145916">LATIN1</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.6.3.2.2.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264706_p840219321599">Yes</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264706_row108601655164315"><td class="cellrowborder" rowspan="3" valign="top" width="33.33333333333333%" headers="mcps1.3.6.3.2.2.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264706_p1786055514318">GBK</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.3.2.2.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264706_p1786035594320">GBK</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.3.2.2.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264706_p286045515433">Yes</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264706_row166304144010"><td class="cellrowborder" valign="top" headers="mcps1.3.6.3.2.2.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264706_p56301514407">UTF-8</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.6.3.2.2.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264706_p126309145015">Yes</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264706_row205945171408"><td class="cellrowborder" valign="top" headers="mcps1.3.6.3.2.2.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264706_p9594317608">LATIN1</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.6.3.2.2.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264706_p5594117608">No</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264706_row1125843617458"><td class="cellrowborder" rowspan="3" valign="top" width="33.33333333333333%" headers="mcps1.3.6.3.2.2.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264706_p11259163610455">LATIN1</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.3.2.2.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264706_p172591836204513">LATIN1</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.3.2.2.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264706_p12591636124510">Yes</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264706_row1637216452013"><td class="cellrowborder" valign="top" headers="mcps1.3.6.3.2.2.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264706_p5372545915">GBK</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.6.3.2.2.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264706_p13721745310">No</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264706_row678318471115"><td class="cellrowborder" valign="top" headers="mcps1.3.6.3.2.2.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264706_p1278394715113">UTF-8</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.6.3.2.2.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264706_p1578310471818">Yes</p>
</td>
</tr>
</tbody>
</table>
</div>
</p></li></ol>
</div>
<div class="section" id="EN-US_TOPIC_0000001860318801__section1750411331107"><h4 class="sectiontitle">Deleting a Function/Procedure</h4><p id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264300_p15536152212525">You can delete functions or programs one by one or in batches.</p>
<ol id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264300_ol45921510"><li id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264300_li10640407"><span>In the <strong id="EN-US_TOPIC_0000001860318801__b738617488615">Object Browser</strong> pane, right-click the selected function/procedure object and select <strong id="EN-US_TOPIC_0000001860318801__b1365713534610">Drop Object</strong>.</span></li><li id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264300_li18863173112381"><span>Select one or more function or procedure objects and choose <strong id="EN-US_TOPIC_0000001860318801__b71141832163613">Delete Object</strong>.</span></li><li id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264300_li32249809"><span>In the dialog box that is displayed, click <strong id="EN-US_TOPIC_0000001860318801__b9117172911714">Yes</strong>.</span><p><p id="EN-US_TOPIC_0000001860318801__en-us_topic_0185264300_p8907132914491">The status bar displays the status of the completed operation.</p>
</p></li></ol>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="DWS_DS_012.html">Database Management</a></div>
</div>
</div>
<script language="JavaScript">
<!--
image_size('.imgResize');
var msg_imageMax = "view original image";
var msg_imageClose = "close";
//--></script>
View Git Blame Copy Permalink