knex 3.0.1 → 3.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (199) hide show
  1. package/CHANGELOG.md +2431 -2358
  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 -201
  33. package/lib/dialects/mysql/query/mysql-querybuilder.js +14 -0
  34. package/lib/dialects/mysql/query/mysql-querycompiler.js +292 -274
  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 -381
  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 -20
  47. package/lib/dialects/oracle/schema/internal/trigger.js +155 -135
  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 -122
  51. package/lib/dialects/oracle/schema/oracle-tablecompiler.js +210 -190
  52. package/lib/dialects/oracle/utils.js +107 -87
  53. package/lib/dialects/oracledb/index.js +381 -327
  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 -358
  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 -409
  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 -433
  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 +285 -266
  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 -3272
  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
@@ -1,146 +1,146 @@
1
- const extend = require('lodash/extend');
2
- const assign = require('lodash/assign');
3
- const toArray = require('lodash/toArray');
4
- const { addQueryContext } = require('../util/helpers');
5
-
6
- // The chainable interface off the original "column" method.
7
- class ColumnBuilder {
8
- constructor(client, tableBuilder, type, args) {
9
- this.client = client;
10
- this._method = 'add';
11
- this._single = {};
12
- this._modifiers = {};
13
- this._statements = [];
14
- this._type = columnAlias[type] || type;
15
- this._args = args;
16
- this._tableBuilder = tableBuilder;
17
-
18
- // If we're altering the table, extend the object
19
- // with the available "alter" methods.
20
- if (tableBuilder._method === 'alter') {
21
- extend(this, AlterMethods);
22
- }
23
- }
24
-
25
- // Specify that the current column "references" a column,
26
- // which may be tableName.column or just "column"
27
- references(value) {
28
- return this._tableBuilder.foreign
29
- .call(this._tableBuilder, this._args[0], undefined, this)
30
- ._columnBuilder(this)
31
- .references(value);
32
- }
33
- }
34
-
35
- // All of the modifier methods that can be used to modify the current query.
36
- const modifiers = [
37
- 'default',
38
- 'defaultsTo',
39
- 'defaultTo',
40
- 'unsigned',
41
- 'nullable',
42
- 'first',
43
- 'after',
44
- 'comment',
45
- 'collate',
46
- 'check',
47
- 'checkPositive',
48
- 'checkNegative',
49
- 'checkIn',
50
- 'checkNotIn',
51
- 'checkBetween',
52
- 'checkLength',
53
- 'checkRegex',
54
- ];
55
-
56
- // Aliases for convenience.
57
- const aliasMethod = {
58
- default: 'defaultTo',
59
- defaultsTo: 'defaultTo',
60
- };
61
-
62
- // If we call any of the modifiers (index or otherwise) on the chainable, we pretend
63
- // as though we're calling `table.method(column)` directly.
64
- modifiers.forEach(function (method) {
65
- const key = aliasMethod[method] || method;
66
- ColumnBuilder.prototype[method] = function () {
67
- this._modifiers[key] = toArray(arguments);
68
- return this;
69
- };
70
- });
71
-
72
- addQueryContext(ColumnBuilder);
73
-
74
- ColumnBuilder.prototype.notNull = ColumnBuilder.prototype.notNullable =
75
- function notNullable() {
76
- return this.nullable(false);
77
- };
78
-
79
- ['index', 'primary', 'unique'].forEach(function (method) {
80
- ColumnBuilder.prototype[method] = function () {
81
- if (this._type.toLowerCase().indexOf('increments') === -1) {
82
- this._tableBuilder[method].apply(
83
- this._tableBuilder,
84
- [this._args[0]].concat(toArray(arguments))
85
- );
86
- }
87
- return this;
88
- };
89
- });
90
-
91
- ColumnBuilder.extend = (methodName, fn) => {
92
- if (
93
- Object.prototype.hasOwnProperty.call(ColumnBuilder.prototype, methodName)
94
- ) {
95
- throw new Error(
96
- `Can't extend ColumnBuilder with existing method ('${methodName}').`
97
- );
98
- }
99
-
100
- assign(ColumnBuilder.prototype, { [methodName]: fn });
101
- };
102
-
103
- const AlterMethods = {};
104
-
105
- // Specify that the column is to be dropped. This takes precedence
106
- // over all other rules for the column.
107
- AlterMethods.drop = function () {
108
- this._single.drop = true;
109
-
110
- return this;
111
- };
112
-
113
- // Specify the "type" that we're looking to set the
114
- // Knex takes no responsibility for any data-loss that may
115
- // occur when changing data types.
116
- AlterMethods.alterType = function (type) {
117
- this._statements.push({
118
- grouping: 'alterType',
119
- value: type,
120
- });
121
-
122
- return this;
123
- };
124
-
125
- // Set column method to alter (default is add).
126
- AlterMethods.alter = function ({
127
- alterNullable = true,
128
- alterType = true,
129
- } = {}) {
130
- this._method = 'alter';
131
- this.alterNullable = alterNullable;
132
- this.alterType = alterType;
133
-
134
- return this;
135
- };
136
-
137
- // Alias a few methods for clarity when processing.
138
- const columnAlias = {
139
- float: 'floating',
140
- enum: 'enu',
141
- boolean: 'bool',
142
- string: 'varchar',
143
- bigint: 'bigInteger',
144
- };
145
-
146
- module.exports = ColumnBuilder;
1
+ const extend = require('lodash/extend');
2
+ const assign = require('lodash/assign');
3
+ const toArray = require('lodash/toArray');
4
+ const { addQueryContext } = require('../util/helpers');
5
+
6
+ // The chainable interface off the original "column" method.
7
+ class ColumnBuilder {
8
+ constructor(client, tableBuilder, type, args) {
9
+ this.client = client;
10
+ this._method = 'add';
11
+ this._single = {};
12
+ this._modifiers = {};
13
+ this._statements = [];
14
+ this._type = columnAlias[type] || type;
15
+ this._args = args;
16
+ this._tableBuilder = tableBuilder;
17
+
18
+ // If we're altering the table, extend the object
19
+ // with the available "alter" methods.
20
+ if (tableBuilder._method === 'alter') {
21
+ extend(this, AlterMethods);
22
+ }
23
+ }
24
+
25
+ // Specify that the current column "references" a column,
26
+ // which may be tableName.column or just "column"
27
+ references(value) {
28
+ return this._tableBuilder.foreign
29
+ .call(this._tableBuilder, this._args[0], undefined, this)
30
+ ._columnBuilder(this)
31
+ .references(value);
32
+ }
33
+ }
34
+
35
+ // All of the modifier methods that can be used to modify the current query.
36
+ const modifiers = [
37
+ 'default',
38
+ 'defaultsTo',
39
+ 'defaultTo',
40
+ 'unsigned',
41
+ 'nullable',
42
+ 'first',
43
+ 'after',
44
+ 'comment',
45
+ 'collate',
46
+ 'check',
47
+ 'checkPositive',
48
+ 'checkNegative',
49
+ 'checkIn',
50
+ 'checkNotIn',
51
+ 'checkBetween',
52
+ 'checkLength',
53
+ 'checkRegex',
54
+ ];
55
+
56
+ // Aliases for convenience.
57
+ const aliasMethod = {
58
+ default: 'defaultTo',
59
+ defaultsTo: 'defaultTo',
60
+ };
61
+
62
+ // If we call any of the modifiers (index or otherwise) on the chainable, we pretend
63
+ // as though we're calling `table.method(column)` directly.
64
+ modifiers.forEach(function (method) {
65
+ const key = aliasMethod[method] || method;
66
+ ColumnBuilder.prototype[method] = function () {
67
+ this._modifiers[key] = toArray(arguments);
68
+ return this;
69
+ };
70
+ });
71
+
72
+ addQueryContext(ColumnBuilder);
73
+
74
+ ColumnBuilder.prototype.notNull = ColumnBuilder.prototype.notNullable =
75
+ function notNullable() {
76
+ return this.nullable(false);
77
+ };
78
+
79
+ ['index', 'primary', 'unique'].forEach(function (method) {
80
+ ColumnBuilder.prototype[method] = function () {
81
+ if (this._type.toLowerCase().indexOf('increments') === -1) {
82
+ this._tableBuilder[method].apply(
83
+ this._tableBuilder,
84
+ [this._args[0]].concat(toArray(arguments))
85
+ );
86
+ }
87
+ return this;
88
+ };
89
+ });
90
+
91
+ ColumnBuilder.extend = (methodName, fn) => {
92
+ if (
93
+ Object.prototype.hasOwnProperty.call(ColumnBuilder.prototype, methodName)
94
+ ) {
95
+ throw new Error(
96
+ `Can't extend ColumnBuilder with existing method ('${methodName}').`
97
+ );
98
+ }
99
+
100
+ assign(ColumnBuilder.prototype, { [methodName]: fn });
101
+ };
102
+
103
+ const AlterMethods = {};
104
+
105
+ // Specify that the column is to be dropped. This takes precedence
106
+ // over all other rules for the column.
107
+ AlterMethods.drop = function () {
108
+ this._single.drop = true;
109
+
110
+ return this;
111
+ };
112
+
113
+ // Specify the "type" that we're looking to set the
114
+ // Knex takes no responsibility for any data-loss that may
115
+ // occur when changing data types.
116
+ AlterMethods.alterType = function (type) {
117
+ this._statements.push({
118
+ grouping: 'alterType',
119
+ value: type,
120
+ });
121
+
122
+ return this;
123
+ };
124
+
125
+ // Set column method to alter (default is add).
126
+ AlterMethods.alter = function ({
127
+ alterNullable = true,
128
+ alterType = true,
129
+ } = {}) {
130
+ this._method = 'alter';
131
+ this.alterNullable = alterNullable;
132
+ this.alterType = alterType;
133
+
134
+ return this;
135
+ };
136
+
137
+ // Alias a few methods for clarity when processing.
138
+ const columnAlias = {
139
+ float: 'floating',
140
+ enum: 'enu',
141
+ boolean: 'bool',
142
+ string: 'varchar',
143
+ bigint: 'bigInteger',
144
+ };
145
+
146
+ module.exports = ColumnBuilder;