knex 2.4.2 → 2.5.0

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 (190) hide show
  1. package/CHANGELOG.md +54 -18
  2. package/CONTRIBUTING.md +194 -194
  3. package/LICENSE +22 -22
  4. package/README.md +147 -148
  5. package/UPGRADING.md +233 -233
  6. package/bin/cli.js +473 -473
  7. package/bin/utils/cli-config-utils.js +210 -210
  8. package/bin/utils/constants.js +7 -7
  9. package/bin/utils/migrationsLister.js +37 -37
  10. package/knex.js +23 -23
  11. package/knex.mjs +11 -0
  12. package/lib/builder-interface-augmenter.js +120 -120
  13. package/lib/client.js +495 -475
  14. package/lib/constants.js +61 -61
  15. package/lib/dialects/better-sqlite3/index.js +77 -72
  16. package/lib/dialects/cockroachdb/crdb-columncompiler.js +14 -14
  17. package/lib/dialects/cockroachdb/crdb-querybuilder.js +11 -11
  18. package/lib/dialects/cockroachdb/crdb-querycompiler.js +122 -122
  19. package/lib/dialects/cockroachdb/crdb-tablecompiler.js +37 -37
  20. package/lib/dialects/cockroachdb/crdb-viewcompiler.js +15 -15
  21. package/lib/dialects/cockroachdb/index.js +86 -86
  22. package/lib/dialects/index.js +33 -33
  23. package/lib/dialects/mssql/index.js +500 -495
  24. package/lib/dialects/mssql/mssql-formatter.js +34 -34
  25. package/lib/dialects/mssql/query/mssql-querycompiler.js +601 -600
  26. package/lib/dialects/mssql/schema/mssql-columncompiler.js +185 -185
  27. package/lib/dialects/mssql/schema/mssql-compiler.js +91 -91
  28. package/lib/dialects/mssql/schema/mssql-tablecompiler.js +378 -378
  29. package/lib/dialects/mssql/schema/mssql-viewcompiler.js +55 -55
  30. package/lib/dialects/mssql/transaction.js +176 -176
  31. package/lib/dialects/mysql/index.js +201 -201
  32. package/lib/dialects/mysql/query/mysql-querycompiler.js +274 -274
  33. package/lib/dialects/mysql/schema/mysql-columncompiler.js +193 -193
  34. package/lib/dialects/mysql/schema/mysql-compiler.js +60 -60
  35. package/lib/dialects/mysql/schema/mysql-tablecompiler.js +381 -381
  36. package/lib/dialects/mysql/schema/mysql-viewbuilder.js +21 -21
  37. package/lib/dialects/mysql/schema/mysql-viewcompiler.js +15 -15
  38. package/lib/dialects/mysql/transaction.js +46 -46
  39. package/lib/dialects/mysql2/index.js +53 -33
  40. package/lib/dialects/mysql2/transaction.js +44 -44
  41. package/lib/dialects/oracle/DEAD_CODE.md +5 -5
  42. package/lib/dialects/oracle/index.js +92 -92
  43. package/lib/dialects/oracle/query/oracle-querycompiler.js +343 -342
  44. package/lib/dialects/oracle/schema/internal/incrementUtils.js +20 -20
  45. package/lib/dialects/oracle/schema/internal/trigger.js +135 -135
  46. package/lib/dialects/oracle/schema/oracle-columnbuilder.js +17 -17
  47. package/lib/dialects/oracle/schema/oracle-columncompiler.js +126 -126
  48. package/lib/dialects/oracle/schema/oracle-compiler.js +122 -122
  49. package/lib/dialects/oracle/schema/oracle-tablecompiler.js +190 -190
  50. package/lib/dialects/oracle/utils.js +87 -87
  51. package/lib/dialects/oracledb/index.js +327 -327
  52. package/lib/dialects/oracledb/query/oracledb-querycompiler.js +481 -481
  53. package/lib/dialects/oracledb/schema/oracledb-columncompiler.js +61 -55
  54. package/lib/dialects/oracledb/schema/oracledb-tablecompiler.js +19 -19
  55. package/lib/dialects/oracledb/schema/oracledb-viewbuilder.js +13 -13
  56. package/lib/dialects/oracledb/schema/oracledb-viewcompiler.js +19 -19
  57. package/lib/dialects/oracledb/transaction.js +98 -98
  58. package/lib/dialects/oracledb/utils.js +208 -208
  59. package/lib/dialects/pgnative/index.js +60 -60
  60. package/lib/dialects/postgres/execution/pg-transaction.js +19 -12
  61. package/lib/dialects/postgres/index.js +358 -358
  62. package/lib/dialects/postgres/query/pg-querybuilder.js +43 -38
  63. package/lib/dialects/postgres/query/pg-querycompiler.js +400 -395
  64. package/lib/dialects/postgres/schema/pg-columncompiler.js +156 -156
  65. package/lib/dialects/postgres/schema/pg-compiler.js +138 -138
  66. package/lib/dialects/postgres/schema/pg-tablecompiler.js +304 -299
  67. package/lib/dialects/postgres/schema/pg-viewbuilder.js +21 -21
  68. package/lib/dialects/postgres/schema/pg-viewcompiler.js +35 -35
  69. package/lib/dialects/redshift/index.js +86 -86
  70. package/lib/dialects/redshift/query/redshift-querycompiler.js +163 -163
  71. package/lib/dialects/redshift/schema/redshift-columnbuilder.js +22 -22
  72. package/lib/dialects/redshift/schema/redshift-columncompiler.js +67 -67
  73. package/lib/dialects/redshift/schema/redshift-compiler.js +14 -14
  74. package/lib/dialects/redshift/schema/redshift-tablecompiler.js +122 -122
  75. package/lib/dialects/redshift/schema/redshift-viewcompiler.js +11 -11
  76. package/lib/dialects/redshift/transaction.js +32 -25
  77. package/lib/dialects/sqlite3/execution/sqlite-transaction.js +25 -18
  78. package/lib/dialects/sqlite3/index.js +250 -250
  79. package/lib/dialects/sqlite3/query/sqlite-querybuilder.js +33 -33
  80. package/lib/dialects/sqlite3/query/sqlite-querycompiler.js +334 -334
  81. package/lib/dialects/sqlite3/schema/ddl.js +400 -400
  82. package/lib/dialects/sqlite3/schema/internal/compiler.js +327 -327
  83. package/lib/dialects/sqlite3/schema/internal/parser-combinator.js +161 -161
  84. package/lib/dialects/sqlite3/schema/internal/parser.js +638 -638
  85. package/lib/dialects/sqlite3/schema/internal/sqlite-ddl-operations.js +41 -41
  86. package/lib/dialects/sqlite3/schema/internal/tokenizer.js +38 -38
  87. package/lib/dialects/sqlite3/schema/internal/utils.js +12 -12
  88. package/lib/dialects/sqlite3/schema/sqlite-columncompiler.js +50 -50
  89. package/lib/dialects/sqlite3/schema/sqlite-compiler.js +80 -80
  90. package/lib/dialects/sqlite3/schema/sqlite-tablecompiler.js +347 -347
  91. package/lib/dialects/sqlite3/schema/sqlite-viewcompiler.js +40 -40
  92. package/lib/execution/batch-insert.js +51 -51
  93. package/lib/execution/internal/delay.js +6 -6
  94. package/lib/execution/internal/ensure-connection-callback.js +41 -41
  95. package/lib/execution/internal/query-executioner.js +62 -62
  96. package/lib/execution/runner.js +325 -307
  97. package/lib/execution/transaction.js +409 -401
  98. package/lib/formatter/formatterUtils.js +42 -42
  99. package/lib/formatter/rawFormatter.js +84 -84
  100. package/lib/formatter/wrappingFormatter.js +250 -250
  101. package/lib/formatter.js +25 -25
  102. package/lib/index.js +3 -3
  103. package/lib/knex-builder/FunctionHelper.js +80 -54
  104. package/lib/knex-builder/Knex.js +59 -59
  105. package/lib/knex-builder/internal/config-resolver.js +57 -57
  106. package/lib/knex-builder/internal/parse-connection.js +87 -87
  107. package/lib/knex-builder/make-knex.js +345 -340
  108. package/lib/logger.js +76 -76
  109. package/lib/migrations/common/MigrationsLoader.js +36 -36
  110. package/lib/migrations/migrate/MigrationGenerator.js +84 -84
  111. package/lib/migrations/migrate/Migrator.js +598 -598
  112. package/lib/migrations/migrate/migrate-stub.js +17 -17
  113. package/lib/migrations/migrate/migration-list-resolver.js +33 -33
  114. package/lib/migrations/migrate/migrator-configuration-merger.js +58 -58
  115. package/lib/migrations/migrate/sources/fs-migrations.js +74 -74
  116. package/lib/migrations/migrate/stub/cjs.stub +15 -15
  117. package/lib/migrations/migrate/stub/coffee.stub +13 -13
  118. package/lib/migrations/migrate/stub/eg.stub +14 -14
  119. package/lib/migrations/migrate/stub/js-schema.stub +22 -22
  120. package/lib/migrations/migrate/stub/js.stub +22 -22
  121. package/lib/migrations/migrate/stub/knexfile-coffee.stub +34 -34
  122. package/lib/migrations/migrate/stub/knexfile-eg.stub +43 -43
  123. package/lib/migrations/migrate/stub/knexfile-js.stub +47 -47
  124. package/lib/migrations/migrate/stub/knexfile-ls.stub +35 -35
  125. package/lib/migrations/migrate/stub/knexfile-ts.stub +47 -47
  126. package/lib/migrations/migrate/stub/ls.stub +14 -14
  127. package/lib/migrations/migrate/stub/mjs.stub +23 -23
  128. package/lib/migrations/migrate/stub/ts-schema.stub +21 -21
  129. package/lib/migrations/migrate/stub/ts.stub +21 -21
  130. package/lib/migrations/migrate/table-creator.js +77 -77
  131. package/lib/migrations/migrate/table-resolver.js +27 -27
  132. package/lib/migrations/seed/Seeder.js +137 -137
  133. package/lib/migrations/seed/seed-stub.js +13 -13
  134. package/lib/migrations/seed/seeder-configuration-merger.js +60 -60
  135. package/lib/migrations/seed/sources/fs-seeds.js +65 -65
  136. package/lib/migrations/seed/stub/coffee.stub +9 -9
  137. package/lib/migrations/seed/stub/eg.stub +11 -11
  138. package/lib/migrations/seed/stub/js.stub +13 -13
  139. package/lib/migrations/seed/stub/ls.stub +11 -11
  140. package/lib/migrations/seed/stub/mjs.stub +12 -12
  141. package/lib/migrations/seed/stub/ts.stub +13 -13
  142. package/lib/migrations/util/fs.js +86 -86
  143. package/lib/migrations/util/import-file.js +12 -12
  144. package/lib/migrations/util/is-module-type.js +9 -9
  145. package/lib/migrations/util/template.js +52 -52
  146. package/lib/migrations/util/timestamp.js +14 -14
  147. package/lib/query/analytic.js +52 -52
  148. package/lib/query/constants.js +15 -15
  149. package/lib/query/joinclause.js +270 -270
  150. package/lib/query/method-constants.js +136 -135
  151. package/lib/query/querybuilder.js +1793 -1794
  152. package/lib/query/querycompiler.js +1591 -1580
  153. package/lib/raw.js +139 -139
  154. package/lib/ref.js +39 -39
  155. package/lib/schema/builder.js +115 -115
  156. package/lib/schema/columnbuilder.js +146 -146
  157. package/lib/schema/columncompiler.js +307 -307
  158. package/lib/schema/compiler.js +187 -187
  159. package/lib/schema/internal/helpers.js +55 -55
  160. package/lib/schema/tablebuilder.js +376 -376
  161. package/lib/schema/tablecompiler.js +433 -433
  162. package/lib/schema/viewbuilder.js +92 -92
  163. package/lib/schema/viewcompiler.js +138 -138
  164. package/lib/util/finally-mixin.js +13 -13
  165. package/lib/util/helpers.js +95 -95
  166. package/lib/util/is.js +32 -32
  167. package/lib/util/nanoid.js +40 -40
  168. package/lib/util/noop.js +1 -1
  169. package/lib/util/save-async-stack.js +14 -14
  170. package/lib/util/security.js +26 -0
  171. package/lib/util/string.js +190 -190
  172. package/lib/util/timeout.js +29 -29
  173. package/package.json +12 -10
  174. package/scripts/build.js +125 -125
  175. package/scripts/clean.js +31 -31
  176. package/scripts/docker-compose.yml +152 -152
  177. package/scripts/next-release-howto.md +24 -24
  178. package/scripts/oracledb-install-driver-libs.sh +82 -82
  179. package/scripts/release.sh +34 -34
  180. package/scripts/runkit-example.js +34 -34
  181. package/scripts/stress-test/README.txt +18 -18
  182. package/scripts/stress-test/docker-compose.yml +57 -57
  183. package/scripts/stress-test/knex-stress-test.js +208 -208
  184. package/scripts/stress-test/mysql2-random-hanging-every-now-and-then.js +145 -145
  185. package/scripts/stress-test/mysql2-sudden-exit-without-error.js +100 -100
  186. package/scripts/stress-test/reconnect-test-mysql-based-drivers.js +184 -184
  187. package/scripts/update_gitignore_for_tsc_output.js +90 -90
  188. package/types/index.d.ts +3273 -3233
  189. package/types/result.d.ts +27 -27
  190. package/types/tables.d.ts +4 -4
@@ -1,495 +1,500 @@
1
- // MSSQL Client
2
- // -------
3
- const map = require('lodash/map');
4
- const isNil = require('lodash/isNil');
5
-
6
- const Client = require('../../client');
7
- const MSSQL_Formatter = require('./mssql-formatter');
8
- const Transaction = require('./transaction');
9
- const QueryCompiler = require('./query/mssql-querycompiler');
10
- const SchemaCompiler = require('./schema/mssql-compiler');
11
- const TableCompiler = require('./schema/mssql-tablecompiler');
12
- const ViewCompiler = require('./schema/mssql-viewcompiler');
13
- const ColumnCompiler = require('./schema/mssql-columncompiler');
14
- const QueryBuilder = require('../../query/querybuilder');
15
-
16
- const debug = require('debug')('knex:mssql');
17
-
18
- const SQL_INT4 = { MIN: -2147483648, MAX: 2147483647 };
19
- const SQL_BIGINT_SAFE = { MIN: -9007199254740991, MAX: 9007199254740991 };
20
-
21
- // Always initialize with the "QueryBuilder" and "QueryCompiler" objects, which
22
- // extend the base 'lib/query/builder' and 'lib/query/compiler', respectively.
23
- class Client_MSSQL extends Client {
24
- constructor(config = {}) {
25
- super(config);
26
- }
27
-
28
- /**
29
- * @param {import('knex').Config} options
30
- */
31
- _generateConnection() {
32
- const settings = this.connectionSettings;
33
- settings.options = settings.options || {};
34
-
35
- /** @type {import('tedious').ConnectionConfig} */
36
- const cfg = {
37
- authentication: {
38
- type: settings.type || 'default',
39
- options: {
40
- userName: settings.userName || settings.user,
41
- password: settings.password,
42
- domain: settings.domain,
43
- token: settings.token,
44
- clientId: settings.clientId,
45
- clientSecret: settings.clientSecret,
46
- tenantId: settings.tenantId,
47
- msiEndpoint: settings.msiEndpoint,
48
- },
49
- },
50
- server: settings.server || settings.host,
51
- options: {
52
- database: settings.database,
53
- encrypt: settings.encrypt || false,
54
- port: settings.port || 1433,
55
- connectTimeout: settings.connectionTimeout || settings.timeout || 15000,
56
- requestTimeout: !isNil(settings.requestTimeout)
57
- ? settings.requestTimeout
58
- : 15000,
59
- rowCollectionOnDone: false,
60
- rowCollectionOnRequestCompletion: false,
61
- useColumnNames: false,
62
- tdsVersion: settings.options.tdsVersion || '7_4',
63
- appName: settings.options.appName || 'knex',
64
- trustServerCertificate: false,
65
- ...settings.options,
66
- },
67
- };
68
-
69
- // tedious always connect via tcp when port is specified
70
- if (cfg.options.instanceName) delete cfg.options.port;
71
-
72
- if (isNaN(cfg.options.requestTimeout)) cfg.options.requestTimeout = 15000;
73
- if (cfg.options.requestTimeout === Infinity) cfg.options.requestTimeout = 0;
74
- if (cfg.options.requestTimeout < 0) cfg.options.requestTimeout = 0;
75
-
76
- if (settings.debug) {
77
- cfg.options.debug = {
78
- packet: true,
79
- token: true,
80
- data: true,
81
- payload: true,
82
- };
83
- }
84
-
85
- return cfg;
86
- }
87
-
88
- _driver() {
89
- const tds = require('tedious');
90
-
91
- return tds;
92
- }
93
-
94
- formatter() {
95
- return new MSSQL_Formatter(this, ...arguments);
96
- }
97
-
98
- transaction() {
99
- return new Transaction(this, ...arguments);
100
- }
101
-
102
- queryCompiler() {
103
- return new QueryCompiler(this, ...arguments);
104
- }
105
-
106
- schemaCompiler() {
107
- return new SchemaCompiler(this, ...arguments);
108
- }
109
-
110
- tableCompiler() {
111
- return new TableCompiler(this, ...arguments);
112
- }
113
-
114
- viewCompiler() {
115
- return new ViewCompiler(this, ...arguments);
116
- }
117
- queryBuilder() {
118
- const b = new QueryBuilder(this);
119
- return b;
120
- }
121
-
122
- columnCompiler() {
123
- return new ColumnCompiler(this, ...arguments);
124
- }
125
-
126
- wrapIdentifierImpl(value) {
127
- if (value === '*') {
128
- return '*';
129
- }
130
-
131
- return `[${value.replace(/[[\]]+/g, '')}]`;
132
- }
133
-
134
- // Get a raw connection, called by the `pool` whenever a new
135
- // connection needs to be added to the pool.
136
- acquireRawConnection() {
137
- return new Promise((resolver, rejecter) => {
138
- debug('connection::connection new connection requested');
139
- const Driver = this._driver();
140
- const settings = Object.assign({}, this._generateConnection());
141
-
142
- const connection = new Driver.Connection(settings);
143
-
144
- connection.connect((err) => {
145
- if (err) {
146
- debug('connection::connect error: %s', err.message);
147
- return rejecter(err);
148
- }
149
-
150
- debug('connection::connect connected to server');
151
-
152
- connection.connected = true;
153
- connection.on('error', (e) => {
154
- debug('connection::error message=%s', e.message);
155
- connection.__knex__disposed = e;
156
- connection.connected = false;
157
- });
158
-
159
- connection.once('end', () => {
160
- connection.connected = false;
161
- connection.__knex__disposed = 'Connection to server was terminated.';
162
- debug('connection::end connection ended.');
163
- });
164
-
165
- return resolver(connection);
166
- });
167
- });
168
- }
169
-
170
- validateConnection(connection) {
171
- return connection && connection.connected;
172
- }
173
-
174
- // Used to explicitly close a connection, called internally by the pool
175
- // when a connection times out or the pool is shutdown.
176
- destroyRawConnection(connection) {
177
- debug('connection::destroy');
178
-
179
- return new Promise((resolve) => {
180
- connection.once('end', () => {
181
- resolve();
182
- });
183
-
184
- connection.close();
185
- });
186
- }
187
-
188
- // Position the bindings for the query.
189
- positionBindings(sql) {
190
- let questionCount = -1;
191
- return sql.replace(/\\?\?/g, (match) => {
192
- if (match === '\\?') {
193
- return '?';
194
- }
195
-
196
- questionCount += 1;
197
- return `@p${questionCount}`;
198
- });
199
- }
200
-
201
- _chomp(connection) {
202
- if (connection.state.name === 'LoggedIn') {
203
- const nextRequest = this.requestQueue.pop();
204
- if (nextRequest) {
205
- debug(
206
- 'connection::query executing query, %d more in queue',
207
- this.requestQueue.length
208
- );
209
-
210
- connection.execSql(nextRequest);
211
- }
212
- }
213
- }
214
-
215
- _enqueueRequest(request, connection) {
216
- this.requestQueue.push(request);
217
- this._chomp(connection);
218
- }
219
-
220
- _makeRequest(query, callback) {
221
- const Driver = this._driver();
222
- const sql = typeof query === 'string' ? query : query.sql;
223
- let rowCount = 0;
224
-
225
- if (!sql) throw new Error('The query is empty');
226
-
227
- debug('request::request sql=%s', sql);
228
-
229
- const request = new Driver.Request(sql, (err, remoteRowCount) => {
230
- if (err) {
231
- debug('request::error message=%s', err.message);
232
- return callback(err);
233
- }
234
-
235
- rowCount = remoteRowCount;
236
- debug('request::callback rowCount=%d', rowCount);
237
- });
238
-
239
- request.on('prepared', () => {
240
- debug('request %s::request prepared', this.id);
241
- });
242
-
243
- request.on('done', (rowCount, more) => {
244
- debug('request::done rowCount=%d more=%s', rowCount, more);
245
- });
246
-
247
- request.on('doneProc', (rowCount, more) => {
248
- debug(
249
- 'request::doneProc id=%s rowCount=%d more=%s',
250
- request.id,
251
- rowCount,
252
- more
253
- );
254
- });
255
-
256
- request.on('doneInProc', (rowCount, more) => {
257
- debug(
258
- 'request::doneInProc id=%s rowCount=%d more=%s',
259
- request.id,
260
- rowCount,
261
- more
262
- );
263
- });
264
-
265
- request.once('requestCompleted', () => {
266
- debug('request::completed id=%s', request.id);
267
- return callback(null, rowCount);
268
- });
269
-
270
- request.on('error', (err) => {
271
- debug('request::error id=%s message=%s', request.id, err.message);
272
- return callback(err);
273
- });
274
-
275
- return request;
276
- }
277
-
278
- // Grab a connection, run the query via the MSSQL streaming interface,
279
- // and pass that through to the stream we've sent back to the client.
280
- _stream(connection, query, /** @type {NodeJS.ReadWriteStream} */ stream) {
281
- return new Promise((resolve, reject) => {
282
- const request = this._makeRequest(query, (err) => {
283
- if (err) {
284
- stream.emit('error', err);
285
- return reject(err);
286
- }
287
-
288
- resolve();
289
- });
290
-
291
- request.on('row', (row) => {
292
- stream.write(
293
- row.reduce(
294
- (prev, curr) => ({
295
- ...prev,
296
- [curr.metadata.colName]: curr.value,
297
- }),
298
- {}
299
- )
300
- );
301
- });
302
- request.on('error', (err) => {
303
- stream.emit('error', err);
304
- reject(err);
305
- });
306
- request.once('requestCompleted', () => {
307
- stream.end();
308
- resolve();
309
- });
310
-
311
- this._assignBindings(request, query.bindings);
312
- this._enqueueRequest(request, connection);
313
- });
314
- }
315
-
316
- _assignBindings(request, bindings) {
317
- if (Array.isArray(bindings)) {
318
- for (let i = 0; i < bindings.length; i++) {
319
- const binding = bindings[i];
320
- this._setReqInput(request, i, binding);
321
- }
322
- }
323
- }
324
-
325
- _scaleForBinding(binding) {
326
- if (binding % 1 === 0) {
327
- throw new Error(`The binding value ${binding} must be a decimal number.`);
328
- }
329
-
330
- return { scale: 10 };
331
- }
332
-
333
- _typeForBinding(binding) {
334
- const Driver = this._driver();
335
-
336
- if (
337
- this.connectionSettings.options &&
338
- this.connectionSettings.options.mapBinding
339
- ) {
340
- const result = this.connectionSettings.options.mapBinding(binding);
341
- if (result) {
342
- return [result.value, result.type];
343
- }
344
- }
345
-
346
- switch (typeof binding) {
347
- case 'string':
348
- return [binding, Driver.TYPES.NVarChar];
349
- case 'boolean':
350
- return [binding, Driver.TYPES.Bit];
351
- case 'number': {
352
- if (binding % 1 !== 0) {
353
- return [binding, Driver.TYPES.Float];
354
- }
355
-
356
- if (binding < SQL_INT4.MIN || binding > SQL_INT4.MAX) {
357
- if (binding < SQL_BIGINT_SAFE.MIN || binding > SQL_BIGINT_SAFE.MAX) {
358
- throw new Error(
359
- `Bigint must be safe integer or must be passed as string, saw ${binding}`
360
- );
361
- }
362
-
363
- return [binding, Driver.TYPES.BigInt];
364
- }
365
-
366
- return [binding, Driver.TYPES.Int];
367
- }
368
- default: {
369
- if (binding instanceof Date) {
370
- return [binding, Driver.TYPES.DateTime];
371
- }
372
-
373
- if (binding instanceof Buffer) {
374
- return [binding, Driver.TYPES.VarBinary];
375
- }
376
-
377
- return [binding, Driver.TYPES.NVarChar];
378
- }
379
- }
380
- }
381
-
382
- // Runs the query on the specified connection, providing the bindings
383
- // and any other necessary prep work.
384
- _query(connection, query) {
385
- return new Promise((resolve, reject) => {
386
- const rows = [];
387
- const request = this._makeRequest(query, (err, count) => {
388
- if (err) {
389
- return reject(err);
390
- }
391
-
392
- query.response = rows;
393
-
394
- process.nextTick(() => this._chomp(connection));
395
-
396
- resolve(query);
397
- });
398
-
399
- request.on('row', (row) => {
400
- debug('request::row');
401
- rows.push(row);
402
- });
403
-
404
- this._assignBindings(request, query.bindings);
405
- this._enqueueRequest(request, connection);
406
- });
407
- }
408
-
409
- // sets a request input parameter. Detects bigints and decimals and sets type appropriately.
410
- _setReqInput(req, i, inputBinding) {
411
- const [binding, tediousType] = this._typeForBinding(inputBinding);
412
- const bindingName = 'p'.concat(i);
413
- let options;
414
-
415
- if (typeof binding === 'number' && binding % 1 !== 0) {
416
- options = this._scaleForBinding(binding);
417
- }
418
-
419
- debug(
420
- 'request::binding pos=%d type=%s value=%s',
421
- i,
422
- tediousType.name,
423
- binding
424
- );
425
-
426
- if (Buffer.isBuffer(binding)) {
427
- options = {
428
- length: 'max',
429
- };
430
- }
431
-
432
- req.addParameter(bindingName, tediousType, binding, options);
433
- }
434
-
435
- // Process the response as returned from the query.
436
- processResponse(query, runner) {
437
- if (query == null) return;
438
- let { response } = query;
439
- const { method } = query;
440
-
441
- if (query.output) {
442
- return query.output.call(runner, response);
443
- }
444
-
445
- response = response.map((row) =>
446
- row.reduce((columns, r) => {
447
- const colName = r.metadata.colName;
448
-
449
- if (columns[colName]) {
450
- if (!Array.isArray(columns[colName])) {
451
- columns[colName] = [columns[colName]];
452
- }
453
-
454
- columns[colName].push(r.value);
455
- } else {
456
- columns[colName] = r.value;
457
- }
458
-
459
- return columns;
460
- }, {})
461
- );
462
-
463
- if (query.output) return query.output.call(runner, response);
464
- switch (method) {
465
- case 'select':
466
- return response;
467
- case 'first':
468
- return response[0];
469
- case 'pluck':
470
- return map(response, query.pluck);
471
- case 'insert':
472
- case 'del':
473
- case 'update':
474
- case 'counter':
475
- if (query.returning) {
476
- if (query.returning === '@@rowcount') {
477
- return response[0][''];
478
- }
479
- }
480
- return response;
481
- default:
482
- return response;
483
- }
484
- }
485
- }
486
-
487
- Object.assign(Client_MSSQL.prototype, {
488
- requestQueue: [],
489
-
490
- dialect: 'mssql',
491
-
492
- driverName: 'mssql',
493
- });
494
-
495
- module.exports = Client_MSSQL;
1
+ // MSSQL Client
2
+ // -------
3
+ const map = require('lodash/map');
4
+ const isNil = require('lodash/isNil');
5
+
6
+ const Client = require('../../client');
7
+ const MSSQL_Formatter = require('./mssql-formatter');
8
+ const Transaction = require('./transaction');
9
+ const QueryCompiler = require('./query/mssql-querycompiler');
10
+ const SchemaCompiler = require('./schema/mssql-compiler');
11
+ const TableCompiler = require('./schema/mssql-tablecompiler');
12
+ const ViewCompiler = require('./schema/mssql-viewcompiler');
13
+ const ColumnCompiler = require('./schema/mssql-columncompiler');
14
+ const QueryBuilder = require('../../query/querybuilder');
15
+ const { setHiddenProperty } = require('../../util/security');
16
+
17
+ const debug = require('debug')('knex:mssql');
18
+
19
+ const SQL_INT4 = { MIN: -2147483648, MAX: 2147483647 };
20
+ const SQL_BIGINT_SAFE = { MIN: -9007199254740991, MAX: 9007199254740991 };
21
+
22
+ // Always initialize with the "QueryBuilder" and "QueryCompiler" objects, which
23
+ // extend the base 'lib/query/builder' and 'lib/query/compiler', respectively.
24
+ class Client_MSSQL extends Client {
25
+ constructor(config = {}) {
26
+ super(config);
27
+ }
28
+
29
+ /**
30
+ * @param {import('knex').Config} options
31
+ */
32
+ _generateConnection() {
33
+ const settings = this.connectionSettings;
34
+ settings.options = settings.options || {};
35
+
36
+ /** @type {import('tedious').ConnectionConfig} */
37
+ const cfg = {
38
+ authentication: {
39
+ type: settings.type || 'default',
40
+ options: {
41
+ userName: settings.userName || settings.user,
42
+ password: settings.password,
43
+ domain: settings.domain,
44
+ token: settings.token,
45
+ clientId: settings.clientId,
46
+ clientSecret: settings.clientSecret,
47
+ tenantId: settings.tenantId,
48
+ msiEndpoint: settings.msiEndpoint,
49
+ },
50
+ },
51
+ server: settings.server || settings.host,
52
+ options: {
53
+ database: settings.database,
54
+ encrypt: settings.encrypt || false,
55
+ port: settings.port || 1433,
56
+ connectTimeout: settings.connectionTimeout || settings.timeout || 15000,
57
+ requestTimeout: !isNil(settings.requestTimeout)
58
+ ? settings.requestTimeout
59
+ : 15000,
60
+ rowCollectionOnDone: false,
61
+ rowCollectionOnRequestCompletion: false,
62
+ useColumnNames: false,
63
+ tdsVersion: settings.options.tdsVersion || '7_4',
64
+ appName: settings.options.appName || 'knex',
65
+ trustServerCertificate: false,
66
+ ...settings.options,
67
+ },
68
+ };
69
+
70
+ if (cfg.authentication.options.password) {
71
+ setHiddenProperty(cfg.authentication.options);
72
+ }
73
+
74
+ // tedious always connect via tcp when port is specified
75
+ if (cfg.options.instanceName) delete cfg.options.port;
76
+
77
+ if (isNaN(cfg.options.requestTimeout)) cfg.options.requestTimeout = 15000;
78
+ if (cfg.options.requestTimeout === Infinity) cfg.options.requestTimeout = 0;
79
+ if (cfg.options.requestTimeout < 0) cfg.options.requestTimeout = 0;
80
+
81
+ if (settings.debug) {
82
+ cfg.options.debug = {
83
+ packet: true,
84
+ token: true,
85
+ data: true,
86
+ payload: true,
87
+ };
88
+ }
89
+
90
+ return cfg;
91
+ }
92
+
93
+ _driver() {
94
+ const tds = require('tedious');
95
+
96
+ return tds;
97
+ }
98
+
99
+ formatter() {
100
+ return new MSSQL_Formatter(this, ...arguments);
101
+ }
102
+
103
+ transaction() {
104
+ return new Transaction(this, ...arguments);
105
+ }
106
+
107
+ queryCompiler() {
108
+ return new QueryCompiler(this, ...arguments);
109
+ }
110
+
111
+ schemaCompiler() {
112
+ return new SchemaCompiler(this, ...arguments);
113
+ }
114
+
115
+ tableCompiler() {
116
+ return new TableCompiler(this, ...arguments);
117
+ }
118
+
119
+ viewCompiler() {
120
+ return new ViewCompiler(this, ...arguments);
121
+ }
122
+ queryBuilder() {
123
+ const b = new QueryBuilder(this);
124
+ return b;
125
+ }
126
+
127
+ columnCompiler() {
128
+ return new ColumnCompiler(this, ...arguments);
129
+ }
130
+
131
+ wrapIdentifierImpl(value) {
132
+ if (value === '*') {
133
+ return '*';
134
+ }
135
+
136
+ return `[${value.replace(/[[\]]+/g, '')}]`;
137
+ }
138
+
139
+ // Get a raw connection, called by the `pool` whenever a new
140
+ // connection needs to be added to the pool.
141
+ acquireRawConnection() {
142
+ return new Promise((resolver, rejecter) => {
143
+ debug('connection::connection new connection requested');
144
+ const Driver = this._driver();
145
+ const settings = Object.assign({}, this._generateConnection());
146
+
147
+ const connection = new Driver.Connection(settings);
148
+
149
+ connection.connect((err) => {
150
+ if (err) {
151
+ debug('connection::connect error: %s', err.message);
152
+ return rejecter(err);
153
+ }
154
+
155
+ debug('connection::connect connected to server');
156
+
157
+ connection.connected = true;
158
+ connection.on('error', (e) => {
159
+ debug('connection::error message=%s', e.message);
160
+ connection.__knex__disposed = e;
161
+ connection.connected = false;
162
+ });
163
+
164
+ connection.once('end', () => {
165
+ connection.connected = false;
166
+ connection.__knex__disposed = 'Connection to server was terminated.';
167
+ debug('connection::end connection ended.');
168
+ });
169
+
170
+ return resolver(connection);
171
+ });
172
+ });
173
+ }
174
+
175
+ validateConnection(connection) {
176
+ return connection && connection.connected;
177
+ }
178
+
179
+ // Used to explicitly close a connection, called internally by the pool
180
+ // when a connection times out or the pool is shutdown.
181
+ destroyRawConnection(connection) {
182
+ debug('connection::destroy');
183
+
184
+ return new Promise((resolve) => {
185
+ connection.once('end', () => {
186
+ resolve();
187
+ });
188
+
189
+ connection.close();
190
+ });
191
+ }
192
+
193
+ // Position the bindings for the query.
194
+ positionBindings(sql) {
195
+ let questionCount = -1;
196
+ return sql.replace(/\\?\?/g, (match) => {
197
+ if (match === '\\?') {
198
+ return '?';
199
+ }
200
+
201
+ questionCount += 1;
202
+ return `@p${questionCount}`;
203
+ });
204
+ }
205
+
206
+ _chomp(connection) {
207
+ if (connection.state.name === 'LoggedIn') {
208
+ const nextRequest = this.requestQueue.pop();
209
+ if (nextRequest) {
210
+ debug(
211
+ 'connection::query executing query, %d more in queue',
212
+ this.requestQueue.length
213
+ );
214
+
215
+ connection.execSql(nextRequest);
216
+ }
217
+ }
218
+ }
219
+
220
+ _enqueueRequest(request, connection) {
221
+ this.requestQueue.push(request);
222
+ this._chomp(connection);
223
+ }
224
+
225
+ _makeRequest(query, callback) {
226
+ const Driver = this._driver();
227
+ const sql = typeof query === 'string' ? query : query.sql;
228
+ let rowCount = 0;
229
+
230
+ if (!sql) throw new Error('The query is empty');
231
+
232
+ debug('request::request sql=%s', sql);
233
+
234
+ const request = new Driver.Request(sql, (err, remoteRowCount) => {
235
+ if (err) {
236
+ debug('request::error message=%s', err.message);
237
+ return callback(err);
238
+ }
239
+
240
+ rowCount = remoteRowCount;
241
+ debug('request::callback rowCount=%d', rowCount);
242
+ });
243
+
244
+ request.on('prepared', () => {
245
+ debug('request %s::request prepared', this.id);
246
+ });
247
+
248
+ request.on('done', (rowCount, more) => {
249
+ debug('request::done rowCount=%d more=%s', rowCount, more);
250
+ });
251
+
252
+ request.on('doneProc', (rowCount, more) => {
253
+ debug(
254
+ 'request::doneProc id=%s rowCount=%d more=%s',
255
+ request.id,
256
+ rowCount,
257
+ more
258
+ );
259
+ });
260
+
261
+ request.on('doneInProc', (rowCount, more) => {
262
+ debug(
263
+ 'request::doneInProc id=%s rowCount=%d more=%s',
264
+ request.id,
265
+ rowCount,
266
+ more
267
+ );
268
+ });
269
+
270
+ request.once('requestCompleted', () => {
271
+ debug('request::completed id=%s', request.id);
272
+ return callback(null, rowCount);
273
+ });
274
+
275
+ request.on('error', (err) => {
276
+ debug('request::error id=%s message=%s', request.id, err.message);
277
+ return callback(err);
278
+ });
279
+
280
+ return request;
281
+ }
282
+
283
+ // Grab a connection, run the query via the MSSQL streaming interface,
284
+ // and pass that through to the stream we've sent back to the client.
285
+ _stream(connection, query, /** @type {NodeJS.ReadWriteStream} */ stream) {
286
+ return new Promise((resolve, reject) => {
287
+ const request = this._makeRequest(query, (err) => {
288
+ if (err) {
289
+ stream.emit('error', err);
290
+ return reject(err);
291
+ }
292
+
293
+ resolve();
294
+ });
295
+
296
+ request.on('row', (row) => {
297
+ stream.write(
298
+ row.reduce(
299
+ (prev, curr) => ({
300
+ ...prev,
301
+ [curr.metadata.colName]: curr.value,
302
+ }),
303
+ {}
304
+ )
305
+ );
306
+ });
307
+ request.on('error', (err) => {
308
+ stream.emit('error', err);
309
+ reject(err);
310
+ });
311
+ request.once('requestCompleted', () => {
312
+ stream.end();
313
+ resolve();
314
+ });
315
+
316
+ this._assignBindings(request, query.bindings);
317
+ this._enqueueRequest(request, connection);
318
+ });
319
+ }
320
+
321
+ _assignBindings(request, bindings) {
322
+ if (Array.isArray(bindings)) {
323
+ for (let i = 0; i < bindings.length; i++) {
324
+ const binding = bindings[i];
325
+ this._setReqInput(request, i, binding);
326
+ }
327
+ }
328
+ }
329
+
330
+ _scaleForBinding(binding) {
331
+ if (binding % 1 === 0) {
332
+ throw new Error(`The binding value ${binding} must be a decimal number.`);
333
+ }
334
+
335
+ return { scale: 10 };
336
+ }
337
+
338
+ _typeForBinding(binding) {
339
+ const Driver = this._driver();
340
+
341
+ if (
342
+ this.connectionSettings.options &&
343
+ this.connectionSettings.options.mapBinding
344
+ ) {
345
+ const result = this.connectionSettings.options.mapBinding(binding);
346
+ if (result) {
347
+ return [result.value, result.type];
348
+ }
349
+ }
350
+
351
+ switch (typeof binding) {
352
+ case 'string':
353
+ return [binding, Driver.TYPES.NVarChar];
354
+ case 'boolean':
355
+ return [binding, Driver.TYPES.Bit];
356
+ case 'number': {
357
+ if (binding % 1 !== 0) {
358
+ return [binding, Driver.TYPES.Float];
359
+ }
360
+
361
+ if (binding < SQL_INT4.MIN || binding > SQL_INT4.MAX) {
362
+ if (binding < SQL_BIGINT_SAFE.MIN || binding > SQL_BIGINT_SAFE.MAX) {
363
+ throw new Error(
364
+ `Bigint must be safe integer or must be passed as string, saw ${binding}`
365
+ );
366
+ }
367
+
368
+ return [binding, Driver.TYPES.BigInt];
369
+ }
370
+
371
+ return [binding, Driver.TYPES.Int];
372
+ }
373
+ default: {
374
+ if (binding instanceof Date) {
375
+ return [binding, Driver.TYPES.DateTime];
376
+ }
377
+
378
+ if (binding instanceof Buffer) {
379
+ return [binding, Driver.TYPES.VarBinary];
380
+ }
381
+
382
+ return [binding, Driver.TYPES.NVarChar];
383
+ }
384
+ }
385
+ }
386
+
387
+ // Runs the query on the specified connection, providing the bindings
388
+ // and any other necessary prep work.
389
+ _query(connection, query) {
390
+ return new Promise((resolve, reject) => {
391
+ const rows = [];
392
+ const request = this._makeRequest(query, (err, count) => {
393
+ if (err) {
394
+ return reject(err);
395
+ }
396
+
397
+ query.response = rows;
398
+
399
+ process.nextTick(() => this._chomp(connection));
400
+
401
+ resolve(query);
402
+ });
403
+
404
+ request.on('row', (row) => {
405
+ debug('request::row');
406
+ rows.push(row);
407
+ });
408
+
409
+ this._assignBindings(request, query.bindings);
410
+ this._enqueueRequest(request, connection);
411
+ });
412
+ }
413
+
414
+ // sets a request input parameter. Detects bigints and decimals and sets type appropriately.
415
+ _setReqInput(req, i, inputBinding) {
416
+ const [binding, tediousType] = this._typeForBinding(inputBinding);
417
+ const bindingName = 'p'.concat(i);
418
+ let options;
419
+
420
+ if (typeof binding === 'number' && binding % 1 !== 0) {
421
+ options = this._scaleForBinding(binding);
422
+ }
423
+
424
+ debug(
425
+ 'request::binding pos=%d type=%s value=%s',
426
+ i,
427
+ tediousType.name,
428
+ binding
429
+ );
430
+
431
+ if (Buffer.isBuffer(binding)) {
432
+ options = {
433
+ length: 'max',
434
+ };
435
+ }
436
+
437
+ req.addParameter(bindingName, tediousType, binding, options);
438
+ }
439
+
440
+ // Process the response as returned from the query.
441
+ processResponse(query, runner) {
442
+ if (query == null) return;
443
+ let { response } = query;
444
+ const { method } = query;
445
+
446
+ if (query.output) {
447
+ return query.output.call(runner, response);
448
+ }
449
+
450
+ response = response.map((row) =>
451
+ row.reduce((columns, r) => {
452
+ const colName = r.metadata.colName;
453
+
454
+ if (columns[colName]) {
455
+ if (!Array.isArray(columns[colName])) {
456
+ columns[colName] = [columns[colName]];
457
+ }
458
+
459
+ columns[colName].push(r.value);
460
+ } else {
461
+ columns[colName] = r.value;
462
+ }
463
+
464
+ return columns;
465
+ }, {})
466
+ );
467
+
468
+ if (query.output) return query.output.call(runner, response);
469
+ switch (method) {
470
+ case 'select':
471
+ return response;
472
+ case 'first':
473
+ return response[0];
474
+ case 'pluck':
475
+ return map(response, query.pluck);
476
+ case 'insert':
477
+ case 'del':
478
+ case 'update':
479
+ case 'counter':
480
+ if (query.returning) {
481
+ if (query.returning === '@@rowcount') {
482
+ return response[0][''];
483
+ }
484
+ }
485
+ return response;
486
+ default:
487
+ return response;
488
+ }
489
+ }
490
+ }
491
+
492
+ Object.assign(Client_MSSQL.prototype, {
493
+ requestQueue: [],
494
+
495
+ dialect: 'mssql',
496
+
497
+ driverName: 'mssql',
498
+ });
499
+
500
+ module.exports = Client_MSSQL;