@itwin/core-backend 3.4.0-dev.55 → 3.4.0-dev.57

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 (227) hide show
  1. package/lib/cjs/AliCloudStorageService.d.ts +23 -23
  2. package/lib/cjs/AliCloudStorageService.js +71 -71
  3. package/lib/cjs/AliCloudStorageService.js.map +1 -1
  4. package/lib/cjs/BackendHubAccess.d.ts +224 -224
  5. package/lib/cjs/BackendHubAccess.js +41 -41
  6. package/lib/cjs/BackendHubAccess.js.map +1 -1
  7. package/lib/cjs/BackendLoggerCategory.d.ts +91 -91
  8. package/lib/cjs/BackendLoggerCategory.js +99 -99
  9. package/lib/cjs/BackendLoggerCategory.js.map +1 -1
  10. package/lib/cjs/BisCoreSchema.d.ts +21 -21
  11. package/lib/cjs/BisCoreSchema.js +60 -60
  12. package/lib/cjs/BisCoreSchema.js.map +1 -1
  13. package/lib/cjs/BriefcaseManager.d.ts +165 -165
  14. package/lib/cjs/BriefcaseManager.js +405 -405
  15. package/lib/cjs/BriefcaseManager.js.map +1 -1
  16. package/lib/cjs/Category.d.ts +153 -153
  17. package/lib/cjs/Category.js +243 -243
  18. package/lib/cjs/Category.js.map +1 -1
  19. package/lib/cjs/ChangeSummaryManager.d.ts +187 -187
  20. package/lib/cjs/ChangeSummaryManager.js +445 -445
  21. package/lib/cjs/ChangeSummaryManager.js.map +1 -1
  22. package/lib/cjs/ChangedElementsDb.d.ts +99 -99
  23. package/lib/cjs/ChangedElementsDb.js +165 -165
  24. package/lib/cjs/ChangedElementsDb.js.map +1 -1
  25. package/lib/cjs/ChangedElementsManager.d.ts +39 -39
  26. package/lib/cjs/ChangedElementsManager.js +88 -88
  27. package/lib/cjs/ChangedElementsManager.js.map +1 -1
  28. package/lib/cjs/CheckpointManager.d.ts +120 -120
  29. package/lib/cjs/CheckpointManager.js +343 -343
  30. package/lib/cjs/CheckpointManager.js.map +1 -1
  31. package/lib/cjs/ClassRegistry.d.ts +71 -71
  32. package/lib/cjs/ClassRegistry.js +215 -215
  33. package/lib/cjs/ClassRegistry.js.map +1 -1
  34. package/lib/cjs/CloudSqlite.d.ts +349 -328
  35. package/lib/cjs/CloudSqlite.d.ts.map +1 -1
  36. package/lib/cjs/CloudSqlite.js +151 -135
  37. package/lib/cjs/CloudSqlite.js.map +1 -1
  38. package/lib/cjs/CloudStorageBackend.d.ts +58 -58
  39. package/lib/cjs/CloudStorageBackend.js +173 -173
  40. package/lib/cjs/CloudStorageBackend.js.map +1 -1
  41. package/lib/cjs/CodeService.d.ts +396 -391
  42. package/lib/cjs/CodeService.d.ts.map +1 -1
  43. package/lib/cjs/CodeService.js +63 -63
  44. package/lib/cjs/CodeService.js.map +1 -1
  45. package/lib/cjs/CodeSpecs.d.ts +50 -50
  46. package/lib/cjs/CodeSpecs.js +112 -112
  47. package/lib/cjs/CodeSpecs.js.map +1 -1
  48. package/lib/cjs/ConcurrentQuery.d.ts +11 -11
  49. package/lib/cjs/ConcurrentQuery.js +30 -30
  50. package/lib/cjs/ConcurrentQuery.js.map +1 -1
  51. package/lib/cjs/CustomViewState3dCreator.d.ts +32 -32
  52. package/lib/cjs/CustomViewState3dCreator.js +113 -113
  53. package/lib/cjs/CustomViewState3dCreator.js.map +1 -1
  54. package/lib/cjs/DevTools.d.ts +71 -71
  55. package/lib/cjs/DevTools.js +154 -154
  56. package/lib/cjs/DevTools.js.map +1 -1
  57. package/lib/cjs/DisplayStyle.d.ts +106 -106
  58. package/lib/cjs/DisplayStyle.js +256 -256
  59. package/lib/cjs/DisplayStyle.js.map +1 -1
  60. package/lib/cjs/ECDb.d.ts +191 -191
  61. package/lib/cjs/ECDb.js +350 -350
  62. package/lib/cjs/ECDb.js.map +1 -1
  63. package/lib/cjs/ECSchemaXmlContext.d.ts +18 -18
  64. package/lib/cjs/ECSchemaXmlContext.js +41 -41
  65. package/lib/cjs/ECSchemaXmlContext.js.map +1 -1
  66. package/lib/cjs/ECSqlStatement.d.ts +466 -466
  67. package/lib/cjs/ECSqlStatement.js +791 -791
  68. package/lib/cjs/ECSqlStatement.js.map +1 -1
  69. package/lib/cjs/Element.d.ts +1109 -1109
  70. package/lib/cjs/Element.js +1420 -1420
  71. package/lib/cjs/Element.js.map +1 -1
  72. package/lib/cjs/ElementAspect.d.ts +156 -156
  73. package/lib/cjs/ElementAspect.js +178 -178
  74. package/lib/cjs/ElementAspect.js.map +1 -1
  75. package/lib/cjs/ElementGraphics.d.ts +9 -9
  76. package/lib/cjs/ElementGraphics.js +41 -41
  77. package/lib/cjs/ElementGraphics.js.map +1 -1
  78. package/lib/cjs/ElementTreeWalker.d.ts +162 -162
  79. package/lib/cjs/ElementTreeWalker.js +409 -409
  80. package/lib/cjs/ElementTreeWalker.js.map +1 -1
  81. package/lib/cjs/Entity.d.ts +76 -76
  82. package/lib/cjs/Entity.js +82 -82
  83. package/lib/cjs/Entity.js.map +1 -1
  84. package/lib/cjs/ExportGraphics.d.ts +317 -317
  85. package/lib/cjs/ExportGraphics.js +208 -208
  86. package/lib/cjs/ExportGraphics.js.map +1 -1
  87. package/lib/cjs/ExternalSource.d.ts +94 -94
  88. package/lib/cjs/ExternalSource.js +125 -125
  89. package/lib/cjs/ExternalSource.js.map +1 -1
  90. package/lib/cjs/GeoCoordConfig.d.ts +19 -19
  91. package/lib/cjs/GeoCoordConfig.js +82 -82
  92. package/lib/cjs/GeoCoordConfig.js.map +1 -1
  93. package/lib/cjs/GeometrySummary.d.ts +4 -4
  94. package/lib/cjs/GeometrySummary.js +380 -380
  95. package/lib/cjs/GeometrySummary.js.map +1 -1
  96. package/lib/cjs/HubMock.d.ts +93 -93
  97. package/lib/cjs/HubMock.js +190 -190
  98. package/lib/cjs/HubMock.js.map +1 -1
  99. package/lib/cjs/IModelCloneContext.d.ts +85 -85
  100. package/lib/cjs/IModelCloneContext.js +150 -150
  101. package/lib/cjs/IModelCloneContext.js.map +1 -1
  102. package/lib/cjs/IModelDb.d.ts +1164 -1164
  103. package/lib/cjs/IModelDb.js +2324 -2324
  104. package/lib/cjs/IModelDb.js.map +1 -1
  105. package/lib/cjs/IModelHost.d.ts +361 -361
  106. package/lib/cjs/IModelHost.d.ts.map +1 -1
  107. package/lib/cjs/IModelHost.js +489 -491
  108. package/lib/cjs/IModelHost.js.map +1 -1
  109. package/lib/cjs/IModelJsFs.d.ts +62 -62
  110. package/lib/cjs/IModelJsFs.js +140 -140
  111. package/lib/cjs/IModelJsFs.js.map +1 -1
  112. package/lib/cjs/IpcHost.d.ts +98 -98
  113. package/lib/cjs/IpcHost.js +234 -234
  114. package/lib/cjs/IpcHost.js.map +1 -1
  115. package/lib/cjs/LineStyle.d.ts +311 -311
  116. package/lib/cjs/LineStyle.js +295 -295
  117. package/lib/cjs/LineStyle.js.map +1 -1
  118. package/lib/cjs/LocalHub.d.ts +162 -162
  119. package/lib/cjs/LocalHub.js +587 -587
  120. package/lib/cjs/LocalHub.js.map +1 -1
  121. package/lib/cjs/LocalhostIpcHost.d.ts +20 -20
  122. package/lib/cjs/LocalhostIpcHost.js +81 -81
  123. package/lib/cjs/LocalhostIpcHost.js.map +1 -1
  124. package/lib/cjs/Material.d.ts +103 -103
  125. package/lib/cjs/Material.js +147 -147
  126. package/lib/cjs/Material.js.map +1 -1
  127. package/lib/cjs/Model.d.ts +386 -386
  128. package/lib/cjs/Model.js +471 -471
  129. package/lib/cjs/Model.js.map +1 -1
  130. package/lib/cjs/NativeAppStorage.d.ts +51 -51
  131. package/lib/cjs/NativeAppStorage.js +202 -202
  132. package/lib/cjs/NativeAppStorage.js.map +1 -1
  133. package/lib/cjs/NativeHost.d.ts +52 -52
  134. package/lib/cjs/NativeHost.js +168 -168
  135. package/lib/cjs/NativeHost.js.map +1 -1
  136. package/lib/cjs/NavigationRelationship.d.ts +156 -156
  137. package/lib/cjs/NavigationRelationship.js +225 -225
  138. package/lib/cjs/NavigationRelationship.js.map +1 -1
  139. package/lib/cjs/PromiseMemoizer.d.ts +51 -51
  140. package/lib/cjs/PromiseMemoizer.js +101 -101
  141. package/lib/cjs/PromiseMemoizer.js.map +1 -1
  142. package/lib/cjs/PropertyStore.d.ts +132 -132
  143. package/lib/cjs/PropertyStore.d.ts.map +1 -1
  144. package/lib/cjs/PropertyStore.js +11 -11
  145. package/lib/cjs/PropertyStore.js.map +1 -1
  146. package/lib/cjs/Relationship.d.ts +400 -400
  147. package/lib/cjs/Relationship.js +465 -465
  148. package/lib/cjs/Relationship.js.map +1 -1
  149. package/lib/cjs/RpcBackend.d.ts +28 -28
  150. package/lib/cjs/RpcBackend.js +126 -126
  151. package/lib/cjs/RpcBackend.js.map +1 -1
  152. package/lib/cjs/SQLiteDb.d.ts +219 -219
  153. package/lib/cjs/SQLiteDb.js +214 -214
  154. package/lib/cjs/SQLiteDb.js.map +1 -1
  155. package/lib/cjs/Schema.d.ts +55 -55
  156. package/lib/cjs/Schema.js +83 -83
  157. package/lib/cjs/Schema.js.map +1 -1
  158. package/lib/cjs/ServerBasedLocks.d.ts +57 -57
  159. package/lib/cjs/ServerBasedLocks.js +168 -168
  160. package/lib/cjs/ServerBasedLocks.js.map +1 -1
  161. package/lib/cjs/SqliteStatement.d.ts +283 -283
  162. package/lib/cjs/SqliteStatement.js +448 -448
  163. package/lib/cjs/SqliteStatement.js.map +1 -1
  164. package/lib/cjs/Texture.d.ts +58 -58
  165. package/lib/cjs/Texture.js +82 -82
  166. package/lib/cjs/Texture.js.map +1 -1
  167. package/lib/cjs/TileStorage.d.ts +18 -18
  168. package/lib/cjs/TileStorage.js +90 -90
  169. package/lib/cjs/TileStorage.js.map +1 -1
  170. package/lib/cjs/TxnManager.d.ts +202 -202
  171. package/lib/cjs/TxnManager.js +356 -356
  172. package/lib/cjs/TxnManager.js.map +1 -1
  173. package/lib/cjs/ViewDefinition.d.ts +435 -435
  174. package/lib/cjs/ViewDefinition.js +635 -635
  175. package/lib/cjs/ViewDefinition.js.map +1 -1
  176. package/lib/cjs/ViewStateHydrator.d.ts +13 -13
  177. package/lib/cjs/ViewStateHydrator.js +103 -103
  178. package/lib/cjs/ViewStateHydrator.js.map +1 -1
  179. package/lib/cjs/assets/IModelChange.02.00.00.ecschema.xml +90 -90
  180. package/lib/cjs/assets/Settings/Schemas/Cloud.Schema.json +67 -67
  181. package/lib/cjs/assets/Settings/Schemas/Gcs.schema.json +31 -31
  182. package/lib/cjs/assets/Settings/Schemas/Workspace.Schema.json +52 -52
  183. package/lib/cjs/assets/Settings/backend.setting.json5 +138 -138
  184. package/lib/cjs/core-backend.d.ts +182 -182
  185. package/lib/cjs/core-backend.js +202 -202
  186. package/lib/cjs/core-backend.js.map +1 -1
  187. package/lib/cjs/domains/FunctionalElements.d.ts +101 -101
  188. package/lib/cjs/domains/FunctionalElements.js +145 -145
  189. package/lib/cjs/domains/FunctionalElements.js.map +1 -1
  190. package/lib/cjs/domains/FunctionalSchema.d.ts +13 -13
  191. package/lib/cjs/domains/FunctionalSchema.js +40 -40
  192. package/lib/cjs/domains/FunctionalSchema.js.map +1 -1
  193. package/lib/cjs/domains/GenericElements.d.ts +177 -177
  194. package/lib/cjs/domains/GenericElements.js +263 -263
  195. package/lib/cjs/domains/GenericElements.js.map +1 -1
  196. package/lib/cjs/domains/GenericSchema.d.ts +10 -10
  197. package/lib/cjs/domains/GenericSchema.js +28 -28
  198. package/lib/cjs/domains/GenericSchema.js.map +1 -1
  199. package/lib/cjs/rpc-impl/DevToolsRpcImpl.d.ts +15 -15
  200. package/lib/cjs/rpc-impl/DevToolsRpcImpl.js +32 -32
  201. package/lib/cjs/rpc-impl/DevToolsRpcImpl.js.map +1 -1
  202. package/lib/cjs/rpc-impl/IModelReadRpcImpl.d.ts +45 -45
  203. package/lib/cjs/rpc-impl/IModelReadRpcImpl.js +262 -262
  204. package/lib/cjs/rpc-impl/IModelReadRpcImpl.js.map +1 -1
  205. package/lib/cjs/rpc-impl/IModelTileRpcImpl.d.ts +22 -22
  206. package/lib/cjs/rpc-impl/IModelTileRpcImpl.js +204 -204
  207. package/lib/cjs/rpc-impl/IModelTileRpcImpl.js.map +1 -1
  208. package/lib/cjs/rpc-impl/RpcBriefcaseUtility.d.ts +36 -36
  209. package/lib/cjs/rpc-impl/RpcBriefcaseUtility.js +168 -168
  210. package/lib/cjs/rpc-impl/RpcBriefcaseUtility.js.map +1 -1
  211. package/lib/cjs/rpc-impl/SnapshotIModelRpcImpl.d.ts +16 -16
  212. package/lib/cjs/rpc-impl/SnapshotIModelRpcImpl.js +43 -43
  213. package/lib/cjs/rpc-impl/SnapshotIModelRpcImpl.js.map +1 -1
  214. package/lib/cjs/rpc-impl/WipRpcImpl.d.ts +15 -15
  215. package/lib/cjs/rpc-impl/WipRpcImpl.js +37 -37
  216. package/lib/cjs/rpc-impl/WipRpcImpl.js.map +1 -1
  217. package/lib/cjs/workspace/Settings.d.ts +186 -186
  218. package/lib/cjs/workspace/Settings.js +155 -155
  219. package/lib/cjs/workspace/Settings.js.map +1 -1
  220. package/lib/cjs/workspace/SettingsSchemas.d.ts +75 -75
  221. package/lib/cjs/workspace/SettingsSchemas.js +191 -191
  222. package/lib/cjs/workspace/SettingsSchemas.js.map +1 -1
  223. package/lib/cjs/workspace/Workspace.d.ts +414 -405
  224. package/lib/cjs/workspace/Workspace.d.ts.map +1 -1
  225. package/lib/cjs/workspace/Workspace.js +543 -539
  226. package/lib/cjs/workspace/Workspace.js.map +1 -1
  227. package/package.json +11 -11
@@ -1,449 +1,449 @@
1
- "use strict";
2
- /*---------------------------------------------------------------------------------------------
3
- * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
4
- * See LICENSE.md in the project root for license terms and full copyright notice.
5
- *--------------------------------------------------------------------------------------------*/
6
- /** @packageDocumentation
7
- * @module SQLite
8
- */
9
- Object.defineProperty(exports, "__esModule", { value: true });
10
- exports.StatementCache = exports.SqliteValue = exports.SqliteValueType = exports.SqliteStatement = void 0;
11
- const core_bentley_1 = require("@itwin/core-bentley");
12
- const core_common_1 = require("@itwin/core-common");
13
- const IModelHost_1 = require("./IModelHost");
14
- /** Executes SQLite SQL statements.
15
- *
16
- * A statement must be prepared before it can be executed, and it must be released when no longer needed.
17
- * See [IModelDb.withPreparedSqliteStatement]($backend) or
18
- * [ECDb.withPreparedSqliteStatement]($backend) for a convenient and
19
- * reliable way to prepare, execute, and then release a statement.
20
- *
21
- * A statement may contain parameters that must be filled in before use by calling [SqliteStatement.bindValue]($backend)
22
- * or [SqliteStatement.bindValues]($backend).
23
- *
24
- * Once prepared (and parameters are bound, if any), the statement is executed by calling [SqliteStatement.step]($backend).
25
- * In case of an **SQL SELECT** statement, the current row can be retrieved with [SqliteStatement.getRow]($backend) as
26
- * a whole, or with [SqliteStatement.getValue]($backend) when individual values are needed.
27
- * Alternatively, query results of an **SQL SELECT** statement can be stepped through by using
28
- * standard iteration syntax, such as `for of`.
29
- *
30
- * > Preparing a statement can be time-consuming. The best way to reduce the effect of this overhead is to cache and reuse prepared
31
- * > statements. A cached prepared statement may be used in different places in an app, as long as the statement is general enough.
32
- * > The key to making this strategy work is to phrase a statement in a general way and use placeholders to represent parameters that will vary on each use.
33
- * @public
34
- */
35
- class SqliteStatement {
36
- constructor(_sql) {
37
- this._sql = _sql;
38
- }
39
- get stmt() { return this._stmt; }
40
- get sql() { return this._sql; }
41
- /** Check if this statement has been prepared successfully or not */
42
- get isPrepared() { return undefined !== this._stmt; }
43
- /** Prepare this statement prior to first use.
44
- * @param db The DgnDb or ECDb to prepare the statement against
45
- * @param sql The SQL statement string to prepare
46
- * @param logErrors Determine if errors are logged or not
47
- * @throws if the SQL statement cannot be prepared. Normally, prepare fails due to SQL syntax errors or references to tables or properties that do not exist.
48
- * The error.message property will provide details.
49
- */
50
- prepare(db, logErrors = true) {
51
- if (this.isPrepared)
52
- throw new Error("SqliteStatement is already prepared");
53
- this._db = db;
54
- this._stmt = new IModelHost_1.IModelHost.platform.SqliteStatement();
55
- this._stmt.prepare(db, this._sql, logErrors);
56
- }
57
- /** Indicates whether the prepared statement makes no **direct* changes to the content of the file
58
- * or not. See [SQLite docs](https://www.sqlite.org/c3ref/stmt_readonly.html) for details.
59
- */
60
- get isReadonly() {
61
- return this.stmt.isReadonly();
62
- }
63
- /** Reset this statement so that the next call to step will return the first row, if any.
64
- */
65
- reset() {
66
- this.stmt.reset();
67
- }
68
- /** Call this function when finished with this statement. This releases the native resources held by the statement. */
69
- dispose() {
70
- if (this._stmt) {
71
- this._stmt.dispose(); // free native statement
72
- this._stmt = undefined;
73
- this._db = undefined;
74
- }
75
- }
76
- /**
77
- * Call `step` on this statement and determine whether a new row is available.
78
- * Use this method only when this statement has been prepared with a SELECT statement.
79
- * @return true if a new row is available, false otherwise.
80
- * @throws if `step` returns anything other than BE_SQLITE_ROW or BE_SQLITE_DONE.
81
- */
82
- nextRow() {
83
- const rc = this.step();
84
- switch (rc) {
85
- case core_bentley_1.DbResult.BE_SQLITE_ROW:
86
- return true;
87
- case core_bentley_1.DbResult.BE_SQLITE_DONE:
88
- return false;
89
- }
90
- throw new core_bentley_1.BentleyError(rc, this._db.getLastError());
91
- }
92
- /** Binds a value to the specified SQL parameter.
93
- * The value must be of one of these types:
94
- * JavaScript Type | SQLite Type
95
- * --- | ---
96
- * undefined | NULL
97
- * boolean | INTEGER with true being bound as 1 and false as 0
98
- * number | INTEGER if number is integral or REAL if number is not integral
99
- * string | TEXT
100
- * Uint8Array or ArrayBuffer | BLOB
101
- * [StringParam]($backend) where member **id** is set | INTEGER
102
- * [StringParam]($backend) where member **guid** is set | BLOB
103
- *
104
- * @param parameter Index (1-based) or name of the parameter (including the initial ':', '@' or '$')
105
- * @param value Value to bind.
106
- * @throws [IModelError]($common) if the value is of an unsupported type or in
107
- * case of other binding errors.
108
- */
109
- bindValue(parameter, value) {
110
- let stat;
111
- if (value === undefined || value === null) {
112
- stat = this.stmt.bindNull(parameter);
113
- }
114
- else if (typeof (value) === "number") {
115
- if (Number.isInteger(value))
116
- stat = this.stmt.bindInteger(parameter, value);
117
- else
118
- stat = this.stmt.bindDouble(parameter, value);
119
- }
120
- else if (typeof (value) === "boolean") {
121
- stat = this.stmt.bindInteger(parameter, value ? 1 : 0);
122
- }
123
- else if (typeof (value) === "string") {
124
- stat = this.stmt.bindString(parameter, value);
125
- }
126
- else if (!!value.id) {
127
- stat = this.stmt.bindId(parameter, value.id);
128
- }
129
- else if (!!value.guid) {
130
- stat = this.stmt.bindGuid(parameter, value.guid);
131
- }
132
- else if (value instanceof Uint8Array) {
133
- stat = this.stmt.bindBlob(parameter, value);
134
- }
135
- else
136
- throw new core_common_1.IModelError(core_bentley_1.DbResult.BE_SQLITE_ERROR, `Parameter value ${value} is of an unsupported data type.`);
137
- if (stat !== core_bentley_1.DbResult.BE_SQLITE_OK)
138
- throw new core_common_1.IModelError(stat, "Error in bindValue");
139
- }
140
- checkBind(stat) {
141
- if (stat !== core_bentley_1.DbResult.BE_SQLITE_OK)
142
- throw new core_common_1.IModelError(stat, "SQLite Bind error");
143
- }
144
- /** Bind an integer parameter
145
- * @param parameter Index (1-based) or name of the parameter (including the initial ':', '@' or '$')
146
- * @param val integer to bind.
147
- */
148
- bindInteger(parameter, val) {
149
- this.checkBind(this.stmt.bindInteger(parameter, val));
150
- }
151
- /** Bind a double parameter
152
- * @param parameter Index (1-based) or name of the parameter (including the initial ':', '@' or '$')
153
- * @param val double to bind.
154
- */
155
- bindDouble(parameter, val) {
156
- this.checkBind(this.stmt.bindDouble(parameter, val));
157
- }
158
- /** Bind a string parameter
159
- * @param parameter Index (1-based) or name of the parameter (including the initial ':', '@' or '$')
160
- * @param val string to bind.
161
- */
162
- bindString(parameter, val) {
163
- this.checkBind(this.stmt.bindString(parameter, val));
164
- }
165
- /** Bind an Id64String parameter as a 64-bit integer
166
- * @param parameter Index (1-based) or name of the parameter (including the initial ':', '@' or '$')
167
- * @param val Id to bind.
168
- */
169
- bindId(parameter, id) {
170
- this.checkBind(this.stmt.bindId(parameter, id));
171
- }
172
- /** Bind a Guid parameter
173
- * @param parameter Index (1-based) or name of the parameter (including the initial ':', '@' or '$')
174
- * @param val Guid to bind.
175
- */
176
- bindGuid(parameter, guid) {
177
- this.checkBind(this.stmt.bindGuid(parameter, guid));
178
- }
179
- /** Bind a blob parameter
180
- * @param parameter Index (1-based) or name of the parameter (including the initial ':', '@' or '$')
181
- * @param val blob to bind.
182
- */
183
- bindBlob(parameter, blob) {
184
- this.checkBind(this.stmt.bindBlob(parameter, blob));
185
- }
186
- /** Bind null to a parameter
187
- * @param parameter Index (1-based) or name of the parameter (including the initial ':', '@' or '$')
188
- */
189
- bindNull(parameter) {
190
- this.checkBind(this.stmt.bindNull(parameter));
191
- }
192
- /** Bind values to all parameters in the statement.
193
- * @param values The values to bind to the parameters.
194
- * Pass an *array* of values if the parameters are *positional*.
195
- * Pass an *object of the values keyed on the parameter name* for *named parameters*.
196
- * The values in either the array or object must match the respective types of the parameter.
197
- * See [[SqliteStatement.bindValue]] for details on the supported types.
198
- */
199
- bindValues(values) {
200
- if (Array.isArray(values)) {
201
- for (let i = 0; i < values.length; i++) {
202
- const paramIndex = i + 1;
203
- const paramValue = values[i];
204
- if (paramValue === undefined || paramValue === null)
205
- continue;
206
- this.bindValue(paramIndex, paramValue);
207
- }
208
- return;
209
- }
210
- for (const entry of Object.entries(values)) {
211
- const paramName = entry[0];
212
- const paramValue = entry[1];
213
- if (paramValue === undefined || paramValue === null)
214
- continue;
215
- this.bindValue(paramName, paramValue);
216
- }
217
- }
218
- /** Clear any bindings that were previously set on this statement.
219
- * @throws [IModelError]($common) in case of errors
220
- */
221
- clearBindings() {
222
- const stat = this.stmt.clearBindings();
223
- if (stat !== core_bentley_1.DbResult.BE_SQLITE_OK)
224
- throw new core_common_1.IModelError(stat, "Error in clearBindings");
225
- }
226
- /** Step this statement to the next row.
227
- *
228
- * For **SQL SELECT** statements the method returns
229
- * - [DbResult.BE_SQLITE_ROW]($core-bentley) if the statement now points successfully to the next row.
230
- * - [DbResult.BE_SQLITE_DONE]($core-bentley) if the statement has no more rows.
231
- * - Error status in case of errors.
232
- *
233
- * For **SQL INSERT, UPDATE, DELETE** statements the method returns
234
- * - [DbResult.BE_SQLITE_DONE]($core-bentley) if the statement has been executed successfully.
235
- * - Error status in case of errors.
236
- */
237
- step() { return this.stmt.step(); }
238
- /** Get the query result's column count (only for SQL SELECT statements). */
239
- getColumnCount() { return this.stmt.getColumnCount(); }
240
- /** Get the value for the column at the given index in the query result.
241
- * @param columnIx Index of SQL column in query result (0-based)
242
- */
243
- getValue(columnIx) { return new SqliteValue(this.stmt, columnIx); }
244
- /** Determine whether the value of the specified column is null
245
- * @param colIndex Index of SQL column in query result (0-based)
246
- */
247
- isValueNull(colIndex) { return this.stmt.isValueNull(colIndex); }
248
- /** Get a size in bytes of a blob or text column
249
- * @param colIndex Index of SQL column in query result (0-based)
250
- */
251
- getColumnBytes(colIndex) { return this.stmt.getColumnBytes(colIndex); }
252
- /** Get a value as a blob
253
- * @param colIndex Index of SQL column in query result (0-based)
254
- */
255
- getValueBlob(colIndex) { return this.stmt.getValueBlob(colIndex); }
256
- /** Get a value as a double
257
- * @param colIndex Index of SQL column in query result (0-based)
258
- */
259
- getValueDouble(colIndex) { return this.stmt.getValueDouble(colIndex); }
260
- /** Get a value as a integer
261
- * @param colIndex Index of SQL column in query result (0-based)
262
- */
263
- getValueInteger(colIndex) { return this.stmt.getValueInteger(colIndex); }
264
- /** Get a value as a string
265
- * @param colIndex Index of SQL column in query result (0-based)
266
- */
267
- getValueString(colIndex) { return this.stmt.getValueString(colIndex); }
268
- /** Get a value as an Id
269
- * @param colIndex Index of SQL column in query result (0-based)
270
- */
271
- getValueId(colIndex) { return this.stmt.getValueId(colIndex); }
272
- /** Get a value as a Guid
273
- * @param colIndex Index of SQL column in query result (0-based)
274
- */
275
- getValueGuid(colIndex) { return this.stmt.getValueGuid(colIndex); }
276
- /** Get the current row.
277
- * The returned row is formatted as JavaScript object where every SELECT clause item becomes a property in the JavaScript object.
278
- *
279
- * The SQL select clause item's name becomes the member name of the JavaScript object, **with the first character lowered**.
280
- *
281
- * SQLite Type | JavaScript Type
282
- * --- | ---
283
- * [SqliteValueType.Null]($backend) | undefined
284
- * [SqliteValueType.Integer]($backend) | number
285
- * [SqliteValueType.Double]($backend) | number
286
- * [SqliteValueType.String]($backend) | string
287
- * [SqliteValueType.Blob]($backend) | Uint8Array
288
- */
289
- getRow() {
290
- const colCount = this.getColumnCount();
291
- const row = {};
292
- const duplicatePropNames = new Map();
293
- for (let i = 0; i < colCount; i++) {
294
- const sqliteValue = this.getValue(i);
295
- if (!sqliteValue.isNull) {
296
- const propName = SqliteStatement.determineResultRowPropertyName(duplicatePropNames, sqliteValue);
297
- let val;
298
- switch (sqliteValue.type) {
299
- case SqliteValueType.Blob:
300
- val = sqliteValue.getBlob();
301
- break;
302
- case SqliteValueType.Double:
303
- val = sqliteValue.getDouble();
304
- break;
305
- case SqliteValueType.Integer:
306
- val = sqliteValue.getInteger();
307
- break;
308
- case SqliteValueType.String:
309
- val = sqliteValue.getString();
310
- break;
311
- default:
312
- throw new Error("Unsupported SqliteValueType");
313
- }
314
- Object.defineProperty(row, propName, { enumerable: true, configurable: true, writable: true, value: val });
315
- }
316
- }
317
- return row;
318
- }
319
- static determineResultRowPropertyName(duplicatePropNames, sqliteValue) {
320
- let jsName = core_common_1.ECJsNames.toJsName(sqliteValue.columnName);
321
- // now check duplicates. If there are, append a numeric suffix to the duplicates
322
- let suffix = duplicatePropNames.get(jsName);
323
- if (suffix === undefined)
324
- duplicatePropNames.set(jsName, 0);
325
- else {
326
- suffix++;
327
- duplicatePropNames.set(jsName, suffix);
328
- jsName += `_${suffix}`;
329
- }
330
- return jsName;
331
- }
332
- /** Calls step when called as an iterator.
333
- */
334
- next() {
335
- return core_bentley_1.DbResult.BE_SQLITE_ROW === this.step() ? { done: false, value: this.getRow() } : { done: true, value: undefined };
336
- }
337
- /** The iterator that will step through the results of this statement. */
338
- [Symbol.iterator]() { return this; }
339
- }
340
- exports.SqliteStatement = SqliteStatement;
341
- /** Data type of a value in in an SQLite SQL query result.
342
- * See also:
343
- * - [SqliteValue]($backend)
344
- * - [SqliteStatement]($backend)
345
- * - [SqliteStatement.getValue]($backend)
346
- * @public
347
- */
348
- var SqliteValueType;
349
- (function (SqliteValueType) {
350
- // do not change the values of that enum. It must correspond to the respective
351
- // enum DbValueType in the native BeSQLite API.
352
- SqliteValueType[SqliteValueType["Integer"] = 1] = "Integer";
353
- SqliteValueType[SqliteValueType["Double"] = 2] = "Double";
354
- SqliteValueType[SqliteValueType["String"] = 3] = "String";
355
- SqliteValueType[SqliteValueType["Blob"] = 4] = "Blob";
356
- SqliteValueType[SqliteValueType["Null"] = 5] = "Null";
357
- })(SqliteValueType = exports.SqliteValueType || (exports.SqliteValueType = {}));
358
- /** Value of a column in a row of an SQLite SQL query result.
359
- * See also:
360
- * - [SqliteStatement]($backend)
361
- * - [SqliteStatement.getValue]($backend)
362
- * @public
363
- */
364
- class SqliteValue {
365
- constructor(stmt, colIndex) {
366
- this._stmt = stmt;
367
- this._colIndex = colIndex;
368
- }
369
- /** Indicates whether the value is NULL or not. */
370
- get isNull() { return this._stmt.isValueNull(this._colIndex); }
371
- /** Gets the data type of the value. */
372
- get type() { return this._stmt.getColumnType(this._colIndex); }
373
- /** Gets the name of the column of the value. */
374
- get columnName() { return this._stmt.getColumnName(this._colIndex); }
375
- /** Gets the SqlValue as JavaScript value.
376
- *
377
- * SQLite Type | JavaScript Type
378
- * --- | ---
379
- * [SqliteValueType.Null]($backend) | undefined
380
- * [SqliteValueType.Integer]($backend) | number
381
- * [SqliteValueType.Double]($backend) | number
382
- * [SqliteValueType.String]($backend) | string
383
- * [SqliteValueType.Blob]($backend) | Uint8Array
384
- */
385
- get value() {
386
- switch (this.type) {
387
- case SqliteValueType.Null:
388
- return undefined;
389
- case SqliteValueType.Blob:
390
- return this.getBlob();
391
- case SqliteValueType.Double:
392
- return this.getDouble();
393
- case SqliteValueType.Integer:
394
- return this.getInteger();
395
- case SqliteValueType.String:
396
- return this.getString();
397
- default:
398
- throw new Error("Unhandled SqliteValueType");
399
- }
400
- }
401
- /** Get the value as BLOB */
402
- getBlob() { return this._stmt.getValueBlob(this._colIndex); }
403
- /** Get the value as a double value */
404
- getDouble() { return this._stmt.getValueDouble(this._colIndex); }
405
- /** Get the value as a integer value */
406
- getInteger() { return this._stmt.getValueInteger(this._colIndex); }
407
- /** Get the value as a string value */
408
- getString() { return this._stmt.getValueString(this._colIndex); }
409
- /** Get the value as an Id value */
410
- getId() { return this._stmt.getValueId(this._colIndex); }
411
- /** Get the value as a Guid value */
412
- getGuid() { return this._stmt.getValueGuid(this._colIndex); }
413
- }
414
- exports.SqliteValue = SqliteValue;
415
- /** A cache for previously prepared SqliteStatements.
416
- * It only holds Statements after they are no longer in use, resetting and clearing their bindings before saving them.
417
- * When a request to use a statement from the cache is made, it is first removed from the cache.
418
- * @internal
419
- */
420
- class StatementCache {
421
- constructor(maxCount = 40) {
422
- this._cache = new core_bentley_1.LRUMap(maxCount);
423
- }
424
- get size() { return this._cache.size; }
425
- addOrDispose(stmt) {
426
- (0, core_bentley_1.assert)(stmt.isPrepared);
427
- const existing = this._cache.get(stmt.sql);
428
- if (existing !== undefined) {
429
- stmt.dispose(); // we already have a statement with this sql cached, we can't save another one so just dispose it
430
- return;
431
- }
432
- if (this._cache.size >= this._cache.limit) {
433
- const oldest = this._cache.shift();
434
- oldest[1].dispose();
435
- }
436
- stmt.reset();
437
- stmt.clearBindings();
438
- this._cache.set(stmt.sql, stmt);
439
- }
440
- findAndRemove(sql) {
441
- return this._cache.delete(sql);
442
- }
443
- clear() {
444
- this._cache.forEach((stmt) => stmt.dispose());
445
- this._cache.clear();
446
- }
447
- }
448
- exports.StatementCache = StatementCache;
1
+ "use strict";
2
+ /*---------------------------------------------------------------------------------------------
3
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
4
+ * See LICENSE.md in the project root for license terms and full copyright notice.
5
+ *--------------------------------------------------------------------------------------------*/
6
+ /** @packageDocumentation
7
+ * @module SQLite
8
+ */
9
+ Object.defineProperty(exports, "__esModule", { value: true });
10
+ exports.StatementCache = exports.SqliteValue = exports.SqliteValueType = exports.SqliteStatement = void 0;
11
+ const core_bentley_1 = require("@itwin/core-bentley");
12
+ const core_common_1 = require("@itwin/core-common");
13
+ const IModelHost_1 = require("./IModelHost");
14
+ /** Executes SQLite SQL statements.
15
+ *
16
+ * A statement must be prepared before it can be executed, and it must be released when no longer needed.
17
+ * See [IModelDb.withPreparedSqliteStatement]($backend) or
18
+ * [ECDb.withPreparedSqliteStatement]($backend) for a convenient and
19
+ * reliable way to prepare, execute, and then release a statement.
20
+ *
21
+ * A statement may contain parameters that must be filled in before use by calling [SqliteStatement.bindValue]($backend)
22
+ * or [SqliteStatement.bindValues]($backend).
23
+ *
24
+ * Once prepared (and parameters are bound, if any), the statement is executed by calling [SqliteStatement.step]($backend).
25
+ * In case of an **SQL SELECT** statement, the current row can be retrieved with [SqliteStatement.getRow]($backend) as
26
+ * a whole, or with [SqliteStatement.getValue]($backend) when individual values are needed.
27
+ * Alternatively, query results of an **SQL SELECT** statement can be stepped through by using
28
+ * standard iteration syntax, such as `for of`.
29
+ *
30
+ * > Preparing a statement can be time-consuming. The best way to reduce the effect of this overhead is to cache and reuse prepared
31
+ * > statements. A cached prepared statement may be used in different places in an app, as long as the statement is general enough.
32
+ * > The key to making this strategy work is to phrase a statement in a general way and use placeholders to represent parameters that will vary on each use.
33
+ * @public
34
+ */
35
+ class SqliteStatement {
36
+ constructor(_sql) {
37
+ this._sql = _sql;
38
+ }
39
+ get stmt() { return this._stmt; }
40
+ get sql() { return this._sql; }
41
+ /** Check if this statement has been prepared successfully or not */
42
+ get isPrepared() { return undefined !== this._stmt; }
43
+ /** Prepare this statement prior to first use.
44
+ * @param db The DgnDb or ECDb to prepare the statement against
45
+ * @param sql The SQL statement string to prepare
46
+ * @param logErrors Determine if errors are logged or not
47
+ * @throws if the SQL statement cannot be prepared. Normally, prepare fails due to SQL syntax errors or references to tables or properties that do not exist.
48
+ * The error.message property will provide details.
49
+ */
50
+ prepare(db, logErrors = true) {
51
+ if (this.isPrepared)
52
+ throw new Error("SqliteStatement is already prepared");
53
+ this._db = db;
54
+ this._stmt = new IModelHost_1.IModelHost.platform.SqliteStatement();
55
+ this._stmt.prepare(db, this._sql, logErrors);
56
+ }
57
+ /** Indicates whether the prepared statement makes no **direct* changes to the content of the file
58
+ * or not. See [SQLite docs](https://www.sqlite.org/c3ref/stmt_readonly.html) for details.
59
+ */
60
+ get isReadonly() {
61
+ return this.stmt.isReadonly();
62
+ }
63
+ /** Reset this statement so that the next call to step will return the first row, if any.
64
+ */
65
+ reset() {
66
+ this.stmt.reset();
67
+ }
68
+ /** Call this function when finished with this statement. This releases the native resources held by the statement. */
69
+ dispose() {
70
+ if (this._stmt) {
71
+ this._stmt.dispose(); // free native statement
72
+ this._stmt = undefined;
73
+ this._db = undefined;
74
+ }
75
+ }
76
+ /**
77
+ * Call `step` on this statement and determine whether a new row is available.
78
+ * Use this method only when this statement has been prepared with a SELECT statement.
79
+ * @return true if a new row is available, false otherwise.
80
+ * @throws if `step` returns anything other than BE_SQLITE_ROW or BE_SQLITE_DONE.
81
+ */
82
+ nextRow() {
83
+ const rc = this.step();
84
+ switch (rc) {
85
+ case core_bentley_1.DbResult.BE_SQLITE_ROW:
86
+ return true;
87
+ case core_bentley_1.DbResult.BE_SQLITE_DONE:
88
+ return false;
89
+ }
90
+ throw new core_bentley_1.BentleyError(rc, this._db.getLastError());
91
+ }
92
+ /** Binds a value to the specified SQL parameter.
93
+ * The value must be of one of these types:
94
+ * JavaScript Type | SQLite Type
95
+ * --- | ---
96
+ * undefined | NULL
97
+ * boolean | INTEGER with true being bound as 1 and false as 0
98
+ * number | INTEGER if number is integral or REAL if number is not integral
99
+ * string | TEXT
100
+ * Uint8Array or ArrayBuffer | BLOB
101
+ * [StringParam]($backend) where member **id** is set | INTEGER
102
+ * [StringParam]($backend) where member **guid** is set | BLOB
103
+ *
104
+ * @param parameter Index (1-based) or name of the parameter (including the initial ':', '@' or '$')
105
+ * @param value Value to bind.
106
+ * @throws [IModelError]($common) if the value is of an unsupported type or in
107
+ * case of other binding errors.
108
+ */
109
+ bindValue(parameter, value) {
110
+ let stat;
111
+ if (value === undefined || value === null) {
112
+ stat = this.stmt.bindNull(parameter);
113
+ }
114
+ else if (typeof (value) === "number") {
115
+ if (Number.isInteger(value))
116
+ stat = this.stmt.bindInteger(parameter, value);
117
+ else
118
+ stat = this.stmt.bindDouble(parameter, value);
119
+ }
120
+ else if (typeof (value) === "boolean") {
121
+ stat = this.stmt.bindInteger(parameter, value ? 1 : 0);
122
+ }
123
+ else if (typeof (value) === "string") {
124
+ stat = this.stmt.bindString(parameter, value);
125
+ }
126
+ else if (!!value.id) {
127
+ stat = this.stmt.bindId(parameter, value.id);
128
+ }
129
+ else if (!!value.guid) {
130
+ stat = this.stmt.bindGuid(parameter, value.guid);
131
+ }
132
+ else if (value instanceof Uint8Array) {
133
+ stat = this.stmt.bindBlob(parameter, value);
134
+ }
135
+ else
136
+ throw new core_common_1.IModelError(core_bentley_1.DbResult.BE_SQLITE_ERROR, `Parameter value ${value} is of an unsupported data type.`);
137
+ if (stat !== core_bentley_1.DbResult.BE_SQLITE_OK)
138
+ throw new core_common_1.IModelError(stat, "Error in bindValue");
139
+ }
140
+ checkBind(stat) {
141
+ if (stat !== core_bentley_1.DbResult.BE_SQLITE_OK)
142
+ throw new core_common_1.IModelError(stat, "SQLite Bind error");
143
+ }
144
+ /** Bind an integer parameter
145
+ * @param parameter Index (1-based) or name of the parameter (including the initial ':', '@' or '$')
146
+ * @param val integer to bind.
147
+ */
148
+ bindInteger(parameter, val) {
149
+ this.checkBind(this.stmt.bindInteger(parameter, val));
150
+ }
151
+ /** Bind a double parameter
152
+ * @param parameter Index (1-based) or name of the parameter (including the initial ':', '@' or '$')
153
+ * @param val double to bind.
154
+ */
155
+ bindDouble(parameter, val) {
156
+ this.checkBind(this.stmt.bindDouble(parameter, val));
157
+ }
158
+ /** Bind a string parameter
159
+ * @param parameter Index (1-based) or name of the parameter (including the initial ':', '@' or '$')
160
+ * @param val string to bind.
161
+ */
162
+ bindString(parameter, val) {
163
+ this.checkBind(this.stmt.bindString(parameter, val));
164
+ }
165
+ /** Bind an Id64String parameter as a 64-bit integer
166
+ * @param parameter Index (1-based) or name of the parameter (including the initial ':', '@' or '$')
167
+ * @param val Id to bind.
168
+ */
169
+ bindId(parameter, id) {
170
+ this.checkBind(this.stmt.bindId(parameter, id));
171
+ }
172
+ /** Bind a Guid parameter
173
+ * @param parameter Index (1-based) or name of the parameter (including the initial ':', '@' or '$')
174
+ * @param val Guid to bind.
175
+ */
176
+ bindGuid(parameter, guid) {
177
+ this.checkBind(this.stmt.bindGuid(parameter, guid));
178
+ }
179
+ /** Bind a blob parameter
180
+ * @param parameter Index (1-based) or name of the parameter (including the initial ':', '@' or '$')
181
+ * @param val blob to bind.
182
+ */
183
+ bindBlob(parameter, blob) {
184
+ this.checkBind(this.stmt.bindBlob(parameter, blob));
185
+ }
186
+ /** Bind null to a parameter
187
+ * @param parameter Index (1-based) or name of the parameter (including the initial ':', '@' or '$')
188
+ */
189
+ bindNull(parameter) {
190
+ this.checkBind(this.stmt.bindNull(parameter));
191
+ }
192
+ /** Bind values to all parameters in the statement.
193
+ * @param values The values to bind to the parameters.
194
+ * Pass an *array* of values if the parameters are *positional*.
195
+ * Pass an *object of the values keyed on the parameter name* for *named parameters*.
196
+ * The values in either the array or object must match the respective types of the parameter.
197
+ * See [[SqliteStatement.bindValue]] for details on the supported types.
198
+ */
199
+ bindValues(values) {
200
+ if (Array.isArray(values)) {
201
+ for (let i = 0; i < values.length; i++) {
202
+ const paramIndex = i + 1;
203
+ const paramValue = values[i];
204
+ if (paramValue === undefined || paramValue === null)
205
+ continue;
206
+ this.bindValue(paramIndex, paramValue);
207
+ }
208
+ return;
209
+ }
210
+ for (const entry of Object.entries(values)) {
211
+ const paramName = entry[0];
212
+ const paramValue = entry[1];
213
+ if (paramValue === undefined || paramValue === null)
214
+ continue;
215
+ this.bindValue(paramName, paramValue);
216
+ }
217
+ }
218
+ /** Clear any bindings that were previously set on this statement.
219
+ * @throws [IModelError]($common) in case of errors
220
+ */
221
+ clearBindings() {
222
+ const stat = this.stmt.clearBindings();
223
+ if (stat !== core_bentley_1.DbResult.BE_SQLITE_OK)
224
+ throw new core_common_1.IModelError(stat, "Error in clearBindings");
225
+ }
226
+ /** Step this statement to the next row.
227
+ *
228
+ * For **SQL SELECT** statements the method returns
229
+ * - [DbResult.BE_SQLITE_ROW]($core-bentley) if the statement now points successfully to the next row.
230
+ * - [DbResult.BE_SQLITE_DONE]($core-bentley) if the statement has no more rows.
231
+ * - Error status in case of errors.
232
+ *
233
+ * For **SQL INSERT, UPDATE, DELETE** statements the method returns
234
+ * - [DbResult.BE_SQLITE_DONE]($core-bentley) if the statement has been executed successfully.
235
+ * - Error status in case of errors.
236
+ */
237
+ step() { return this.stmt.step(); }
238
+ /** Get the query result's column count (only for SQL SELECT statements). */
239
+ getColumnCount() { return this.stmt.getColumnCount(); }
240
+ /** Get the value for the column at the given index in the query result.
241
+ * @param columnIx Index of SQL column in query result (0-based)
242
+ */
243
+ getValue(columnIx) { return new SqliteValue(this.stmt, columnIx); }
244
+ /** Determine whether the value of the specified column is null
245
+ * @param colIndex Index of SQL column in query result (0-based)
246
+ */
247
+ isValueNull(colIndex) { return this.stmt.isValueNull(colIndex); }
248
+ /** Get a size in bytes of a blob or text column
249
+ * @param colIndex Index of SQL column in query result (0-based)
250
+ */
251
+ getColumnBytes(colIndex) { return this.stmt.getColumnBytes(colIndex); }
252
+ /** Get a value as a blob
253
+ * @param colIndex Index of SQL column in query result (0-based)
254
+ */
255
+ getValueBlob(colIndex) { return this.stmt.getValueBlob(colIndex); }
256
+ /** Get a value as a double
257
+ * @param colIndex Index of SQL column in query result (0-based)
258
+ */
259
+ getValueDouble(colIndex) { return this.stmt.getValueDouble(colIndex); }
260
+ /** Get a value as a integer
261
+ * @param colIndex Index of SQL column in query result (0-based)
262
+ */
263
+ getValueInteger(colIndex) { return this.stmt.getValueInteger(colIndex); }
264
+ /** Get a value as a string
265
+ * @param colIndex Index of SQL column in query result (0-based)
266
+ */
267
+ getValueString(colIndex) { return this.stmt.getValueString(colIndex); }
268
+ /** Get a value as an Id
269
+ * @param colIndex Index of SQL column in query result (0-based)
270
+ */
271
+ getValueId(colIndex) { return this.stmt.getValueId(colIndex); }
272
+ /** Get a value as a Guid
273
+ * @param colIndex Index of SQL column in query result (0-based)
274
+ */
275
+ getValueGuid(colIndex) { return this.stmt.getValueGuid(colIndex); }
276
+ /** Get the current row.
277
+ * The returned row is formatted as JavaScript object where every SELECT clause item becomes a property in the JavaScript object.
278
+ *
279
+ * The SQL select clause item's name becomes the member name of the JavaScript object, **with the first character lowered**.
280
+ *
281
+ * SQLite Type | JavaScript Type
282
+ * --- | ---
283
+ * [SqliteValueType.Null]($backend) | undefined
284
+ * [SqliteValueType.Integer]($backend) | number
285
+ * [SqliteValueType.Double]($backend) | number
286
+ * [SqliteValueType.String]($backend) | string
287
+ * [SqliteValueType.Blob]($backend) | Uint8Array
288
+ */
289
+ getRow() {
290
+ const colCount = this.getColumnCount();
291
+ const row = {};
292
+ const duplicatePropNames = new Map();
293
+ for (let i = 0; i < colCount; i++) {
294
+ const sqliteValue = this.getValue(i);
295
+ if (!sqliteValue.isNull) {
296
+ const propName = SqliteStatement.determineResultRowPropertyName(duplicatePropNames, sqliteValue);
297
+ let val;
298
+ switch (sqliteValue.type) {
299
+ case SqliteValueType.Blob:
300
+ val = sqliteValue.getBlob();
301
+ break;
302
+ case SqliteValueType.Double:
303
+ val = sqliteValue.getDouble();
304
+ break;
305
+ case SqliteValueType.Integer:
306
+ val = sqliteValue.getInteger();
307
+ break;
308
+ case SqliteValueType.String:
309
+ val = sqliteValue.getString();
310
+ break;
311
+ default:
312
+ throw new Error("Unsupported SqliteValueType");
313
+ }
314
+ Object.defineProperty(row, propName, { enumerable: true, configurable: true, writable: true, value: val });
315
+ }
316
+ }
317
+ return row;
318
+ }
319
+ static determineResultRowPropertyName(duplicatePropNames, sqliteValue) {
320
+ let jsName = core_common_1.ECJsNames.toJsName(sqliteValue.columnName);
321
+ // now check duplicates. If there are, append a numeric suffix to the duplicates
322
+ let suffix = duplicatePropNames.get(jsName);
323
+ if (suffix === undefined)
324
+ duplicatePropNames.set(jsName, 0);
325
+ else {
326
+ suffix++;
327
+ duplicatePropNames.set(jsName, suffix);
328
+ jsName += `_${suffix}`;
329
+ }
330
+ return jsName;
331
+ }
332
+ /** Calls step when called as an iterator.
333
+ */
334
+ next() {
335
+ return core_bentley_1.DbResult.BE_SQLITE_ROW === this.step() ? { done: false, value: this.getRow() } : { done: true, value: undefined };
336
+ }
337
+ /** The iterator that will step through the results of this statement. */
338
+ [Symbol.iterator]() { return this; }
339
+ }
340
+ exports.SqliteStatement = SqliteStatement;
341
+ /** Data type of a value in in an SQLite SQL query result.
342
+ * See also:
343
+ * - [SqliteValue]($backend)
344
+ * - [SqliteStatement]($backend)
345
+ * - [SqliteStatement.getValue]($backend)
346
+ * @public
347
+ */
348
+ var SqliteValueType;
349
+ (function (SqliteValueType) {
350
+ // do not change the values of that enum. It must correspond to the respective
351
+ // enum DbValueType in the native BeSQLite API.
352
+ SqliteValueType[SqliteValueType["Integer"] = 1] = "Integer";
353
+ SqliteValueType[SqliteValueType["Double"] = 2] = "Double";
354
+ SqliteValueType[SqliteValueType["String"] = 3] = "String";
355
+ SqliteValueType[SqliteValueType["Blob"] = 4] = "Blob";
356
+ SqliteValueType[SqliteValueType["Null"] = 5] = "Null";
357
+ })(SqliteValueType = exports.SqliteValueType || (exports.SqliteValueType = {}));
358
+ /** Value of a column in a row of an SQLite SQL query result.
359
+ * See also:
360
+ * - [SqliteStatement]($backend)
361
+ * - [SqliteStatement.getValue]($backend)
362
+ * @public
363
+ */
364
+ class SqliteValue {
365
+ constructor(stmt, colIndex) {
366
+ this._stmt = stmt;
367
+ this._colIndex = colIndex;
368
+ }
369
+ /** Indicates whether the value is NULL or not. */
370
+ get isNull() { return this._stmt.isValueNull(this._colIndex); }
371
+ /** Gets the data type of the value. */
372
+ get type() { return this._stmt.getColumnType(this._colIndex); }
373
+ /** Gets the name of the column of the value. */
374
+ get columnName() { return this._stmt.getColumnName(this._colIndex); }
375
+ /** Gets the SqlValue as JavaScript value.
376
+ *
377
+ * SQLite Type | JavaScript Type
378
+ * --- | ---
379
+ * [SqliteValueType.Null]($backend) | undefined
380
+ * [SqliteValueType.Integer]($backend) | number
381
+ * [SqliteValueType.Double]($backend) | number
382
+ * [SqliteValueType.String]($backend) | string
383
+ * [SqliteValueType.Blob]($backend) | Uint8Array
384
+ */
385
+ get value() {
386
+ switch (this.type) {
387
+ case SqliteValueType.Null:
388
+ return undefined;
389
+ case SqliteValueType.Blob:
390
+ return this.getBlob();
391
+ case SqliteValueType.Double:
392
+ return this.getDouble();
393
+ case SqliteValueType.Integer:
394
+ return this.getInteger();
395
+ case SqliteValueType.String:
396
+ return this.getString();
397
+ default:
398
+ throw new Error("Unhandled SqliteValueType");
399
+ }
400
+ }
401
+ /** Get the value as BLOB */
402
+ getBlob() { return this._stmt.getValueBlob(this._colIndex); }
403
+ /** Get the value as a double value */
404
+ getDouble() { return this._stmt.getValueDouble(this._colIndex); }
405
+ /** Get the value as a integer value */
406
+ getInteger() { return this._stmt.getValueInteger(this._colIndex); }
407
+ /** Get the value as a string value */
408
+ getString() { return this._stmt.getValueString(this._colIndex); }
409
+ /** Get the value as an Id value */
410
+ getId() { return this._stmt.getValueId(this._colIndex); }
411
+ /** Get the value as a Guid value */
412
+ getGuid() { return this._stmt.getValueGuid(this._colIndex); }
413
+ }
414
+ exports.SqliteValue = SqliteValue;
415
+ /** A cache for previously prepared SqliteStatements.
416
+ * It only holds Statements after they are no longer in use, resetting and clearing their bindings before saving them.
417
+ * When a request to use a statement from the cache is made, it is first removed from the cache.
418
+ * @internal
419
+ */
420
+ class StatementCache {
421
+ constructor(maxCount = 40) {
422
+ this._cache = new core_bentley_1.LRUMap(maxCount);
423
+ }
424
+ get size() { return this._cache.size; }
425
+ addOrDispose(stmt) {
426
+ (0, core_bentley_1.assert)(stmt.isPrepared);
427
+ const existing = this._cache.get(stmt.sql);
428
+ if (existing !== undefined) {
429
+ stmt.dispose(); // we already have a statement with this sql cached, we can't save another one so just dispose it
430
+ return;
431
+ }
432
+ if (this._cache.size >= this._cache.limit) {
433
+ const oldest = this._cache.shift();
434
+ oldest[1].dispose();
435
+ }
436
+ stmt.reset();
437
+ stmt.clearBindings();
438
+ this._cache.set(stmt.sql, stmt);
439
+ }
440
+ findAndRemove(sql) {
441
+ return this._cache.delete(sql);
442
+ }
443
+ clear() {
444
+ this._cache.forEach((stmt) => stmt.dispose());
445
+ this._cache.clear();
446
+ }
447
+ }
448
+ exports.StatementCache = StatementCache;
449
449
  //# sourceMappingURL=SqliteStatement.js.map