knex 0.21.20 → 0.21.21

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 (141) hide show
  1. package/CHANGELOG.md +6 -0
  2. package/CONTRIBUTING.md +184 -184
  3. package/LICENSE +22 -22
  4. package/README.md +95 -95
  5. package/bin/cli.js +414 -414
  6. package/bin/utils/cli-config-utils.js +151 -151
  7. package/bin/utils/constants.js +7 -7
  8. package/bin/utils/migrationsLister.js +37 -37
  9. package/knex.js +8 -8
  10. package/lib/client.js +413 -413
  11. package/lib/config-resolver.js +61 -61
  12. package/lib/constants.js +44 -44
  13. package/lib/dialects/mssql/index.js +390 -390
  14. package/lib/dialects/mssql/query/compiler.js +444 -444
  15. package/lib/dialects/mssql/schema/columncompiler.js +103 -103
  16. package/lib/dialects/mssql/schema/compiler.js +59 -59
  17. package/lib/dialects/mssql/schema/tablecompiler.js +245 -245
  18. package/lib/dialects/mssql/transaction.js +97 -97
  19. package/lib/dialects/mysql/index.js +191 -191
  20. package/lib/dialects/mysql/query/compiler.js +142 -142
  21. package/lib/dialects/mysql/schema/columncompiler.js +171 -171
  22. package/lib/dialects/mysql/schema/compiler.js +60 -60
  23. package/lib/dialects/mysql/schema/tablecompiler.js +262 -262
  24. package/lib/dialects/mysql/transaction.js +48 -48
  25. package/lib/dialects/mysql2/index.js +35 -35
  26. package/lib/dialects/mysql2/transaction.js +46 -46
  27. package/lib/dialects/oracle/DEAD_CODE.md +5 -5
  28. package/lib/dialects/oracle/formatter.js +20 -20
  29. package/lib/dialects/oracle/index.js +79 -79
  30. package/lib/dialects/oracle/query/compiler.js +327 -327
  31. package/lib/dialects/oracle/schema/columnbuilder.js +18 -18
  32. package/lib/dialects/oracle/schema/columncompiler.js +139 -139
  33. package/lib/dialects/oracle/schema/compiler.js +81 -81
  34. package/lib/dialects/oracle/schema/tablecompiler.js +165 -165
  35. package/lib/dialects/oracle/schema/trigger.js +126 -126
  36. package/lib/dialects/oracle/utils.js +86 -86
  37. package/lib/dialects/oracledb/index.js +489 -489
  38. package/lib/dialects/oracledb/query/compiler.js +363 -363
  39. package/lib/dialects/oracledb/schema/columncompiler.js +35 -35
  40. package/lib/dialects/oracledb/transaction.js +76 -76
  41. package/lib/dialects/oracledb/utils.js +14 -14
  42. package/lib/dialects/postgres/index.js +319 -319
  43. package/lib/dialects/postgres/query/compiler.js +206 -206
  44. package/lib/dialects/postgres/schema/columncompiler.js +125 -125
  45. package/lib/dialects/postgres/schema/compiler.js +109 -109
  46. package/lib/dialects/postgres/schema/tablecompiler.js +183 -183
  47. package/lib/dialects/redshift/index.js +73 -73
  48. package/lib/dialects/redshift/query/compiler.js +119 -119
  49. package/lib/dialects/redshift/schema/columnbuilder.js +20 -20
  50. package/lib/dialects/redshift/schema/columncompiler.js +60 -60
  51. package/lib/dialects/redshift/schema/compiler.js +14 -14
  52. package/lib/dialects/redshift/schema/tablecompiler.js +123 -123
  53. package/lib/dialects/redshift/transaction.js +18 -18
  54. package/lib/dialects/sqlite3/formatter.js +21 -21
  55. package/lib/dialects/sqlite3/index.js +169 -169
  56. package/lib/dialects/sqlite3/query/compiler.js +222 -222
  57. package/lib/dialects/sqlite3/schema/columncompiler.js +27 -27
  58. package/lib/dialects/sqlite3/schema/compiler.js +49 -49
  59. package/lib/dialects/sqlite3/schema/ddl.js +525 -525
  60. package/lib/dialects/sqlite3/schema/tablecompiler.js +238 -238
  61. package/lib/formatter.js +295 -295
  62. package/lib/functionhelper.js +14 -14
  63. package/lib/helpers.js +92 -92
  64. package/lib/index.js +3 -3
  65. package/lib/interface.js +115 -115
  66. package/lib/knex.js +42 -42
  67. package/lib/logger.js +76 -76
  68. package/lib/migrate/MigrationGenerator.js +82 -82
  69. package/lib/migrate/Migrator.js +611 -611
  70. package/lib/migrate/configuration-merger.js +60 -60
  71. package/lib/migrate/migrate-stub.js +17 -17
  72. package/lib/migrate/migration-list-resolver.js +36 -36
  73. package/lib/migrate/sources/fs-migrations.js +99 -99
  74. package/lib/migrate/stub/cjs.stub +15 -15
  75. package/lib/migrate/stub/coffee.stub +13 -13
  76. package/lib/migrate/stub/eg.stub +14 -14
  77. package/lib/migrate/stub/js.stub +15 -15
  78. package/lib/migrate/stub/knexfile-coffee.stub +34 -34
  79. package/lib/migrate/stub/knexfile-eg.stub +43 -43
  80. package/lib/migrate/stub/knexfile-js.stub +44 -44
  81. package/lib/migrate/stub/knexfile-ls.stub +35 -35
  82. package/lib/migrate/stub/knexfile-ts.stub +44 -44
  83. package/lib/migrate/stub/ls.stub +14 -14
  84. package/lib/migrate/stub/ts.stub +21 -21
  85. package/lib/migrate/table-creator.js +67 -67
  86. package/lib/migrate/table-resolver.js +27 -27
  87. package/lib/query/builder.js +1372 -1372
  88. package/lib/query/compiler.js +889 -889
  89. package/lib/query/constants.js +13 -13
  90. package/lib/query/joinclause.js +263 -263
  91. package/lib/query/methods.js +92 -92
  92. package/lib/query/string.js +190 -190
  93. package/lib/raw.js +188 -188
  94. package/lib/ref.js +39 -39
  95. package/lib/runner.js +285 -285
  96. package/lib/schema/builder.js +82 -82
  97. package/lib/schema/columnbuilder.js +117 -117
  98. package/lib/schema/columncompiler.js +177 -177
  99. package/lib/schema/compiler.js +101 -101
  100. package/lib/schema/helpers.js +51 -51
  101. package/lib/schema/tablebuilder.js +288 -288
  102. package/lib/schema/tablecompiler.js +296 -296
  103. package/lib/seed/Seeder.js +203 -203
  104. package/lib/seed/seed-stub.js +13 -13
  105. package/lib/seed/stub/coffee.stub +9 -9
  106. package/lib/seed/stub/eg.stub +11 -11
  107. package/lib/seed/stub/js.stub +13 -13
  108. package/lib/seed/stub/ls.stub +11 -11
  109. package/lib/seed/stub/ts.stub +13 -13
  110. package/lib/transaction.js +363 -363
  111. package/lib/util/batchInsert.js +59 -59
  112. package/lib/util/delay.js +6 -6
  113. package/lib/util/fake-client.js +9 -9
  114. package/lib/util/finally-mixin.js +13 -13
  115. package/lib/util/fs.js +76 -76
  116. package/lib/util/import-file.js +13 -13
  117. package/lib/util/is-module-type.js +14 -14
  118. package/lib/util/is.js +32 -32
  119. package/lib/util/make-knex.js +338 -338
  120. package/lib/util/nanoid.js +29 -29
  121. package/lib/util/noop.js +1 -1
  122. package/lib/util/parse-connection.js +66 -66
  123. package/lib/util/save-async-stack.js +14 -14
  124. package/lib/util/template.js +52 -52
  125. package/lib/util/timeout.js +29 -29
  126. package/lib/util/timestamp.js +16 -16
  127. package/package.json +1 -1
  128. package/scripts/build.js +125 -125
  129. package/scripts/docker-compose.yml +111 -111
  130. package/scripts/next-release-howto.md +24 -24
  131. package/scripts/release.sh +34 -34
  132. package/scripts/runkit-example.js +34 -34
  133. package/scripts/stress-test/README.txt +18 -18
  134. package/scripts/stress-test/docker-compose.yml +47 -47
  135. package/scripts/stress-test/knex-stress-test.js +196 -196
  136. package/scripts/stress-test/mysql2-random-hanging-every-now-and-then.js +145 -145
  137. package/scripts/stress-test/mysql2-sudden-exit-without-error.js +100 -100
  138. package/scripts/stress-test/reconnect-test-mysql-based-drivers.js +184 -184
  139. package/types/index.d.ts +2249 -2249
  140. package/types/result.d.ts +27 -27
  141. package/types/tables.d.ts +4 -4
@@ -1,82 +1,82 @@
1
- const { inherits } = require('util');
2
- const { EventEmitter } = require('events');
3
- const toArray = require('lodash/toArray');
4
- const { addQueryContext } = require('../helpers');
5
- const saveAsyncStack = require('../util/save-async-stack');
6
-
7
- // Constructor for the builder instance, typically called from
8
- // `knex.builder`, accepting the current `knex` instance,
9
- // and pulling out the `client` and `grammar` from the current
10
- // knex instance.
11
- function SchemaBuilder(client) {
12
- this.client = client;
13
- this._sequence = [];
14
-
15
- if (client.config) {
16
- this._debug = client.config.debug;
17
- saveAsyncStack(this, 4);
18
- }
19
- }
20
-
21
- inherits(SchemaBuilder, EventEmitter);
22
-
23
- // Each of the schema builder methods just add to the
24
- // "_sequence" array for consistency.
25
- [
26
- 'createTable',
27
- 'createTableIfNotExists',
28
- 'createSchema',
29
- 'createSchemaIfNotExists',
30
- 'dropSchema',
31
- 'dropSchemaIfExists',
32
- 'createExtension',
33
- 'createExtensionIfNotExists',
34
- 'dropExtension',
35
- 'dropExtensionIfExists',
36
- 'table',
37
- 'alterTable',
38
- 'hasTable',
39
- 'hasColumn',
40
- 'dropTable',
41
- 'renameTable',
42
- 'dropTableIfExists',
43
- 'raw',
44
- ].forEach(function (method) {
45
- SchemaBuilder.prototype[method] = function () {
46
- if (method === 'createTableIfNotExists') {
47
- this.client.logger.warn(
48
- [
49
- 'Use async .hasTable to check if table exists and then use plain .createTable. Since ',
50
- '.createTableIfNotExists actually just generates plain "CREATE TABLE IF NOT EXIST..." ',
51
- 'query it will not work correctly if there are any alter table queries generated for ',
52
- 'columns afterwards. To not break old migrations this function is left untouched for now',
53
- ', but it should not be used when writing new code and it is removed from documentation.',
54
- ].join('')
55
- );
56
- }
57
- if (method === 'table') method = 'alterTable';
58
- this._sequence.push({
59
- method,
60
- args: toArray(arguments),
61
- });
62
- return this;
63
- };
64
- });
65
-
66
- require('../interface')(SchemaBuilder);
67
- addQueryContext(SchemaBuilder);
68
-
69
- SchemaBuilder.prototype.withSchema = function (schemaName) {
70
- this._schema = schemaName;
71
- return this;
72
- };
73
-
74
- SchemaBuilder.prototype.toString = function () {
75
- return this.toQuery();
76
- };
77
-
78
- SchemaBuilder.prototype.toSQL = function () {
79
- return this.client.schemaCompiler(this).toSQL();
80
- };
81
-
82
- module.exports = SchemaBuilder;
1
+ const { inherits } = require('util');
2
+ const { EventEmitter } = require('events');
3
+ const toArray = require('lodash/toArray');
4
+ const { addQueryContext } = require('../helpers');
5
+ const saveAsyncStack = require('../util/save-async-stack');
6
+
7
+ // Constructor for the builder instance, typically called from
8
+ // `knex.builder`, accepting the current `knex` instance,
9
+ // and pulling out the `client` and `grammar` from the current
10
+ // knex instance.
11
+ function SchemaBuilder(client) {
12
+ this.client = client;
13
+ this._sequence = [];
14
+
15
+ if (client.config) {
16
+ this._debug = client.config.debug;
17
+ saveAsyncStack(this, 4);
18
+ }
19
+ }
20
+
21
+ inherits(SchemaBuilder, EventEmitter);
22
+
23
+ // Each of the schema builder methods just add to the
24
+ // "_sequence" array for consistency.
25
+ [
26
+ 'createTable',
27
+ 'createTableIfNotExists',
28
+ 'createSchema',
29
+ 'createSchemaIfNotExists',
30
+ 'dropSchema',
31
+ 'dropSchemaIfExists',
32
+ 'createExtension',
33
+ 'createExtensionIfNotExists',
34
+ 'dropExtension',
35
+ 'dropExtensionIfExists',
36
+ 'table',
37
+ 'alterTable',
38
+ 'hasTable',
39
+ 'hasColumn',
40
+ 'dropTable',
41
+ 'renameTable',
42
+ 'dropTableIfExists',
43
+ 'raw',
44
+ ].forEach(function (method) {
45
+ SchemaBuilder.prototype[method] = function () {
46
+ if (method === 'createTableIfNotExists') {
47
+ this.client.logger.warn(
48
+ [
49
+ 'Use async .hasTable to check if table exists and then use plain .createTable. Since ',
50
+ '.createTableIfNotExists actually just generates plain "CREATE TABLE IF NOT EXIST..." ',
51
+ 'query it will not work correctly if there are any alter table queries generated for ',
52
+ 'columns afterwards. To not break old migrations this function is left untouched for now',
53
+ ', but it should not be used when writing new code and it is removed from documentation.',
54
+ ].join('')
55
+ );
56
+ }
57
+ if (method === 'table') method = 'alterTable';
58
+ this._sequence.push({
59
+ method,
60
+ args: toArray(arguments),
61
+ });
62
+ return this;
63
+ };
64
+ });
65
+
66
+ require('../interface')(SchemaBuilder);
67
+ addQueryContext(SchemaBuilder);
68
+
69
+ SchemaBuilder.prototype.withSchema = function (schemaName) {
70
+ this._schema = schemaName;
71
+ return this;
72
+ };
73
+
74
+ SchemaBuilder.prototype.toString = function () {
75
+ return this.toQuery();
76
+ };
77
+
78
+ SchemaBuilder.prototype.toSQL = function () {
79
+ return this.client.schemaCompiler(this).toSQL();
80
+ };
81
+
82
+ module.exports = SchemaBuilder;
@@ -1,117 +1,117 @@
1
- const extend = require('lodash/extend');
2
- const toArray = require('lodash/toArray');
3
- const { addQueryContext } = require('../helpers');
4
-
5
- // The chainable interface off the original "column" method.
6
- function ColumnBuilder(client, tableBuilder, type, args) {
7
- this.client = client;
8
- this._method = 'add';
9
- this._single = {};
10
- this._modifiers = {};
11
- this._statements = [];
12
- this._type = columnAlias[type] || type;
13
- this._args = args;
14
- this._tableBuilder = tableBuilder;
15
-
16
- // If we're altering the table, extend the object
17
- // with the available "alter" methods.
18
- if (tableBuilder._method === 'alter') {
19
- extend(this, AlterMethods);
20
- }
21
- }
22
-
23
- // All of the modifier methods that can be used to modify the current query.
24
- const modifiers = [
25
- 'default',
26
- 'defaultsTo',
27
- 'defaultTo',
28
- 'unsigned',
29
- 'nullable',
30
- 'first',
31
- 'after',
32
- 'comment',
33
- 'collate',
34
- ];
35
-
36
- // Aliases for convenience.
37
- const aliasMethod = {
38
- default: 'defaultTo',
39
- defaultsTo: 'defaultTo',
40
- };
41
-
42
- // If we call any of the modifiers (index or otherwise) on the chainable, we pretend
43
- // as though we're calling `table.method(column)` directly.
44
- modifiers.forEach(function (method) {
45
- const key = aliasMethod[method] || method;
46
- ColumnBuilder.prototype[method] = function () {
47
- this._modifiers[key] = toArray(arguments);
48
- return this;
49
- };
50
- });
51
-
52
- addQueryContext(ColumnBuilder);
53
-
54
- ColumnBuilder.prototype.notNull = ColumnBuilder.prototype.notNullable = function notNullable() {
55
- return this.nullable(false);
56
- };
57
-
58
- ['index', 'primary', 'unique'].forEach(function (method) {
59
- ColumnBuilder.prototype[method] = function () {
60
- if (this._type.toLowerCase().indexOf('increments') === -1) {
61
- this._tableBuilder[method].apply(
62
- this._tableBuilder,
63
- [this._args[0]].concat(toArray(arguments))
64
- );
65
- }
66
- return this;
67
- };
68
- });
69
-
70
- // Specify that the current column "references" a column,
71
- // which may be tableName.column or just "column"
72
- ColumnBuilder.prototype.references = function (value) {
73
- return this._tableBuilder.foreign
74
- .call(this._tableBuilder, this._args[0], undefined, this)
75
- ._columnBuilder(this)
76
- .references(value);
77
- };
78
-
79
- const AlterMethods = {};
80
-
81
- // Specify that the column is to be dropped. This takes precedence
82
- // over all other rules for the column.
83
- AlterMethods.drop = function () {
84
- this._single.drop = true;
85
-
86
- return this;
87
- };
88
-
89
- // Specify the "type" that we're looking to set the
90
- // Knex takes no responsibility for any data-loss that may
91
- // occur when changing data types.
92
- AlterMethods.alterType = function (type) {
93
- this._statements.push({
94
- grouping: 'alterType',
95
- value: type,
96
- });
97
-
98
- return this;
99
- };
100
-
101
- // Set column method to alter (default is add).
102
- AlterMethods.alter = function () {
103
- this._method = 'alter';
104
-
105
- return this;
106
- };
107
-
108
- // Alias a few methods for clarity when processing.
109
- const columnAlias = {
110
- float: 'floating',
111
- enum: 'enu',
112
- boolean: 'bool',
113
- string: 'varchar',
114
- bigint: 'bigInteger',
115
- };
116
-
117
- module.exports = ColumnBuilder;
1
+ const extend = require('lodash/extend');
2
+ const toArray = require('lodash/toArray');
3
+ const { addQueryContext } = require('../helpers');
4
+
5
+ // The chainable interface off the original "column" method.
6
+ function ColumnBuilder(client, tableBuilder, type, args) {
7
+ this.client = client;
8
+ this._method = 'add';
9
+ this._single = {};
10
+ this._modifiers = {};
11
+ this._statements = [];
12
+ this._type = columnAlias[type] || type;
13
+ this._args = args;
14
+ this._tableBuilder = tableBuilder;
15
+
16
+ // If we're altering the table, extend the object
17
+ // with the available "alter" methods.
18
+ if (tableBuilder._method === 'alter') {
19
+ extend(this, AlterMethods);
20
+ }
21
+ }
22
+
23
+ // All of the modifier methods that can be used to modify the current query.
24
+ const modifiers = [
25
+ 'default',
26
+ 'defaultsTo',
27
+ 'defaultTo',
28
+ 'unsigned',
29
+ 'nullable',
30
+ 'first',
31
+ 'after',
32
+ 'comment',
33
+ 'collate',
34
+ ];
35
+
36
+ // Aliases for convenience.
37
+ const aliasMethod = {
38
+ default: 'defaultTo',
39
+ defaultsTo: 'defaultTo',
40
+ };
41
+
42
+ // If we call any of the modifiers (index or otherwise) on the chainable, we pretend
43
+ // as though we're calling `table.method(column)` directly.
44
+ modifiers.forEach(function (method) {
45
+ const key = aliasMethod[method] || method;
46
+ ColumnBuilder.prototype[method] = function () {
47
+ this._modifiers[key] = toArray(arguments);
48
+ return this;
49
+ };
50
+ });
51
+
52
+ addQueryContext(ColumnBuilder);
53
+
54
+ ColumnBuilder.prototype.notNull = ColumnBuilder.prototype.notNullable = function notNullable() {
55
+ return this.nullable(false);
56
+ };
57
+
58
+ ['index', 'primary', 'unique'].forEach(function (method) {
59
+ ColumnBuilder.prototype[method] = function () {
60
+ if (this._type.toLowerCase().indexOf('increments') === -1) {
61
+ this._tableBuilder[method].apply(
62
+ this._tableBuilder,
63
+ [this._args[0]].concat(toArray(arguments))
64
+ );
65
+ }
66
+ return this;
67
+ };
68
+ });
69
+
70
+ // Specify that the current column "references" a column,
71
+ // which may be tableName.column or just "column"
72
+ ColumnBuilder.prototype.references = function (value) {
73
+ return this._tableBuilder.foreign
74
+ .call(this._tableBuilder, this._args[0], undefined, this)
75
+ ._columnBuilder(this)
76
+ .references(value);
77
+ };
78
+
79
+ const AlterMethods = {};
80
+
81
+ // Specify that the column is to be dropped. This takes precedence
82
+ // over all other rules for the column.
83
+ AlterMethods.drop = function () {
84
+ this._single.drop = true;
85
+
86
+ return this;
87
+ };
88
+
89
+ // Specify the "type" that we're looking to set the
90
+ // Knex takes no responsibility for any data-loss that may
91
+ // occur when changing data types.
92
+ AlterMethods.alterType = function (type) {
93
+ this._statements.push({
94
+ grouping: 'alterType',
95
+ value: type,
96
+ });
97
+
98
+ return this;
99
+ };
100
+
101
+ // Set column method to alter (default is add).
102
+ AlterMethods.alter = function () {
103
+ this._method = 'alter';
104
+
105
+ return this;
106
+ };
107
+
108
+ // Alias a few methods for clarity when processing.
109
+ const columnAlias = {
110
+ float: 'floating',
111
+ enum: 'enu',
112
+ boolean: 'bool',
113
+ string: 'varchar',
114
+ bigint: 'bigInteger',
115
+ };
116
+
117
+ module.exports = ColumnBuilder;