@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/$.db.html ADDED
@@ -0,0 +1,773 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+
4
+ <head>
5
+ <meta charset="utf-8">
6
+ <title>JSDoc: Namespace: db</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
+ <script src="scripts/launch-8b3c5ca29b9e.min.js"></script>
12
+ <script src="scripts/highlight.js"></script>
13
+
14
+
15
+ </head>
16
+ <body>
17
+ <div id="main">
18
+ <h1 class="page-title">Namespace: db</h1>
19
+ <section>
20
+ <header>
21
+ <h2>
22
+ <span class="ancestors"><a href="$.html">$</a>.</span>
23
+ db
24
+ </h2>
25
+ </header>
26
+ <article>
27
+ <div class="container-overview">
28
+ <div class="description">Namespace for HANA database access</div>
29
+ <dl class="details">
30
+ </dl>
31
+ </div>
32
+ <h3 class="subsection-title">Classes</h3>
33
+ <dl>
34
+ <dt><a href="$.db.CallableStatement.html">CallableStatement</a></dt>
35
+ <dd></dd>
36
+ <dt><a href="$.db.Connection.html">Connection</a></dt>
37
+ <dd></dd>
38
+ <dt><a href="$.db.ParameterMetaData.html">ParameterMetaData</a></dt>
39
+ <dd></dd>
40
+ <dt><a href="$.db.PreparedStatement.html">PreparedStatement</a></dt>
41
+ <dd></dd>
42
+ <dt><a href="$.db.ResultSet.html">ResultSet</a></dt>
43
+ <dd></dd>
44
+ <dt><a href="$.db.ResultSetMetaData.html">ResultSetMetaData</a></dt>
45
+ <dd></dd>
46
+ <dt><a href="$.db.SQLException.html">SQLException</a></dt>
47
+ <dd></dd>
48
+ </dl>
49
+ <h3 class="subsection-title">Members</h3>
50
+ <dl>
51
+ <dt>
52
+ <h4 class="name" id="isolation"><span class="type-signature">&lt;static> </span>isolation<span
53
+ class="type-signature"></span></h4>
54
+ </dt>
55
+ <dd>
56
+ <div class="description">
57
+ Constants that represent the isolation levels for a transaction
58
+ </div>
59
+ <dl class="details">
60
+ <h5 class="subsection-title">Properties:</h5>
61
+ <dl>
62
+ <table class="props">
63
+ <thead>
64
+ <tr>
65
+ <th>Name</th>
66
+ <th>Type</th>
67
+ <th>Default</th>
68
+ </tr>
69
+ </thead>
70
+ <tbody>
71
+ <tr>
72
+ <td class="name"><code>READ_COMMITTED</code></td>
73
+ <td class="type">
74
+ <span class="param-type">number</span>
75
+ </td>
76
+ <td class="default">
77
+ 2
78
+ </td>
79
+ </tr>
80
+ <tr>
81
+ <td class="name"><code>REPEATABLE_READ</code></td>
82
+ <td class="type">
83
+ <span class="param-type">number</span>
84
+ </td>
85
+ <td class="default">
86
+ 4
87
+ </td>
88
+ </tr>
89
+ <tr>
90
+ <td class="name"><code>SERIALIZABLE</code></td>
91
+ <td class="type">
92
+ <span class="param-type">number</span>
93
+ </td>
94
+ <td class="default">
95
+ 8
96
+ </td>
97
+ </tr>
98
+ </tbody>
99
+ </table>
100
+ </dl>
101
+ </dl>
102
+ </dd>
103
+ <dt>
104
+ <h4 class="name" id="types"><span class="type-signature">&lt;static> </span>types<span
105
+ class="type-signature"></span></h4>
106
+ </dt>
107
+ <dd>
108
+ <div class="description">
109
+ Set of constants of the database column types
110
+ </div>
111
+ <dl class="details">
112
+ <h5 class="subsection-title">Properties:</h5>
113
+ <dl>
114
+ <table class="props">
115
+ <thead>
116
+ <tr>
117
+ <th>Name</th>
118
+ <th>Type</th>
119
+ <th>Default</th>
120
+ </tr>
121
+ </thead>
122
+ <tbody>
123
+ <tr>
124
+ <td class="name"><code>TINYINT</code></td>
125
+ <td class="type">
126
+ <span class="param-type">number</span>
127
+ </td>
128
+ <td class="default">
129
+ 1
130
+ </td>
131
+ </tr>
132
+ <tr>
133
+ <td class="name"><code>SMALLINT</code></td>
134
+ <td class="type">
135
+ <span class="param-type">number</span>
136
+ </td>
137
+ <td class="default">
138
+ 2
139
+ </td>
140
+ </tr>
141
+ <tr>
142
+ <td class="name"><code>INT</code></td>
143
+ <td class="type">
144
+ <span class="param-type">number</span>
145
+ </td>
146
+ <td class="default">
147
+ 3
148
+ </td>
149
+ </tr>
150
+ <tr>
151
+ <td class="name"><code>INTEGER</code></td>
152
+ <td class="type">
153
+ <span class="param-type">number</span>
154
+ </td>
155
+ <td class="default">
156
+ 3
157
+ </td>
158
+ </tr>
159
+ <tr>
160
+ <td class="name"><code>BIGINT</code></td>
161
+ <td class="type">
162
+ <span class="param-type">number</span>
163
+ </td>
164
+ <td class="default">
165
+ 4
166
+ </td>
167
+ </tr>
168
+ <tr>
169
+ <td class="name"><code>DECIMAL</code></td>
170
+ <td class="type">
171
+ <span class="param-type">number</span>
172
+ </td>
173
+ <td class="default">
174
+ 5
175
+ </td>
176
+ </tr>
177
+ <tr>
178
+ <td class="name"><code>REAL</code></td>
179
+ <td class="type">
180
+ <span class="param-type">number</span>
181
+ </td>
182
+ <td class="default">
183
+ 6
184
+ </td>
185
+ </tr>
186
+ <tr>
187
+ <td class="name"><code>DOUBLE</code></td>
188
+ <td class="type">
189
+ <span class="param-type">number</span>
190
+ </td>
191
+ <td class="default">
192
+ 7
193
+ </td>
194
+ </tr>
195
+ <tr>
196
+ <td class="name"><code>CHAR</code></td>
197
+ <td class="type">
198
+ <span class="param-type">number</span>
199
+ </td>
200
+ <td class="default">
201
+ 8
202
+ </td>
203
+ </tr>
204
+ <tr>
205
+ <td class="name"><code>VARCHAR</code></td>
206
+ <td class="type">
207
+ <span class="param-type">number</span>
208
+ </td>
209
+ <td class="default">
210
+ 9
211
+ </td>
212
+ </tr>
213
+ <tr>
214
+ <td class="name"><code>NCHAR</code></td>
215
+ <td class="type">
216
+ <span class="param-type">number</span>
217
+ </td>
218
+ <td class="default">
219
+ 10
220
+ </td>
221
+ </tr>
222
+ <tr>
223
+ <td class="name"><code>NVARCHAR</code></td>
224
+ <td class="type">
225
+ <span class="param-type">number</span>
226
+ </td>
227
+ <td class="default">
228
+ 11
229
+ </td>
230
+ </tr>
231
+ <tr>
232
+ <td class="name"><code>BINARY</code></td>
233
+ <td class="type">
234
+ <span class="param-type">number</span>
235
+ </td>
236
+ <td class="default">
237
+ 12
238
+ </td>
239
+ </tr>
240
+ <tr>
241
+ <td class="name"><code>VARBINARY</code></td>
242
+ <td class="type">
243
+ <span class="param-type">number</span>
244
+ </td>
245
+ <td class="default">
246
+ 13
247
+ </td>
248
+ </tr>
249
+ <tr>
250
+ <td class="name"><code>DATE</code></td>
251
+ <td class="type">
252
+ <span class="param-type">number</span>
253
+ </td>
254
+ <td class="default">
255
+ 14
256
+ </td>
257
+ </tr>
258
+ <tr>
259
+ <td class="name"><code>TIME</code></td>
260
+ <td class="type">
261
+ <span class="param-type">number</span>
262
+ </td>
263
+ <td class="default">
264
+ 15
265
+ </td>
266
+ </tr>
267
+ <tr>
268
+ <td class="name"><code>TIMESTAMP</code></td>
269
+ <td class="type">
270
+ <span class="param-type">number</span>
271
+ </td>
272
+ <td class="default">
273
+ 16
274
+ </td>
275
+ </tr>
276
+ <tr>
277
+ <td class="name"><code>CLOB</code></td>
278
+ <td class="type">
279
+ <span class="param-type">number</span>
280
+ </td>
281
+ <td class="default">
282
+ 25
283
+ </td>
284
+ </tr>
285
+ <tr>
286
+ <td class="name"><code>NCLOB</code></td>
287
+ <td class="type">
288
+ <span class="param-type">number</span>
289
+ </td>
290
+ <td class="default">
291
+ 26
292
+ </td>
293
+ </tr>
294
+ <tr>
295
+ <td class="name"><code>BLOB</code></td>
296
+ <td class="type">
297
+ <span class="param-type">number</span>
298
+ </td>
299
+ <td class="default">
300
+ 27
301
+ </td>
302
+ </tr>
303
+ <tr>
304
+ <td class="name"><code>TABLE</code></td>
305
+ <td class="type">
306
+ <span class="param-type">number</span>
307
+ </td>
308
+ <td class="default">
309
+ 45
310
+ </td>
311
+ </tr>
312
+ <tr>
313
+ <td class="name"><code>SMALLDECIMAL</code></td>
314
+ <td class="type">
315
+ <span class="param-type">number</span>
316
+ </td>
317
+ <td class="default">
318
+ 47
319
+ </td>
320
+ </tr>
321
+ <tr>
322
+ <td class="name"><code>TEXT</code></td>
323
+ <td class="type">
324
+ <span class="param-type">number</span>
325
+ </td>
326
+ <td class="default">
327
+ 51
328
+ </td>
329
+ </tr>
330
+ <tr>
331
+ <td class="name"><code>SHORTTEXT</code></td>
332
+ <td class="type">
333
+ <span class="param-type">number</span>
334
+ </td>
335
+ <td class="default">
336
+ 52
337
+ </td>
338
+ </tr>
339
+ <tr>
340
+ <td class="name"><code>ALPHANUM</code></td>
341
+ <td class="type">
342
+ <span class="param-type">number</span>
343
+ </td>
344
+ <td class="default">
345
+ 55
346
+ </td>
347
+ </tr>
348
+ <tr>
349
+ <td class="name"><code>SECONDDATE</code></td>
350
+ <td class="type">
351
+ <span class="param-type">number</span>
352
+ </td>
353
+ <td class="default">
354
+ 62
355
+ </td>
356
+ </tr>
357
+ </tbody>
358
+ </table>
359
+ </dl>
360
+ </dl>
361
+ </dd>
362
+ </dl>
363
+ <h3 class="subsection-title">Methods</h3>
364
+ <dl>
365
+ <dt>
366
+ <h4 class="name" id="getConnection"><span
367
+ class="type-signature">&lt;static> async </span>getConnection<span class="signature">(<span
368
+ class="optional">sqlcc</span>, <span class="optional">isolationLevel</span>)</span><span
369
+ class="type-signature"> &rarr; {<a href="$.db.Connection.html">$.db.Connection</a>}</span>
370
+ </h4>
371
+ </dt>
372
+ <dd>
373
+ <div class="description">
374
+ Returns a connection to the database
375
+ </div>
376
+ <h5>Parameters:</h5>
377
+ <table class="params">
378
+ <thead>
379
+ <tr>
380
+ <th>Name</th>
381
+ <th>Type</th>
382
+ <th>Argument</th>
383
+ <th>Default</th>
384
+ <th class="last">Description</th>
385
+ </tr>
386
+ </thead>
387
+ <tbody>
388
+ <tr>
389
+ <td class="name"><code>sqlcc</code></td>
390
+ <td class="type">
391
+ <span class="param-type">string</span>
392
+ </td>
393
+ <td class="attributes">
394
+ &lt;optional><br>
395
+ </td>
396
+ <td class="default">
397
+ </td>
398
+ <td class="description last">Specifies XS SQL Connection Configuration file(*.xssqlcc) used
399
+ to create the connection.
400
+ </td>
401
+ </tr>
402
+ <tr>
403
+ <td class="name"><code>isolationLevel</code></td>
404
+ <td class="type">
405
+ <span class="param-type">number</span>
406
+ </td>
407
+ <td class="attributes">
408
+ &lt;optional><br>
409
+ </td>
410
+ <td class="default">
411
+ $.db.isolation.READ_COMMITTED
412
+ </td>
413
+ <td class="description last">Specifies the transaction isolation level, for example, <a
414
+ href="$.db.html#isolation">$.db.isolation.READ_COMMITTED</a>, <a
415
+ href="$.db.html#isolation">$.db.isolation.REPEATABLE_READ</a>, or <a
416
+ href="$.db.html#isolation">$.db.isolation.SERIALIZABLE</a>. Default is <a
417
+ href="$.db.html#isolation">$.db.isolation.READ_COMMITTED</a>.
418
+ </td>
419
+ </tr>
420
+ </tbody>
421
+ </table>
422
+ <dl class="details">
423
+ <dt class="important tag-deprecated">Deprecated:</dt>
424
+ <dd>
425
+ <ul class="dummy">
426
+ <li>This version of getConnection is deprecated. Please use the one with the object
427
+ parameter.
428
+ </li>
429
+ <ul>
430
+ </dd>
431
+ </dl>
432
+ <h5>Returns:</h5>
433
+ <div class="param-desc">
434
+ Connection - The internal connection to the database with the user of the current session.
435
+ </div>
436
+ <dl>
437
+ <dt>
438
+ Type
439
+ </dt>
440
+ <dd>
441
+ <span class="param-type"><a href="$.db.Connection.html">$.db.Connection</a></span>
442
+ </dd>
443
+ </dl>
444
+ </dd>
445
+ <dt>
446
+ <h4 class="name" id="getConnection"><span
447
+ class="type-signature">&lt;static> async </span>getConnection<span class="signature">(<span
448
+ class="optional">configurationObject</span>)</span><span class="type-signature"> &rarr; {<a
449
+ href="$.db.Connection.html">$.db.Connection</a>}</span></h4>
450
+ </dt>
451
+ <dd>
452
+ <div class="description">
453
+ Returns a connection to the database
454
+ </div>
455
+ <h5>Parameters:</h5>
456
+ <table class="params">
457
+ <thead>
458
+ <tr>
459
+ <th>Name</th>
460
+ <th>Type</th>
461
+ <th>Argument</th>
462
+ <th class="last">Description</th>
463
+ </tr>
464
+ </thead>
465
+ <tbody>
466
+ <tr>
467
+ <td class="name"><code>configurationObject</code></td>
468
+ <td class="type">
469
+ <span class="param-type"><a href="$.db.html#configurationObject">$.db~configurationObject</a></span>
470
+ </td>
471
+ <td class="attributes">
472
+ &lt;optional><br>
473
+ </td>
474
+ <td class="description last">object Object may specify the following optional parameters:
475
+ isolation level, sqlcc and locale to configure the connection.
476
+ </td>
477
+ </tr>
478
+ </tbody>
479
+ </table>
480
+ <dl class="details">
481
+ </dl>
482
+ <h5>Returns:</h5>
483
+ <div class="param-desc">
484
+ Connection - The internal connection to the database with the user of the current session.
485
+ </div>
486
+ <dl>
487
+ <dt>
488
+ Type
489
+ </dt>
490
+ <dd>
491
+ <span class="param-type"><a href="$.db.Connection.html">$.db.Connection</a></span>
492
+ </dd>
493
+ </dl>
494
+ </dd>
495
+ </dl>
496
+ <h3 class="subsection-title">Type Definitions</h3>
497
+ <dl>
498
+ <dt>
499
+ <h4 class="name" id="configurationObject">configurationObject</h4>
500
+ </dt>
501
+ <dd>
502
+ <h5>Type:</h5>
503
+ <ul>
504
+ <li>
505
+ <span class="param-type">object</span>
506
+ </li>
507
+ </ul>
508
+ <dl class="details">
509
+ <h5 class="subsection-title">Properties:</h5>
510
+ <dl>
511
+ <table class="props">
512
+ <thead>
513
+ <tr>
514
+ <th>Name</th>
515
+ <th>Type</th>
516
+ <th>Argument</th>
517
+ <th>Default</th>
518
+ <th class="last">Description</th>
519
+ </tr>
520
+ </thead>
521
+ <tbody>
522
+ <tr>
523
+ <td class="name"><code>sqlcc</code></td>
524
+ <td class="type">
525
+ <span class="param-type">string</span>
526
+ </td>
527
+ <td class="attributes">
528
+ &lt;optional><br>
529
+ </td>
530
+ <td class="default">
531
+ </td>
532
+ <td class="description last">Specifies XS SQL Connection Configuration file
533
+ (*.xssqlcc) used to create the connection.
534
+ </td>
535
+ </tr>
536
+ <tr>
537
+ <td class="name"><code>isolationLevel</code></td>
538
+ <td class="type">
539
+ <span class="param-type">number</span>
540
+ </td>
541
+ <td class="attributes">
542
+ &lt;optional><br>
543
+ </td>
544
+ <td class="default">
545
+ $.db.isolation.READ_COMMITTED
546
+ </td>
547
+ <td class="description last">Specifies the transaction isolation level, for example,
548
+ <a href="$.db.html#isolation">$.db.isolation.READ_COMMITTED</a>, <a
549
+ href="$.db.html#isolation">$.db.isolation.REPEATABLE_READ</a>, or <a
550
+ href="$.db.html#isolation">$.db.isolation.SERIALIZABLE</a>. Default is
551
+ <a href="$.db.html#isolation">$.db.isolation.READ_COMMITTED</a>.
552
+ </td>
553
+ </tr>
554
+ <tr>
555
+ <td class="name"><code>locale</code></td>
556
+ <td class="type">
557
+ <span class="param-type">string</span>
558
+ </td>
559
+ <td class="attributes">
560
+ &lt;optional><br>
561
+ </td>
562
+ <td class="default">
563
+ </td>
564
+ <td class="description last">Locale to configure the connection in IETF (BCP 47)
565
+ format. Configuring the connection with a locale enables coherent behavior of
566
+ request-based and background processing (e.g., when XS Jobs and HTTP Requests
567
+ trigger the execution of the same script).
568
+ </td>
569
+ </tr>
570
+ </tbody>
571
+ </table>
572
+ </dl>
573
+ </dl>
574
+ </dd>
575
+ </dl>
576
+ </article>
577
+ </section>
578
+ </div>
579
+ <nav>
580
+ <h2><a href="index.html">Index</a></h2>
581
+ <h3>Classes</h3>
582
+ <table>
583
+ <tr>
584
+ <td><a href="$.security.AntiVirus.html">AntiVirus</a></td>
585
+ <td class="oblique">$.security</td>
586
+ </tr>
587
+ <tr>
588
+ <td><a href="$.Application.html">Application</a></td>
589
+ <td class="oblique">$</td>
590
+ </tr>
591
+ <tr>
592
+ <td><a href="$.web.Body.html">Body</a></td>
593
+ <td class="oblique">$.web</td>
594
+ </tr>
595
+ <tr>
596
+ <td><a href="$.db.CallableStatement.html">CallableStatement</a></td>
597
+ <td class="oblique">$.db</td>
598
+ </tr>
599
+ <tr>
600
+ <td><a href="$.net.http.Client.html">Client</a></td>
601
+ <td class="oblique">$.net.http</td>
602
+ </tr>
603
+ <tr>
604
+ <td><a href="$.hdb.ColumnMetadata.html">ColumnMetadata</a></td>
605
+ <td class="oblique">$.hdb</td>
606
+ </tr>
607
+ <tr>
608
+ <td><a href="$.db.Connection.html">Connection</a></td>
609
+ <td class="oblique">$.db</td>
610
+ </tr>
611
+ <tr>
612
+ <td><a href="$.hdb.Connection.html">Connection</a></td>
613
+ <td class="oblique">$.hdb</td>
614
+ </tr>
615
+ <tr>
616
+ <td><a href="$.net.Destination.html">Destination</a></td>
617
+ <td class="oblique">$.net</td>
618
+ </tr>
619
+ <tr>
620
+ <td><a href="$.net.http.Destination.html">Destination</a></td>
621
+ <td class="oblique">$.net.http</td>
622
+ </tr>
623
+ <tr>
624
+ <td><a href="$.web.EntityList.html">EntityList</a></td>
625
+ <td class="oblique">$.web</td>
626
+ </tr>
627
+ <tr>
628
+ <td><a href="$.jobs.Job.html">Job</a></td>
629
+ <td class="oblique">$.jobs</td>
630
+ </tr>
631
+ <tr>
632
+ <td><a href="$.jobs.JobLog.html">JobLog</a></td>
633
+ <td class="oblique">$.jobs</td>
634
+ </tr>
635
+ <tr>
636
+ <td><a href="$.jobs.JobSchedules.html">JobSchedules</a></td>
637
+ <td class="oblique">$.jobs</td>
638
+ </tr>
639
+ <tr>
640
+ <td><a href="$.net.Mail.html">Mail</a></td>
641
+ <td class="oblique">$.net</td>
642
+ </tr>
643
+ <tr>
644
+ <td><a href="$.db.ParameterMetaData.html">ParameterMetaData</a></td>
645
+ <td class="oblique">$.db</td>
646
+ </tr>
647
+ <tr>
648
+ <td><a href="$.net.Mail.Part.html">Part</a></td>
649
+ <td class="oblique">$.net.Mail</td>
650
+ </tr>
651
+ <tr>
652
+ <td><a href="$.db.PreparedStatement.html">PreparedStatement</a></td>
653
+ <td class="oblique">$.db</td>
654
+ </tr>
655
+ <tr>
656
+ <td><a href="$.hdb.ProcedureResult.html">ProcedureResult</a></td>
657
+ <td class="oblique">$.hdb</td>
658
+ </tr>
659
+ <tr>
660
+ <td><a href="$.net.http.Request.html">Request</a></td>
661
+ <td class="oblique">$.net.http</td>
662
+ </tr>
663
+ <tr>
664
+ <td><a href="$.db.ResultSet.html">ResultSet</a></td>
665
+ <td class="oblique">$.db</td>
666
+ </tr>
667
+ <tr>
668
+ <td><a href="$.hdb.ResultSet.html">ResultSet</a></td>
669
+ <td class="oblique">$.hdb</td>
670
+ </tr>
671
+ <tr>
672
+ <td><a href="$.hdb.ResultSetIterator.html">ResultSetIterator</a></td>
673
+ <td class="oblique">$.hdb</td>
674
+ </tr>
675
+ <tr>
676
+ <td><a href="$.db.ResultSetMetaData.html">ResultSetMetaData</a></td>
677
+ <td class="oblique">$.db</td>
678
+ </tr>
679
+ <tr>
680
+ <td><a href="$.hdb.ResultSetMetaData.html">ResultSetMetaData</a></td>
681
+ <td class="oblique">$.hdb</td>
682
+ </tr>
683
+ <tr>
684
+ <td><a href="$.util.SAXParser.html">SAXParser</a></td>
685
+ <td class="oblique">$.util</td>
686
+ </tr>
687
+ <tr>
688
+ <td><a href="$.Session.html">Session</a></td>
689
+ <td class="oblique">$</td>
690
+ </tr>
691
+ <tr>
692
+ <td><a href="$.text.analysis.Session.html">Session</a></td>
693
+ <td class="oblique">$.text.analysis</td>
694
+ </tr>
695
+ <tr>
696
+ <td><a href="$.text.mining.Session.html">Session</a></td>
697
+ <td class="oblique">$.text.mining</td>
698
+ </tr>
699
+ <tr>
700
+ <td><a href="$.net.SMTPConnection.html">SMTPConnection</a></td>
701
+ <td class="oblique">$.net</td>
702
+ </tr>
703
+ <tr>
704
+ <td><a href="$.db.SQLException.html">SQLException</a></td>
705
+ <td class="oblique">$.db</td>
706
+ </tr>
707
+ <tr>
708
+ <td><a href="$.hdb.SQLException.html">SQLException</a></td>
709
+ <td class="oblique">$.hdb</td>
710
+ </tr>
711
+ <tr>
712
+ <td><a href="$.security.Store.html">Store</a></td>
713
+ <td class="oblique">$.security</td>
714
+ </tr>
715
+ <tr>
716
+ <td><a href="$.web.TupelList.html">TupelList</a></td>
717
+ <td class="oblique">$.web</td>
718
+ </tr>
719
+ <tr>
720
+ <td><a href="$.web.WebEntityRequest.html">WebEntityRequest</a></td>
721
+ <td class="oblique">$.web</td>
722
+ </tr>
723
+ <tr>
724
+ <td><a href="$.web.WebEntityResponse.html">WebEntityResponse</a></td>
725
+ <td class="oblique">$.web</td>
726
+ </tr>
727
+ <tr>
728
+ <td><a href="$.web.WebRequest.html">WebRequest</a></td>
729
+ <td class="oblique">$.web</td>
730
+ </tr>
731
+ <tr>
732
+ <td><a href="$.web.WebResponse.html">WebResponse</a></td>
733
+ <td class="oblique">$.web</td>
734
+ </tr>
735
+ <tr>
736
+ <td><a href="$.util.Zip.html">Zip</a></td>
737
+ <td class="oblique">$.util</td>
738
+ </tr>
739
+ </table>
740
+ <h3>Namespaces</h3>
741
+ <ul>
742
+ <li><a href="$.html"><span class="oblique"></span>$</a></li>
743
+ <li><a href="$.db.html"><span class="oblique">$.</span>db</a></li>
744
+ <li><a href="$.hdb.html"><span class="oblique">$.</span>hdb</a></li>
745
+ <li><a href="$.jobs.html"><span class="oblique">$.</span>jobs</a></li>
746
+ <li><a href="$.net.html"><span class="oblique">$.</span>net</a></li>
747
+ <li><a href="$.net.http.html"><span class="oblique">$.net.</span>http</a></li>
748
+ <li><a href="$.security.html"><span class="oblique">$.</span>security</a></li>
749
+ <li><a href="$.security.crypto.html"><span class="oblique">$.security.</span>crypto</a></li>
750
+ <li><a href="$.security.x509.html"><span class="oblique">$.security.</span>x509</a></li>
751
+ <li><a href="$.text.html"><span class="oblique">$.</span>text</a></li>
752
+ <li><a href="$.text.analysis.html"><span class="oblique">$.text.</span>analysis</a></li>
753
+ <li><a href="$.text.mining.html"><span class="oblique">$.text.</span>mining</a></li>
754
+ <li><a href="$.trace.html"><span class="oblique">$.</span>trace</a></li>
755
+ <li><a href="$.util.html"><span class="oblique">$.</span>util</a></li>
756
+ <li><a href="$.util.codec.html"><span class="oblique">$.util.</span>codec</a></li>
757
+ <li><a href="$.util.compression.html"><span class="oblique">$.util.</span>compression</a></li>
758
+ <li><a href="$.util.sql.html"><span class="oblique">$.util.</span>sql</a></li>
759
+ <li><a href="$.web.html"><span class="oblique">$.</span>web</a></li>
760
+ </ul>
761
+ </nav>
762
+ <br clear="both">
763
+ <footer>
764
+ <a href="Copyright-SAP.html">Copyright</a>
765
+ &
766
+ <a href="Disclaimer-SAP.html">Disclaimer</a>
767
+ </footer>
768
+ <script>prettyPrint();</script>
769
+ <script src="scripts/linenumber.js"></script>
770
+
771
+ </body>
772
+
773
+ </html>