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.
- package/CHANGELOG.md +54 -18
- package/CONTRIBUTING.md +194 -194
- package/LICENSE +22 -22
- package/README.md +147 -148
- package/UPGRADING.md +233 -233
- package/bin/cli.js +473 -473
- package/bin/utils/cli-config-utils.js +210 -210
- package/bin/utils/constants.js +7 -7
- package/bin/utils/migrationsLister.js +37 -37
- package/knex.js +23 -23
- package/knex.mjs +11 -0
- package/lib/builder-interface-augmenter.js +120 -120
- package/lib/client.js +495 -475
- package/lib/constants.js +61 -61
- package/lib/dialects/better-sqlite3/index.js +77 -72
- package/lib/dialects/cockroachdb/crdb-columncompiler.js +14 -14
- package/lib/dialects/cockroachdb/crdb-querybuilder.js +11 -11
- package/lib/dialects/cockroachdb/crdb-querycompiler.js +122 -122
- package/lib/dialects/cockroachdb/crdb-tablecompiler.js +37 -37
- package/lib/dialects/cockroachdb/crdb-viewcompiler.js +15 -15
- package/lib/dialects/cockroachdb/index.js +86 -86
- package/lib/dialects/index.js +33 -33
- package/lib/dialects/mssql/index.js +500 -495
- package/lib/dialects/mssql/mssql-formatter.js +34 -34
- package/lib/dialects/mssql/query/mssql-querycompiler.js +601 -600
- package/lib/dialects/mssql/schema/mssql-columncompiler.js +185 -185
- package/lib/dialects/mssql/schema/mssql-compiler.js +91 -91
- package/lib/dialects/mssql/schema/mssql-tablecompiler.js +378 -378
- package/lib/dialects/mssql/schema/mssql-viewcompiler.js +55 -55
- package/lib/dialects/mssql/transaction.js +176 -176
- package/lib/dialects/mysql/index.js +201 -201
- package/lib/dialects/mysql/query/mysql-querycompiler.js +274 -274
- package/lib/dialects/mysql/schema/mysql-columncompiler.js +193 -193
- package/lib/dialects/mysql/schema/mysql-compiler.js +60 -60
- package/lib/dialects/mysql/schema/mysql-tablecompiler.js +381 -381
- package/lib/dialects/mysql/schema/mysql-viewbuilder.js +21 -21
- package/lib/dialects/mysql/schema/mysql-viewcompiler.js +15 -15
- package/lib/dialects/mysql/transaction.js +46 -46
- package/lib/dialects/mysql2/index.js +53 -33
- package/lib/dialects/mysql2/transaction.js +44 -44
- package/lib/dialects/oracle/DEAD_CODE.md +5 -5
- package/lib/dialects/oracle/index.js +92 -92
- package/lib/dialects/oracle/query/oracle-querycompiler.js +343 -342
- package/lib/dialects/oracle/schema/internal/incrementUtils.js +20 -20
- package/lib/dialects/oracle/schema/internal/trigger.js +135 -135
- package/lib/dialects/oracle/schema/oracle-columnbuilder.js +17 -17
- package/lib/dialects/oracle/schema/oracle-columncompiler.js +126 -126
- package/lib/dialects/oracle/schema/oracle-compiler.js +122 -122
- package/lib/dialects/oracle/schema/oracle-tablecompiler.js +190 -190
- package/lib/dialects/oracle/utils.js +87 -87
- package/lib/dialects/oracledb/index.js +327 -327
- package/lib/dialects/oracledb/query/oracledb-querycompiler.js +481 -481
- package/lib/dialects/oracledb/schema/oracledb-columncompiler.js +61 -55
- package/lib/dialects/oracledb/schema/oracledb-tablecompiler.js +19 -19
- package/lib/dialects/oracledb/schema/oracledb-viewbuilder.js +13 -13
- package/lib/dialects/oracledb/schema/oracledb-viewcompiler.js +19 -19
- package/lib/dialects/oracledb/transaction.js +98 -98
- package/lib/dialects/oracledb/utils.js +208 -208
- package/lib/dialects/pgnative/index.js +60 -60
- package/lib/dialects/postgres/execution/pg-transaction.js +19 -12
- package/lib/dialects/postgres/index.js +358 -358
- package/lib/dialects/postgres/query/pg-querybuilder.js +43 -38
- package/lib/dialects/postgres/query/pg-querycompiler.js +400 -395
- package/lib/dialects/postgres/schema/pg-columncompiler.js +156 -156
- package/lib/dialects/postgres/schema/pg-compiler.js +138 -138
- package/lib/dialects/postgres/schema/pg-tablecompiler.js +304 -299
- package/lib/dialects/postgres/schema/pg-viewbuilder.js +21 -21
- package/lib/dialects/postgres/schema/pg-viewcompiler.js +35 -35
- package/lib/dialects/redshift/index.js +86 -86
- package/lib/dialects/redshift/query/redshift-querycompiler.js +163 -163
- package/lib/dialects/redshift/schema/redshift-columnbuilder.js +22 -22
- package/lib/dialects/redshift/schema/redshift-columncompiler.js +67 -67
- package/lib/dialects/redshift/schema/redshift-compiler.js +14 -14
- package/lib/dialects/redshift/schema/redshift-tablecompiler.js +122 -122
- package/lib/dialects/redshift/schema/redshift-viewcompiler.js +11 -11
- package/lib/dialects/redshift/transaction.js +32 -25
- package/lib/dialects/sqlite3/execution/sqlite-transaction.js +25 -18
- package/lib/dialects/sqlite3/index.js +250 -250
- package/lib/dialects/sqlite3/query/sqlite-querybuilder.js +33 -33
- package/lib/dialects/sqlite3/query/sqlite-querycompiler.js +334 -334
- package/lib/dialects/sqlite3/schema/ddl.js +400 -400
- package/lib/dialects/sqlite3/schema/internal/compiler.js +327 -327
- package/lib/dialects/sqlite3/schema/internal/parser-combinator.js +161 -161
- package/lib/dialects/sqlite3/schema/internal/parser.js +638 -638
- package/lib/dialects/sqlite3/schema/internal/sqlite-ddl-operations.js +41 -41
- package/lib/dialects/sqlite3/schema/internal/tokenizer.js +38 -38
- package/lib/dialects/sqlite3/schema/internal/utils.js +12 -12
- package/lib/dialects/sqlite3/schema/sqlite-columncompiler.js +50 -50
- package/lib/dialects/sqlite3/schema/sqlite-compiler.js +80 -80
- package/lib/dialects/sqlite3/schema/sqlite-tablecompiler.js +347 -347
- package/lib/dialects/sqlite3/schema/sqlite-viewcompiler.js +40 -40
- package/lib/execution/batch-insert.js +51 -51
- package/lib/execution/internal/delay.js +6 -6
- package/lib/execution/internal/ensure-connection-callback.js +41 -41
- package/lib/execution/internal/query-executioner.js +62 -62
- package/lib/execution/runner.js +325 -307
- package/lib/execution/transaction.js +409 -401
- package/lib/formatter/formatterUtils.js +42 -42
- package/lib/formatter/rawFormatter.js +84 -84
- package/lib/formatter/wrappingFormatter.js +250 -250
- package/lib/formatter.js +25 -25
- package/lib/index.js +3 -3
- package/lib/knex-builder/FunctionHelper.js +80 -54
- package/lib/knex-builder/Knex.js +59 -59
- package/lib/knex-builder/internal/config-resolver.js +57 -57
- package/lib/knex-builder/internal/parse-connection.js +87 -87
- package/lib/knex-builder/make-knex.js +345 -340
- package/lib/logger.js +76 -76
- package/lib/migrations/common/MigrationsLoader.js +36 -36
- package/lib/migrations/migrate/MigrationGenerator.js +84 -84
- package/lib/migrations/migrate/Migrator.js +598 -598
- package/lib/migrations/migrate/migrate-stub.js +17 -17
- package/lib/migrations/migrate/migration-list-resolver.js +33 -33
- package/lib/migrations/migrate/migrator-configuration-merger.js +58 -58
- package/lib/migrations/migrate/sources/fs-migrations.js +74 -74
- package/lib/migrations/migrate/stub/cjs.stub +15 -15
- package/lib/migrations/migrate/stub/coffee.stub +13 -13
- package/lib/migrations/migrate/stub/eg.stub +14 -14
- package/lib/migrations/migrate/stub/js-schema.stub +22 -22
- package/lib/migrations/migrate/stub/js.stub +22 -22
- package/lib/migrations/migrate/stub/knexfile-coffee.stub +34 -34
- package/lib/migrations/migrate/stub/knexfile-eg.stub +43 -43
- package/lib/migrations/migrate/stub/knexfile-js.stub +47 -47
- package/lib/migrations/migrate/stub/knexfile-ls.stub +35 -35
- package/lib/migrations/migrate/stub/knexfile-ts.stub +47 -47
- package/lib/migrations/migrate/stub/ls.stub +14 -14
- package/lib/migrations/migrate/stub/mjs.stub +23 -23
- package/lib/migrations/migrate/stub/ts-schema.stub +21 -21
- package/lib/migrations/migrate/stub/ts.stub +21 -21
- package/lib/migrations/migrate/table-creator.js +77 -77
- package/lib/migrations/migrate/table-resolver.js +27 -27
- package/lib/migrations/seed/Seeder.js +137 -137
- package/lib/migrations/seed/seed-stub.js +13 -13
- package/lib/migrations/seed/seeder-configuration-merger.js +60 -60
- package/lib/migrations/seed/sources/fs-seeds.js +65 -65
- package/lib/migrations/seed/stub/coffee.stub +9 -9
- package/lib/migrations/seed/stub/eg.stub +11 -11
- package/lib/migrations/seed/stub/js.stub +13 -13
- package/lib/migrations/seed/stub/ls.stub +11 -11
- package/lib/migrations/seed/stub/mjs.stub +12 -12
- package/lib/migrations/seed/stub/ts.stub +13 -13
- package/lib/migrations/util/fs.js +86 -86
- package/lib/migrations/util/import-file.js +12 -12
- package/lib/migrations/util/is-module-type.js +9 -9
- package/lib/migrations/util/template.js +52 -52
- package/lib/migrations/util/timestamp.js +14 -14
- package/lib/query/analytic.js +52 -52
- package/lib/query/constants.js +15 -15
- package/lib/query/joinclause.js +270 -270
- package/lib/query/method-constants.js +136 -135
- package/lib/query/querybuilder.js +1793 -1794
- package/lib/query/querycompiler.js +1591 -1580
- package/lib/raw.js +139 -139
- package/lib/ref.js +39 -39
- package/lib/schema/builder.js +115 -115
- package/lib/schema/columnbuilder.js +146 -146
- package/lib/schema/columncompiler.js +307 -307
- package/lib/schema/compiler.js +187 -187
- package/lib/schema/internal/helpers.js +55 -55
- package/lib/schema/tablebuilder.js +376 -376
- package/lib/schema/tablecompiler.js +433 -433
- package/lib/schema/viewbuilder.js +92 -92
- package/lib/schema/viewcompiler.js +138 -138
- package/lib/util/finally-mixin.js +13 -13
- package/lib/util/helpers.js +95 -95
- package/lib/util/is.js +32 -32
- package/lib/util/nanoid.js +40 -40
- package/lib/util/noop.js +1 -1
- package/lib/util/save-async-stack.js +14 -14
- package/lib/util/security.js +26 -0
- package/lib/util/string.js +190 -190
- package/lib/util/timeout.js +29 -29
- package/package.json +12 -10
- package/scripts/build.js +125 -125
- package/scripts/clean.js +31 -31
- package/scripts/docker-compose.yml +152 -152
- package/scripts/next-release-howto.md +24 -24
- package/scripts/oracledb-install-driver-libs.sh +82 -82
- package/scripts/release.sh +34 -34
- package/scripts/runkit-example.js +34 -34
- package/scripts/stress-test/README.txt +18 -18
- package/scripts/stress-test/docker-compose.yml +57 -57
- package/scripts/stress-test/knex-stress-test.js +208 -208
- package/scripts/stress-test/mysql2-random-hanging-every-now-and-then.js +145 -145
- package/scripts/stress-test/mysql2-sudden-exit-without-error.js +100 -100
- package/scripts/stress-test/reconnect-test-mysql-based-drivers.js +184 -184
- package/scripts/update_gitignore_for_tsc_output.js +90 -90
- package/types/index.d.ts +3273 -3233
- package/types/result.d.ts +27 -27
- 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
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
const
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
//
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
settings
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
if (cfg.options.
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
connection.
|
|
161
|
-
connection.
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
}
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
});
|
|
269
|
-
|
|
270
|
-
request.
|
|
271
|
-
debug('request::
|
|
272
|
-
return callback(
|
|
273
|
-
});
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
)
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
});
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
|
|
443
|
-
}
|
|
444
|
-
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
|
|
451
|
-
|
|
452
|
-
|
|
453
|
-
|
|
454
|
-
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
|
|
468
|
-
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
case '
|
|
473
|
-
|
|
474
|
-
case '
|
|
475
|
-
|
|
476
|
-
|
|
477
|
-
|
|
478
|
-
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
|
|
490
|
-
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
|
|
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;
|