knex 3.2.3 → 3.2.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (199) hide show
  1. package/CHANGELOG.md +2447 -2441
  2. package/CONTRIBUTING.md +190 -190
  3. package/LICENSE +22 -22
  4. package/README.md +156 -156
  5. package/UPGRADING.md +245 -245
  6. package/bin/cli.js +516 -516
  7. package/bin/knexfile-runtime-error.js +27 -27
  8. package/bin/utils/cli-config-utils.js +217 -217
  9. package/bin/utils/constants.js +7 -7
  10. package/bin/utils/migrationsLister.js +37 -37
  11. package/knex.js +23 -23
  12. package/knex.mjs +11 -11
  13. package/lib/builder-interface-augmenter.js +120 -120
  14. package/lib/client.js +585 -585
  15. package/lib/constants.js +61 -61
  16. package/lib/dialects/better-sqlite3/index.js +101 -101
  17. package/lib/dialects/cockroachdb/crdb-columncompiler.js +14 -14
  18. package/lib/dialects/cockroachdb/crdb-querybuilder.js +11 -11
  19. package/lib/dialects/cockroachdb/crdb-querycompiler.js +122 -122
  20. package/lib/dialects/cockroachdb/crdb-tablecompiler.js +46 -46
  21. package/lib/dialects/cockroachdb/crdb-viewcompiler.js +15 -15
  22. package/lib/dialects/cockroachdb/index.js +86 -86
  23. package/lib/dialects/index.js +34 -34
  24. package/lib/dialects/mssql/index.js +498 -498
  25. package/lib/dialects/mssql/mssql-formatter.js +34 -34
  26. package/lib/dialects/mssql/query/mssql-querycompiler.js +601 -601
  27. package/lib/dialects/mssql/schema/mssql-columncompiler.js +185 -185
  28. package/lib/dialects/mssql/schema/mssql-compiler.js +91 -91
  29. package/lib/dialects/mssql/schema/mssql-tablecompiler.js +393 -393
  30. package/lib/dialects/mssql/schema/mssql-viewcompiler.js +55 -55
  31. package/lib/dialects/mssql/transaction.js +176 -176
  32. package/lib/dialects/mysql/index.js +317 -317
  33. package/lib/dialects/mysql/query/mysql-querybuilder.js +14 -14
  34. package/lib/dialects/mysql/query/mysql-querycompiler.js +292 -292
  35. package/lib/dialects/mysql/schema/mysql-columncompiler.js +193 -193
  36. package/lib/dialects/mysql/schema/mysql-compiler.js +60 -60
  37. package/lib/dialects/mysql/schema/mysql-tablecompiler.js +426 -426
  38. package/lib/dialects/mysql/schema/mysql-viewbuilder.js +21 -21
  39. package/lib/dialects/mysql/schema/mysql-viewcompiler.js +15 -15
  40. package/lib/dialects/mysql/transaction.js +46 -46
  41. package/lib/dialects/mysql2/index.js +53 -53
  42. package/lib/dialects/mysql2/transaction.js +44 -44
  43. package/lib/dialects/oracle/DEAD_CODE.md +5 -5
  44. package/lib/dialects/oracle/index.js +92 -92
  45. package/lib/dialects/oracle/query/oracle-querycompiler.js +343 -343
  46. package/lib/dialects/oracle/schema/internal/incrementUtils.js +22 -22
  47. package/lib/dialects/oracle/schema/internal/trigger.js +155 -155
  48. package/lib/dialects/oracle/schema/oracle-columnbuilder.js +17 -17
  49. package/lib/dialects/oracle/schema/oracle-columncompiler.js +126 -126
  50. package/lib/dialects/oracle/schema/oracle-compiler.js +124 -124
  51. package/lib/dialects/oracle/schema/oracle-tablecompiler.js +210 -210
  52. package/lib/dialects/oracle/utils.js +107 -107
  53. package/lib/dialects/oracledb/index.js +381 -381
  54. package/lib/dialects/oracledb/query/oracledb-querycompiler.js +481 -481
  55. package/lib/dialects/oracledb/schema/oracledb-columncompiler.js +61 -61
  56. package/lib/dialects/oracledb/schema/oracledb-tablecompiler.js +19 -19
  57. package/lib/dialects/oracledb/schema/oracledb-viewbuilder.js +13 -13
  58. package/lib/dialects/oracledb/schema/oracledb-viewcompiler.js +19 -19
  59. package/lib/dialects/oracledb/transaction.js +98 -98
  60. package/lib/dialects/oracledb/utils.js +208 -208
  61. package/lib/dialects/pgnative/index.js +60 -60
  62. package/lib/dialects/postgres/execution/pg-transaction.js +19 -19
  63. package/lib/dialects/postgres/index.js +373 -373
  64. package/lib/dialects/postgres/query/pg-querybuilder.js +43 -43
  65. package/lib/dialects/postgres/query/pg-querycompiler.js +400 -400
  66. package/lib/dialects/postgres/schema/pg-columncompiler.js +162 -162
  67. package/lib/dialects/postgres/schema/pg-compiler.js +138 -138
  68. package/lib/dialects/postgres/schema/pg-tablecompiler.js +331 -331
  69. package/lib/dialects/postgres/schema/pg-viewbuilder.js +21 -21
  70. package/lib/dialects/postgres/schema/pg-viewcompiler.js +35 -35
  71. package/lib/dialects/redshift/index.js +86 -86
  72. package/lib/dialects/redshift/query/redshift-querycompiler.js +163 -163
  73. package/lib/dialects/redshift/schema/redshift-columnbuilder.js +22 -22
  74. package/lib/dialects/redshift/schema/redshift-columncompiler.js +67 -67
  75. package/lib/dialects/redshift/schema/redshift-compiler.js +14 -14
  76. package/lib/dialects/redshift/schema/redshift-tablecompiler.js +134 -134
  77. package/lib/dialects/redshift/schema/redshift-viewcompiler.js +11 -11
  78. package/lib/dialects/redshift/transaction.js +32 -32
  79. package/lib/dialects/sqlite3/execution/sqlite-transaction.js +172 -172
  80. package/lib/dialects/sqlite3/index.js +263 -263
  81. package/lib/dialects/sqlite3/query/sqlite-querybuilder.js +33 -33
  82. package/lib/dialects/sqlite3/query/sqlite-querycompiler.js +341 -341
  83. package/lib/dialects/sqlite3/schema/ddl.js +380 -380
  84. package/lib/dialects/sqlite3/schema/internal/compiler.js +327 -327
  85. package/lib/dialects/sqlite3/schema/internal/parser-combinator.js +161 -161
  86. package/lib/dialects/sqlite3/schema/internal/parser.js +638 -638
  87. package/lib/dialects/sqlite3/schema/internal/sqlite-ddl-operations.js +41 -41
  88. package/lib/dialects/sqlite3/schema/internal/tokenizer.js +38 -38
  89. package/lib/dialects/sqlite3/schema/internal/utils.js +12 -12
  90. package/lib/dialects/sqlite3/schema/sqlite-columncompiler.js +50 -50
  91. package/lib/dialects/sqlite3/schema/sqlite-compiler.js +80 -80
  92. package/lib/dialects/sqlite3/schema/sqlite-tablecompiler.js +364 -364
  93. package/lib/dialects/sqlite3/schema/sqlite-viewcompiler.js +40 -40
  94. package/lib/execution/batch-insert.js +51 -51
  95. package/lib/execution/internal/delay.js +6 -6
  96. package/lib/execution/internal/ensure-connection-callback.js +41 -41
  97. package/lib/execution/internal/query-executioner.js +62 -62
  98. package/lib/execution/runner.js +325 -325
  99. package/lib/execution/transaction.js +417 -417
  100. package/lib/formatter/formatterUtils.js +42 -42
  101. package/lib/formatter/rawFormatter.js +84 -84
  102. package/lib/formatter/wrappingFormatter.js +253 -253
  103. package/lib/formatter.js +25 -25
  104. package/lib/index.js +3 -3
  105. package/lib/knex-builder/FunctionHelper.js +80 -80
  106. package/lib/knex-builder/Knex.js +59 -59
  107. package/lib/knex-builder/internal/config-resolver.js +57 -57
  108. package/lib/knex-builder/internal/parse-connection.js +87 -87
  109. package/lib/knex-builder/make-knex.js +345 -345
  110. package/lib/logger.js +76 -76
  111. package/lib/migrations/common/MigrationsLoader.js +36 -36
  112. package/lib/migrations/migrate/MigrationGenerator.js +84 -84
  113. package/lib/migrations/migrate/Migrator.js +632 -632
  114. package/lib/migrations/migrate/migrate-stub.js +17 -17
  115. package/lib/migrations/migrate/migration-list-resolver.js +33 -33
  116. package/lib/migrations/migrate/migrator-configuration-merger.js +58 -58
  117. package/lib/migrations/migrate/sources/fs-migrations.js +74 -74
  118. package/lib/migrations/migrate/stub/cjs.stub +15 -15
  119. package/lib/migrations/migrate/stub/coffee.stub +13 -13
  120. package/lib/migrations/migrate/stub/eg.stub +14 -14
  121. package/lib/migrations/migrate/stub/js-schema.stub +22 -22
  122. package/lib/migrations/migrate/stub/js.stub +22 -22
  123. package/lib/migrations/migrate/stub/knexfile-coffee.stub +34 -34
  124. package/lib/migrations/migrate/stub/knexfile-eg.stub +43 -43
  125. package/lib/migrations/migrate/stub/knexfile-js.stub +47 -47
  126. package/lib/migrations/migrate/stub/knexfile-ls.stub +35 -35
  127. package/lib/migrations/migrate/stub/knexfile-ts.stub +47 -47
  128. package/lib/migrations/migrate/stub/ls.stub +14 -14
  129. package/lib/migrations/migrate/stub/mjs.stub +23 -23
  130. package/lib/migrations/migrate/stub/ts-schema.stub +21 -21
  131. package/lib/migrations/migrate/stub/ts.stub +21 -21
  132. package/lib/migrations/migrate/table-creator.js +77 -77
  133. package/lib/migrations/migrate/table-resolver.js +27 -27
  134. package/lib/migrations/seed/Seeder.js +137 -137
  135. package/lib/migrations/seed/seed-stub.js +13 -13
  136. package/lib/migrations/seed/seeder-configuration-merger.js +60 -60
  137. package/lib/migrations/seed/sources/fs-seeds.js +65 -65
  138. package/lib/migrations/seed/stub/coffee.stub +9 -9
  139. package/lib/migrations/seed/stub/eg.stub +11 -11
  140. package/lib/migrations/seed/stub/js.stub +13 -13
  141. package/lib/migrations/seed/stub/ls.stub +11 -11
  142. package/lib/migrations/seed/stub/mjs.stub +12 -12
  143. package/lib/migrations/seed/stub/ts.stub +13 -13
  144. package/lib/migrations/util/fs.js +86 -86
  145. package/lib/migrations/util/import-file.js +12 -12
  146. package/lib/migrations/util/is-module-type.js +9 -9
  147. package/lib/migrations/util/template.js +52 -52
  148. package/lib/migrations/util/timestamp.js +14 -14
  149. package/lib/query/analytic.js +52 -52
  150. package/lib/query/constants.js +15 -15
  151. package/lib/query/joinclause.js +270 -270
  152. package/lib/query/method-constants.js +136 -136
  153. package/lib/query/querybuilder.js +1793 -1793
  154. package/lib/query/querycompiler.js +1634 -1634
  155. package/lib/raw.js +139 -139
  156. package/lib/ref.js +39 -39
  157. package/lib/schema/builder.js +115 -115
  158. package/lib/schema/columnbuilder.js +146 -146
  159. package/lib/schema/columncompiler.js +307 -307
  160. package/lib/schema/compiler.js +187 -187
  161. package/lib/schema/internal/helpers.js +55 -55
  162. package/lib/schema/tablebuilder.js +379 -379
  163. package/lib/schema/tablecompiler.js +450 -450
  164. package/lib/schema/viewbuilder.js +92 -92
  165. package/lib/schema/viewcompiler.js +138 -138
  166. package/lib/util/finally-mixin.js +13 -13
  167. package/lib/util/helpers.js +95 -95
  168. package/lib/util/is.js +32 -32
  169. package/lib/util/nanoid.js +40 -40
  170. package/lib/util/noop.js +1 -1
  171. package/lib/util/save-async-stack.js +14 -14
  172. package/lib/util/security.js +32 -32
  173. package/lib/util/string.js +190 -190
  174. package/lib/util/timeout.js +29 -29
  175. package/package.json +294 -293
  176. package/scripts/act-testing/act.sh +19 -19
  177. package/scripts/act-testing/merged-no-label.json +11 -11
  178. package/scripts/act-testing/merged-patch-labeled.json +12 -12
  179. package/scripts/act-testing/merged-skip-labeled.json +12 -12
  180. package/scripts/act-testing/not-merged-patch-labeled.json +12 -12
  181. package/scripts/build-for-release.sh +121 -121
  182. package/scripts/build.js +125 -125
  183. package/scripts/clean.js +31 -31
  184. package/scripts/docker-compose.yml +150 -150
  185. package/scripts/format-changelog.js +55 -55
  186. package/scripts/next-release-howto.md +24 -24
  187. package/scripts/oracledb-install-driver-libs.sh +82 -82
  188. package/scripts/release.sh +36 -36
  189. package/scripts/runkit-example.js +35 -35
  190. package/scripts/stress-test/README.txt +18 -18
  191. package/scripts/stress-test/docker-compose.yml +55 -55
  192. package/scripts/stress-test/knex-stress-test.js +212 -212
  193. package/scripts/stress-test/mysql2-random-hanging-every-now-and-then.js +149 -149
  194. package/scripts/stress-test/mysql2-sudden-exit-without-error.js +101 -101
  195. package/scripts/stress-test/reconnect-test-mysql-based-drivers.js +188 -188
  196. package/types/index.d.mts +11 -0
  197. package/types/index.d.ts +3321 -3321
  198. package/types/result.d.ts +27 -27
  199. package/types/tables.d.ts +4 -4
@@ -1,426 +1,426 @@
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
- const bigIncrementsCols = this._getBigIncrementsColumnNames();
164
- if (bigIncrementsCols.length) {
165
- bigIncrementsCols.forEach((c) => {
166
- if (!columns.includes(c)) {
167
- columns.unshift(c);
168
- }
169
- });
170
- }
171
- }
172
-
173
- return `,${constraintName} primary key (${this.formatter.columnize(
174
- columns
175
- )})`;
176
- }
177
- }
178
-
179
- getFKRefs(runner) {
180
- const bindingsHolder = {
181
- bindings: [],
182
- };
183
-
184
- const sql =
185
- 'SELECT KCU.CONSTRAINT_NAME, KCU.TABLE_NAME, KCU.COLUMN_NAME, ' +
186
- ' KCU.REFERENCED_TABLE_NAME, KCU.REFERENCED_COLUMN_NAME, ' +
187
- ' RC.UPDATE_RULE, RC.DELETE_RULE ' +
188
- 'FROM INFORMATION_SCHEMA.KEY_COLUMN_USAGE AS KCU ' +
189
- 'JOIN INFORMATION_SCHEMA.REFERENTIAL_CONSTRAINTS AS RC ' +
190
- ' USING(CONSTRAINT_NAME)' +
191
- 'WHERE KCU.REFERENCED_TABLE_NAME = ' +
192
- this.client.parameter(
193
- this.tableNameRaw,
194
- this.tableBuilder,
195
- bindingsHolder
196
- ) +
197
- ' ' +
198
- ' AND KCU.CONSTRAINT_SCHEMA = ' +
199
- this.client.parameter(
200
- this.client.database(),
201
- this.tableBuilder,
202
- bindingsHolder
203
- ) +
204
- ' ' +
205
- ' AND RC.CONSTRAINT_SCHEMA = ' +
206
- this.client.parameter(
207
- this.client.database(),
208
- this.tableBuilder,
209
- bindingsHolder
210
- );
211
-
212
- return runner.query({
213
- sql,
214
- bindings: bindingsHolder.bindings,
215
- });
216
- }
217
-
218
- dropFKRefs(runner, refs) {
219
- const formatter = this.client.formatter(this.tableBuilder);
220
-
221
- return Promise.all(
222
- refs.map(function (ref) {
223
- const constraintName = formatter.wrap(ref.CONSTRAINT_NAME);
224
- const tableName = formatter.wrap(ref.TABLE_NAME);
225
- return runner.query({
226
- sql: `alter table ${tableName} drop foreign key ${constraintName}`,
227
- });
228
- })
229
- );
230
- }
231
-
232
- createFKRefs(runner, refs) {
233
- const formatter = this.client.formatter(this.tableBuilder);
234
-
235
- return Promise.all(
236
- refs.map(function (ref) {
237
- const tableName = formatter.wrap(ref.TABLE_NAME);
238
- const keyName = formatter.wrap(ref.CONSTRAINT_NAME);
239
- const column = formatter.columnize(ref.COLUMN_NAME);
240
- const references = formatter.columnize(ref.REFERENCED_COLUMN_NAME);
241
- const inTable = formatter.wrap(ref.REFERENCED_TABLE_NAME);
242
- const onUpdate = ` ON UPDATE ${ref.UPDATE_RULE}`;
243
- const onDelete = ` ON DELETE ${ref.DELETE_RULE}`;
244
-
245
- return runner.query({
246
- sql:
247
- `alter table ${tableName} add constraint ${keyName} ` +
248
- 'foreign key (' +
249
- column +
250
- ') references ' +
251
- inTable +
252
- ' (' +
253
- references +
254
- ')' +
255
- onUpdate +
256
- onDelete,
257
- });
258
- })
259
- );
260
- }
261
-
262
- index(columns, indexName, options) {
263
- let storageEngineIndexType;
264
- let indexType;
265
-
266
- if (isString(options)) {
267
- indexType = options;
268
- } else if (isObject(options)) {
269
- ({ indexType, storageEngineIndexType } = options);
270
- }
271
-
272
- indexName = indexName
273
- ? this.formatter.wrap(indexName)
274
- : this._indexCommand('index', this.tableNameRaw, columns);
275
- storageEngineIndexType = storageEngineIndexType
276
- ? ` using ${storageEngineIndexType}`
277
- : '';
278
- this.pushQuery(
279
- `alter table ${this.tableName()} add${
280
- indexType ? ` ${indexType}` : ''
281
- } index ${indexName}(${this.formatter.columnize(
282
- columns
283
- )})${storageEngineIndexType}`
284
- );
285
- }
286
-
287
- primary(columns, constraintName) {
288
- let deferrable;
289
- if (isObject(constraintName)) {
290
- ({ constraintName, deferrable } = constraintName);
291
- }
292
- if (deferrable && deferrable !== 'not deferrable') {
293
- this.client.logger.warn(
294
- `mysql: primary key constraint \`${constraintName}\` will not be deferrable ${deferrable} because mysql does not support deferred constraints.`
295
- );
296
- }
297
- constraintName = constraintName
298
- ? this.formatter.wrap(constraintName)
299
- : this.formatter.wrap(`${this.tableNameRaw}_pkey`);
300
-
301
- const primaryCols = columns;
302
- let incrementsCols = [];
303
- let bigIncrementsCols = [];
304
- if (this.grouped.columns) {
305
- incrementsCols = this._getIncrementsColumnNames();
306
- if (incrementsCols) {
307
- incrementsCols.forEach((c) => {
308
- if (!primaryCols.includes(c)) {
309
- primaryCols.unshift(c);
310
- }
311
- });
312
- }
313
- bigIncrementsCols = this._getBigIncrementsColumnNames();
314
- if (bigIncrementsCols) {
315
- bigIncrementsCols.forEach((c) => {
316
- if (!primaryCols.includes(c)) {
317
- primaryCols.unshift(c);
318
- }
319
- });
320
- }
321
- }
322
- if (this.method !== 'create' && this.method !== 'createIfNot') {
323
- this.pushQuery(
324
- `alter table ${this.tableName()} add primary key ${constraintName}(${this.formatter.columnize(
325
- primaryCols
326
- )})`
327
- );
328
- }
329
- if (incrementsCols.length) {
330
- this.pushQuery(
331
- `alter table ${this.tableName()} modify column ${this.formatter.columnize(
332
- incrementsCols
333
- )} int unsigned not null auto_increment`
334
- );
335
- }
336
- if (bigIncrementsCols.length) {
337
- this.pushQuery(
338
- `alter table ${this.tableName()} modify column ${this.formatter.columnize(
339
- bigIncrementsCols
340
- )} bigint unsigned not null auto_increment`
341
- );
342
- }
343
- }
344
-
345
- unique(columns, indexName) {
346
- let storageEngineIndexType;
347
- let deferrable;
348
- if (isObject(indexName)) {
349
- ({ indexName, deferrable, storageEngineIndexType } = indexName);
350
- }
351
- if (deferrable && deferrable !== 'not deferrable') {
352
- this.client.logger.warn(
353
- `mysql: unique index \`${indexName}\` will not be deferrable ${deferrable} because mysql does not support deferred constraints.`
354
- );
355
- }
356
- indexName = indexName
357
- ? this.formatter.wrap(indexName)
358
- : this._indexCommand('unique', this.tableNameRaw, columns);
359
- storageEngineIndexType = storageEngineIndexType
360
- ? ` using ${storageEngineIndexType}`
361
- : '';
362
- this.pushQuery(
363
- `alter table ${this.tableName()} add unique ${indexName}(${this.formatter.columnize(
364
- columns
365
- )})${storageEngineIndexType}`
366
- );
367
- }
368
-
369
- // Compile a drop index command.
370
- dropIndex(columns, indexName) {
371
- indexName = indexName
372
- ? this.formatter.wrap(indexName)
373
- : this._indexCommand('index', this.tableNameRaw, columns);
374
- this.pushQuery(`alter table ${this.tableName()} drop index ${indexName}`);
375
- }
376
-
377
- // Compile a drop foreign key command.
378
- dropForeign(columns, indexName) {
379
- indexName = indexName
380
- ? this.formatter.wrap(indexName)
381
- : this._indexCommand('foreign', this.tableNameRaw, columns);
382
- this.pushQuery(
383
- `alter table ${this.tableName()} drop foreign key ${indexName}`
384
- );
385
- }
386
-
387
- dropForeignIfExists() {
388
- throw new Error('.dropForeignIfExists is not supported for mysql.');
389
- }
390
-
391
- // Compile a drop primary key command.
392
- dropPrimary() {
393
- this.pushQuery(`alter table ${this.tableName()} drop primary key`);
394
- }
395
-
396
- dropPrimaryIfExists() {
397
- throw new Error('.dropPrimaryIfExists is not supported for mysql.');
398
- }
399
-
400
- // Compile a drop unique key command.
401
- dropUnique(column, indexName) {
402
- indexName = indexName
403
- ? this.formatter.wrap(indexName)
404
- : this._indexCommand('unique', this.tableNameRaw, column);
405
- this.pushQuery(`alter table ${this.tableName()} drop index ${indexName}`);
406
- }
407
-
408
- dropUniqueIfExists(column, indexName) {
409
- if (this.client.isMariaDB) {
410
- indexName = indexName
411
- ? this.formatter.wrap(indexName)
412
- : this._indexCommand('unique', this.tableNameRaw, column);
413
- this.pushQuery(
414
- `alter table ${this.tableName()} drop index if exists ${indexName}`
415
- );
416
- return;
417
- }
418
- throw new Error('.dropUniqueIfExists is not supported for mysql.');
419
- }
420
- }
421
-
422
- TableCompiler_MySQL.prototype.addColumnsPrefix = 'add ';
423
- TableCompiler_MySQL.prototype.alterColumnsPrefix = 'modify ';
424
- TableCompiler_MySQL.prototype.dropColumnPrefix = 'drop ';
425
-
426
- 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
+ const bigIncrementsCols = this._getBigIncrementsColumnNames();
164
+ if (bigIncrementsCols.length) {
165
+ bigIncrementsCols.forEach((c) => {
166
+ if (!columns.includes(c)) {
167
+ columns.unshift(c);
168
+ }
169
+ });
170
+ }
171
+ }
172
+
173
+ return `,${constraintName} primary key (${this.formatter.columnize(
174
+ columns
175
+ )})`;
176
+ }
177
+ }
178
+
179
+ getFKRefs(runner) {
180
+ const bindingsHolder = {
181
+ bindings: [],
182
+ };
183
+
184
+ const sql =
185
+ 'SELECT KCU.CONSTRAINT_NAME, KCU.TABLE_NAME, KCU.COLUMN_NAME, ' +
186
+ ' KCU.REFERENCED_TABLE_NAME, KCU.REFERENCED_COLUMN_NAME, ' +
187
+ ' RC.UPDATE_RULE, RC.DELETE_RULE ' +
188
+ 'FROM INFORMATION_SCHEMA.KEY_COLUMN_USAGE AS KCU ' +
189
+ 'JOIN INFORMATION_SCHEMA.REFERENTIAL_CONSTRAINTS AS RC ' +
190
+ ' USING(CONSTRAINT_NAME)' +
191
+ 'WHERE KCU.REFERENCED_TABLE_NAME = ' +
192
+ this.client.parameter(
193
+ this.tableNameRaw,
194
+ this.tableBuilder,
195
+ bindingsHolder
196
+ ) +
197
+ ' ' +
198
+ ' AND KCU.CONSTRAINT_SCHEMA = ' +
199
+ this.client.parameter(
200
+ this.client.database(),
201
+ this.tableBuilder,
202
+ bindingsHolder
203
+ ) +
204
+ ' ' +
205
+ ' AND RC.CONSTRAINT_SCHEMA = ' +
206
+ this.client.parameter(
207
+ this.client.database(),
208
+ this.tableBuilder,
209
+ bindingsHolder
210
+ );
211
+
212
+ return runner.query({
213
+ sql,
214
+ bindings: bindingsHolder.bindings,
215
+ });
216
+ }
217
+
218
+ dropFKRefs(runner, refs) {
219
+ const formatter = this.client.formatter(this.tableBuilder);
220
+
221
+ return Promise.all(
222
+ refs.map(function (ref) {
223
+ const constraintName = formatter.wrap(ref.CONSTRAINT_NAME);
224
+ const tableName = formatter.wrap(ref.TABLE_NAME);
225
+ return runner.query({
226
+ sql: `alter table ${tableName} drop foreign key ${constraintName}`,
227
+ });
228
+ })
229
+ );
230
+ }
231
+
232
+ createFKRefs(runner, refs) {
233
+ const formatter = this.client.formatter(this.tableBuilder);
234
+
235
+ return Promise.all(
236
+ refs.map(function (ref) {
237
+ const tableName = formatter.wrap(ref.TABLE_NAME);
238
+ const keyName = formatter.wrap(ref.CONSTRAINT_NAME);
239
+ const column = formatter.columnize(ref.COLUMN_NAME);
240
+ const references = formatter.columnize(ref.REFERENCED_COLUMN_NAME);
241
+ const inTable = formatter.wrap(ref.REFERENCED_TABLE_NAME);
242
+ const onUpdate = ` ON UPDATE ${ref.UPDATE_RULE}`;
243
+ const onDelete = ` ON DELETE ${ref.DELETE_RULE}`;
244
+
245
+ return runner.query({
246
+ sql:
247
+ `alter table ${tableName} add constraint ${keyName} ` +
248
+ 'foreign key (' +
249
+ column +
250
+ ') references ' +
251
+ inTable +
252
+ ' (' +
253
+ references +
254
+ ')' +
255
+ onUpdate +
256
+ onDelete,
257
+ });
258
+ })
259
+ );
260
+ }
261
+
262
+ index(columns, indexName, options) {
263
+ let storageEngineIndexType;
264
+ let indexType;
265
+
266
+ if (isString(options)) {
267
+ indexType = options;
268
+ } else if (isObject(options)) {
269
+ ({ indexType, storageEngineIndexType } = options);
270
+ }
271
+
272
+ indexName = indexName
273
+ ? this.formatter.wrap(indexName)
274
+ : this._indexCommand('index', this.tableNameRaw, columns);
275
+ storageEngineIndexType = storageEngineIndexType
276
+ ? ` using ${storageEngineIndexType}`
277
+ : '';
278
+ this.pushQuery(
279
+ `alter table ${this.tableName()} add${
280
+ indexType ? ` ${indexType}` : ''
281
+ } index ${indexName}(${this.formatter.columnize(
282
+ columns
283
+ )})${storageEngineIndexType}`
284
+ );
285
+ }
286
+
287
+ primary(columns, constraintName) {
288
+ let deferrable;
289
+ if (isObject(constraintName)) {
290
+ ({ constraintName, deferrable } = constraintName);
291
+ }
292
+ if (deferrable && deferrable !== 'not deferrable') {
293
+ this.client.logger.warn(
294
+ `mysql: primary key constraint \`${constraintName}\` will not be deferrable ${deferrable} because mysql does not support deferred constraints.`
295
+ );
296
+ }
297
+ constraintName = constraintName
298
+ ? this.formatter.wrap(constraintName)
299
+ : this.formatter.wrap(`${this.tableNameRaw}_pkey`);
300
+
301
+ const primaryCols = columns;
302
+ let incrementsCols = [];
303
+ let bigIncrementsCols = [];
304
+ if (this.grouped.columns) {
305
+ incrementsCols = this._getIncrementsColumnNames();
306
+ if (incrementsCols) {
307
+ incrementsCols.forEach((c) => {
308
+ if (!primaryCols.includes(c)) {
309
+ primaryCols.unshift(c);
310
+ }
311
+ });
312
+ }
313
+ bigIncrementsCols = this._getBigIncrementsColumnNames();
314
+ if (bigIncrementsCols) {
315
+ bigIncrementsCols.forEach((c) => {
316
+ if (!primaryCols.includes(c)) {
317
+ primaryCols.unshift(c);
318
+ }
319
+ });
320
+ }
321
+ }
322
+ if (this.method !== 'create' && this.method !== 'createIfNot') {
323
+ this.pushQuery(
324
+ `alter table ${this.tableName()} add primary key ${constraintName}(${this.formatter.columnize(
325
+ primaryCols
326
+ )})`
327
+ );
328
+ }
329
+ if (incrementsCols.length) {
330
+ this.pushQuery(
331
+ `alter table ${this.tableName()} modify column ${this.formatter.columnize(
332
+ incrementsCols
333
+ )} int unsigned not null auto_increment`
334
+ );
335
+ }
336
+ if (bigIncrementsCols.length) {
337
+ this.pushQuery(
338
+ `alter table ${this.tableName()} modify column ${this.formatter.columnize(
339
+ bigIncrementsCols
340
+ )} bigint unsigned not null auto_increment`
341
+ );
342
+ }
343
+ }
344
+
345
+ unique(columns, indexName) {
346
+ let storageEngineIndexType;
347
+ let deferrable;
348
+ if (isObject(indexName)) {
349
+ ({ indexName, deferrable, storageEngineIndexType } = indexName);
350
+ }
351
+ if (deferrable && deferrable !== 'not deferrable') {
352
+ this.client.logger.warn(
353
+ `mysql: unique index \`${indexName}\` will not be deferrable ${deferrable} because mysql does not support deferred constraints.`
354
+ );
355
+ }
356
+ indexName = indexName
357
+ ? this.formatter.wrap(indexName)
358
+ : this._indexCommand('unique', this.tableNameRaw, columns);
359
+ storageEngineIndexType = storageEngineIndexType
360
+ ? ` using ${storageEngineIndexType}`
361
+ : '';
362
+ this.pushQuery(
363
+ `alter table ${this.tableName()} add unique ${indexName}(${this.formatter.columnize(
364
+ columns
365
+ )})${storageEngineIndexType}`
366
+ );
367
+ }
368
+
369
+ // Compile a drop index command.
370
+ dropIndex(columns, indexName) {
371
+ indexName = indexName
372
+ ? this.formatter.wrap(indexName)
373
+ : this._indexCommand('index', this.tableNameRaw, columns);
374
+ this.pushQuery(`alter table ${this.tableName()} drop index ${indexName}`);
375
+ }
376
+
377
+ // Compile a drop foreign key command.
378
+ dropForeign(columns, indexName) {
379
+ indexName = indexName
380
+ ? this.formatter.wrap(indexName)
381
+ : this._indexCommand('foreign', this.tableNameRaw, columns);
382
+ this.pushQuery(
383
+ `alter table ${this.tableName()} drop foreign key ${indexName}`
384
+ );
385
+ }
386
+
387
+ dropForeignIfExists() {
388
+ throw new Error('.dropForeignIfExists is not supported for mysql.');
389
+ }
390
+
391
+ // Compile a drop primary key command.
392
+ dropPrimary() {
393
+ this.pushQuery(`alter table ${this.tableName()} drop primary key`);
394
+ }
395
+
396
+ dropPrimaryIfExists() {
397
+ throw new Error('.dropPrimaryIfExists is not supported for mysql.');
398
+ }
399
+
400
+ // Compile a drop unique key command.
401
+ dropUnique(column, indexName) {
402
+ indexName = indexName
403
+ ? this.formatter.wrap(indexName)
404
+ : this._indexCommand('unique', this.tableNameRaw, column);
405
+ this.pushQuery(`alter table ${this.tableName()} drop index ${indexName}`);
406
+ }
407
+
408
+ dropUniqueIfExists(column, indexName) {
409
+ if (this.client.isMariaDB) {
410
+ indexName = indexName
411
+ ? this.formatter.wrap(indexName)
412
+ : this._indexCommand('unique', this.tableNameRaw, column);
413
+ this.pushQuery(
414
+ `alter table ${this.tableName()} drop index if exists ${indexName}`
415
+ );
416
+ return;
417
+ }
418
+ throw new Error('.dropUniqueIfExists is not supported for mysql.');
419
+ }
420
+ }
421
+
422
+ TableCompiler_MySQL.prototype.addColumnsPrefix = 'add ';
423
+ TableCompiler_MySQL.prototype.alterColumnsPrefix = 'modify ';
424
+ TableCompiler_MySQL.prototype.dropColumnPrefix = 'drop ';
425
+
426
+ module.exports = TableCompiler_MySQL;