knex 3.2.2 → 3.2.4

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 (199) hide show
  1. package/CHANGELOG.md +2447 -2441
  2. package/CONTRIBUTING.md +190 -190
  3. package/LICENSE +22 -22
  4. package/README.md +156 -156
  5. package/UPGRADING.md +245 -245
  6. package/bin/cli.js +516 -516
  7. package/bin/knexfile-runtime-error.js +27 -27
  8. package/bin/utils/cli-config-utils.js +217 -217
  9. package/bin/utils/constants.js +7 -7
  10. package/bin/utils/migrationsLister.js +37 -37
  11. package/knex.js +23 -23
  12. package/knex.mjs +11 -11
  13. package/lib/builder-interface-augmenter.js +120 -120
  14. package/lib/client.js +585 -585
  15. package/lib/constants.js +61 -61
  16. package/lib/dialects/better-sqlite3/index.js +101 -101
  17. package/lib/dialects/cockroachdb/crdb-columncompiler.js +14 -14
  18. package/lib/dialects/cockroachdb/crdb-querybuilder.js +11 -11
  19. package/lib/dialects/cockroachdb/crdb-querycompiler.js +122 -122
  20. package/lib/dialects/cockroachdb/crdb-tablecompiler.js +46 -46
  21. package/lib/dialects/cockroachdb/crdb-viewcompiler.js +15 -15
  22. package/lib/dialects/cockroachdb/index.js +86 -86
  23. package/lib/dialects/index.js +34 -34
  24. package/lib/dialects/mssql/index.js +498 -498
  25. package/lib/dialects/mssql/mssql-formatter.js +34 -34
  26. package/lib/dialects/mssql/query/mssql-querycompiler.js +601 -601
  27. package/lib/dialects/mssql/schema/mssql-columncompiler.js +185 -185
  28. package/lib/dialects/mssql/schema/mssql-compiler.js +91 -91
  29. package/lib/dialects/mssql/schema/mssql-tablecompiler.js +393 -393
  30. package/lib/dialects/mssql/schema/mssql-viewcompiler.js +55 -55
  31. package/lib/dialects/mssql/transaction.js +176 -176
  32. package/lib/dialects/mysql/index.js +317 -317
  33. package/lib/dialects/mysql/query/mysql-querybuilder.js +14 -14
  34. package/lib/dialects/mysql/query/mysql-querycompiler.js +292 -292
  35. package/lib/dialects/mysql/schema/mysql-columncompiler.js +193 -193
  36. package/lib/dialects/mysql/schema/mysql-compiler.js +60 -60
  37. package/lib/dialects/mysql/schema/mysql-tablecompiler.js +426 -426
  38. package/lib/dialects/mysql/schema/mysql-viewbuilder.js +21 -21
  39. package/lib/dialects/mysql/schema/mysql-viewcompiler.js +15 -15
  40. package/lib/dialects/mysql/transaction.js +46 -46
  41. package/lib/dialects/mysql2/index.js +53 -53
  42. package/lib/dialects/mysql2/transaction.js +44 -44
  43. package/lib/dialects/oracle/DEAD_CODE.md +5 -5
  44. package/lib/dialects/oracle/index.js +92 -92
  45. package/lib/dialects/oracle/query/oracle-querycompiler.js +343 -343
  46. package/lib/dialects/oracle/schema/internal/incrementUtils.js +22 -22
  47. package/lib/dialects/oracle/schema/internal/trigger.js +155 -155
  48. package/lib/dialects/oracle/schema/oracle-columnbuilder.js +17 -17
  49. package/lib/dialects/oracle/schema/oracle-columncompiler.js +126 -126
  50. package/lib/dialects/oracle/schema/oracle-compiler.js +124 -124
  51. package/lib/dialects/oracle/schema/oracle-tablecompiler.js +210 -210
  52. package/lib/dialects/oracle/utils.js +107 -107
  53. package/lib/dialects/oracledb/index.js +381 -381
  54. package/lib/dialects/oracledb/query/oracledb-querycompiler.js +481 -481
  55. package/lib/dialects/oracledb/schema/oracledb-columncompiler.js +61 -61
  56. package/lib/dialects/oracledb/schema/oracledb-tablecompiler.js +19 -19
  57. package/lib/dialects/oracledb/schema/oracledb-viewbuilder.js +13 -13
  58. package/lib/dialects/oracledb/schema/oracledb-viewcompiler.js +19 -19
  59. package/lib/dialects/oracledb/transaction.js +98 -98
  60. package/lib/dialects/oracledb/utils.js +208 -208
  61. package/lib/dialects/pgnative/index.js +60 -60
  62. package/lib/dialects/postgres/execution/pg-transaction.js +19 -19
  63. package/lib/dialects/postgres/index.js +373 -373
  64. package/lib/dialects/postgres/query/pg-querybuilder.js +43 -43
  65. package/lib/dialects/postgres/query/pg-querycompiler.js +400 -400
  66. package/lib/dialects/postgres/schema/pg-columncompiler.js +162 -162
  67. package/lib/dialects/postgres/schema/pg-compiler.js +138 -138
  68. package/lib/dialects/postgres/schema/pg-tablecompiler.js +331 -331
  69. package/lib/dialects/postgres/schema/pg-viewbuilder.js +21 -21
  70. package/lib/dialects/postgres/schema/pg-viewcompiler.js +35 -35
  71. package/lib/dialects/redshift/index.js +86 -86
  72. package/lib/dialects/redshift/query/redshift-querycompiler.js +163 -163
  73. package/lib/dialects/redshift/schema/redshift-columnbuilder.js +22 -22
  74. package/lib/dialects/redshift/schema/redshift-columncompiler.js +67 -67
  75. package/lib/dialects/redshift/schema/redshift-compiler.js +14 -14
  76. package/lib/dialects/redshift/schema/redshift-tablecompiler.js +134 -134
  77. package/lib/dialects/redshift/schema/redshift-viewcompiler.js +11 -11
  78. package/lib/dialects/redshift/transaction.js +32 -32
  79. package/lib/dialects/sqlite3/execution/sqlite-transaction.js +172 -172
  80. package/lib/dialects/sqlite3/index.js +263 -263
  81. package/lib/dialects/sqlite3/query/sqlite-querybuilder.js +33 -33
  82. package/lib/dialects/sqlite3/query/sqlite-querycompiler.js +341 -341
  83. package/lib/dialects/sqlite3/schema/ddl.js +380 -380
  84. package/lib/dialects/sqlite3/schema/internal/compiler.js +327 -327
  85. package/lib/dialects/sqlite3/schema/internal/parser-combinator.js +161 -161
  86. package/lib/dialects/sqlite3/schema/internal/parser.js +638 -638
  87. package/lib/dialects/sqlite3/schema/internal/sqlite-ddl-operations.js +41 -41
  88. package/lib/dialects/sqlite3/schema/internal/tokenizer.js +38 -38
  89. package/lib/dialects/sqlite3/schema/internal/utils.js +12 -12
  90. package/lib/dialects/sqlite3/schema/sqlite-columncompiler.js +50 -50
  91. package/lib/dialects/sqlite3/schema/sqlite-compiler.js +80 -80
  92. package/lib/dialects/sqlite3/schema/sqlite-tablecompiler.js +364 -364
  93. package/lib/dialects/sqlite3/schema/sqlite-viewcompiler.js +40 -40
  94. package/lib/execution/batch-insert.js +51 -51
  95. package/lib/execution/internal/delay.js +6 -6
  96. package/lib/execution/internal/ensure-connection-callback.js +41 -41
  97. package/lib/execution/internal/query-executioner.js +62 -62
  98. package/lib/execution/runner.js +325 -325
  99. package/lib/execution/transaction.js +417 -417
  100. package/lib/formatter/formatterUtils.js +42 -42
  101. package/lib/formatter/rawFormatter.js +84 -84
  102. package/lib/formatter/wrappingFormatter.js +253 -253
  103. package/lib/formatter.js +25 -25
  104. package/lib/index.js +3 -3
  105. package/lib/knex-builder/FunctionHelper.js +80 -80
  106. package/lib/knex-builder/Knex.js +59 -59
  107. package/lib/knex-builder/internal/config-resolver.js +57 -57
  108. package/lib/knex-builder/internal/parse-connection.js +87 -87
  109. package/lib/knex-builder/make-knex.js +345 -345
  110. package/lib/logger.js +76 -76
  111. package/lib/migrations/common/MigrationsLoader.js +36 -36
  112. package/lib/migrations/migrate/MigrationGenerator.js +84 -84
  113. package/lib/migrations/migrate/Migrator.js +632 -632
  114. package/lib/migrations/migrate/migrate-stub.js +17 -17
  115. package/lib/migrations/migrate/migration-list-resolver.js +33 -33
  116. package/lib/migrations/migrate/migrator-configuration-merger.js +58 -58
  117. package/lib/migrations/migrate/sources/fs-migrations.js +74 -74
  118. package/lib/migrations/migrate/stub/cjs.stub +15 -15
  119. package/lib/migrations/migrate/stub/coffee.stub +13 -13
  120. package/lib/migrations/migrate/stub/eg.stub +14 -14
  121. package/lib/migrations/migrate/stub/js-schema.stub +22 -22
  122. package/lib/migrations/migrate/stub/js.stub +22 -22
  123. package/lib/migrations/migrate/stub/knexfile-coffee.stub +34 -34
  124. package/lib/migrations/migrate/stub/knexfile-eg.stub +43 -43
  125. package/lib/migrations/migrate/stub/knexfile-js.stub +47 -47
  126. package/lib/migrations/migrate/stub/knexfile-ls.stub +35 -35
  127. package/lib/migrations/migrate/stub/knexfile-ts.stub +47 -47
  128. package/lib/migrations/migrate/stub/ls.stub +14 -14
  129. package/lib/migrations/migrate/stub/mjs.stub +23 -23
  130. package/lib/migrations/migrate/stub/ts-schema.stub +21 -21
  131. package/lib/migrations/migrate/stub/ts.stub +21 -21
  132. package/lib/migrations/migrate/table-creator.js +77 -77
  133. package/lib/migrations/migrate/table-resolver.js +27 -27
  134. package/lib/migrations/seed/Seeder.js +137 -137
  135. package/lib/migrations/seed/seed-stub.js +13 -13
  136. package/lib/migrations/seed/seeder-configuration-merger.js +60 -60
  137. package/lib/migrations/seed/sources/fs-seeds.js +65 -65
  138. package/lib/migrations/seed/stub/coffee.stub +9 -9
  139. package/lib/migrations/seed/stub/eg.stub +11 -11
  140. package/lib/migrations/seed/stub/js.stub +13 -13
  141. package/lib/migrations/seed/stub/ls.stub +11 -11
  142. package/lib/migrations/seed/stub/mjs.stub +12 -12
  143. package/lib/migrations/seed/stub/ts.stub +13 -13
  144. package/lib/migrations/util/fs.js +86 -86
  145. package/lib/migrations/util/import-file.js +12 -12
  146. package/lib/migrations/util/is-module-type.js +9 -9
  147. package/lib/migrations/util/template.js +52 -52
  148. package/lib/migrations/util/timestamp.js +14 -14
  149. package/lib/query/analytic.js +52 -52
  150. package/lib/query/constants.js +15 -15
  151. package/lib/query/joinclause.js +270 -270
  152. package/lib/query/method-constants.js +136 -136
  153. package/lib/query/querybuilder.js +1793 -1793
  154. package/lib/query/querycompiler.js +1634 -1634
  155. package/lib/raw.js +139 -139
  156. package/lib/ref.js +39 -39
  157. package/lib/schema/builder.js +115 -115
  158. package/lib/schema/columnbuilder.js +146 -146
  159. package/lib/schema/columncompiler.js +307 -307
  160. package/lib/schema/compiler.js +187 -187
  161. package/lib/schema/internal/helpers.js +55 -55
  162. package/lib/schema/tablebuilder.js +379 -379
  163. package/lib/schema/tablecompiler.js +450 -450
  164. package/lib/schema/viewbuilder.js +92 -92
  165. package/lib/schema/viewcompiler.js +138 -138
  166. package/lib/util/finally-mixin.js +13 -13
  167. package/lib/util/helpers.js +95 -95
  168. package/lib/util/is.js +32 -32
  169. package/lib/util/nanoid.js +40 -40
  170. package/lib/util/noop.js +1 -1
  171. package/lib/util/save-async-stack.js +14 -14
  172. package/lib/util/security.js +32 -32
  173. package/lib/util/string.js +190 -190
  174. package/lib/util/timeout.js +29 -29
  175. package/package.json +294 -296
  176. package/scripts/act-testing/act.sh +19 -19
  177. package/scripts/act-testing/merged-no-label.json +11 -11
  178. package/scripts/act-testing/merged-patch-labeled.json +12 -12
  179. package/scripts/act-testing/merged-skip-labeled.json +12 -12
  180. package/scripts/act-testing/not-merged-patch-labeled.json +12 -12
  181. package/scripts/build-for-release.sh +121 -121
  182. package/scripts/build.js +125 -125
  183. package/scripts/clean.js +31 -31
  184. package/scripts/docker-compose.yml +150 -150
  185. package/scripts/format-changelog.js +55 -55
  186. package/scripts/next-release-howto.md +24 -24
  187. package/scripts/oracledb-install-driver-libs.sh +82 -82
  188. package/scripts/release.sh +36 -36
  189. package/scripts/runkit-example.js +35 -35
  190. package/scripts/stress-test/README.txt +18 -18
  191. package/scripts/stress-test/docker-compose.yml +55 -55
  192. package/scripts/stress-test/knex-stress-test.js +212 -212
  193. package/scripts/stress-test/mysql2-random-hanging-every-now-and-then.js +149 -149
  194. package/scripts/stress-test/mysql2-sudden-exit-without-error.js +101 -101
  195. package/scripts/stress-test/reconnect-test-mysql-based-drivers.js +188 -188
  196. package/types/index.d.mts +11 -0
  197. package/types/index.d.ts +3321 -3321
  198. package/types/result.d.ts +27 -27
  199. package/types/tables.d.ts +4 -4
package/lib/client.js CHANGED
@@ -1,585 +1,585 @@
1
- const { Pool, TimeoutError } = require('tarn');
2
- const { EventEmitter } = require('events');
3
- const { promisify } = require('util');
4
- const { makeEscape } = require('./util/string');
5
- const cloneDeep = require('lodash/cloneDeep');
6
- const defaults = require('lodash/defaults');
7
- const uniqueId = require('lodash/uniqueId');
8
-
9
- const Runner = require('./execution/runner');
10
- const Transaction = require('./execution/transaction');
11
- const {
12
- executeQuery,
13
- enrichQueryObject,
14
- } = require('./execution/internal/query-executioner');
15
- const QueryBuilder = require('./query/querybuilder');
16
- const QueryCompiler = require('./query/querycompiler');
17
- const SchemaBuilder = require('./schema/builder');
18
- const SchemaCompiler = require('./schema/compiler');
19
- const TableBuilder = require('./schema/tablebuilder');
20
- const TableCompiler = require('./schema/tablecompiler');
21
- const ColumnBuilder = require('./schema/columnbuilder');
22
- const ColumnCompiler = require('./schema/columncompiler');
23
- const { KnexTimeoutError } = require('./util/timeout');
24
- const { outputQuery, unwrapRaw } = require('./formatter/wrappingFormatter');
25
- const { compileCallback } = require('./formatter/formatterUtils');
26
- const Raw = require('./raw');
27
- const Ref = require('./ref');
28
- const Formatter = require('./formatter');
29
- const Logger = require('./logger');
30
- const { POOL_CONFIG_OPTIONS } = require('./constants');
31
- const ViewBuilder = require('./schema/viewbuilder.js');
32
- const ViewCompiler = require('./schema/viewcompiler.js');
33
- const isPlainObject = require('lodash/isPlainObject');
34
- const { setHiddenProperty } = require('./util/security.js');
35
-
36
- const debug = require('debug')('knex:client');
37
-
38
- // The base client provides the general structure
39
- // for a dialect specific client object.
40
-
41
- class Client extends EventEmitter {
42
- constructor(config = {}) {
43
- super();
44
- this.config = config;
45
- this.logger = new Logger(config);
46
-
47
- if (this.config.connection && this.config.connection.password) {
48
- setHiddenProperty(this.config.connection);
49
- }
50
-
51
- //Client is a required field, so throw error if it's not supplied.
52
- //If 'this.dialect' is set, then this is a 'super()' call, in which case
53
- //'client' does not have to be set as it's already assigned on the client prototype.
54
-
55
- if (this.dialect && !this.config.client) {
56
- this.logger.warn(
57
- `Using 'this.dialect' to identify the client is deprecated and support for it will be removed in the future. Please use configuration option 'client' instead.`
58
- );
59
- }
60
-
61
- const dbClient = this.config.client || this.dialect;
62
- if (!dbClient) {
63
- throw new Error(
64
- `knex: Required configuration option 'client' is missing.`
65
- );
66
- }
67
-
68
- if (config.version) {
69
- this.version = config.version;
70
- }
71
-
72
- if (config.connection && config.connection instanceof Function) {
73
- this.connectionConfigProvider = config.connection;
74
- this.connectionConfigExpirationChecker = () => true; // causes the provider to be called on first use
75
- } else {
76
- this.connectionSettings = cloneDeep(config.connection || {});
77
- if (config.connection && config.connection.password) {
78
- setHiddenProperty(this.connectionSettings, config.connection);
79
- }
80
- this.connectionConfigExpirationChecker = null;
81
- }
82
- if (this.driverName && config.connection) {
83
- this.initializeDriver();
84
- if (!config.pool || (config.pool && config.pool.max !== 0)) {
85
- this.initializePool(config);
86
- }
87
- }
88
- this.valueForUndefined = this.raw('DEFAULT');
89
- if (config.useNullAsDefault) {
90
- this.valueForUndefined = null;
91
- }
92
- }
93
- formatter(builder) {
94
- return new Formatter(this, builder);
95
- }
96
-
97
- queryBuilder() {
98
- return new QueryBuilder(this);
99
- }
100
-
101
- queryCompiler(builder, formatter) {
102
- return new QueryCompiler(this, builder, formatter);
103
- }
104
-
105
- schemaBuilder() {
106
- return new SchemaBuilder(this);
107
- }
108
-
109
- schemaCompiler(builder) {
110
- return new SchemaCompiler(this, builder);
111
- }
112
-
113
- tableBuilder(type, tableName, tableNameLike, fn) {
114
- return new TableBuilder(this, type, tableName, tableNameLike, fn);
115
- }
116
-
117
- viewBuilder(type, viewBuilder, fn) {
118
- return new ViewBuilder(this, type, viewBuilder, fn);
119
- }
120
-
121
- tableCompiler(tableBuilder) {
122
- return new TableCompiler(this, tableBuilder);
123
- }
124
-
125
- viewCompiler(viewCompiler) {
126
- return new ViewCompiler(this, viewCompiler);
127
- }
128
-
129
- columnBuilder(tableBuilder, type, args) {
130
- return new ColumnBuilder(this, tableBuilder, type, args);
131
- }
132
-
133
- columnCompiler(tableBuilder, columnBuilder) {
134
- return new ColumnCompiler(this, tableBuilder, columnBuilder);
135
- }
136
-
137
- runner(builder) {
138
- return new Runner(this, builder);
139
- }
140
-
141
- transaction(container, config, outerTx) {
142
- return new Transaction(this, container, config, outerTx);
143
- }
144
-
145
- raw() {
146
- return new Raw(this).set(...arguments);
147
- }
148
-
149
- ref() {
150
- return new Ref(this, ...arguments);
151
- }
152
- query(connection, queryParam) {
153
- const queryObject = enrichQueryObject(connection, queryParam, this);
154
- return executeQuery(connection, queryObject, this);
155
- }
156
-
157
- stream(connection, queryParam, stream, options) {
158
- const queryObject = enrichQueryObject(connection, queryParam, this);
159
- return this._stream(connection, queryObject, stream, options);
160
- }
161
-
162
- prepBindings(bindings) {
163
- return bindings;
164
- }
165
-
166
- positionBindings(sql) {
167
- return sql;
168
- }
169
-
170
- postProcessResponse(resp, queryContext) {
171
- if (this.config.postProcessResponse) {
172
- return this.config.postProcessResponse(resp, queryContext);
173
- }
174
- return resp;
175
- }
176
-
177
- wrapIdentifier(value, queryContext) {
178
- return this.customWrapIdentifier(
179
- value,
180
- this.wrapIdentifierImpl,
181
- queryContext
182
- );
183
- }
184
-
185
- customWrapIdentifier(value, origImpl, queryContext) {
186
- if (this.config.wrapIdentifier) {
187
- return this.config.wrapIdentifier(value, origImpl, queryContext);
188
- }
189
- return origImpl(value);
190
- }
191
-
192
- wrapIdentifierImpl(value) {
193
- return value !== '*' ? `"${value.replace(/"/g, '""')}"` : '*';
194
- }
195
-
196
- initializeDriver() {
197
- try {
198
- this.driver = this._driver();
199
- } catch (e) {
200
- const message = `Knex: run\n$ npm install ${this.driverName} --save`;
201
- this.logger.error(`${message}\n${e.message}\n${e.stack}`);
202
- throw new Error(`${message}\n${e.message}`);
203
- }
204
- }
205
-
206
- poolDefaults() {
207
- return { min: 2, max: 10, propagateCreateError: true };
208
- }
209
-
210
- getPoolSettings(poolConfig) {
211
- const {
212
- afterCreate: userAfterCreate,
213
- validate: userValidate,
214
- maxConnectionLifetimeMillis,
215
- maxConnectionLifetimeJitterMillis,
216
- ...tarnOptions
217
- } = defaults({}, poolConfig, this.poolDefaults());
218
-
219
- POOL_CONFIG_OPTIONS.forEach((option) => {
220
- if (option in tarnOptions) {
221
- this.logger.warn(
222
- [
223
- `Pool config option "${option}" is no longer supported.`,
224
- `See https://github.com/Vincit/tarn.js for possible pool config options.`,
225
- ].join(' ')
226
- );
227
- }
228
- });
229
-
230
- const DEFAULT_ACQUIRE_TIMEOUT = 60000;
231
- const timeouts = [
232
- this.config.acquireConnectionTimeout,
233
- tarnOptions.acquireTimeoutMillis,
234
- ].filter((timeout) => timeout !== undefined);
235
-
236
- if (!timeouts.length) {
237
- timeouts.push(DEFAULT_ACQUIRE_TIMEOUT);
238
- }
239
-
240
- // acquire connection timeout can be set on config or config.pool
241
- // choose the smallest, positive timeout setting and set on poolConfig
242
- const acquireTimeoutMillis = Math.min(...timeouts);
243
-
244
- const hasMaxConnectionLifetime =
245
- typeof maxConnectionLifetimeMillis === 'number' &&
246
- Number.isFinite(maxConnectionLifetimeMillis) &&
247
- maxConnectionLifetimeMillis > 0;
248
-
249
- const generateLifetimeLimit = () => {
250
- if (!hasMaxConnectionLifetime) {
251
- return null;
252
- }
253
- const jitter =
254
- typeof maxConnectionLifetimeJitterMillis === 'number' &&
255
- maxConnectionLifetimeJitterMillis > 0
256
- ? Math.floor(Math.random() * maxConnectionLifetimeJitterMillis)
257
- : 0;
258
- return performance.now() + maxConnectionLifetimeMillis + jitter;
259
- };
260
-
261
- const updatePoolConnectionSettingsFromProvider = async (
262
- forceRefresh = false
263
- ) => {
264
- if (!this.connectionConfigProvider) {
265
- return; // static configuration, nothing to update
266
- }
267
- if (
268
- !forceRefresh &&
269
- (!this.connectionConfigExpirationChecker ||
270
- !this.connectionConfigExpirationChecker())
271
- ) {
272
- return; // not expired, reuse existing connection
273
- }
274
- const providerResult = await this.connectionConfigProvider();
275
- if (providerResult.expirationChecker) {
276
- this.connectionConfigExpirationChecker =
277
- providerResult.expirationChecker;
278
- delete providerResult.expirationChecker; // MySQL2 driver warns on receiving extra properties
279
- } else {
280
- this.connectionConfigExpirationChecker = null;
281
- }
282
- this.connectionSettings = providerResult;
283
- };
284
-
285
- const connectionIsDisposed = (connection) => {
286
- if (connection.__knex__disposed) {
287
- this.logger.warn(`Connection Error: ${connection.__knex__disposed}`);
288
- return true;
289
- }
290
- return false;
291
- };
292
-
293
- const connectionIsOverLifetime = (connection) => {
294
- if (!hasMaxConnectionLifetime) {
295
- return false;
296
- }
297
- if (!connection.__knexLifetimeLimit) {
298
- connection.__knexLifetimeLimit = generateLifetimeLimit();
299
- }
300
- return (
301
- connection.__knexLifetimeLimit &&
302
- performance.now() > connection.__knexLifetimeLimit
303
- );
304
- };
305
-
306
- const configWasRefreshed = async () => {
307
- if (!this.connectionConfigExpirationChecker) {
308
- return false;
309
- }
310
- if (!this.connectionConfigExpirationChecker()) {
311
- return false;
312
- }
313
- await updatePoolConnectionSettingsFromProvider(true);
314
- if (
315
- this.connectionConfigExpirationChecker &&
316
- this.connectionConfigExpirationChecker()
317
- ) {
318
- throw new Error(
319
- 'Connection configuration still reported expired after refresh'
320
- );
321
- }
322
- return true;
323
- };
324
-
325
- const tarnPoolConfig = {
326
- ...tarnOptions,
327
- acquireTimeoutMillis,
328
- create: async () => {
329
- await updatePoolConnectionSettingsFromProvider();
330
- const connection = await this.acquireRawConnection();
331
- connection.__knexUid = uniqueId('__knexUid');
332
- if (hasMaxConnectionLifetime) {
333
- connection.__knexLifetimeLimit = generateLifetimeLimit();
334
- }
335
- if (userAfterCreate) {
336
- await promisify(userAfterCreate)(connection);
337
- }
338
- return connection;
339
- },
340
-
341
- destroy: (connection) => {
342
- if (connection !== void 0) {
343
- return this.destroyRawConnection(connection);
344
- }
345
- },
346
-
347
- validate: async (connection) => {
348
- if (connectionIsDisposed(connection)) {
349
- return false;
350
- }
351
-
352
- if (connectionIsOverLifetime(connection)) {
353
- return false;
354
- }
355
-
356
- if (await configWasRefreshed()) {
357
- return false;
358
- }
359
-
360
- if (userValidate) {
361
- try {
362
- const validationResult = await userValidate(connection);
363
- if (!validationResult) {
364
- return false;
365
- }
366
- } catch (validationError) {
367
- this.logger.warn(
368
- `Pool validate threw an error: ${validationError.message}`
369
- );
370
- return false;
371
- }
372
- }
373
-
374
- return this.validateConnection(connection);
375
- },
376
- };
377
-
378
- if (tarnPoolConfig.afterCreate) {
379
- delete tarnPoolConfig.afterCreate;
380
- }
381
-
382
- return tarnPoolConfig;
383
- }
384
-
385
- initializePool(config = this.config) {
386
- if (this.pool) {
387
- this.logger.warn('The pool has already been initialized');
388
- return;
389
- }
390
-
391
- this.pool = new Pool(this.getPoolSettings(config.pool));
392
- }
393
-
394
- validateConnection(connection) {
395
- return true;
396
- }
397
-
398
- // Acquire a connection from the pool.
399
- async acquireConnection() {
400
- if (!this.pool) {
401
- throw new Error('Unable to acquire a connection');
402
- }
403
- try {
404
- const connection = await this.pool.acquire().promise;
405
- debug('acquired connection from pool: %s', connection.__knexUid);
406
- if (connection.config) {
407
- if (connection.config.password) {
408
- setHiddenProperty(connection.config);
409
- }
410
- if (
411
- connection.config.authentication &&
412
- connection.config.authentication.options &&
413
- connection.config.authentication.options.password
414
- ) {
415
- setHiddenProperty(connection.config.authentication.options);
416
- }
417
- }
418
- return connection;
419
- } catch (error) {
420
- let convertedError = error;
421
- if (error instanceof TimeoutError) {
422
- convertedError = new KnexTimeoutError(
423
- 'Knex: Timeout acquiring a connection. The pool is probably full. ' +
424
- 'Are you missing a .transacting(trx) call?'
425
- );
426
- }
427
- throw convertedError;
428
- }
429
- }
430
-
431
- // Releases a connection back to the connection pool,
432
- // returning a promise resolved when the connection is released.
433
- releaseConnection(connection) {
434
- debug('releasing connection to pool: %s', connection.__knexUid);
435
- const didRelease = this.pool.release(connection);
436
-
437
- if (!didRelease) {
438
- debug('pool refused connection: %s', connection.__knexUid);
439
- }
440
-
441
- return Promise.resolve();
442
- }
443
-
444
- // Destroy the current connection pool for the client.
445
- async destroy(callback) {
446
- try {
447
- if (this.pool && this.pool.destroy) {
448
- await this.pool.destroy();
449
- }
450
- this.pool = undefined;
451
-
452
- if (typeof callback === 'function') {
453
- callback();
454
- }
455
- } catch (err) {
456
- if (typeof callback === 'function') {
457
- return callback(err);
458
- }
459
- throw err;
460
- }
461
- }
462
-
463
- // Return the database being used by this client.
464
- database() {
465
- return this.connectionSettings.database;
466
- }
467
-
468
- toString() {
469
- return '[object KnexClient]';
470
- }
471
-
472
- assertCanCancelQuery() {
473
- if (!this.canCancelQuery) {
474
- throw new Error('Query cancelling not supported for this dialect');
475
- }
476
- }
477
-
478
- cancelQuery() {
479
- throw new Error('Query cancelling not supported for this dialect');
480
- }
481
-
482
- // Formatter part
483
-
484
- alias(first, second) {
485
- return first + ' as ' + second;
486
- }
487
-
488
- // Checks whether a value is a function... if it is, we compile it
489
- // otherwise we check whether it's a raw
490
- parameter(value, builder, bindingsHolder) {
491
- if (typeof value === 'function') {
492
- return outputQuery(
493
- compileCallback(value, undefined, this, bindingsHolder),
494
- true,
495
- builder,
496
- this
497
- );
498
- }
499
- return unwrapRaw(value, true, builder, this, bindingsHolder) || '?';
500
- }
501
-
502
- // Turns a list of values into a list of ?'s, joining them with commas unless
503
- // a "joining" value is specified (e.g. ' and ')
504
- parameterize(values, notSetValue, builder, bindingsHolder) {
505
- if (typeof values === 'function')
506
- return this.parameter(values, builder, bindingsHolder);
507
- values = Array.isArray(values) ? values : [values];
508
- let str = '',
509
- i = -1;
510
- while (++i < values.length) {
511
- if (i > 0) str += ', ';
512
- let value = values[i];
513
- // json columns can have object in values.
514
- if (isPlainObject(value)) {
515
- value = JSON.stringify(value);
516
- }
517
- str += this.parameter(
518
- value === undefined ? notSetValue : value,
519
- builder,
520
- bindingsHolder
521
- );
522
- }
523
- return str;
524
- }
525
-
526
- // Formats `values` into a parenthesized list of parameters for a `VALUES`
527
- // clause.
528
- //
529
- // [1, 2] -> '(?, ?)'
530
- // [[1, 2], [3, 4]] -> '((?, ?), (?, ?))'
531
- // knex('table') -> '(select * from "table")'
532
- // knex.raw('select ?', 1) -> '(select ?)'
533
- //
534
- values(values, builder, bindingsHolder) {
535
- if (Array.isArray(values)) {
536
- if (Array.isArray(values[0])) {
537
- return `(${values
538
- .map(
539
- (value) =>
540
- `(${this.parameterize(
541
- value,
542
- undefined,
543
- builder,
544
- bindingsHolder
545
- )})`
546
- )
547
- .join(', ')})`;
548
- }
549
- return `(${this.parameterize(
550
- values,
551
- undefined,
552
- builder,
553
- bindingsHolder
554
- )})`;
555
- }
556
-
557
- if (values && values.isRawInstance) {
558
- return `(${this.parameter(values, builder, bindingsHolder)})`;
559
- }
560
-
561
- return this.parameter(values, builder, bindingsHolder);
562
- }
563
-
564
- processPassedConnection(connection) {
565
- // Default implementation is noop
566
- }
567
-
568
- toPathForJson(jsonPath) {
569
- // By default, we want a json path, so if this function is not overriden,
570
- // we return the path.
571
- return jsonPath;
572
- }
573
- }
574
-
575
- Object.assign(Client.prototype, {
576
- _escapeBinding: makeEscape({
577
- escapeString(str) {
578
- return `'${str.replace(/'/g, "''")}'`;
579
- },
580
- }),
581
-
582
- canCancelQuery: false,
583
- });
584
-
585
- module.exports = Client;
1
+ const { Pool, TimeoutError } = require('tarn');
2
+ const { EventEmitter } = require('events');
3
+ const { promisify } = require('util');
4
+ const { makeEscape } = require('./util/string');
5
+ const cloneDeep = require('lodash/cloneDeep');
6
+ const defaults = require('lodash/defaults');
7
+ const uniqueId = require('lodash/uniqueId');
8
+
9
+ const Runner = require('./execution/runner');
10
+ const Transaction = require('./execution/transaction');
11
+ const {
12
+ executeQuery,
13
+ enrichQueryObject,
14
+ } = require('./execution/internal/query-executioner');
15
+ const QueryBuilder = require('./query/querybuilder');
16
+ const QueryCompiler = require('./query/querycompiler');
17
+ const SchemaBuilder = require('./schema/builder');
18
+ const SchemaCompiler = require('./schema/compiler');
19
+ const TableBuilder = require('./schema/tablebuilder');
20
+ const TableCompiler = require('./schema/tablecompiler');
21
+ const ColumnBuilder = require('./schema/columnbuilder');
22
+ const ColumnCompiler = require('./schema/columncompiler');
23
+ const { KnexTimeoutError } = require('./util/timeout');
24
+ const { outputQuery, unwrapRaw } = require('./formatter/wrappingFormatter');
25
+ const { compileCallback } = require('./formatter/formatterUtils');
26
+ const Raw = require('./raw');
27
+ const Ref = require('./ref');
28
+ const Formatter = require('./formatter');
29
+ const Logger = require('./logger');
30
+ const { POOL_CONFIG_OPTIONS } = require('./constants');
31
+ const ViewBuilder = require('./schema/viewbuilder.js');
32
+ const ViewCompiler = require('./schema/viewcompiler.js');
33
+ const isPlainObject = require('lodash/isPlainObject');
34
+ const { setHiddenProperty } = require('./util/security.js');
35
+
36
+ const debug = require('debug')('knex:client');
37
+
38
+ // The base client provides the general structure
39
+ // for a dialect specific client object.
40
+
41
+ class Client extends EventEmitter {
42
+ constructor(config = {}) {
43
+ super();
44
+ this.config = config;
45
+ this.logger = new Logger(config);
46
+
47
+ if (this.config.connection && this.config.connection.password) {
48
+ setHiddenProperty(this.config.connection);
49
+ }
50
+
51
+ //Client is a required field, so throw error if it's not supplied.
52
+ //If 'this.dialect' is set, then this is a 'super()' call, in which case
53
+ //'client' does not have to be set as it's already assigned on the client prototype.
54
+
55
+ if (this.dialect && !this.config.client) {
56
+ this.logger.warn(
57
+ `Using 'this.dialect' to identify the client is deprecated and support for it will be removed in the future. Please use configuration option 'client' instead.`
58
+ );
59
+ }
60
+
61
+ const dbClient = this.config.client || this.dialect;
62
+ if (!dbClient) {
63
+ throw new Error(
64
+ `knex: Required configuration option 'client' is missing.`
65
+ );
66
+ }
67
+
68
+ if (config.version) {
69
+ this.version = config.version;
70
+ }
71
+
72
+ if (config.connection && config.connection instanceof Function) {
73
+ this.connectionConfigProvider = config.connection;
74
+ this.connectionConfigExpirationChecker = () => true; // causes the provider to be called on first use
75
+ } else {
76
+ this.connectionSettings = cloneDeep(config.connection || {});
77
+ if (config.connection && config.connection.password) {
78
+ setHiddenProperty(this.connectionSettings, config.connection);
79
+ }
80
+ this.connectionConfigExpirationChecker = null;
81
+ }
82
+ if (this.driverName && config.connection) {
83
+ this.initializeDriver();
84
+ if (!config.pool || (config.pool && config.pool.max !== 0)) {
85
+ this.initializePool(config);
86
+ }
87
+ }
88
+ this.valueForUndefined = this.raw('DEFAULT');
89
+ if (config.useNullAsDefault) {
90
+ this.valueForUndefined = null;
91
+ }
92
+ }
93
+ formatter(builder) {
94
+ return new Formatter(this, builder);
95
+ }
96
+
97
+ queryBuilder() {
98
+ return new QueryBuilder(this);
99
+ }
100
+
101
+ queryCompiler(builder, formatter) {
102
+ return new QueryCompiler(this, builder, formatter);
103
+ }
104
+
105
+ schemaBuilder() {
106
+ return new SchemaBuilder(this);
107
+ }
108
+
109
+ schemaCompiler(builder) {
110
+ return new SchemaCompiler(this, builder);
111
+ }
112
+
113
+ tableBuilder(type, tableName, tableNameLike, fn) {
114
+ return new TableBuilder(this, type, tableName, tableNameLike, fn);
115
+ }
116
+
117
+ viewBuilder(type, viewBuilder, fn) {
118
+ return new ViewBuilder(this, type, viewBuilder, fn);
119
+ }
120
+
121
+ tableCompiler(tableBuilder) {
122
+ return new TableCompiler(this, tableBuilder);
123
+ }
124
+
125
+ viewCompiler(viewCompiler) {
126
+ return new ViewCompiler(this, viewCompiler);
127
+ }
128
+
129
+ columnBuilder(tableBuilder, type, args) {
130
+ return new ColumnBuilder(this, tableBuilder, type, args);
131
+ }
132
+
133
+ columnCompiler(tableBuilder, columnBuilder) {
134
+ return new ColumnCompiler(this, tableBuilder, columnBuilder);
135
+ }
136
+
137
+ runner(builder) {
138
+ return new Runner(this, builder);
139
+ }
140
+
141
+ transaction(container, config, outerTx) {
142
+ return new Transaction(this, container, config, outerTx);
143
+ }
144
+
145
+ raw() {
146
+ return new Raw(this).set(...arguments);
147
+ }
148
+
149
+ ref() {
150
+ return new Ref(this, ...arguments);
151
+ }
152
+ query(connection, queryParam) {
153
+ const queryObject = enrichQueryObject(connection, queryParam, this);
154
+ return executeQuery(connection, queryObject, this);
155
+ }
156
+
157
+ stream(connection, queryParam, stream, options) {
158
+ const queryObject = enrichQueryObject(connection, queryParam, this);
159
+ return this._stream(connection, queryObject, stream, options);
160
+ }
161
+
162
+ prepBindings(bindings) {
163
+ return bindings;
164
+ }
165
+
166
+ positionBindings(sql) {
167
+ return sql;
168
+ }
169
+
170
+ postProcessResponse(resp, queryContext) {
171
+ if (this.config.postProcessResponse) {
172
+ return this.config.postProcessResponse(resp, queryContext);
173
+ }
174
+ return resp;
175
+ }
176
+
177
+ wrapIdentifier(value, queryContext) {
178
+ return this.customWrapIdentifier(
179
+ value,
180
+ this.wrapIdentifierImpl,
181
+ queryContext
182
+ );
183
+ }
184
+
185
+ customWrapIdentifier(value, origImpl, queryContext) {
186
+ if (this.config.wrapIdentifier) {
187
+ return this.config.wrapIdentifier(value, origImpl, queryContext);
188
+ }
189
+ return origImpl(value);
190
+ }
191
+
192
+ wrapIdentifierImpl(value) {
193
+ return value !== '*' ? `"${value.replace(/"/g, '""')}"` : '*';
194
+ }
195
+
196
+ initializeDriver() {
197
+ try {
198
+ this.driver = this._driver();
199
+ } catch (e) {
200
+ const message = `Knex: run\n$ npm install ${this.driverName} --save`;
201
+ this.logger.error(`${message}\n${e.message}\n${e.stack}`);
202
+ throw new Error(`${message}\n${e.message}`);
203
+ }
204
+ }
205
+
206
+ poolDefaults() {
207
+ return { min: 2, max: 10, propagateCreateError: true };
208
+ }
209
+
210
+ getPoolSettings(poolConfig) {
211
+ const {
212
+ afterCreate: userAfterCreate,
213
+ validate: userValidate,
214
+ maxConnectionLifetimeMillis,
215
+ maxConnectionLifetimeJitterMillis,
216
+ ...tarnOptions
217
+ } = defaults({}, poolConfig, this.poolDefaults());
218
+
219
+ POOL_CONFIG_OPTIONS.forEach((option) => {
220
+ if (option in tarnOptions) {
221
+ this.logger.warn(
222
+ [
223
+ `Pool config option "${option}" is no longer supported.`,
224
+ `See https://github.com/Vincit/tarn.js for possible pool config options.`,
225
+ ].join(' ')
226
+ );
227
+ }
228
+ });
229
+
230
+ const DEFAULT_ACQUIRE_TIMEOUT = 60000;
231
+ const timeouts = [
232
+ this.config.acquireConnectionTimeout,
233
+ tarnOptions.acquireTimeoutMillis,
234
+ ].filter((timeout) => timeout !== undefined);
235
+
236
+ if (!timeouts.length) {
237
+ timeouts.push(DEFAULT_ACQUIRE_TIMEOUT);
238
+ }
239
+
240
+ // acquire connection timeout can be set on config or config.pool
241
+ // choose the smallest, positive timeout setting and set on poolConfig
242
+ const acquireTimeoutMillis = Math.min(...timeouts);
243
+
244
+ const hasMaxConnectionLifetime =
245
+ typeof maxConnectionLifetimeMillis === 'number' &&
246
+ Number.isFinite(maxConnectionLifetimeMillis) &&
247
+ maxConnectionLifetimeMillis > 0;
248
+
249
+ const generateLifetimeLimit = () => {
250
+ if (!hasMaxConnectionLifetime) {
251
+ return null;
252
+ }
253
+ const jitter =
254
+ typeof maxConnectionLifetimeJitterMillis === 'number' &&
255
+ maxConnectionLifetimeJitterMillis > 0
256
+ ? Math.floor(Math.random() * maxConnectionLifetimeJitterMillis)
257
+ : 0;
258
+ return performance.now() + maxConnectionLifetimeMillis + jitter;
259
+ };
260
+
261
+ const updatePoolConnectionSettingsFromProvider = async (
262
+ forceRefresh = false
263
+ ) => {
264
+ if (!this.connectionConfigProvider) {
265
+ return; // static configuration, nothing to update
266
+ }
267
+ if (
268
+ !forceRefresh &&
269
+ (!this.connectionConfigExpirationChecker ||
270
+ !this.connectionConfigExpirationChecker())
271
+ ) {
272
+ return; // not expired, reuse existing connection
273
+ }
274
+ const providerResult = await this.connectionConfigProvider();
275
+ if (providerResult.expirationChecker) {
276
+ this.connectionConfigExpirationChecker =
277
+ providerResult.expirationChecker;
278
+ delete providerResult.expirationChecker; // MySQL2 driver warns on receiving extra properties
279
+ } else {
280
+ this.connectionConfigExpirationChecker = null;
281
+ }
282
+ this.connectionSettings = providerResult;
283
+ };
284
+
285
+ const connectionIsDisposed = (connection) => {
286
+ if (connection.__knex__disposed) {
287
+ this.logger.warn(`Connection Error: ${connection.__knex__disposed}`);
288
+ return true;
289
+ }
290
+ return false;
291
+ };
292
+
293
+ const connectionIsOverLifetime = (connection) => {
294
+ if (!hasMaxConnectionLifetime) {
295
+ return false;
296
+ }
297
+ if (!connection.__knexLifetimeLimit) {
298
+ connection.__knexLifetimeLimit = generateLifetimeLimit();
299
+ }
300
+ return (
301
+ connection.__knexLifetimeLimit &&
302
+ performance.now() > connection.__knexLifetimeLimit
303
+ );
304
+ };
305
+
306
+ const configWasRefreshed = async () => {
307
+ if (!this.connectionConfigExpirationChecker) {
308
+ return false;
309
+ }
310
+ if (!this.connectionConfigExpirationChecker()) {
311
+ return false;
312
+ }
313
+ await updatePoolConnectionSettingsFromProvider(true);
314
+ if (
315
+ this.connectionConfigExpirationChecker &&
316
+ this.connectionConfigExpirationChecker()
317
+ ) {
318
+ throw new Error(
319
+ 'Connection configuration still reported expired after refresh'
320
+ );
321
+ }
322
+ return true;
323
+ };
324
+
325
+ const tarnPoolConfig = {
326
+ ...tarnOptions,
327
+ acquireTimeoutMillis,
328
+ create: async () => {
329
+ await updatePoolConnectionSettingsFromProvider();
330
+ const connection = await this.acquireRawConnection();
331
+ connection.__knexUid = uniqueId('__knexUid');
332
+ if (hasMaxConnectionLifetime) {
333
+ connection.__knexLifetimeLimit = generateLifetimeLimit();
334
+ }
335
+ if (userAfterCreate) {
336
+ await promisify(userAfterCreate)(connection);
337
+ }
338
+ return connection;
339
+ },
340
+
341
+ destroy: (connection) => {
342
+ if (connection !== void 0) {
343
+ return this.destroyRawConnection(connection);
344
+ }
345
+ },
346
+
347
+ validate: async (connection) => {
348
+ if (connectionIsDisposed(connection)) {
349
+ return false;
350
+ }
351
+
352
+ if (connectionIsOverLifetime(connection)) {
353
+ return false;
354
+ }
355
+
356
+ if (await configWasRefreshed()) {
357
+ return false;
358
+ }
359
+
360
+ if (userValidate) {
361
+ try {
362
+ const validationResult = await userValidate(connection);
363
+ if (!validationResult) {
364
+ return false;
365
+ }
366
+ } catch (validationError) {
367
+ this.logger.warn(
368
+ `Pool validate threw an error: ${validationError.message}`
369
+ );
370
+ return false;
371
+ }
372
+ }
373
+
374
+ return this.validateConnection(connection);
375
+ },
376
+ };
377
+
378
+ if (tarnPoolConfig.afterCreate) {
379
+ delete tarnPoolConfig.afterCreate;
380
+ }
381
+
382
+ return tarnPoolConfig;
383
+ }
384
+
385
+ initializePool(config = this.config) {
386
+ if (this.pool) {
387
+ this.logger.warn('The pool has already been initialized');
388
+ return;
389
+ }
390
+
391
+ this.pool = new Pool(this.getPoolSettings(config.pool));
392
+ }
393
+
394
+ validateConnection(connection) {
395
+ return true;
396
+ }
397
+
398
+ // Acquire a connection from the pool.
399
+ async acquireConnection() {
400
+ if (!this.pool) {
401
+ throw new Error('Unable to acquire a connection');
402
+ }
403
+ try {
404
+ const connection = await this.pool.acquire().promise;
405
+ debug('acquired connection from pool: %s', connection.__knexUid);
406
+ if (connection.config) {
407
+ if (connection.config.password) {
408
+ setHiddenProperty(connection.config);
409
+ }
410
+ if (
411
+ connection.config.authentication &&
412
+ connection.config.authentication.options &&
413
+ connection.config.authentication.options.password
414
+ ) {
415
+ setHiddenProperty(connection.config.authentication.options);
416
+ }
417
+ }
418
+ return connection;
419
+ } catch (error) {
420
+ let convertedError = error;
421
+ if (error instanceof TimeoutError) {
422
+ convertedError = new KnexTimeoutError(
423
+ 'Knex: Timeout acquiring a connection. The pool is probably full. ' +
424
+ 'Are you missing a .transacting(trx) call?'
425
+ );
426
+ }
427
+ throw convertedError;
428
+ }
429
+ }
430
+
431
+ // Releases a connection back to the connection pool,
432
+ // returning a promise resolved when the connection is released.
433
+ releaseConnection(connection) {
434
+ debug('releasing connection to pool: %s', connection.__knexUid);
435
+ const didRelease = this.pool.release(connection);
436
+
437
+ if (!didRelease) {
438
+ debug('pool refused connection: %s', connection.__knexUid);
439
+ }
440
+
441
+ return Promise.resolve();
442
+ }
443
+
444
+ // Destroy the current connection pool for the client.
445
+ async destroy(callback) {
446
+ try {
447
+ if (this.pool && this.pool.destroy) {
448
+ await this.pool.destroy();
449
+ }
450
+ this.pool = undefined;
451
+
452
+ if (typeof callback === 'function') {
453
+ callback();
454
+ }
455
+ } catch (err) {
456
+ if (typeof callback === 'function') {
457
+ return callback(err);
458
+ }
459
+ throw err;
460
+ }
461
+ }
462
+
463
+ // Return the database being used by this client.
464
+ database() {
465
+ return this.connectionSettings.database;
466
+ }
467
+
468
+ toString() {
469
+ return '[object KnexClient]';
470
+ }
471
+
472
+ assertCanCancelQuery() {
473
+ if (!this.canCancelQuery) {
474
+ throw new Error('Query cancelling not supported for this dialect');
475
+ }
476
+ }
477
+
478
+ cancelQuery() {
479
+ throw new Error('Query cancelling not supported for this dialect');
480
+ }
481
+
482
+ // Formatter part
483
+
484
+ alias(first, second) {
485
+ return first + ' as ' + second;
486
+ }
487
+
488
+ // Checks whether a value is a function... if it is, we compile it
489
+ // otherwise we check whether it's a raw
490
+ parameter(value, builder, bindingsHolder) {
491
+ if (typeof value === 'function') {
492
+ return outputQuery(
493
+ compileCallback(value, undefined, this, bindingsHolder),
494
+ true,
495
+ builder,
496
+ this
497
+ );
498
+ }
499
+ return unwrapRaw(value, true, builder, this, bindingsHolder) || '?';
500
+ }
501
+
502
+ // Turns a list of values into a list of ?'s, joining them with commas unless
503
+ // a "joining" value is specified (e.g. ' and ')
504
+ parameterize(values, notSetValue, builder, bindingsHolder) {
505
+ if (typeof values === 'function')
506
+ return this.parameter(values, builder, bindingsHolder);
507
+ values = Array.isArray(values) ? values : [values];
508
+ let str = '',
509
+ i = -1;
510
+ while (++i < values.length) {
511
+ if (i > 0) str += ', ';
512
+ let value = values[i];
513
+ // json columns can have object in values.
514
+ if (isPlainObject(value)) {
515
+ value = JSON.stringify(value);
516
+ }
517
+ str += this.parameter(
518
+ value === undefined ? notSetValue : value,
519
+ builder,
520
+ bindingsHolder
521
+ );
522
+ }
523
+ return str;
524
+ }
525
+
526
+ // Formats `values` into a parenthesized list of parameters for a `VALUES`
527
+ // clause.
528
+ //
529
+ // [1, 2] -> '(?, ?)'
530
+ // [[1, 2], [3, 4]] -> '((?, ?), (?, ?))'
531
+ // knex('table') -> '(select * from "table")'
532
+ // knex.raw('select ?', 1) -> '(select ?)'
533
+ //
534
+ values(values, builder, bindingsHolder) {
535
+ if (Array.isArray(values)) {
536
+ if (Array.isArray(values[0])) {
537
+ return `(${values
538
+ .map(
539
+ (value) =>
540
+ `(${this.parameterize(
541
+ value,
542
+ undefined,
543
+ builder,
544
+ bindingsHolder
545
+ )})`
546
+ )
547
+ .join(', ')})`;
548
+ }
549
+ return `(${this.parameterize(
550
+ values,
551
+ undefined,
552
+ builder,
553
+ bindingsHolder
554
+ )})`;
555
+ }
556
+
557
+ if (values && values.isRawInstance) {
558
+ return `(${this.parameter(values, builder, bindingsHolder)})`;
559
+ }
560
+
561
+ return this.parameter(values, builder, bindingsHolder);
562
+ }
563
+
564
+ processPassedConnection(connection) {
565
+ // Default implementation is noop
566
+ }
567
+
568
+ toPathForJson(jsonPath) {
569
+ // By default, we want a json path, so if this function is not overriden,
570
+ // we return the path.
571
+ return jsonPath;
572
+ }
573
+ }
574
+
575
+ Object.assign(Client.prototype, {
576
+ _escapeBinding: makeEscape({
577
+ escapeString(str) {
578
+ return `'${str.replace(/'/g, "''")}'`;
579
+ },
580
+ }),
581
+
582
+ canCancelQuery: false,
583
+ });
584
+
585
+ module.exports = Client;