@sap/async-xsjs 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (178) hide show
  1. package/CHANGELOG.md +26 -0
  2. package/LICENSE +37 -0
  3. package/README.md +445 -0
  4. package/differences.md +162 -0
  5. package/docs/$.Application.html +262 -0
  6. package/docs/$.Session.html +674 -0
  7. package/docs/$.db.CallableStatement.html +2524 -0
  8. package/docs/$.db.Connection.html +511 -0
  9. package/docs/$.db.ParameterMetaData.html +805 -0
  10. package/docs/$.db.PreparedStatement.html +1796 -0
  11. package/docs/$.db.ResultSet.html +1308 -0
  12. package/docs/$.db.ResultSetMetaData.html +800 -0
  13. package/docs/$.db.SQLException.html +259 -0
  14. package/docs/$.db.html +773 -0
  15. package/docs/$.hdb.ColumnMetadata.html +438 -0
  16. package/docs/$.hdb.Connection.html +663 -0
  17. package/docs/$.hdb.ProcedureResult.html +280 -0
  18. package/docs/$.hdb.ResultSet.html +324 -0
  19. package/docs/$.hdb.ResultSetIterator.html +315 -0
  20. package/docs/$.hdb.ResultSetMetaData.html +259 -0
  21. package/docs/$.hdb.SQLException.html +259 -0
  22. package/docs/$.hdb.html +557 -0
  23. package/docs/$.html +471 -0
  24. package/docs/$.jobs.Job.html +783 -0
  25. package/docs/$.jobs.JobLog.html +380 -0
  26. package/docs/$.jobs.JobSchedules.html +852 -0
  27. package/docs/$.jobs.html +238 -0
  28. package/docs/$.net.Destination.html +304 -0
  29. package/docs/$.net.Mail.Part.html +510 -0
  30. package/docs/$.net.Mail.html +504 -0
  31. package/docs/$.net.SMTPConnection.html +347 -0
  32. package/docs/$.net.html +749 -0
  33. package/docs/$.net.http.Client.html +562 -0
  34. package/docs/$.net.http.Destination.html +237 -0
  35. package/docs/$.net.http.Request.html +567 -0
  36. package/docs/$.net.http.html +292 -0
  37. package/docs/$.security.AntiVirus.html +361 -0
  38. package/docs/$.security.Store.html +636 -0
  39. package/docs/$.security.crypto.html +414 -0
  40. package/docs/$.security.html +247 -0
  41. package/docs/$.security.x509.html +373 -0
  42. package/docs/$.text.analysis.Session.html +983 -0
  43. package/docs/$.text.analysis.html +242 -0
  44. package/docs/$.text.html +246 -0
  45. package/docs/$.text.mining.Session.html +2018 -0
  46. package/docs/$.text.mining.html +242 -0
  47. package/docs/$.trace.html +525 -0
  48. package/docs/$.util.SAXParser.html +955 -0
  49. package/docs/$.util.Zip.html +474 -0
  50. package/docs/$.util.codec.html +414 -0
  51. package/docs/$.util.compression.html +357 -0
  52. package/docs/$.util.html +325 -0
  53. package/docs/$.util.sql.html +290 -0
  54. package/docs/$.web.Body.html +333 -0
  55. package/docs/$.web.EntityList.html +296 -0
  56. package/docs/$.web.TupelList.html +496 -0
  57. package/docs/$.web.WebEntityRequest.html +393 -0
  58. package/docs/$.web.WebEntityResponse.html +392 -0
  59. package/docs/$.web.WebRequest.html +560 -0
  60. package/docs/$.web.WebResponse.html +609 -0
  61. package/docs/$.web.html +246 -0
  62. package/docs/Copyright-SAP.html +39 -0
  63. package/docs/Disclaimer-SAP.html +55 -0
  64. package/docs/index.html +232 -0
  65. package/docs/styles/jsdoc-default.css +382 -0
  66. package/lib/AppConfig.js +36 -0
  67. package/lib/AuditLogger.js +41 -0
  68. package/lib/cacert.js +26 -0
  69. package/lib/ctypes.js +153 -0
  70. package/lib/destinations/dest-provider.js +57 -0
  71. package/lib/index.js +235 -0
  72. package/lib/jobs/Action.js +40 -0
  73. package/lib/jobs/Job.js +100 -0
  74. package/lib/jobs/JobManager.js +150 -0
  75. package/lib/jobs/JobsRuntime.js +133 -0
  76. package/lib/jobs/SqlScriptJobRunner.js +36 -0
  77. package/lib/jobs/XsjsJobRunner.js +78 -0
  78. package/lib/jobs/index.js +11 -0
  79. package/lib/logging.js +16 -0
  80. package/lib/middleware.js +125 -0
  81. package/lib/odata/ODataService.js +125 -0
  82. package/lib/odata/index.js +7 -0
  83. package/lib/odata/service-factory.js +26 -0
  84. package/lib/passport-noauth.js +17 -0
  85. package/lib/routes.js +115 -0
  86. package/lib/runtime.js +740 -0
  87. package/lib/sandbox.js +40 -0
  88. package/lib/utils/XsJsFunctionRunner.js +57 -0
  89. package/lib/utils/XsJsLibFunctionRunner.js +57 -0
  90. package/lib/utils/buffer-utils.js +77 -0
  91. package/lib/utils/compression-utils.js +14 -0
  92. package/lib/utils/date-utils.js +104 -0
  93. package/lib/utils/errors/HttpError.js +20 -0
  94. package/lib/utils/errors/wrap-app-error.js +18 -0
  95. package/lib/utils/index.js +17 -0
  96. package/lib/utils/xs-function-runner.js +51 -0
  97. package/lib/utils/xs-types.js +21 -0
  98. package/lib/utils/xspath.js +36 -0
  99. package/lib/utils/xsstack.js +28 -0
  100. package/lib/views/error.html +28 -0
  101. package/lib/xsjs/Application.js +28 -0
  102. package/lib/xsjs/Locale.js +53 -0
  103. package/lib/xsjs/Session.js +31 -0
  104. package/lib/xsjs/constants.js +71 -0
  105. package/lib/xsjs/db/common/DbBase.js +85 -0
  106. package/lib/xsjs/db/common/DbOptions.js +163 -0
  107. package/lib/xsjs/db/common/arguments-validation.js +102 -0
  108. package/lib/xsjs/db/common/connection.js +12 -0
  109. package/lib/xsjs/db/common/enums.js +93 -0
  110. package/lib/xsjs/db/common/execute-batch.js +38 -0
  111. package/lib/xsjs/db/common/parse-time.js +139 -0
  112. package/lib/xsjs/db/dbapi/CallableStatement.js +192 -0
  113. package/lib/xsjs/db/dbapi/Connection.js +78 -0
  114. package/lib/xsjs/db/dbapi/DB.js +39 -0
  115. package/lib/xsjs/db/dbapi/ParameterMetaData.js +118 -0
  116. package/lib/xsjs/db/dbapi/PreparedStatement.js +78 -0
  117. package/lib/xsjs/db/dbapi/ResultSet.js +220 -0
  118. package/lib/xsjs/db/dbapi/ResultSetMetaData.js +116 -0
  119. package/lib/xsjs/db/dbapi/Statement.js +514 -0
  120. package/lib/xsjs/db/dbapi/conversions.js +113 -0
  121. package/lib/xsjs/db/dbapi/fetch-rows.js +32 -0
  122. package/lib/xsjs/db/hdbapi/Connection.js +525 -0
  123. package/lib/xsjs/db/hdbapi/HDB.js +32 -0
  124. package/lib/xsjs/db/hdbapi/ResultSetIterator.js +40 -0
  125. package/lib/xsjs/db/hdbapi/convert.js +77 -0
  126. package/lib/xsjs/db/hdbapi/table-string-parser.js +52 -0
  127. package/lib/xsjs/db/index.js +4 -0
  128. package/lib/xsjs/index.js +13 -0
  129. package/lib/xsjs/jobs/Job.js +228 -0
  130. package/lib/xsjs/jobs/Jobs.js +11 -0
  131. package/lib/xsjs/jobs/Logs.js +127 -0
  132. package/lib/xsjs/jobs/Schedule.js +110 -0
  133. package/lib/xsjs/jobs/Schedules.js +108 -0
  134. package/lib/xsjs/net/Destination.js +43 -0
  135. package/lib/xsjs/net/http/Client.js +220 -0
  136. package/lib/xsjs/net/http/HTTP.js +72 -0
  137. package/lib/xsjs/net/index.js +5 -0
  138. package/lib/xsjs/net/smtp/Mail.js +38 -0
  139. package/lib/xsjs/net/smtp/Part.js +30 -0
  140. package/lib/xsjs/net/smtp/SMTPConnection.js +39 -0
  141. package/lib/xsjs/net/smtp/index.js +18 -0
  142. package/lib/xsjs/net/smtp/nodemailer-util.js +77 -0
  143. package/lib/xsjs/require.js +39 -0
  144. package/lib/xsjs/security/AntiVirus.js +31 -0
  145. package/lib/xsjs/security/Store.js +119 -0
  146. package/lib/xsjs/security/crypto.js +23 -0
  147. package/lib/xsjs/security/index.js +5 -0
  148. package/lib/xsjs/security/x509.js +12 -0
  149. package/lib/xsjs/text/analysis/Session.js +128 -0
  150. package/lib/xsjs/text/index.js +30 -0
  151. package/lib/xsjs/text/mining/Session.js +82 -0
  152. package/lib/xsjs/trace/trace.js +41 -0
  153. package/lib/xsjs/util/SAXParser.js +174 -0
  154. package/lib/xsjs/util/Zip.js +220 -0
  155. package/lib/xsjs/util/codec.js +33 -0
  156. package/lib/xsjs/util/compression.js +24 -0
  157. package/lib/xsjs/util/index.js +22 -0
  158. package/lib/xsjs/web/BasicWebEntity.js +41 -0
  159. package/lib/xsjs/web/EntityList.js +11 -0
  160. package/lib/xsjs/web/TupelLists/CookiesTupelList.js +47 -0
  161. package/lib/xsjs/web/TupelLists/HeadersTupelList.js +55 -0
  162. package/lib/xsjs/web/TupelLists/ParametersTupelList.js +83 -0
  163. package/lib/xsjs/web/TupelLists/TupelListBase.js +45 -0
  164. package/lib/xsjs/web/WebBody.js +135 -0
  165. package/lib/xsjs/web/WebEntityRequest.js +40 -0
  166. package/lib/xsjs/web/WebEntityResponse.js +26 -0
  167. package/lib/xsjs/web/WebRequest.js +209 -0
  168. package/lib/xsjs/web/WebResponse.js +183 -0
  169. package/lib/xsjs/web/index.js +4 -0
  170. package/lib/xsjs/web/utils/HeadersParser.js +53 -0
  171. package/lib/xsjs/web/utils/HttpRequestParser.js +93 -0
  172. package/lib/xsjs/web/utils/MultipartParser.js +163 -0
  173. package/lib/xsjs/web/utils/MultipartResponseBuilder.js +73 -0
  174. package/lib/xsjs/web/utils/SetCookieParser.js +32 -0
  175. package/lib/xsjslib/TextBundleWrapper.js +46 -0
  176. package/lib/xsjslib/index.js +11 -0
  177. package/npm-shrinkwrap.json +11540 -0
  178. package/package.json +84 -0
package/docs/$.jobs.JobSchedules.html ADDED
@@ -0,0 +1,852 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+
4
+ <head>
5
+ <meta charset="utf-8">
6
+ <title>JSDoc: Class: JobSchedules</title>
7
+ <script src="scripts/prettify/prettify.js"></script>
8
+ <script src="scripts/prettify/lang-css.js"></script>
9
+ <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
10
+
11
+
12
+ <script src="scripts/launch-8b3c5ca29b9e.min.js"></script>
13
+ <script src="scripts/highlight.js"></script>
14
+ <link rel="canonical" href="$.jobs.JobSchedules.html">
15
+ </head>
16
+ <body>
17
+ <div id="main">
18
+ <h1 class="page-title">Class: JobSchedules</h1>
19
+ <section>
20
+ <header>
21
+ <h2>
22
+ <span class="ancestors"><a href="$.html">$</a><a href="$.jobs.html">.jobs</a>.</span>
23
+ JobSchedules
24
+ </h2>
25
+ <div class="class-description">$.jobs.JobSchedules Allows manipulation of a job's schedules.
26
+ Properties below are only visible when schedules object is accessed as array object (e.g.,
27
+ schedules[id]).
28
+ </div>
29
+ </header>
30
+ <article>
31
+ <div class="container-overview">
32
+ <dt>
33
+ <h4 class="name" id="JobSchedules"><span class="type-signature"></span>new JobSchedules<span
34
+ class="signature">()</span><span class="type-signature"> -> { Promise }</span></h4>
35
+ </dt>
36
+ <dd>
37
+ <div class="description">
38
+ A scheduled job's schedules. Properties below are only visible when schedules object is accessed
39
+ as array object (e.g., schedules[id]).
40
+ </div>
41
+ <dl class="details">
42
+ <h5 class="subsection-title">Properties:</h5>
43
+ <dl>
44
+ <table class="props">
45
+ <thead>
46
+ <tr>
47
+ <th>Name</th>
48
+ <th>Type</th>
49
+ <th class="last">Description</th>
50
+ </tr>
51
+ </thead>
52
+ <tbody>
53
+ <tr>
54
+ <td class="name"><code>active</code></td>
55
+ <td class="type">
56
+ <span class="param-type">Boolean</span>
57
+ </td>
58
+ <td class="description last">A schedule's status can be active (true) or inactive
59
+ (false).
60
+ </td>
61
+ </tr>
62
+ <tr>
63
+ <td class="name"><code>description</code></td>
64
+ <td class="type">
65
+ <span class="param-type">String</span>
66
+ </td>
67
+ <td class="description last">Description of a schedule.</td>
68
+ </tr>
69
+ <tr>
70
+ <td class="name"><code>parameter</code></td>
71
+ <td class="type">
72
+ <span class="param-type">String</span>
73
+ |
74
+ <span class="param-type">object</span>
75
+ </td>
76
+ <td class="description last">Parameter object or JSON string to be passed to
77
+ schedule.
78
+ </td>
79
+ </tr>
80
+ <tr>
81
+ <td class="name"><code>xscron</code></td>
82
+ <td class="type">
83
+ <span class="param-type">String</span>
84
+ </td>
85
+ <td class="description last">Xscron string of a schedule.</td>
86
+ </tr>
87
+ <tr>
88
+ <td class="name"><code>logs</code></td>
89
+ <td class="type">
90
+ <span class="param-type"><a href="$.jobs.JobLog.html">$.jobs.JobLog</a></span>
91
+ </td>
92
+ <td class="description last">Provides access to log entries of a job's schedules.
93
+ </td>
94
+ </tr>
95
+ </tbody>
96
+ </table>
97
+ </dl>
98
+ </dl>
99
+ <h5>Example</h5>
100
+ <pre class="prettyprint"><code>// Note: Manipulating a schedule via properties does not change the schedule id.
101
+ for (var id in myjob.schedules) {
102
+ // set new description
103
+ myjob.schedules[id].description = "New description";
104
+ // set new parameter as JSON string
105
+ myjob.schedules[id].parameter = "{\"a\":\"b\"}";
106
+ // set new parameter as object
107
+ myjob.schedules[id].parameter = {a:"b"};
108
+ // set new xscron value
109
+ myjob.schedules[id].xscron = "* * * * * * *";
110
+ // set new status
111
+ myjob.schedules[id].active = true;
112
+ }</code></pre>
113
+ </dd>
114
+ </div>
115
+ <h3 class="subsection-title">Methods</h3>
116
+ <dl>
117
+ <dt>
118
+ <h4 class="name" id="add"><span class="type-signature">async </span>add<span class="signature">(parameters)</span><span
119
+ class="type-signature"> &rarr; {integer}</span></h4>
120
+ </dt>
121
+ <dd>
122
+ <div class="description">
123
+ Used to add a schedule to a job.
124
+ </div>
125
+ <h5>Parameters:</h5>
126
+ <table class="params">
127
+ <thead>
128
+ <tr>
129
+ <th>Name</th>
130
+ <th>Type</th>
131
+ <th class="last">Description</th>
132
+ </tr>
133
+ </thead>
134
+ <tbody>
135
+ <tr>
136
+ <td class="name"><code>parameters</code></td>
137
+ <td class="type">
138
+ <span class="param-type"><a href="$.jobs.JobSchedules.html#AddParameters">$.jobs.JobSchedules~AddParameters</a></span>
139
+ </td>
140
+ <td class="description last">parameter object</td>
141
+ </tr>
142
+ </tbody>
143
+ </table>
144
+ <dl class="details">
145
+ </dl>
146
+ <h5>Throws:</h5>
147
+ <div class="param-desc">
148
+ Throws an error if the parameters object is not valid or the execution fails.
149
+ </div>
150
+ <h5>Returns:</h5>
151
+ <div class="param-desc">
152
+ ID of the created schedule
153
+ </div>
154
+ <dl>
155
+ <dt>
156
+ Type
157
+ </dt>
158
+ <dd>
159
+ <span class="param-type">integer</span>
160
+ </dd>
161
+ </dl>
162
+ <h5>Example</h5>
163
+ <pre class="prettyprint"><code>var id = <b>await </b>myjob.schedules.add({
164
+ description: "Added at runtime, run every 10 minutes",
165
+ xscron: "* * * * * *&#47;10 0",
166
+ parameter: {
167
+ a: "c"
168
+ }
169
+ });</code></pre>
170
+ </dd>
171
+ <dt>
172
+ <h4 class="name" id="delete"><span class="type-signature">async </span>delete<span class="signature">(parameters)</span><span
173
+ class="type-signature"> &rarr; {boolean}</span></h4>
174
+ </dt>
175
+ <dd>
176
+ <div class="description">
177
+ Used to delete a schedule from a job.
178
+ </div>
179
+ <h5>Parameters:</h5>
180
+ <table class="params">
181
+ <thead>
182
+ <tr>
183
+ <th>Name</th>
184
+ <th>Type</th>
185
+ <th class="last">Description</th>
186
+ </tr>
187
+ </thead>
188
+ <tbody>
189
+ <tr>
190
+ <td class="name"><code>parameters</code></td>
191
+ <td class="type">
192
+ <span class="param-type"><a href="$.jobs.JobSchedules.html#DeleteParameters">$.jobs.JobSchedules~DeleteParameters</a></span>
193
+ </td>
194
+ <td class="description last">parameter object</td>
195
+ </tr>
196
+ </tbody>
197
+ </table>
198
+ <dl class="details">
199
+ </dl>
200
+ <h5>Throws:</h5>
201
+ <div class="param-desc">
202
+ Throws an error if the parameters object is not valid or the execution fails.
203
+ </div>
204
+ <h5>Returns:</h5>
205
+ <div class="param-desc">
206
+ True if the schedule has been deleted, false otherwise
207
+ </div>
208
+ <dl>
209
+ <dt>F
210
+ Type
211
+ </dt>
212
+ <dd>
213
+ <span class="param-type">boolean</span>
214
+ </dd>
215
+ </dl>
216
+ <h5>Example</h5>
217
+ <pre class="prettyprint"><code><b>await </b>myjob.schedules.delete({id: id});</code></pre>
218
+ </dd>
219
+ <dt>
220
+ <h4 class="name" id="deleteAll"><span class="type-signature">async </span>deleteAll<span
221
+ class="signature">(<span class="optional">filter</span>)</span><span class="type-signature"> &rarr; {integer}</span>
222
+ </h4>
223
+ </dt>
224
+ <dd>
225
+ <div class="description">
226
+ This method is not supported in async-xsjs</br>
227
+ Used to delete all schedules from a job.
228
+ </div>
229
+ <h5>Parameters:</h5>
230
+ <table class="params">
231
+ <thead>
232
+ <tr>
233
+ <th>Name</th>
234
+ <th>Type</th>
235
+ <th>Argument</th>
236
+ <th class="last">Description</th>
237
+ </tr>
238
+ </thead>
239
+ <tbody>
240
+ <tr>
241
+ <td class="name"><code>filter</code></td>
242
+ <td class="type">
243
+ <span class="param-type">object</span>
244
+ </td>
245
+ <td class="attributes">
246
+ &lt;optional><br>
247
+ </td>
248
+ <td class="description last">filter oject that restricts deleted schedules to ones that
249
+ match filter
250
+ <h6>Properties</h6>
251
+ <table class="params">
252
+ <thead>
253
+ <tr>
254
+ <th>Name</th>
255
+ <th>Type</th>
256
+ <th>Argument</th>
257
+ <th class="last">Description</th>
258
+ </tr>
259
+ </thead>
260
+ <tbody>
261
+ <tr>
262
+ <td class="name"><code>active</code></td>
263
+ <td class="type">
264
+ <span class="param-type">boolean</span>
265
+ </td>
266
+ <td class="attributes">
267
+ &lt;optional><br>
268
+ </td>
269
+ <td class="description last">True deletes only schedules with status active.
270
+ False deletes only schedules with status inactive
271
+ </td>
272
+ </tr>
273
+ <tr>
274
+ <td class="name"><code>designtime</code></td>
275
+ <td class="type">
276
+ <span class="param-type">boolean</span>
277
+ </td>
278
+ <td class="attributes">
279
+ &lt;optional><br>
280
+ </td>
281
+ <td class="description last">True deletes only schedules with origin designtime.
282
+ False deletes only schedules with origin runtime
283
+ </td>
284
+ </tr>
285
+ </tbody>
286
+ </table>
287
+ </td>
288
+ </tr>
289
+ </tbody>
290
+ </table>
291
+ <dl class="details">
292
+ </dl>
293
+ <h5>Throws:</h5>
294
+ <div class="param-desc">
295
+ Throws an error if the filter object is not valid or the execution fails.
296
+ </div>
297
+ <h5>Returns:</h5>
298
+ <div class="param-desc">
299
+ Number of schedules that has been deleted
300
+ </div>
301
+ <dl>
302
+ <dt>
303
+ Type
304
+ </dt>
305
+ <dd>
306
+ <span class="param-type">integer</span>
307
+ </dd>
308
+ </dl>
309
+ <h5>Example</h5>
310
+ <pre class="prettyprint"><code>myjob.schedules.deleteAll({active: true, designtime: true});
311
+ myjob.schedules.deleteAll();</code></pre>
312
+ </dd>
313
+ </dl>
314
+ <h3 class="subsection-title">Type Definitions</h3>
315
+ <dl>
316
+ <dt>
317
+ <h4 class="name" id="AddParameters">AddParameters</h4>
318
+ </dt>
319
+ <dd>
320
+ <div class="description">This method is not supported in async-xsjs</div>
321
+ <h5>Type:</h5>
322
+ <ul>
323
+ <li>
324
+ <span class="param-type">object</span>
325
+ </li>
326
+ </ul>
327
+ <dl class="details">
328
+ <h5 class="subsection-title">Properties:</h5>
329
+ <dl>
330
+ <table class="props">
331
+ <thead>
332
+ <tr>
333
+ <th>Name</th>
334
+ <th>Type</th>
335
+ <th>Argument</th>
336
+ <th class="last">Description</th>
337
+ </tr>
338
+ </thead>
339
+ <tbody>
340
+ <tr>
341
+ <td class="name"><code>xscron</code></td>
342
+ <td class="type">
343
+ <span class="param-type">string</span>
344
+ </td>
345
+ <td class="attributes">
346
+ </td>
347
+ <td class="description last">xscron string defining when the schedule should run
348
+ </td>
349
+ </tr>
350
+ <tr>
351
+ <td class="name"><code>description</code></td>
352
+ <td class="type">
353
+ <span class="param-type">string</span>
354
+ </td>
355
+ <td class="attributes">
356
+ &lt;optional><br>
357
+ </td>
358
+ <td class="description last">describes the schedule</td>
359
+ </tr>
360
+ <tr>
361
+ <td class="name"><code>parameter</code></td>
362
+ <td class="type">
363
+ <span class="param-type">object</span>
364
+ |
365
+ <span class="param-type">string</span>
366
+ </td>
367
+ <td class="attributes">
368
+ &lt;optional><br>
369
+ </td>
370
+ <td class="description last">object or JSON string that will be passed to the job's
371
+ action. In case the action is a SQLScript, the structure of the object must
372
+ match that of <a href="$.jobs.JobSchedules.html#AddSqlScriptParameters">$.jobs.JobSchedules~AddSqlScriptParameters</a>
373
+ </td>
374
+ </tr>
375
+ </tbody>
376
+ </table>
377
+ </dl>
378
+ </dl>
379
+ </dd>
380
+ <dt>
381
+ <h4 class="name" id="AddSqlScriptParameters">AddSqlScriptParameters</h4>
382
+ </dt>
383
+ <dd>
384
+ <div class="description">
385
+ This method is not supported in async-xsjs</br>
386
+ Object that will be mapped to input parameters of SQLScript procedures. The mapping uses the
387
+ parameter name of the SQLScript procedure. These mappings via the parameter name of a SQLScript
388
+ procedure are marked with '{}' for this object. Default input parameters of SQLScript procedures
389
+ are supported. Output parameters are not supported. Parameter names may be specified in any
390
+ order.
391
+ </div>
392
+ <h5>Type:</h5>
393
+ <ul>
394
+ <li>
395
+ <span class="param-type">Object</span>
396
+ </li>
397
+ </ul>
398
+ <dl class="details">
399
+ <h5 class="subsection-title">Properties:</h5>
400
+ <dl>
401
+ <table class="props">
402
+ <thead>
403
+ <tr>
404
+ <th>Name</th>
405
+ <th>Type</th>
406
+ <th>Argument</th>
407
+ <th class="last">Description</th>
408
+ </tr>
409
+ </thead>
410
+ <tbody>
411
+ <tr>
412
+ <td class="name"><code>{scalarString}</code></td>
413
+ <td class="type">
414
+ <span class="param-type">String</span>
415
+ </td>
416
+ <td class="attributes">
417
+ &lt;optional><br>
418
+ </td>
419
+ <td class="description last">possible for each parameter name of the SQLScript
420
+ procedure with the following scalar SQLScript types:
421
+ TINYINT, SMALLINT, INTEGER, BIGINT, VARCHAR, NVARCHAR, VARBINARY, DATE, TIME,
422
+ TIMESTAMP, SECONDDATE, DOUBLE, REAL, FLOAT, DECIMAL, SMALLDECIMAL, CLOB, NCLOB,
423
+ BLOB
424
+ </td>
425
+ </tr>
426
+ <tr>
427
+ <td class="name"><code>{scalarNumber}</code></td>
428
+ <td class="type">
429
+ <span class="param-type">Number</span>
430
+ </td>
431
+ <td class="attributes">
432
+ &lt;optional><br>
433
+ </td>
434
+ <td class="description last">Number is additionally supported for the following
435
+ scalar SQLScript types: TINYINT, SMALLINT, INTEGER, DOUBLE, REAL, FLOAT
436
+ </td>
437
+ </tr>
438
+ <tr>
439
+ <td class="name"><code>{tableArray}</code></td>
440
+ <td class="type">
441
+ <span class="param-type">Array</span>
442
+ </td>
443
+ <td class="attributes">
444
+ &lt;optional><br>
445
+ </td>
446
+ <td class="description last">possible for each parameter name of the SQLScript
447
+ procedure with table type. Each item of the array is inserted as a row into a
448
+ newly created local temporary table. This local temporary table is visible only
449
+ within the connection and is destroyed on exit of the XS Job
450
+ <h6>Properties</h6>
451
+ <table class="props">
452
+ <thead>
453
+ <tr>
454
+ <th>Name</th>
455
+ <th>Type</th>
456
+ <th>Argument</th>
457
+ <th class="last">Description</th>
458
+ </tr>
459
+ </thead>
460
+ <tbody>
461
+ <tr>
462
+ <td class="name"><code>{rowIndex}</code></td>
463
+ <td class="type">
464
+ <span class="param-type">Object</span>
465
+ </td>
466
+ <td class="attributes">
467
+ &lt;optional><br>
468
+ </td>
469
+ <td class="description last">object uses table parameter names to map
470
+ input strings to columns of the table and insert the strings
471
+ <h6>Properties</h6>
472
+ <table class="props">
473
+ <thead>
474
+ <tr>
475
+ <th>Name</th>
476
+ <th>Type</th>
477
+ <th>Argument</th>
478
+ <th class="last">Description</th>
479
+ </tr>
480
+ </thead>
481
+ <tbody>
482
+ <tr>
483
+ <td class="name"><code>{scalarString}</code></td>
484
+ <td class="type">
485
+ <span class="param-type">String</span>
486
+ </td>
487
+ <td class="attributes">
488
+ &lt;optional><br>
489
+ </td>
490
+ <td class="description last">possible for each scalar input
491
+ parameter name of the table with the following scalar
492
+ SQLScript types:
493
+ TINYINT, SMALLINT, INTEGER, BIGINT, VARCHAR, NVARCHAR,
494
+ VARBINARY, DATE, TIME, TIMESTAMP, SECONDDATE, DOUBLE,
495
+ REAL, FLOAT, DECIMAL, SMALLDECIMAL, CLOB, NCLOB, BLOB
496
+ </td>
497
+ </tr>
498
+ <tr>
499
+ <td class="name"><code>{scalarNumber}</code></td>
500
+ <td class="type">
501
+ <span class="param-type">Number</span>
502
+ </td>
503
+ <td class="attributes">
504
+ &lt;optional><br>
505
+ </td>
506
+ <td class="description last">Number is additionally
507
+ supported for the following scalar SQLScript types:
508
+ TINYINT, SMALLINT, INTEGER, DOUBLE, REAL, FLOAT
509
+ </td>
510
+ </tr>
511
+ </tbody>
512
+ </table>
513
+ </td>
514
+ </tr>
515
+ </tbody>
516
+ </table>
517
+ </td>
518
+ </tr>
519
+ <tr>
520
+ <td class="name"><code>{tableObject}</code></td>
521
+ <td class="type">
522
+ <span class="param-type">Object</span>
523
+ </td>
524
+ <td class="attributes">
525
+ &lt;optional><br>
526
+ </td>
527
+ <td class="description last">possible for each parameter name of the SQLScript
528
+ procedure with table type. Parameter name establishes binding between object and
529
+ SQL procedure parameter. Object defines table name and schema
530
+ <h6>Properties</h6>
531
+ <table class="props">
532
+ <thead>
533
+ <tr>
534
+ <th>Name</th>
535
+ <th>Type</th>
536
+ <th>Argument</th>
537
+ <th class="last">Description</th>
538
+ </tr>
539
+ </thead>
540
+ <tbody>
541
+ <tr>
542
+ <td class="name"><code>table_name</code></td>
543
+ <td class="type">
544
+ <span class="param-type">String</span>
545
+ </td>
546
+ <td class="attributes">
547
+ </td>
548
+ <td class="description last">name of the table</td>
549
+ </tr>
550
+ <tr>
551
+ <td class="name"><code>schema_name</code></td>
552
+ <td class="type">
553
+ <span class="param-type">String</span>
554
+ </td>
555
+ <td class="attributes">
556
+ &lt;optional><br>
557
+ </td>
558
+ <td class="description last">name of the schema that holds the table
559
+ </td>
560
+ </tr>
561
+ </tbody>
562
+ </table>
563
+ </td>
564
+ </tr>
565
+ </tbody>
566
+ </table>
567
+ </dl>
568
+ </dl>
569
+ <h5>Examples</h5>
570
+ <pre class="prettyprint"><code>// Example1: pass scalar parameters to a SQLScript procedure
571
+ // Prerequisite: SQLScript procedure exists, is referenced in the job action and is defined as follows:
572
+ // procedure "SCHEMA_NAME"."PACKAGE_NAME::PROC_SCALAR" (
573
+ // IN DATEPARA DATE,
574
+ // IN TIMESTAMPPARA TIMESTAMP,
575
+ // IN DOPARA DOUBLE,
576
+ // IN INTPARA INTEGER,
577
+ // IN BIGINTPARA BIGINT)
578
+ // language SQLSCRIPT ...
579
+ "parameter": {
580
+ "DATEPARA": "2013-01-30",
581
+ "TIMESTAMPPARA": "2011-05-11 12:01:59.987654",
582
+ "DOPARA": 5.0,
583
+ "INTPARA": 5,
584
+ "BIGINTPARA": "5"
585
+ }
586
+ </code></pre>
587
+ <pre class="prettyprint"><code>// Example2: pass existing table as parameter to SQLScript procedure
588
+ // Prerequisites:
589
+ // (1) table exists and matches the table type of the parameter name of the SQLScript procedure,
590
+ // (2) SQLScript procedure exists, is referenced in the job action and is defined as follows:
591
+ // procedure "SCHEMA_NAME"."PACKAGE_NAME::PROC_TABLE" (
592
+ // IN TABLE_PARAMETER_NAME "SCHEMA_NAME"."PACKAGE_NAME::TABLETYPE1")
593
+ // language SQLSCRIPT ...
594
+ // table "SCHEMA_NAME"."PACKAGE_NAME::TABLE1" like type "SCHEMA_NAME"."PACKAGE_NAME::TABLETYPE1"
595
+ "parameter": {
596
+ "TABLE_PARAMETER_NAME": {
597
+ "table_name": "PACKAGE_NAME::TABLE1",
598
+ "schema_name": "SCHEMA_NAME"
599
+ }
600
+ }
601
+ </code></pre>
602
+ <pre class="prettyprint"><code>// Example3: create and fill local temporary table and pass to SQLScript procedure
603
+ // Prerequisites:
604
+ // (1) table type exists,
605
+ // (2) SQLScript procedure exists, is referenced in the job action and is defined as follows:
606
+ // procedure "SCHEMA_NAME"."PACKAGE_NAME::PROC_TABLE" (
607
+ // IN TABLE_PARAMETER_NAME "SCHEMA_NAME"."PACKAGE_NAME::TABLETYPE1")
608
+ // language SQLSCRIPT ...
609
+ // type "SCHEMA_NAME"."PACKAGE_NAME::TABLETYPE1" as table (INTPARA INTEGER, TSPARA TIMESTAMP)
610
+ // will create a local temporary table with name "#TABLE_PARAMETER_NAME" that contains two rows:
611
+ "parameter": {
612
+ "TABLE_PARAMETER_NAME":
613
+ [{"INTPARA": "23", "TSPARA": "2014-10-30 17:21:36"},
614
+ {"INTPARA": "24", "TSPARA": "2014-10-30 18:21:36"}]
615
+ }</code></pre>
616
+ </dd>
617
+ <dt>
618
+ <h4 class="name" id="DeleteParameters">DeleteParameters</h4>
619
+ </dt>
620
+ <dd>
621
+ <div class="description">
622
+ This method is not supported in async-xsjs</br>
623
+ </div>
624
+ <h5>Type:</h5>
625
+ <ul>
626
+ <li>
627
+ <span class="param-type">object</span>
628
+ </li>
629
+ </ul>
630
+ <dl class="details">
631
+ <h5 class="subsection-title">Properties:</h5>
632
+ <dl>
633
+ <table class="props">
634
+ <thead>
635
+ <tr>
636
+ <th>Name</th>
637
+ <th>Type</th>
638
+ <th class="last">Description</th>
639
+ </tr>
640
+ </thead>
641
+ <tbody>
642
+ <tr>
643
+ <td class="name"><code>id</code></td>
644
+ <td class="type">
645
+ <span class="param-type">integer</span>
646
+ </td>
647
+ <td class="description last">id of the schedule to delete</td>
648
+ </tr>
649
+ </tbody>
650
+ </table>
651
+ </dl>
652
+ </dl>
653
+ </dd>
654
+ </dl>
655
+ </article>
656
+ </section>
657
+ </div>
658
+ <nav>
659
+ <h2><a href="index.html">Index</a></h2>
660
+ <h3>Classes</h3>
661
+ <table>
662
+ <tr>
663
+ <td><a href="$.security.AntiVirus.html">AntiVirus</a></td>
664
+ <td class="oblique">$.security</td>
665
+ </tr>
666
+ <tr>
667
+ <td><a href="$.Application.html">Application</a></td>
668
+ <td class="oblique">$</td>
669
+ </tr>
670
+ <tr>
671
+ <td><a href="$.web.Body.html">Body</a></td>
672
+ <td class="oblique">$.web</td>
673
+ </tr>
674
+ <tr>
675
+ <td><a href="$.db.CallableStatement.html">CallableStatement</a></td>
676
+ <td class="oblique">$.db</td>
677
+ </tr>
678
+ <tr>
679
+ <td><a href="$.net.http.Client.html">Client</a></td>
680
+ <td class="oblique">$.net.http</td>
681
+ </tr>
682
+ <tr>
683
+ <td><a href="$.hdb.ColumnMetadata.html">ColumnMetadata</a></td>
684
+ <td class="oblique">$.hdb</td>
685
+ </tr>
686
+ <tr>
687
+ <td><a href="$.db.Connection.html">Connection</a></td>
688
+ <td class="oblique">$.db</td>
689
+ </tr>
690
+ <tr>
691
+ <td><a href="$.hdb.Connection.html">Connection</a></td>
692
+ <td class="oblique">$.hdb</td>
693
+ </tr>
694
+ <tr>
695
+ <td><a href="$.net.Destination.html">Destination</a></td>
696
+ <td class="oblique">$.net</td>
697
+ </tr>
698
+ <tr>
699
+ <td><a href="$.net.http.Destination.html">Destination</a></td>
700
+ <td class="oblique">$.net.http</td>
701
+ </tr>
702
+ <tr>
703
+ <td><a href="$.web.EntityList.html">EntityList</a></td>
704
+ <td class="oblique">$.web</td>
705
+ </tr>
706
+ <tr>
707
+ <td><a href="$.jobs.Job.html">Job</a></td>
708
+ <td class="oblique">$.jobs</td>
709
+ </tr>
710
+ <tr>
711
+ <td><a href="$.jobs.JobLog.html">JobLog</a></td>
712
+ <td class="oblique">$.jobs</td>
713
+ </tr>
714
+ <tr>
715
+ <td><a href="$.jobs.JobSchedules.html">JobSchedules</a></td>
716
+ <td class="oblique">$.jobs</td>
717
+ </tr>
718
+ <tr>
719
+ <td><a href="$.net.Mail.html">Mail</a></td>
720
+ <td class="oblique">$.net</td>
721
+ </tr>
722
+ <tr>
723
+ <td><a href="$.db.ParameterMetaData.html">ParameterMetaData</a></td>
724
+ <td class="oblique">$.db</td>
725
+ </tr>
726
+ <tr>
727
+ <td><a href="$.net.Mail.Part.html">Part</a></td>
728
+ <td class="oblique">$.net.Mail</td>
729
+ </tr>
730
+ <tr>
731
+ <td><a href="$.db.PreparedStatement.html">PreparedStatement</a></td>
732
+ <td class="oblique">$.db</td>
733
+ </tr>
734
+ <tr>
735
+ <td><a href="$.hdb.ProcedureResult.html">ProcedureResult</a></td>
736
+ <td class="oblique">$.hdb</td>
737
+ </tr>
738
+ <tr>
739
+ <td><a href="$.net.http.Request.html">Request</a></td>
740
+ <td class="oblique">$.net.http</td>
741
+ </tr>
742
+ <tr>
743
+ <td><a href="$.db.ResultSet.html">ResultSet</a></td>
744
+ <td class="oblique">$.db</td>
745
+ </tr>
746
+ <tr>
747
+ <td><a href="$.hdb.ResultSet.html">ResultSet</a></td>
748
+ <td class="oblique">$.hdb</td>
749
+ </tr>
750
+ <tr>
751
+ <td><a href="$.hdb.ResultSetIterator.html">ResultSetIterator</a></td>
752
+ <td class="oblique">$.hdb</td>
753
+ </tr>
754
+ <tr>
755
+ <td><a href="$.db.ResultSetMetaData.html">ResultSetMetaData</a></td>
756
+ <td class="oblique">$.db</td>
757
+ </tr>
758
+ <tr>
759
+ <td><a href="$.hdb.ResultSetMetaData.html">ResultSetMetaData</a></td>
760
+ <td class="oblique">$.hdb</td>
761
+ </tr>
762
+ <tr>
763
+ <td><a href="$.util.SAXParser.html">SAXParser</a></td>
764
+ <td class="oblique">$.util</td>
765
+ </tr>
766
+ <tr>
767
+ <td><a href="$.Session.html">Session</a></td>
768
+ <td class="oblique">$</td>
769
+ </tr>
770
+ <tr>
771
+ <td><a href="$.text.analysis.Session.html">Session</a></td>
772
+ <td class="oblique">$.text.analysis</td>
773
+ </tr>
774
+ <tr>
775
+ <td><a href="$.text.mining.Session.html">Session</a></td>
776
+ <td class="oblique">$.text.mining</td>
777
+ </tr>
778
+ <tr>
779
+ <td><a href="$.net.SMTPConnection.html">SMTPConnection</a></td>
780
+ <td class="oblique">$.net</td>
781
+ </tr>
782
+ <tr>
783
+ <td><a href="$.db.SQLException.html">SQLException</a></td>
784
+ <td class="oblique">$.db</td>
785
+ </tr>
786
+ <tr>
787
+ <td><a href="$.hdb.SQLException.html">SQLException</a></td>
788
+ <td class="oblique">$.hdb</td>
789
+ </tr>
790
+ <tr>
791
+ <td><a href="$.security.Store.html">Store</a></td>
792
+ <td class="oblique">$.security</td>
793
+ </tr>
794
+ <tr>
795
+ <td><a href="$.web.TupelList.html">TupelList</a></td>
796
+ <td class="oblique">$.web</td>
797
+ </tr>
798
+ <tr>
799
+ <td><a href="$.web.WebEntityRequest.html">WebEntityRequest</a></td>
800
+ <td class="oblique">$.web</td>
801
+ </tr>
802
+ <tr>
803
+ <td><a href="$.web.WebEntityResponse.html">WebEntityResponse</a></td>
804
+ <td class="oblique">$.web</td>
805
+ </tr>
806
+ <tr>
807
+ <td><a href="$.web.WebRequest.html">WebRequest</a></td>
808
+ <td class="oblique">$.web</td>
809
+ </tr>
810
+ <tr>
811
+ <td><a href="$.web.WebResponse.html">WebResponse</a></td>
812
+ <td class="oblique">$.web</td>
813
+ </tr>
814
+ <tr>
815
+ <td><a href="$.util.Zip.html">Zip</a></td>
816
+ <td class="oblique">$.util</td>
817
+ </tr>
818
+ </table>
819
+ <h3>Namespaces</h3>
820
+ <ul>
821
+ <li><a href="$.html"><span class="oblique"></span>$</a></li>
822
+ <li><a href="$.db.html"><span class="oblique">$.</span>db</a></li>
823
+ <li><a href="$.hdb.html"><span class="oblique">$.</span>hdb</a></li>
824
+ <li><a href="$.jobs.html"><span class="oblique">$.</span>jobs</a></li>
825
+ <li><a href="$.net.html"><span class="oblique">$.</span>net</a></li>
826
+ <li><a href="$.net.http.html"><span class="oblique">$.net.</span>http</a></li>
827
+ <li><a href="$.security.html"><span class="oblique">$.</span>security</a></li>
828
+ <li><a href="$.security.crypto.html"><span class="oblique">$.security.</span>crypto</a></li>
829
+ <li><a href="$.security.x509.html"><span class="oblique">$.security.</span>x509</a></li>
830
+ <li><a href="$.text.html"><span class="oblique">$.</span>text</a></li>
831
+ <li><a href="$.text.analysis.html"><span class="oblique">$.text.</span>analysis</a></li>
832
+ <li><a href="$.text.mining.html"><span class="oblique">$.text.</span>mining</a></li>
833
+ <li><a href="$.trace.html"><span class="oblique">$.</span>trace</a></li>
834
+ <li><a href="$.util.html"><span class="oblique">$.</span>util</a></li>
835
+ <li><a href="$.util.codec.html"><span class="oblique">$.util.</span>codec</a></li>
836
+ <li><a href="$.util.compression.html"><span class="oblique">$.util.</span>compression</a></li>
837
+ <li><a href="$.util.sql.html"><span class="oblique">$.util.</span>sql</a></li>
838
+ <li><a href="$.web.html"><span class="oblique">$.</span>web</a></li>
839
+ </ul>
840
+ </nav>
841
+ <br clear="both">
842
+ <footer>
843
+ <a href="Copyright-SAP.html">Copyright</a>
844
+ &
845
+ <a href="Disclaimer-SAP.html">Disclaimer</a>
846
+ </footer>
847
+ <script>prettyPrint();</script>
848
+ <script src="scripts/linenumber.js"></script>
849
+
850
+ </body>
851
+
852
+ </html>