-
Notifications
You must be signed in to change notification settings - Fork 18
/
proceduredeclaration.html
206 lines (163 loc) · 6.43 KB
/
proceduredeclaration.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
<!-- Creator : groff version 1.22.3 -->
<!-- CreationDate: Mon Mar 18 08:51:05 2024 -->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta name="generator" content="groff -Thtml, see www.gnu.org">
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<meta name="Content-Style" content="text/css">
<style type="text/css">
p { margin-top: 0; margin-bottom: 0; vertical-align: top }
pre { margin-top: 0; margin-bottom: 0; vertical-align: top }
table { margin-top: 0; margin-bottom: 0; vertical-align: top }
h1 { text-align: center }
</style>
<title>proceduredeclaration</title>
</head>
<body>
<h1 align="center">proceduredeclaration</h1>
<a href="#NAME">NAME</a><br>
<a href="#SYNTAX">SYNTAX</a><br>
<a href="#DESCRIPTION">DESCRIPTION</a><br>
<a href="#EXAMPLES">EXAMPLES</a><br>
<a href="#COPYRIGHT">COPYRIGHT</a><br>
<a href="#SEE ALSO">SEE ALSO</a><br>
<hr>
<h2>NAME
<a name="NAME"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">procedure
declaration, function declaration − RWP*Load Simulator
declaration of procedures and functions</p>
<h2>SYNTAX
<a name="SYNTAX"></a>
</h2>
<pre style="margin-left:11%; margin-top: 1em">proceduredeclaration ::=
[<b> private</b> ]<b> procedure</b> identifier
<b> (</b> [ argumentlist ]<b> )
</b> [<b> statistics</b> |<b> nostatistics</b> |<b> statisticsonly</b> ]
[<b> is</b> ]
statementlist
<b> end</b> [<b> procedure</b> | identifier ]
functiondeclaration ::=
[<b> private</b> ]<b> function</b> identifier
<b> (</b> [ argumentlist ]<b> ) return</b> simpledatatype [<b> is</b> ]
statementlist
<b> end</b> [<b> function</b> | identifier ]
argumentlist ::=
argument {<b> ,</b> argument }
argument ::=
simpledatatype identifier
simpledatatype ::=
<b> string</b> [<b> (</b> expression<b> )</b> ]
|<b> integer
</b>|<b> double</b></pre>
<h2>DESCRIPTION
<a name="DESCRIPTION"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">Procedure and
functions are a primary structure in rwloadsim, which like
in many other programming language wrap a list of statements
for execution. Both have a potentially empty list of
arguments; if empty, the parentheses must still be there.
The arguments and the return type for functions can be of
type integer, double or string; a string without a specified
length is 128 bytes by default. The actual value of the
string length must be available during parsing. The
<b>is</b> keyword is optional.</p>
<p style="margin-left:11%; margin-top: 1em">Procedures are
often created such that they implement some type of
simulated business logic and are as such called repeatedly
using control loops to simulate some workload. They can
therefore have statistics associated with them, which
includes things like execution times, number of executions,
etc. If the procedure contains any execution of SQL, such
statistics are collected by default; using the
<b>nostatistics</b> keyword turns this off. If the procedure
does not contain any execution of SQL, you can provide the
<b>statistics</b> keyword; doing so will enable statistics
collection for the procedure and will additionally make
rwloadsim treat the procedure as if it were doing SQL
execution. This again implies the procedure will ensure a
database connection exists (e.g. by getting on from a
session pool). If the procedure does not contain any
execution of SQL, you can alternatively provide the
<b>statisticsonly</b> attribute. This implies statistics
such as execution counts is being gathered, but the
procedure will <i>not</i> ensure or require a database
connection. See <a href="controlloop.html">controlloop(1rwl)</a> for an example of how this
can be used.</p>
<p style="margin-left:11%; margin-top: 1em">Functions never
have statistics collected, even if they contain SQL
execution. Functions must have a return type and must have
at least one <b>return</b> statement in their statement
list. If you exit from a function other than via a
<b>return</b> statement, the behavior is unspecified.</p>
<p style="margin-left:11%; margin-top: 1em">The terminating
<b>end</b> can optionally be followed by the appropriate
keyword or by the name of the procedure or function.</p>
<p style="margin-left:11%; margin-top: 1em">If either
declaration has an initial <b>private</b> keyword, the
procedure or function will only be available within the
source file where it has been declared.</p>
<h2>EXAMPLES
<a name="EXAMPLES"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">Declare a
function that will add two doubles and return their sum
rounded to integer.</p>
<pre style="margin-left:17%; margin-top: 1em">function add(double a, double b)
return integer
is
return round(a+b);
end add;</pre>
<p style="margin-left:11%; margin-top: 1em">Declare a
procedure that simulates the business transaction
"create order". Note that some variable
declarations are omitted.</p>
<pre style="margin-left:17%; margin-top: 1em">procedure create_order(integer linecount)
integer custno, ordno, i, prodcode, amount;
custno := uniform(1,maxcustomer); # Choose a random customer
sql insert_order
# Insert the order header returning orderno from sequence
insert into order_header (orderno, custno)
values (order_sequence.nextval, :custno)
returning orderno into :ordno;
bind ":custno" custno;
bindout ":ordno", ordno;
end insert_order;
sql insert_line
# Insert the order lines
insert into orderlines
( ordno, linno, product, amount )
values
( :b1, :b2, :b3, :b4);
bind 1 ordno, 2 i, 3 prodcode, 4 amount;
array 10;
end insert_line;
insert_order;
for i:=1 .. linecount loop
prodcode := uniform(1,maxproducts); # A random product
amount := 1 + round(erlang(10)); # At least one
insert_line;
end loop;
commit;
end create_order;</pre>
<h2>COPYRIGHT
<a name="COPYRIGHT"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">Copyright
© 2023 Oracle Corporation</p>
<p style="margin-left:11%; margin-top: 1em">Licensed under
the Universal Permissive License v 1.0 as shown at
https://oss.oracle.com/licenses/upl</p>
<h2>SEE ALSO
<a name="SEE ALSO"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em"><a href="statement.html">statement(1rwl)</a>,
<a href="cursorloop.html">cursorloop(1rwl)</a>, <a href="declaration.html">declaration(1rwl)</a>,
<a href="randomproceduredeclaration.html">randomproceduredeclaration(1rwl)</a></p>
<hr>
</body>
</html>