knex 2.4.1 → 2.4.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (187) hide show
  1. package/CHANGELOG.md +6 -0
  2. package/CONTRIBUTING.md +194 -194
  3. package/LICENSE +22 -22
  4. package/README.md +148 -148
  5. package/UPGRADING.md +233 -233
  6. package/bin/cli.js +473 -472
  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/lib/builder-interface-augmenter.js +120 -120
  12. package/lib/client.js +475 -475
  13. package/lib/constants.js +61 -61
  14. package/lib/dialects/better-sqlite3/index.js +72 -72
  15. package/lib/dialects/cockroachdb/crdb-columncompiler.js +14 -14
  16. package/lib/dialects/cockroachdb/crdb-querybuilder.js +11 -11
  17. package/lib/dialects/cockroachdb/crdb-querycompiler.js +122 -122
  18. package/lib/dialects/cockroachdb/crdb-tablecompiler.js +37 -37
  19. package/lib/dialects/cockroachdb/crdb-viewcompiler.js +15 -15
  20. package/lib/dialects/cockroachdb/index.js +86 -86
  21. package/lib/dialects/mssql/index.js +495 -495
  22. package/lib/dialects/mssql/mssql-formatter.js +34 -34
  23. package/lib/dialects/mssql/query/mssql-querycompiler.js +600 -600
  24. package/lib/dialects/mssql/schema/mssql-columncompiler.js +185 -185
  25. package/lib/dialects/mssql/schema/mssql-compiler.js +91 -91
  26. package/lib/dialects/mssql/schema/mssql-tablecompiler.js +378 -378
  27. package/lib/dialects/mssql/schema/mssql-viewcompiler.js +55 -55
  28. package/lib/dialects/mssql/transaction.js +176 -176
  29. package/lib/dialects/mysql/index.js +201 -201
  30. package/lib/dialects/mysql/query/mysql-querycompiler.js +274 -274
  31. package/lib/dialects/mysql/schema/mysql-columncompiler.js +193 -193
  32. package/lib/dialects/mysql/schema/mysql-compiler.js +60 -60
  33. package/lib/dialects/mysql/schema/mysql-tablecompiler.js +381 -381
  34. package/lib/dialects/mysql/schema/mysql-viewbuilder.js +21 -21
  35. package/lib/dialects/mysql/schema/mysql-viewcompiler.js +15 -15
  36. package/lib/dialects/mysql/transaction.js +46 -46
  37. package/lib/dialects/mysql2/index.js +33 -33
  38. package/lib/dialects/mysql2/transaction.js +44 -44
  39. package/lib/dialects/oracle/DEAD_CODE.md +5 -5
  40. package/lib/dialects/oracle/index.js +92 -92
  41. package/lib/dialects/oracle/query/oracle-querycompiler.js +342 -342
  42. package/lib/dialects/oracle/schema/internal/incrementUtils.js +20 -20
  43. package/lib/dialects/oracle/schema/internal/trigger.js +135 -135
  44. package/lib/dialects/oracle/schema/oracle-columnbuilder.js +17 -17
  45. package/lib/dialects/oracle/schema/oracle-columncompiler.js +126 -126
  46. package/lib/dialects/oracle/schema/oracle-compiler.js +122 -122
  47. package/lib/dialects/oracle/schema/oracle-tablecompiler.js +190 -190
  48. package/lib/dialects/oracle/utils.js +87 -87
  49. package/lib/dialects/oracledb/index.js +327 -327
  50. package/lib/dialects/oracledb/query/oracledb-querycompiler.js +481 -481
  51. package/lib/dialects/oracledb/schema/oracledb-columncompiler.js +55 -55
  52. package/lib/dialects/oracledb/schema/oracledb-tablecompiler.js +19 -19
  53. package/lib/dialects/oracledb/schema/oracledb-viewbuilder.js +13 -13
  54. package/lib/dialects/oracledb/schema/oracledb-viewcompiler.js +19 -19
  55. package/lib/dialects/oracledb/transaction.js +98 -98
  56. package/lib/dialects/oracledb/utils.js +208 -208
  57. package/lib/dialects/pgnative/index.js +60 -60
  58. package/lib/dialects/postgres/execution/pg-transaction.js +12 -12
  59. package/lib/dialects/postgres/index.js +358 -358
  60. package/lib/dialects/postgres/query/pg-querybuilder.js +38 -38
  61. package/lib/dialects/postgres/query/pg-querycompiler.js +395 -395
  62. package/lib/dialects/postgres/schema/pg-columncompiler.js +156 -156
  63. package/lib/dialects/postgres/schema/pg-compiler.js +138 -136
  64. package/lib/dialects/postgres/schema/pg-tablecompiler.js +299 -299
  65. package/lib/dialects/postgres/schema/pg-viewbuilder.js +21 -21
  66. package/lib/dialects/postgres/schema/pg-viewcompiler.js +35 -35
  67. package/lib/dialects/redshift/index.js +86 -86
  68. package/lib/dialects/redshift/query/redshift-querycompiler.js +163 -163
  69. package/lib/dialects/redshift/schema/redshift-columnbuilder.js +22 -22
  70. package/lib/dialects/redshift/schema/redshift-columncompiler.js +67 -67
  71. package/lib/dialects/redshift/schema/redshift-compiler.js +14 -14
  72. package/lib/dialects/redshift/schema/redshift-tablecompiler.js +122 -122
  73. package/lib/dialects/redshift/schema/redshift-viewcompiler.js +11 -11
  74. package/lib/dialects/redshift/transaction.js +25 -25
  75. package/lib/dialects/sqlite3/execution/sqlite-transaction.js +18 -18
  76. package/lib/dialects/sqlite3/index.js +250 -250
  77. package/lib/dialects/sqlite3/query/sqlite-querybuilder.js +33 -33
  78. package/lib/dialects/sqlite3/query/sqlite-querycompiler.js +334 -334
  79. package/lib/dialects/sqlite3/schema/ddl.js +400 -400
  80. package/lib/dialects/sqlite3/schema/internal/compiler.js +327 -327
  81. package/lib/dialects/sqlite3/schema/internal/parser-combinator.js +161 -161
  82. package/lib/dialects/sqlite3/schema/internal/parser.js +638 -638
  83. package/lib/dialects/sqlite3/schema/internal/sqlite-ddl-operations.js +41 -41
  84. package/lib/dialects/sqlite3/schema/internal/tokenizer.js +38 -38
  85. package/lib/dialects/sqlite3/schema/internal/utils.js +12 -12
  86. package/lib/dialects/sqlite3/schema/sqlite-columncompiler.js +50 -50
  87. package/lib/dialects/sqlite3/schema/sqlite-compiler.js +80 -80
  88. package/lib/dialects/sqlite3/schema/sqlite-tablecompiler.js +347 -347
  89. package/lib/dialects/sqlite3/schema/sqlite-viewcompiler.js +40 -40
  90. package/lib/execution/batch-insert.js +51 -51
  91. package/lib/execution/internal/delay.js +6 -6
  92. package/lib/execution/internal/ensure-connection-callback.js +41 -41
  93. package/lib/execution/internal/query-executioner.js +62 -62
  94. package/lib/execution/runner.js +307 -307
  95. package/lib/execution/transaction.js +401 -401
  96. package/lib/formatter/formatterUtils.js +42 -42
  97. package/lib/formatter/rawFormatter.js +84 -84
  98. package/lib/formatter/wrappingFormatter.js +250 -250
  99. package/lib/formatter.js +25 -25
  100. package/lib/index.js +3 -3
  101. package/lib/knex-builder/FunctionHelper.js +54 -54
  102. package/lib/knex-builder/Knex.js +59 -59
  103. package/lib/knex-builder/internal/config-resolver.js +57 -57
  104. package/lib/knex-builder/internal/parse-connection.js +87 -87
  105. package/lib/knex-builder/make-knex.js +340 -340
  106. package/lib/logger.js +76 -76
  107. package/lib/migrations/common/MigrationsLoader.js +36 -36
  108. package/lib/migrations/migrate/MigrationGenerator.js +84 -82
  109. package/lib/migrations/migrate/Migrator.js +598 -598
  110. package/lib/migrations/migrate/migrate-stub.js +17 -17
  111. package/lib/migrations/migrate/migration-list-resolver.js +33 -33
  112. package/lib/migrations/migrate/migrator-configuration-merger.js +58 -58
  113. package/lib/migrations/migrate/sources/fs-migrations.js +74 -74
  114. package/lib/migrations/migrate/stub/cjs.stub +15 -15
  115. package/lib/migrations/migrate/stub/coffee.stub +13 -13
  116. package/lib/migrations/migrate/stub/eg.stub +14 -14
  117. package/lib/migrations/migrate/stub/js-schema.stub +22 -22
  118. package/lib/migrations/migrate/stub/js.stub +22 -22
  119. package/lib/migrations/migrate/stub/knexfile-coffee.stub +34 -34
  120. package/lib/migrations/migrate/stub/knexfile-eg.stub +43 -43
  121. package/lib/migrations/migrate/stub/knexfile-js.stub +47 -47
  122. package/lib/migrations/migrate/stub/knexfile-ls.stub +35 -35
  123. package/lib/migrations/migrate/stub/knexfile-ts.stub +47 -47
  124. package/lib/migrations/migrate/stub/ls.stub +14 -14
  125. package/lib/migrations/migrate/stub/mjs.stub +23 -23
  126. package/lib/migrations/migrate/stub/ts-schema.stub +21 -21
  127. package/lib/migrations/migrate/stub/ts.stub +21 -21
  128. package/lib/migrations/migrate/table-creator.js +77 -77
  129. package/lib/migrations/migrate/table-resolver.js +27 -27
  130. package/lib/migrations/seed/Seeder.js +137 -137
  131. package/lib/migrations/seed/seed-stub.js +13 -13
  132. package/lib/migrations/seed/seeder-configuration-merger.js +60 -60
  133. package/lib/migrations/seed/sources/fs-seeds.js +65 -65
  134. package/lib/migrations/seed/stub/coffee.stub +9 -9
  135. package/lib/migrations/seed/stub/eg.stub +11 -11
  136. package/lib/migrations/seed/stub/js.stub +13 -13
  137. package/lib/migrations/seed/stub/ls.stub +11 -11
  138. package/lib/migrations/seed/stub/mjs.stub +12 -12
  139. package/lib/migrations/seed/stub/ts.stub +13 -13
  140. package/lib/migrations/util/fs.js +86 -86
  141. package/lib/migrations/util/import-file.js +12 -12
  142. package/lib/migrations/util/is-module-type.js +9 -9
  143. package/lib/migrations/util/template.js +52 -52
  144. package/lib/migrations/util/timestamp.js +14 -14
  145. package/lib/query/analytic.js +52 -52
  146. package/lib/query/constants.js +15 -15
  147. package/lib/query/joinclause.js +270 -270
  148. package/lib/query/method-constants.js +135 -135
  149. package/lib/query/querybuilder.js +1794 -1794
  150. package/lib/query/querycompiler.js +1580 -1580
  151. package/lib/raw.js +139 -139
  152. package/lib/ref.js +39 -39
  153. package/lib/schema/builder.js +115 -114
  154. package/lib/schema/columnbuilder.js +146 -145
  155. package/lib/schema/columncompiler.js +307 -307
  156. package/lib/schema/compiler.js +187 -187
  157. package/lib/schema/internal/helpers.js +55 -55
  158. package/lib/schema/tablebuilder.js +376 -375
  159. package/lib/schema/tablecompiler.js +433 -433
  160. package/lib/schema/viewbuilder.js +92 -93
  161. package/lib/schema/viewcompiler.js +138 -138
  162. package/lib/util/finally-mixin.js +13 -13
  163. package/lib/util/helpers.js +95 -95
  164. package/lib/util/is.js +32 -32
  165. package/lib/util/nanoid.js +40 -40
  166. package/lib/util/noop.js +1 -1
  167. package/lib/util/save-async-stack.js +14 -14
  168. package/lib/util/string.js +190 -190
  169. package/lib/util/timeout.js +29 -29
  170. package/package.json +8 -6
  171. package/scripts/build.js +125 -125
  172. package/scripts/clean.js +31 -29
  173. package/scripts/docker-compose.yml +152 -152
  174. package/scripts/next-release-howto.md +24 -24
  175. package/scripts/oracledb-install-driver-libs.sh +82 -82
  176. package/scripts/release.sh +34 -34
  177. package/scripts/runkit-example.js +34 -34
  178. package/scripts/stress-test/README.txt +18 -18
  179. package/scripts/stress-test/docker-compose.yml +57 -57
  180. package/scripts/stress-test/knex-stress-test.js +208 -208
  181. package/scripts/stress-test/mysql2-random-hanging-every-now-and-then.js +145 -145
  182. package/scripts/stress-test/mysql2-sudden-exit-without-error.js +100 -100
  183. package/scripts/stress-test/reconnect-test-mysql-based-drivers.js +184 -184
  184. package/scripts/update_gitignore_for_tsc_output.js +90 -86
  185. package/types/index.d.ts +3233 -3233
  186. package/types/result.d.ts +27 -27
  187. package/types/tables.d.ts +4 -4
@@ -1,381 +1,381 @@
1
- /* eslint max-len:0*/
2
-
3
- // MySQL Table Builder & Compiler
4
- // -------
5
- const TableCompiler = require('../../../schema/tablecompiler');
6
- const { isObject, isString } = require('../../../util/is');
7
-
8
- // Table Compiler
9
- // ------
10
-
11
- class TableCompiler_MySQL extends TableCompiler {
12
- constructor(client, tableBuilder) {
13
- super(client, tableBuilder);
14
- }
15
-
16
- createQuery(columns, ifNot, like) {
17
- const createStatement = ifNot
18
- ? 'create table if not exists '
19
- : 'create table ';
20
- const { client } = this;
21
- let conn = {};
22
- let columnsSql = ' (' + columns.sql.join(', ');
23
-
24
- columnsSql += this.primaryKeys() || '';
25
- columnsSql += this._addChecks();
26
- columnsSql += ')';
27
-
28
- let sql =
29
- createStatement +
30
- this.tableName() +
31
- (like && this.tableNameLike()
32
- ? ' like ' + this.tableNameLike()
33
- : columnsSql);
34
-
35
- // Check if the connection settings are set.
36
- if (client.connectionSettings) {
37
- conn = client.connectionSettings;
38
- }
39
-
40
- const charset = this.single.charset || conn.charset || '';
41
- const collation = this.single.collate || conn.collate || '';
42
- const engine = this.single.engine || '';
43
-
44
- if (charset && !like) sql += ` default character set ${charset}`;
45
- if (collation) sql += ` collate ${collation}`;
46
- if (engine) sql += ` engine = ${engine}`;
47
-
48
- if (this.single.comment) {
49
- const comment = this.single.comment || '';
50
- const MAX_COMMENT_LENGTH = 1024;
51
- if (comment.length > MAX_COMMENT_LENGTH)
52
- this.client.logger.warn(
53
- `The max length for a table comment is ${MAX_COMMENT_LENGTH} characters`
54
- );
55
- sql += ` comment = '${comment}'`;
56
- }
57
-
58
- this.pushQuery(sql);
59
- if (like) {
60
- this.addColumns(columns, this.addColumnsPrefix);
61
- }
62
- }
63
-
64
- // Compiles the comment on the table.
65
- comment(comment) {
66
- this.pushQuery(`alter table ${this.tableName()} comment = '${comment}'`);
67
- }
68
-
69
- changeType() {
70
- // alter table + table + ' modify ' + wrapped + '// type';
71
- }
72
-
73
- // Renames a column on the table.
74
- renameColumn(from, to) {
75
- const compiler = this;
76
- const table = this.tableName();
77
- const wrapped = this.formatter.wrap(from) + ' ' + this.formatter.wrap(to);
78
-
79
- this.pushQuery({
80
- sql:
81
- `show full fields from ${table} where field = ` +
82
- this.client.parameter(from, this.tableBuilder, this.bindingsHolder),
83
- output(resp) {
84
- const column = resp[0];
85
- const runner = this;
86
- return compiler.getFKRefs(runner).then(([refs]) =>
87
- new Promise((resolve, reject) => {
88
- try {
89
- if (!refs.length) {
90
- resolve();
91
- }
92
- resolve(compiler.dropFKRefs(runner, refs));
93
- } catch (e) {
94
- reject(e);
95
- }
96
- })
97
- .then(function () {
98
- let sql = `alter table ${table} change ${wrapped} ${column.Type}`;
99
-
100
- if (String(column.Null).toUpperCase() !== 'YES') {
101
- sql += ` NOT NULL`;
102
- } else {
103
- // This doesn't matter for most cases except Timestamp, where this is important
104
- sql += ` NULL`;
105
- }
106
- if (column.Default !== void 0 && column.Default !== null) {
107
- sql += ` DEFAULT '${column.Default}'`;
108
- }
109
- if (column.Collation !== void 0 && column.Collation !== null) {
110
- sql += ` COLLATE '${column.Collation}'`;
111
- }
112
- // Add back the auto increment if the column it, fix issue #2767
113
- if (column.Extra == 'auto_increment') {
114
- sql += ` AUTO_INCREMENT`;
115
- }
116
-
117
- return runner.query({
118
- sql,
119
- });
120
- })
121
- .then(function () {
122
- if (!refs.length) {
123
- return;
124
- }
125
- return compiler.createFKRefs(
126
- runner,
127
- refs.map(function (ref) {
128
- if (ref.REFERENCED_COLUMN_NAME === from) {
129
- ref.REFERENCED_COLUMN_NAME = to;
130
- }
131
- if (ref.COLUMN_NAME === from) {
132
- ref.COLUMN_NAME = to;
133
- }
134
- return ref;
135
- })
136
- );
137
- })
138
- );
139
- },
140
- });
141
- }
142
-
143
- primaryKeys() {
144
- const pks = (this.grouped.alterTable || []).filter(
145
- (k) => k.method === 'primary'
146
- );
147
- if (pks.length > 0 && pks[0].args.length > 0) {
148
- const columns = pks[0].args[0];
149
- let constraintName = pks[0].args[1] || '';
150
- if (constraintName) {
151
- constraintName = ' constraint ' + this.formatter.wrap(constraintName);
152
- }
153
-
154
- if (this.grouped.columns) {
155
- const incrementsCols = this._getIncrementsColumnNames();
156
- if (incrementsCols.length) {
157
- incrementsCols.forEach((c) => {
158
- if (!columns.includes(c)) {
159
- columns.unshift(c);
160
- }
161
- });
162
- }
163
- }
164
-
165
- return `,${constraintName} primary key (${this.formatter.columnize(
166
- columns
167
- )})`;
168
- }
169
- }
170
-
171
- getFKRefs(runner) {
172
- const bindingsHolder = {
173
- bindings: [],
174
- };
175
-
176
- const sql =
177
- 'SELECT KCU.CONSTRAINT_NAME, KCU.TABLE_NAME, KCU.COLUMN_NAME, ' +
178
- ' KCU.REFERENCED_TABLE_NAME, KCU.REFERENCED_COLUMN_NAME, ' +
179
- ' RC.UPDATE_RULE, RC.DELETE_RULE ' +
180
- 'FROM INFORMATION_SCHEMA.KEY_COLUMN_USAGE AS KCU ' +
181
- 'JOIN INFORMATION_SCHEMA.REFERENTIAL_CONSTRAINTS AS RC ' +
182
- ' USING(CONSTRAINT_NAME)' +
183
- 'WHERE KCU.REFERENCED_TABLE_NAME = ' +
184
- this.client.parameter(
185
- this.tableNameRaw,
186
- this.tableBuilder,
187
- bindingsHolder
188
- ) +
189
- ' ' +
190
- ' AND KCU.CONSTRAINT_SCHEMA = ' +
191
- this.client.parameter(
192
- this.client.database(),
193
- this.tableBuilder,
194
- bindingsHolder
195
- ) +
196
- ' ' +
197
- ' AND RC.CONSTRAINT_SCHEMA = ' +
198
- this.client.parameter(
199
- this.client.database(),
200
- this.tableBuilder,
201
- bindingsHolder
202
- );
203
-
204
- return runner.query({
205
- sql,
206
- bindings: bindingsHolder.bindings,
207
- });
208
- }
209
-
210
- dropFKRefs(runner, refs) {
211
- const formatter = this.client.formatter(this.tableBuilder);
212
-
213
- return Promise.all(
214
- refs.map(function (ref) {
215
- const constraintName = formatter.wrap(ref.CONSTRAINT_NAME);
216
- const tableName = formatter.wrap(ref.TABLE_NAME);
217
- return runner.query({
218
- sql: `alter table ${tableName} drop foreign key ${constraintName}`,
219
- });
220
- })
221
- );
222
- }
223
-
224
- createFKRefs(runner, refs) {
225
- const formatter = this.client.formatter(this.tableBuilder);
226
-
227
- return Promise.all(
228
- refs.map(function (ref) {
229
- const tableName = formatter.wrap(ref.TABLE_NAME);
230
- const keyName = formatter.wrap(ref.CONSTRAINT_NAME);
231
- const column = formatter.columnize(ref.COLUMN_NAME);
232
- const references = formatter.columnize(ref.REFERENCED_COLUMN_NAME);
233
- const inTable = formatter.wrap(ref.REFERENCED_TABLE_NAME);
234
- const onUpdate = ` ON UPDATE ${ref.UPDATE_RULE}`;
235
- const onDelete = ` ON DELETE ${ref.DELETE_RULE}`;
236
-
237
- return runner.query({
238
- sql:
239
- `alter table ${tableName} add constraint ${keyName} ` +
240
- 'foreign key (' +
241
- column +
242
- ') references ' +
243
- inTable +
244
- ' (' +
245
- references +
246
- ')' +
247
- onUpdate +
248
- onDelete,
249
- });
250
- })
251
- );
252
- }
253
-
254
- index(columns, indexName, options) {
255
- let storageEngineIndexType;
256
- let indexType;
257
-
258
- if (isString(options)) {
259
- indexType = options;
260
- } else if (isObject(options)) {
261
- ({ indexType, storageEngineIndexType } = options);
262
- }
263
-
264
- indexName = indexName
265
- ? this.formatter.wrap(indexName)
266
- : this._indexCommand('index', this.tableNameRaw, columns);
267
- storageEngineIndexType = storageEngineIndexType
268
- ? ` using ${storageEngineIndexType}`
269
- : '';
270
- this.pushQuery(
271
- `alter table ${this.tableName()} add${
272
- indexType ? ` ${indexType}` : ''
273
- } index ${indexName}(${this.formatter.columnize(
274
- columns
275
- )})${storageEngineIndexType}`
276
- );
277
- }
278
-
279
- primary(columns, constraintName) {
280
- let deferrable;
281
- if (isObject(constraintName)) {
282
- ({ constraintName, deferrable } = constraintName);
283
- }
284
- if (deferrable && deferrable !== 'not deferrable') {
285
- this.client.logger.warn(
286
- `mysql: primary key constraint \`${constraintName}\` will not be deferrable ${deferrable} because mysql does not support deferred constraints.`
287
- );
288
- }
289
- constraintName = constraintName
290
- ? this.formatter.wrap(constraintName)
291
- : this.formatter.wrap(`${this.tableNameRaw}_pkey`);
292
-
293
- const primaryCols = columns;
294
- let incrementsCols = [];
295
- if (this.grouped.columns) {
296
- incrementsCols = this._getIncrementsColumnNames();
297
- if (incrementsCols) {
298
- incrementsCols.forEach((c) => {
299
- if (!primaryCols.includes(c)) {
300
- primaryCols.unshift(c);
301
- }
302
- });
303
- }
304
- }
305
- if (this.method !== 'create' && this.method !== 'createIfNot') {
306
- this.pushQuery(
307
- `alter table ${this.tableName()} add primary key ${constraintName}(${this.formatter.columnize(
308
- primaryCols
309
- )})`
310
- );
311
- }
312
- if (incrementsCols.length) {
313
- this.pushQuery(
314
- `alter table ${this.tableName()} modify column ${this.formatter.columnize(
315
- incrementsCols
316
- )} int unsigned not null auto_increment`
317
- );
318
- }
319
- }
320
-
321
- unique(columns, indexName) {
322
- let storageEngineIndexType;
323
- let deferrable;
324
- if (isObject(indexName)) {
325
- ({ indexName, deferrable, storageEngineIndexType } = indexName);
326
- }
327
- if (deferrable && deferrable !== 'not deferrable') {
328
- this.client.logger.warn(
329
- `mysql: unique index \`${indexName}\` will not be deferrable ${deferrable} because mysql does not support deferred constraints.`
330
- );
331
- }
332
- indexName = indexName
333
- ? this.formatter.wrap(indexName)
334
- : this._indexCommand('unique', this.tableNameRaw, columns);
335
- storageEngineIndexType = storageEngineIndexType
336
- ? ` using ${storageEngineIndexType}`
337
- : '';
338
- this.pushQuery(
339
- `alter table ${this.tableName()} add unique ${indexName}(${this.formatter.columnize(
340
- columns
341
- )})${storageEngineIndexType}`
342
- );
343
- }
344
-
345
- // Compile a drop index command.
346
- dropIndex(columns, indexName) {
347
- indexName = indexName
348
- ? this.formatter.wrap(indexName)
349
- : this._indexCommand('index', this.tableNameRaw, columns);
350
- this.pushQuery(`alter table ${this.tableName()} drop index ${indexName}`);
351
- }
352
-
353
- // Compile a drop foreign key command.
354
- dropForeign(columns, indexName) {
355
- indexName = indexName
356
- ? this.formatter.wrap(indexName)
357
- : this._indexCommand('foreign', this.tableNameRaw, columns);
358
- this.pushQuery(
359
- `alter table ${this.tableName()} drop foreign key ${indexName}`
360
- );
361
- }
362
-
363
- // Compile a drop primary key command.
364
- dropPrimary() {
365
- this.pushQuery(`alter table ${this.tableName()} drop primary key`);
366
- }
367
-
368
- // Compile a drop unique key command.
369
- dropUnique(column, indexName) {
370
- indexName = indexName
371
- ? this.formatter.wrap(indexName)
372
- : this._indexCommand('unique', this.tableNameRaw, column);
373
- this.pushQuery(`alter table ${this.tableName()} drop index ${indexName}`);
374
- }
375
- }
376
-
377
- TableCompiler_MySQL.prototype.addColumnsPrefix = 'add ';
378
- TableCompiler_MySQL.prototype.alterColumnsPrefix = 'modify ';
379
- TableCompiler_MySQL.prototype.dropColumnPrefix = 'drop ';
380
-
381
- module.exports = TableCompiler_MySQL;
1
+ /* eslint max-len:0*/
2
+
3
+ // MySQL Table Builder & Compiler
4
+ // -------
5
+ const TableCompiler = require('../../../schema/tablecompiler');
6
+ const { isObject, isString } = require('../../../util/is');
7
+
8
+ // Table Compiler
9
+ // ------
10
+
11
+ class TableCompiler_MySQL extends TableCompiler {
12
+ constructor(client, tableBuilder) {
13
+ super(client, tableBuilder);
14
+ }
15
+
16
+ createQuery(columns, ifNot, like) {
17
+ const createStatement = ifNot
18
+ ? 'create table if not exists '
19
+ : 'create table ';
20
+ const { client } = this;
21
+ let conn = {};
22
+ let columnsSql = ' (' + columns.sql.join(', ');
23
+
24
+ columnsSql += this.primaryKeys() || '';
25
+ columnsSql += this._addChecks();
26
+ columnsSql += ')';
27
+
28
+ let sql =
29
+ createStatement +
30
+ this.tableName() +
31
+ (like && this.tableNameLike()
32
+ ? ' like ' + this.tableNameLike()
33
+ : columnsSql);
34
+
35
+ // Check if the connection settings are set.
36
+ if (client.connectionSettings) {
37
+ conn = client.connectionSettings;
38
+ }
39
+
40
+ const charset = this.single.charset || conn.charset || '';
41
+ const collation = this.single.collate || conn.collate || '';
42
+ const engine = this.single.engine || '';
43
+
44
+ if (charset && !like) sql += ` default character set ${charset}`;
45
+ if (collation) sql += ` collate ${collation}`;
46
+ if (engine) sql += ` engine = ${engine}`;
47
+
48
+ if (this.single.comment) {
49
+ const comment = this.single.comment || '';
50
+ const MAX_COMMENT_LENGTH = 1024;
51
+ if (comment.length > MAX_COMMENT_LENGTH)
52
+ this.client.logger.warn(
53
+ `The max length for a table comment is ${MAX_COMMENT_LENGTH} characters`
54
+ );
55
+ sql += ` comment = '${comment}'`;
56
+ }
57
+
58
+ this.pushQuery(sql);
59
+ if (like) {
60
+ this.addColumns(columns, this.addColumnsPrefix);
61
+ }
62
+ }
63
+
64
+ // Compiles the comment on the table.
65
+ comment(comment) {
66
+ this.pushQuery(`alter table ${this.tableName()} comment = '${comment}'`);
67
+ }
68
+
69
+ changeType() {
70
+ // alter table + table + ' modify ' + wrapped + '// type';
71
+ }
72
+
73
+ // Renames a column on the table.
74
+ renameColumn(from, to) {
75
+ const compiler = this;
76
+ const table = this.tableName();
77
+ const wrapped = this.formatter.wrap(from) + ' ' + this.formatter.wrap(to);
78
+
79
+ this.pushQuery({
80
+ sql:
81
+ `show full fields from ${table} where field = ` +
82
+ this.client.parameter(from, this.tableBuilder, this.bindingsHolder),
83
+ output(resp) {
84
+ const column = resp[0];
85
+ const runner = this;
86
+ return compiler.getFKRefs(runner).then(([refs]) =>
87
+ new Promise((resolve, reject) => {
88
+ try {
89
+ if (!refs.length) {
90
+ resolve();
91
+ }
92
+ resolve(compiler.dropFKRefs(runner, refs));
93
+ } catch (e) {
94
+ reject(e);
95
+ }
96
+ })
97
+ .then(function () {
98
+ let sql = `alter table ${table} change ${wrapped} ${column.Type}`;
99
+
100
+ if (String(column.Null).toUpperCase() !== 'YES') {
101
+ sql += ` NOT NULL`;
102
+ } else {
103
+ // This doesn't matter for most cases except Timestamp, where this is important
104
+ sql += ` NULL`;
105
+ }
106
+ if (column.Default !== void 0 && column.Default !== null) {
107
+ sql += ` DEFAULT '${column.Default}'`;
108
+ }
109
+ if (column.Collation !== void 0 && column.Collation !== null) {
110
+ sql += ` COLLATE '${column.Collation}'`;
111
+ }
112
+ // Add back the auto increment if the column it, fix issue #2767
113
+ if (column.Extra == 'auto_increment') {
114
+ sql += ` AUTO_INCREMENT`;
115
+ }
116
+
117
+ return runner.query({
118
+ sql,
119
+ });
120
+ })
121
+ .then(function () {
122
+ if (!refs.length) {
123
+ return;
124
+ }
125
+ return compiler.createFKRefs(
126
+ runner,
127
+ refs.map(function (ref) {
128
+ if (ref.REFERENCED_COLUMN_NAME === from) {
129
+ ref.REFERENCED_COLUMN_NAME = to;
130
+ }
131
+ if (ref.COLUMN_NAME === from) {
132
+ ref.COLUMN_NAME = to;
133
+ }
134
+ return ref;
135
+ })
136
+ );
137
+ })
138
+ );
139
+ },
140
+ });
141
+ }
142
+
143
+ primaryKeys() {
144
+ const pks = (this.grouped.alterTable || []).filter(
145
+ (k) => k.method === 'primary'
146
+ );
147
+ if (pks.length > 0 && pks[0].args.length > 0) {
148
+ const columns = pks[0].args[0];
149
+ let constraintName = pks[0].args[1] || '';
150
+ if (constraintName) {
151
+ constraintName = ' constraint ' + this.formatter.wrap(constraintName);
152
+ }
153
+
154
+ if (this.grouped.columns) {
155
+ const incrementsCols = this._getIncrementsColumnNames();
156
+ if (incrementsCols.length) {
157
+ incrementsCols.forEach((c) => {
158
+ if (!columns.includes(c)) {
159
+ columns.unshift(c);
160
+ }
161
+ });
162
+ }
163
+ }
164
+
165
+ return `,${constraintName} primary key (${this.formatter.columnize(
166
+ columns
167
+ )})`;
168
+ }
169
+ }
170
+
171
+ getFKRefs(runner) {
172
+ const bindingsHolder = {
173
+ bindings: [],
174
+ };
175
+
176
+ const sql =
177
+ 'SELECT KCU.CONSTRAINT_NAME, KCU.TABLE_NAME, KCU.COLUMN_NAME, ' +
178
+ ' KCU.REFERENCED_TABLE_NAME, KCU.REFERENCED_COLUMN_NAME, ' +
179
+ ' RC.UPDATE_RULE, RC.DELETE_RULE ' +
180
+ 'FROM INFORMATION_SCHEMA.KEY_COLUMN_USAGE AS KCU ' +
181
+ 'JOIN INFORMATION_SCHEMA.REFERENTIAL_CONSTRAINTS AS RC ' +
182
+ ' USING(CONSTRAINT_NAME)' +
183
+ 'WHERE KCU.REFERENCED_TABLE_NAME = ' +
184
+ this.client.parameter(
185
+ this.tableNameRaw,
186
+ this.tableBuilder,
187
+ bindingsHolder
188
+ ) +
189
+ ' ' +
190
+ ' AND KCU.CONSTRAINT_SCHEMA = ' +
191
+ this.client.parameter(
192
+ this.client.database(),
193
+ this.tableBuilder,
194
+ bindingsHolder
195
+ ) +
196
+ ' ' +
197
+ ' AND RC.CONSTRAINT_SCHEMA = ' +
198
+ this.client.parameter(
199
+ this.client.database(),
200
+ this.tableBuilder,
201
+ bindingsHolder
202
+ );
203
+
204
+ return runner.query({
205
+ sql,
206
+ bindings: bindingsHolder.bindings,
207
+ });
208
+ }
209
+
210
+ dropFKRefs(runner, refs) {
211
+ const formatter = this.client.formatter(this.tableBuilder);
212
+
213
+ return Promise.all(
214
+ refs.map(function (ref) {
215
+ const constraintName = formatter.wrap(ref.CONSTRAINT_NAME);
216
+ const tableName = formatter.wrap(ref.TABLE_NAME);
217
+ return runner.query({
218
+ sql: `alter table ${tableName} drop foreign key ${constraintName}`,
219
+ });
220
+ })
221
+ );
222
+ }
223
+
224
+ createFKRefs(runner, refs) {
225
+ const formatter = this.client.formatter(this.tableBuilder);
226
+
227
+ return Promise.all(
228
+ refs.map(function (ref) {
229
+ const tableName = formatter.wrap(ref.TABLE_NAME);
230
+ const keyName = formatter.wrap(ref.CONSTRAINT_NAME);
231
+ const column = formatter.columnize(ref.COLUMN_NAME);
232
+ const references = formatter.columnize(ref.REFERENCED_COLUMN_NAME);
233
+ const inTable = formatter.wrap(ref.REFERENCED_TABLE_NAME);
234
+ const onUpdate = ` ON UPDATE ${ref.UPDATE_RULE}`;
235
+ const onDelete = ` ON DELETE ${ref.DELETE_RULE}`;
236
+
237
+ return runner.query({
238
+ sql:
239
+ `alter table ${tableName} add constraint ${keyName} ` +
240
+ 'foreign key (' +
241
+ column +
242
+ ') references ' +
243
+ inTable +
244
+ ' (' +
245
+ references +
246
+ ')' +
247
+ onUpdate +
248
+ onDelete,
249
+ });
250
+ })
251
+ );
252
+ }
253
+
254
+ index(columns, indexName, options) {
255
+ let storageEngineIndexType;
256
+ let indexType;
257
+
258
+ if (isString(options)) {
259
+ indexType = options;
260
+ } else if (isObject(options)) {
261
+ ({ indexType, storageEngineIndexType } = options);
262
+ }
263
+
264
+ indexName = indexName
265
+ ? this.formatter.wrap(indexName)
266
+ : this._indexCommand('index', this.tableNameRaw, columns);
267
+ storageEngineIndexType = storageEngineIndexType
268
+ ? ` using ${storageEngineIndexType}`
269
+ : '';
270
+ this.pushQuery(
271
+ `alter table ${this.tableName()} add${
272
+ indexType ? ` ${indexType}` : ''
273
+ } index ${indexName}(${this.formatter.columnize(
274
+ columns
275
+ )})${storageEngineIndexType}`
276
+ );
277
+ }
278
+
279
+ primary(columns, constraintName) {
280
+ let deferrable;
281
+ if (isObject(constraintName)) {
282
+ ({ constraintName, deferrable } = constraintName);
283
+ }
284
+ if (deferrable && deferrable !== 'not deferrable') {
285
+ this.client.logger.warn(
286
+ `mysql: primary key constraint \`${constraintName}\` will not be deferrable ${deferrable} because mysql does not support deferred constraints.`
287
+ );
288
+ }
289
+ constraintName = constraintName
290
+ ? this.formatter.wrap(constraintName)
291
+ : this.formatter.wrap(`${this.tableNameRaw}_pkey`);
292
+
293
+ const primaryCols = columns;
294
+ let incrementsCols = [];
295
+ if (this.grouped.columns) {
296
+ incrementsCols = this._getIncrementsColumnNames();
297
+ if (incrementsCols) {
298
+ incrementsCols.forEach((c) => {
299
+ if (!primaryCols.includes(c)) {
300
+ primaryCols.unshift(c);
301
+ }
302
+ });
303
+ }
304
+ }
305
+ if (this.method !== 'create' && this.method !== 'createIfNot') {
306
+ this.pushQuery(
307
+ `alter table ${this.tableName()} add primary key ${constraintName}(${this.formatter.columnize(
308
+ primaryCols
309
+ )})`
310
+ );
311
+ }
312
+ if (incrementsCols.length) {
313
+ this.pushQuery(
314
+ `alter table ${this.tableName()} modify column ${this.formatter.columnize(
315
+ incrementsCols
316
+ )} int unsigned not null auto_increment`
317
+ );
318
+ }
319
+ }
320
+
321
+ unique(columns, indexName) {
322
+ let storageEngineIndexType;
323
+ let deferrable;
324
+ if (isObject(indexName)) {
325
+ ({ indexName, deferrable, storageEngineIndexType } = indexName);
326
+ }
327
+ if (deferrable && deferrable !== 'not deferrable') {
328
+ this.client.logger.warn(
329
+ `mysql: unique index \`${indexName}\` will not be deferrable ${deferrable} because mysql does not support deferred constraints.`
330
+ );
331
+ }
332
+ indexName = indexName
333
+ ? this.formatter.wrap(indexName)
334
+ : this._indexCommand('unique', this.tableNameRaw, columns);
335
+ storageEngineIndexType = storageEngineIndexType
336
+ ? ` using ${storageEngineIndexType}`
337
+ : '';
338
+ this.pushQuery(
339
+ `alter table ${this.tableName()} add unique ${indexName}(${this.formatter.columnize(
340
+ columns
341
+ )})${storageEngineIndexType}`
342
+ );
343
+ }
344
+
345
+ // Compile a drop index command.
346
+ dropIndex(columns, indexName) {
347
+ indexName = indexName
348
+ ? this.formatter.wrap(indexName)
349
+ : this._indexCommand('index', this.tableNameRaw, columns);
350
+ this.pushQuery(`alter table ${this.tableName()} drop index ${indexName}`);
351
+ }
352
+
353
+ // Compile a drop foreign key command.
354
+ dropForeign(columns, indexName) {
355
+ indexName = indexName
356
+ ? this.formatter.wrap(indexName)
357
+ : this._indexCommand('foreign', this.tableNameRaw, columns);
358
+ this.pushQuery(
359
+ `alter table ${this.tableName()} drop foreign key ${indexName}`
360
+ );
361
+ }
362
+
363
+ // Compile a drop primary key command.
364
+ dropPrimary() {
365
+ this.pushQuery(`alter table ${this.tableName()} drop primary key`);
366
+ }
367
+
368
+ // Compile a drop unique key command.
369
+ dropUnique(column, indexName) {
370
+ indexName = indexName
371
+ ? this.formatter.wrap(indexName)
372
+ : this._indexCommand('unique', this.tableNameRaw, column);
373
+ this.pushQuery(`alter table ${this.tableName()} drop index ${indexName}`);
374
+ }
375
+ }
376
+
377
+ TableCompiler_MySQL.prototype.addColumnsPrefix = 'add ';
378
+ TableCompiler_MySQL.prototype.alterColumnsPrefix = 'modify ';
379
+ TableCompiler_MySQL.prototype.dropColumnPrefix = 'drop ';
380
+
381
+ module.exports = TableCompiler_MySQL;