knex 3.1.0 → 3.2.1

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 +2441 -2380
  2. package/CONTRIBUTING.md +190 -194
  3. package/LICENSE +22 -22
  4. package/README.md +156 -149
  5. package/UPGRADING.md +245 -245
  6. package/bin/cli.js +516 -475
  7. package/bin/knexfile-runtime-error.js +27 -0
  8. package/bin/utils/cli-config-utils.js +217 -212
  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 -495
  15. package/lib/constants.js +61 -61
  16. package/lib/dialects/better-sqlite3/index.js +101 -77
  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 -37
  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 -500
  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 -378
  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 -206
  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 -405
  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 -197
  52. package/lib/dialects/oracle/utils.js +107 -106
  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 -361
  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 -156
  67. package/lib/dialects/postgres/schema/pg-compiler.js +138 -138
  68. package/lib/dialects/postgres/schema/pg-tablecompiler.js +331 -304
  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 -122
  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 -25
  80. package/lib/dialects/sqlite3/index.js +263 -250
  81. package/lib/dialects/sqlite3/query/sqlite-querybuilder.js +33 -33
  82. package/lib/dialects/sqlite3/query/sqlite-querycompiler.js +341 -334
  83. package/lib/dialects/sqlite3/schema/ddl.js +380 -400
  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 -347
  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 -413
  100. package/lib/formatter/formatterUtils.js +42 -42
  101. package/lib/formatter/rawFormatter.js +84 -84
  102. package/lib/formatter/wrappingFormatter.js +253 -250
  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 -599
  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 -1591
  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 -376
  163. package/lib/schema/tablecompiler.js +450 -439
  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 -26
  173. package/lib/util/string.js +190 -190
  174. package/lib/util/timeout.js +29 -29
  175. package/package.json +291 -267
  176. package/scripts/act-testing/act.sh +19 -0
  177. package/scripts/act-testing/merged-no-label.json +11 -0
  178. package/scripts/act-testing/merged-patch-labeled.json +12 -0
  179. package/scripts/act-testing/merged-skip-labeled.json +12 -0
  180. package/scripts/act-testing/not-merged-patch-labeled.json +12 -0
  181. package/scripts/build-for-release.sh +122 -0
  182. package/scripts/build.js +125 -125
  183. package/scripts/clean.js +31 -31
  184. package/scripts/docker-compose.yml +150 -152
  185. package/scripts/format-changelog.js +55 -0
  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 -57
  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.ts +3321 -3275
  197. package/types/result.d.ts +27 -27
  198. package/types/tables.d.ts +4 -4
  199. package/scripts/update_gitignore_for_tsc_output.js +0 -90
package/lib/logger.js CHANGED
@@ -1,76 +1,76 @@
1
- const color = require('colorette');
2
- const { inspect } = require('util');
3
- const { isString, isFunction } = require('./util/is');
4
-
5
- class Logger {
6
- constructor(config = {}) {
7
- const {
8
- log: {
9
- debug,
10
- warn,
11
- error,
12
- deprecate,
13
- inspectionDepth,
14
- enableColors,
15
- } = {},
16
- } = config;
17
- this._inspectionDepth = inspectionDepth || 5;
18
- this._enableColors = resolveIsEnabledColors(enableColors);
19
- this._debug = debug;
20
- this._warn = warn;
21
- this._error = error;
22
- this._deprecate = deprecate;
23
- }
24
-
25
- _log(message, userFn, colorFn) {
26
- if (userFn != null && !isFunction(userFn)) {
27
- throw new TypeError('Extensions to knex logger must be functions!');
28
- }
29
-
30
- if (isFunction(userFn)) {
31
- userFn(message);
32
- return;
33
- }
34
-
35
- if (!isString(message)) {
36
- message = inspect(message, {
37
- depth: this._inspectionDepth,
38
- colors: this._enableColors,
39
- });
40
- }
41
-
42
- console.log(colorFn ? colorFn(message) : message);
43
- }
44
-
45
- debug(message) {
46
- this._log(message, this._debug);
47
- }
48
-
49
- warn(message) {
50
- this._log(message, this._warn, color.yellow);
51
- }
52
-
53
- error(message) {
54
- this._log(message, this._error, color.red);
55
- }
56
-
57
- deprecate(method, alternative) {
58
- const message = `${method} is deprecated, please use ${alternative}`;
59
-
60
- this._log(message, this._deprecate, color.yellow);
61
- }
62
- }
63
-
64
- function resolveIsEnabledColors(enableColorsParam) {
65
- if (enableColorsParam != null) {
66
- return enableColorsParam;
67
- }
68
-
69
- if (process && process.stdout) {
70
- return process.stdout.isTTY;
71
- }
72
-
73
- return false;
74
- }
75
-
76
- module.exports = Logger;
1
+ const color = require('colorette');
2
+ const { inspect } = require('util');
3
+ const { isString, isFunction } = require('./util/is');
4
+
5
+ class Logger {
6
+ constructor(config = {}) {
7
+ const {
8
+ log: {
9
+ debug,
10
+ warn,
11
+ error,
12
+ deprecate,
13
+ inspectionDepth,
14
+ enableColors,
15
+ } = {},
16
+ } = config;
17
+ this._inspectionDepth = inspectionDepth || 5;
18
+ this._enableColors = resolveIsEnabledColors(enableColors);
19
+ this._debug = debug;
20
+ this._warn = warn;
21
+ this._error = error;
22
+ this._deprecate = deprecate;
23
+ }
24
+
25
+ _log(message, userFn, colorFn) {
26
+ if (userFn != null && !isFunction(userFn)) {
27
+ throw new TypeError('Extensions to knex logger must be functions!');
28
+ }
29
+
30
+ if (isFunction(userFn)) {
31
+ userFn(message);
32
+ return;
33
+ }
34
+
35
+ if (!isString(message)) {
36
+ message = inspect(message, {
37
+ depth: this._inspectionDepth,
38
+ colors: this._enableColors,
39
+ });
40
+ }
41
+
42
+ console.log(colorFn ? colorFn(message) : message);
43
+ }
44
+
45
+ debug(message) {
46
+ this._log(message, this._debug);
47
+ }
48
+
49
+ warn(message) {
50
+ this._log(message, this._warn, color.yellow);
51
+ }
52
+
53
+ error(message) {
54
+ this._log(message, this._error, color.red);
55
+ }
56
+
57
+ deprecate(method, alternative) {
58
+ const message = `${method} is deprecated, please use ${alternative}`;
59
+
60
+ this._log(message, this._deprecate, color.yellow);
61
+ }
62
+ }
63
+
64
+ function resolveIsEnabledColors(enableColorsParam) {
65
+ if (enableColorsParam != null) {
66
+ return enableColorsParam;
67
+ }
68
+
69
+ if (process && process.stdout) {
70
+ return process.stdout.isTTY;
71
+ }
72
+
73
+ return false;
74
+ }
75
+
76
+ module.exports = Logger;
@@ -1,36 +1,36 @@
1
- const path = require('path');
2
- const DEFAULT_LOAD_EXTENSIONS = Object.freeze([
3
- '.co',
4
- '.coffee',
5
- '.eg',
6
- '.iced',
7
- '.js',
8
- '.cjs',
9
- '.litcoffee',
10
- '.ls',
11
- '.ts',
12
- ]);
13
-
14
- class AbstractMigrationsLoader {
15
- constructor(migrationDirectories, sortDirsSeparately, loadExtensions) {
16
- this.sortDirsSeparately = sortDirsSeparately;
17
-
18
- if (!Array.isArray(migrationDirectories)) {
19
- migrationDirectories = [migrationDirectories];
20
- }
21
- this.migrationsPaths = migrationDirectories;
22
- this.loadExtensions = loadExtensions || DEFAULT_LOAD_EXTENSIONS;
23
- }
24
-
25
- getFile(migrationsInfo) {
26
- const absoluteDir = path.resolve(process.cwd(), migrationsInfo.directory);
27
- const _path = path.join(absoluteDir, migrationsInfo.file);
28
- const importFile = require('../util/import-file'); // late import
29
- return importFile(_path);
30
- }
31
- }
32
-
33
- module.exports = {
34
- DEFAULT_LOAD_EXTENSIONS,
35
- AbstractMigrationsLoader,
36
- };
1
+ const path = require('path');
2
+ const DEFAULT_LOAD_EXTENSIONS = Object.freeze([
3
+ '.co',
4
+ '.coffee',
5
+ '.eg',
6
+ '.iced',
7
+ '.js',
8
+ '.cjs',
9
+ '.litcoffee',
10
+ '.ls',
11
+ '.ts',
12
+ ]);
13
+
14
+ class AbstractMigrationsLoader {
15
+ constructor(migrationDirectories, sortDirsSeparately, loadExtensions) {
16
+ this.sortDirsSeparately = sortDirsSeparately;
17
+
18
+ if (!Array.isArray(migrationDirectories)) {
19
+ migrationDirectories = [migrationDirectories];
20
+ }
21
+ this.migrationsPaths = migrationDirectories;
22
+ this.loadExtensions = loadExtensions || DEFAULT_LOAD_EXTENSIONS;
23
+ }
24
+
25
+ getFile(migrationsInfo) {
26
+ const absoluteDir = path.resolve(process.cwd(), migrationsInfo.directory);
27
+ const _path = path.join(absoluteDir, migrationsInfo.file);
28
+ const importFile = require('../util/import-file'); // late import
29
+ return importFile(_path);
30
+ }
31
+ }
32
+
33
+ module.exports = {
34
+ DEFAULT_LOAD_EXTENSIONS,
35
+ AbstractMigrationsLoader,
36
+ };
@@ -1,84 +1,84 @@
1
- const path = require('path');
2
- const { writeJsFileUsingTemplate } = require('../util/template');
3
- const { getMergedConfig } = require('./migrator-configuration-merger');
4
- const { ensureDirectoryExists } = require('../util/fs');
5
- const { yyyymmddhhmmss } = require('../util/timestamp');
6
-
7
- class MigrationGenerator {
8
- constructor(migrationConfig, logger) {
9
- this.config = getMergedConfig(migrationConfig, undefined, logger);
10
- }
11
-
12
- // Creates a new migration, with a given name.
13
- async make(name, config, logger) {
14
- this.config = getMergedConfig(config, this.config, logger);
15
- if (!name) {
16
- return Promise.reject(
17
- new Error('A name must be specified for the generated migration')
18
- );
19
- }
20
- await this._ensureFolder();
21
- const createdMigrationFilePath = await this._writeNewMigration(name);
22
- return createdMigrationFilePath;
23
- }
24
-
25
- // Ensures a folder for the migrations exist, dependent on the migration
26
- // config settings.
27
- _ensureFolder() {
28
- const dirs = this._absoluteConfigDirs();
29
-
30
- const promises = dirs.map(ensureDirectoryExists);
31
-
32
- return Promise.all(promises);
33
- }
34
-
35
- _getStubPath() {
36
- return (
37
- this.config.stub ||
38
- path.join(__dirname, 'stub', this.config.extension + '.stub')
39
- );
40
- }
41
-
42
- _getNewMigrationName(name) {
43
- if (name[0] === '-') name = name.slice(1);
44
- return (
45
- yyyymmddhhmmss() + '_' + name + '.' + this.config.extension.split('-')[0]
46
- );
47
- }
48
-
49
- _getNewMigrationPath(name) {
50
- const fileName = this._getNewMigrationName(name);
51
- const dirs = this._absoluteConfigDirs();
52
- const dir = dirs.slice(-1)[0]; // Get last specified directory
53
- return path.join(dir, fileName);
54
- }
55
-
56
- // Write a new migration to disk, using the config and generated filename,
57
- // passing any `variables` given in the config to the template.
58
- async _writeNewMigration(name) {
59
- const migrationPath = this._getNewMigrationPath(name);
60
- await writeJsFileUsingTemplate(
61
- migrationPath,
62
- this._getStubPath(),
63
- { variable: 'd' },
64
- this.config.variables || {}
65
- );
66
- return migrationPath;
67
- }
68
-
69
- _absoluteConfigDirs() {
70
- const directories = Array.isArray(this.config.directory)
71
- ? this.config.directory
72
- : [this.config.directory];
73
- return directories.map((directory) => {
74
- if (!directory) {
75
- console.warn(
76
- 'Failed to resolve config file, knex cannot determine where to generate migrations'
77
- );
78
- }
79
- return path.resolve(process.cwd(), directory);
80
- });
81
- }
82
- }
83
-
84
- module.exports = MigrationGenerator;
1
+ const path = require('path');
2
+ const { writeJsFileUsingTemplate } = require('../util/template');
3
+ const { getMergedConfig } = require('./migrator-configuration-merger');
4
+ const { ensureDirectoryExists } = require('../util/fs');
5
+ const { yyyymmddhhmmss } = require('../util/timestamp');
6
+
7
+ class MigrationGenerator {
8
+ constructor(migrationConfig, logger) {
9
+ this.config = getMergedConfig(migrationConfig, undefined, logger);
10
+ }
11
+
12
+ // Creates a new migration, with a given name.
13
+ async make(name, config, logger) {
14
+ this.config = getMergedConfig(config, this.config, logger);
15
+ if (!name) {
16
+ return Promise.reject(
17
+ new Error('A name must be specified for the generated migration')
18
+ );
19
+ }
20
+ await this._ensureFolder();
21
+ const createdMigrationFilePath = await this._writeNewMigration(name);
22
+ return createdMigrationFilePath;
23
+ }
24
+
25
+ // Ensures a folder for the migrations exist, dependent on the migration
26
+ // config settings.
27
+ _ensureFolder() {
28
+ const dirs = this._absoluteConfigDirs();
29
+
30
+ const promises = dirs.map(ensureDirectoryExists);
31
+
32
+ return Promise.all(promises);
33
+ }
34
+
35
+ _getStubPath() {
36
+ return (
37
+ this.config.stub ||
38
+ path.join(__dirname, 'stub', this.config.extension + '.stub')
39
+ );
40
+ }
41
+
42
+ _getNewMigrationName(name) {
43
+ if (name[0] === '-') name = name.slice(1);
44
+ return (
45
+ yyyymmddhhmmss() + '_' + name + '.' + this.config.extension.split('-')[0]
46
+ );
47
+ }
48
+
49
+ _getNewMigrationPath(name) {
50
+ const fileName = this._getNewMigrationName(name);
51
+ const dirs = this._absoluteConfigDirs();
52
+ const dir = dirs.slice(-1)[0]; // Get last specified directory
53
+ return path.join(dir, fileName);
54
+ }
55
+
56
+ // Write a new migration to disk, using the config and generated filename,
57
+ // passing any `variables` given in the config to the template.
58
+ async _writeNewMigration(name) {
59
+ const migrationPath = this._getNewMigrationPath(name);
60
+ await writeJsFileUsingTemplate(
61
+ migrationPath,
62
+ this._getStubPath(),
63
+ { variable: 'd' },
64
+ this.config.variables || {}
65
+ );
66
+ return migrationPath;
67
+ }
68
+
69
+ _absoluteConfigDirs() {
70
+ const directories = Array.isArray(this.config.directory)
71
+ ? this.config.directory
72
+ : [this.config.directory];
73
+ return directories.map((directory) => {
74
+ if (!directory) {
75
+ console.warn(
76
+ 'Failed to resolve config file, knex cannot determine where to generate migrations'
77
+ );
78
+ }
79
+ return path.resolve(process.cwd(), directory);
80
+ });
81
+ }
82
+ }
83
+
84
+ module.exports = MigrationGenerator;