knex 2.5.0 → 3.0.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 (190) hide show
  1. package/CHANGELOG.md +78 -59
  2. package/CONTRIBUTING.md +194 -194
  3. package/LICENSE +22 -22
  4. package/README.md +149 -147
  5. package/UPGRADING.md +245 -233
  6. package/bin/cli.js +475 -473
  7. package/bin/utils/cli-config-utils.js +212 -210
  8. package/bin/utils/constants.js +7 -7
  9. package/bin/utils/migrationsLister.js +37 -37
  10. package/knex.js +23 -23
  11. package/knex.mjs +11 -11
  12. package/lib/builder-interface-augmenter.js +120 -120
  13. package/lib/client.js +495 -495
  14. package/lib/constants.js +61 -61
  15. package/lib/dialects/better-sqlite3/index.js +77 -77
  16. package/lib/dialects/cockroachdb/crdb-columncompiler.js +14 -14
  17. package/lib/dialects/cockroachdb/crdb-querybuilder.js +11 -11
  18. package/lib/dialects/cockroachdb/crdb-querycompiler.js +122 -122
  19. package/lib/dialects/cockroachdb/crdb-tablecompiler.js +37 -37
  20. package/lib/dialects/cockroachdb/crdb-viewcompiler.js +15 -15
  21. package/lib/dialects/cockroachdb/index.js +86 -86
  22. package/lib/dialects/mssql/index.js +500 -500
  23. package/lib/dialects/mssql/mssql-formatter.js +34 -34
  24. package/lib/dialects/mssql/query/mssql-querycompiler.js +601 -601
  25. package/lib/dialects/mssql/schema/mssql-columncompiler.js +185 -185
  26. package/lib/dialects/mssql/schema/mssql-compiler.js +91 -91
  27. package/lib/dialects/mssql/schema/mssql-tablecompiler.js +378 -378
  28. package/lib/dialects/mssql/schema/mssql-viewcompiler.js +55 -55
  29. package/lib/dialects/mssql/transaction.js +176 -176
  30. package/lib/dialects/mysql/index.js +201 -201
  31. package/lib/dialects/mysql/query/mysql-querycompiler.js +274 -274
  32. package/lib/dialects/mysql/schema/mysql-columncompiler.js +193 -193
  33. package/lib/dialects/mysql/schema/mysql-compiler.js +60 -60
  34. package/lib/dialects/mysql/schema/mysql-tablecompiler.js +381 -381
  35. package/lib/dialects/mysql/schema/mysql-viewbuilder.js +21 -21
  36. package/lib/dialects/mysql/schema/mysql-viewcompiler.js +15 -15
  37. package/lib/dialects/mysql/transaction.js +46 -46
  38. package/lib/dialects/mysql2/index.js +53 -53
  39. package/lib/dialects/mysql2/transaction.js +44 -44
  40. package/lib/dialects/oracle/DEAD_CODE.md +5 -5
  41. package/lib/dialects/oracle/index.js +92 -92
  42. package/lib/dialects/oracle/query/oracle-querycompiler.js +343 -343
  43. package/lib/dialects/oracle/schema/internal/incrementUtils.js +20 -20
  44. package/lib/dialects/oracle/schema/internal/trigger.js +135 -135
  45. package/lib/dialects/oracle/schema/oracle-columnbuilder.js +17 -17
  46. package/lib/dialects/oracle/schema/oracle-columncompiler.js +126 -126
  47. package/lib/dialects/oracle/schema/oracle-compiler.js +122 -122
  48. package/lib/dialects/oracle/schema/oracle-tablecompiler.js +190 -190
  49. package/lib/dialects/oracle/utils.js +87 -87
  50. package/lib/dialects/oracledb/index.js +327 -327
  51. package/lib/dialects/oracledb/query/oracledb-querycompiler.js +481 -481
  52. package/lib/dialects/oracledb/schema/oracledb-columncompiler.js +61 -61
  53. package/lib/dialects/oracledb/schema/oracledb-tablecompiler.js +19 -19
  54. package/lib/dialects/oracledb/schema/oracledb-viewbuilder.js +13 -13
  55. package/lib/dialects/oracledb/schema/oracledb-viewcompiler.js +19 -19
  56. package/lib/dialects/oracledb/transaction.js +98 -98
  57. package/lib/dialects/oracledb/utils.js +208 -208
  58. package/lib/dialects/pgnative/index.js +60 -60
  59. package/lib/dialects/postgres/execution/pg-transaction.js +19 -19
  60. package/lib/dialects/postgres/index.js +358 -358
  61. package/lib/dialects/postgres/query/pg-querybuilder.js +43 -43
  62. package/lib/dialects/postgres/query/pg-querycompiler.js +400 -400
  63. package/lib/dialects/postgres/schema/pg-columncompiler.js +156 -156
  64. package/lib/dialects/postgres/schema/pg-compiler.js +138 -138
  65. package/lib/dialects/postgres/schema/pg-tablecompiler.js +304 -304
  66. package/lib/dialects/postgres/schema/pg-viewbuilder.js +21 -21
  67. package/lib/dialects/postgres/schema/pg-viewcompiler.js +35 -35
  68. package/lib/dialects/redshift/index.js +86 -86
  69. package/lib/dialects/redshift/query/redshift-querycompiler.js +163 -163
  70. package/lib/dialects/redshift/schema/redshift-columnbuilder.js +22 -22
  71. package/lib/dialects/redshift/schema/redshift-columncompiler.js +67 -67
  72. package/lib/dialects/redshift/schema/redshift-compiler.js +14 -14
  73. package/lib/dialects/redshift/schema/redshift-tablecompiler.js +122 -122
  74. package/lib/dialects/redshift/schema/redshift-viewcompiler.js +11 -11
  75. package/lib/dialects/redshift/transaction.js +32 -32
  76. package/lib/dialects/sqlite3/execution/sqlite-transaction.js +25 -25
  77. package/lib/dialects/sqlite3/index.js +250 -250
  78. package/lib/dialects/sqlite3/query/sqlite-querybuilder.js +33 -33
  79. package/lib/dialects/sqlite3/query/sqlite-querycompiler.js +334 -334
  80. package/lib/dialects/sqlite3/schema/ddl.js +400 -400
  81. package/lib/dialects/sqlite3/schema/internal/compiler.js +327 -327
  82. package/lib/dialects/sqlite3/schema/internal/parser-combinator.js +161 -161
  83. package/lib/dialects/sqlite3/schema/internal/parser.js +638 -638
  84. package/lib/dialects/sqlite3/schema/internal/sqlite-ddl-operations.js +41 -41
  85. package/lib/dialects/sqlite3/schema/internal/tokenizer.js +38 -38
  86. package/lib/dialects/sqlite3/schema/internal/utils.js +12 -12
  87. package/lib/dialects/sqlite3/schema/sqlite-columncompiler.js +50 -50
  88. package/lib/dialects/sqlite3/schema/sqlite-compiler.js +80 -80
  89. package/lib/dialects/sqlite3/schema/sqlite-tablecompiler.js +347 -347
  90. package/lib/dialects/sqlite3/schema/sqlite-viewcompiler.js +40 -40
  91. package/lib/execution/batch-insert.js +51 -51
  92. package/lib/execution/internal/delay.js +6 -6
  93. package/lib/execution/internal/ensure-connection-callback.js +41 -41
  94. package/lib/execution/internal/query-executioner.js +62 -62
  95. package/lib/execution/runner.js +325 -325
  96. package/lib/execution/transaction.js +409 -409
  97. package/lib/formatter/formatterUtils.js +42 -42
  98. package/lib/formatter/rawFormatter.js +84 -84
  99. package/lib/formatter/wrappingFormatter.js +250 -250
  100. package/lib/formatter.js +25 -25
  101. package/lib/index.js +3 -3
  102. package/lib/knex-builder/FunctionHelper.js +80 -80
  103. package/lib/knex-builder/Knex.js +59 -59
  104. package/lib/knex-builder/internal/config-resolver.js +57 -57
  105. package/lib/knex-builder/internal/parse-connection.js +87 -87
  106. package/lib/knex-builder/make-knex.js +345 -345
  107. package/lib/logger.js +76 -76
  108. package/lib/migrations/common/MigrationsLoader.js +36 -36
  109. package/lib/migrations/migrate/MigrationGenerator.js +84 -84
  110. package/lib/migrations/migrate/Migrator.js +599 -598
  111. package/lib/migrations/migrate/migrate-stub.js +17 -17
  112. package/lib/migrations/migrate/migration-list-resolver.js +33 -33
  113. package/lib/migrations/migrate/migrator-configuration-merger.js +58 -58
  114. package/lib/migrations/migrate/sources/fs-migrations.js +74 -74
  115. package/lib/migrations/migrate/stub/cjs.stub +15 -15
  116. package/lib/migrations/migrate/stub/coffee.stub +13 -13
  117. package/lib/migrations/migrate/stub/eg.stub +14 -14
  118. package/lib/migrations/migrate/stub/js-schema.stub +22 -22
  119. package/lib/migrations/migrate/stub/js.stub +22 -22
  120. package/lib/migrations/migrate/stub/knexfile-coffee.stub +34 -34
  121. package/lib/migrations/migrate/stub/knexfile-eg.stub +43 -43
  122. package/lib/migrations/migrate/stub/knexfile-js.stub +47 -47
  123. package/lib/migrations/migrate/stub/knexfile-ls.stub +35 -35
  124. package/lib/migrations/migrate/stub/knexfile-ts.stub +47 -47
  125. package/lib/migrations/migrate/stub/ls.stub +14 -14
  126. package/lib/migrations/migrate/stub/mjs.stub +23 -23
  127. package/lib/migrations/migrate/stub/ts-schema.stub +21 -21
  128. package/lib/migrations/migrate/stub/ts.stub +21 -21
  129. package/lib/migrations/migrate/table-creator.js +77 -77
  130. package/lib/migrations/migrate/table-resolver.js +27 -27
  131. package/lib/migrations/seed/Seeder.js +137 -137
  132. package/lib/migrations/seed/seed-stub.js +13 -13
  133. package/lib/migrations/seed/seeder-configuration-merger.js +60 -60
  134. package/lib/migrations/seed/sources/fs-seeds.js +65 -65
  135. package/lib/migrations/seed/stub/coffee.stub +9 -9
  136. package/lib/migrations/seed/stub/eg.stub +11 -11
  137. package/lib/migrations/seed/stub/js.stub +13 -13
  138. package/lib/migrations/seed/stub/ls.stub +11 -11
  139. package/lib/migrations/seed/stub/mjs.stub +12 -12
  140. package/lib/migrations/seed/stub/ts.stub +13 -13
  141. package/lib/migrations/util/fs.js +86 -86
  142. package/lib/migrations/util/import-file.js +12 -12
  143. package/lib/migrations/util/is-module-type.js +9 -9
  144. package/lib/migrations/util/template.js +52 -52
  145. package/lib/migrations/util/timestamp.js +14 -14
  146. package/lib/query/analytic.js +52 -52
  147. package/lib/query/constants.js +15 -15
  148. package/lib/query/joinclause.js +270 -270
  149. package/lib/query/method-constants.js +136 -136
  150. package/lib/query/querybuilder.js +1793 -1793
  151. package/lib/query/querycompiler.js +1591 -1591
  152. package/lib/raw.js +139 -139
  153. package/lib/ref.js +39 -39
  154. package/lib/schema/builder.js +115 -115
  155. package/lib/schema/columnbuilder.js +146 -146
  156. package/lib/schema/columncompiler.js +307 -307
  157. package/lib/schema/compiler.js +187 -187
  158. package/lib/schema/internal/helpers.js +55 -55
  159. package/lib/schema/tablebuilder.js +376 -376
  160. package/lib/schema/tablecompiler.js +433 -433
  161. package/lib/schema/viewbuilder.js +92 -92
  162. package/lib/schema/viewcompiler.js +138 -138
  163. package/lib/util/finally-mixin.js +13 -13
  164. package/lib/util/helpers.js +95 -95
  165. package/lib/util/is.js +32 -32
  166. package/lib/util/nanoid.js +40 -40
  167. package/lib/util/noop.js +1 -1
  168. package/lib/util/save-async-stack.js +14 -14
  169. package/lib/util/security.js +26 -26
  170. package/lib/util/string.js +190 -190
  171. package/lib/util/timeout.js +29 -29
  172. package/package.json +13 -12
  173. package/scripts/build.js +125 -125
  174. package/scripts/clean.js +31 -31
  175. package/scripts/docker-compose.yml +152 -152
  176. package/scripts/next-release-howto.md +24 -24
  177. package/scripts/oracledb-install-driver-libs.sh +82 -82
  178. package/scripts/release.sh +36 -34
  179. package/scripts/runkit-example.js +35 -34
  180. package/scripts/stress-test/README.txt +18 -18
  181. package/scripts/stress-test/docker-compose.yml +57 -57
  182. package/scripts/stress-test/knex-stress-test.js +212 -208
  183. package/scripts/stress-test/mysql2-random-hanging-every-now-and-then.js +149 -145
  184. package/scripts/stress-test/mysql2-sudden-exit-without-error.js +101 -100
  185. package/scripts/stress-test/reconnect-test-mysql-based-drivers.js +188 -184
  186. package/scripts/update_gitignore_for_tsc_output.js +90 -90
  187. package/types/index.d.ts +3272 -3273
  188. package/types/result.d.ts +27 -27
  189. package/types/tables.d.ts +4 -4
  190. package/lib/dialects/index.js +0 -34
@@ -1,42 +1,42 @@
1
- const { isObject } = require('../util/is');
2
-
3
- // Compiles a callback using the query builder.
4
- function compileCallback(callback, method, client, bindingsHolder) {
5
- // Build the callback
6
- const builder = client.queryBuilder();
7
- callback.call(builder, builder);
8
-
9
- // Compile the callback, using the current formatter (to track all bindings).
10
- const compiler = client.queryCompiler(builder, bindingsHolder.bindings);
11
-
12
- // Return the compiled & parameterized sql.
13
- return compiler.toSQL(method || builder._method || 'select');
14
- }
15
-
16
- function wrapAsIdentifier(value, builder, client) {
17
- const queryContext = builder.queryContext();
18
- return client.wrapIdentifier((value || '').trim(), queryContext);
19
- }
20
-
21
- function formatDefault(value, type, client) {
22
- if (value === void 0) {
23
- return '';
24
- } else if (value === null) {
25
- return 'null';
26
- } else if (value && value.isRawInstance) {
27
- return value.toQuery();
28
- } else if (type === 'bool') {
29
- if (value === 'false') value = 0;
30
- return `'${value ? 1 : 0}'`;
31
- } else if ((type === 'json' || type === 'jsonb') && isObject(value)) {
32
- return `'${JSON.stringify(value)}'`;
33
- } else {
34
- return client._escapeBinding(value.toString());
35
- }
36
- }
37
-
38
- module.exports = {
39
- compileCallback,
40
- wrapAsIdentifier,
41
- formatDefault,
42
- };
1
+ const { isObject } = require('../util/is');
2
+
3
+ // Compiles a callback using the query builder.
4
+ function compileCallback(callback, method, client, bindingsHolder) {
5
+ // Build the callback
6
+ const builder = client.queryBuilder();
7
+ callback.call(builder, builder);
8
+
9
+ // Compile the callback, using the current formatter (to track all bindings).
10
+ const compiler = client.queryCompiler(builder, bindingsHolder.bindings);
11
+
12
+ // Return the compiled & parameterized sql.
13
+ return compiler.toSQL(method || builder._method || 'select');
14
+ }
15
+
16
+ function wrapAsIdentifier(value, builder, client) {
17
+ const queryContext = builder.queryContext();
18
+ return client.wrapIdentifier((value || '').trim(), queryContext);
19
+ }
20
+
21
+ function formatDefault(value, type, client) {
22
+ if (value === void 0) {
23
+ return '';
24
+ } else if (value === null) {
25
+ return 'null';
26
+ } else if (value && value.isRawInstance) {
27
+ return value.toQuery();
28
+ } else if (type === 'bool') {
29
+ if (value === 'false') value = 0;
30
+ return `'${value ? 1 : 0}'`;
31
+ } else if ((type === 'json' || type === 'jsonb') && isObject(value)) {
32
+ return `'${JSON.stringify(value)}'`;
33
+ } else {
34
+ return client._escapeBinding(value.toString());
35
+ }
36
+ }
37
+
38
+ module.exports = {
39
+ compileCallback,
40
+ wrapAsIdentifier,
41
+ formatDefault,
42
+ };
@@ -1,84 +1,84 @@
1
- const { columnize } = require('./wrappingFormatter');
2
-
3
- function replaceRawArrBindings(raw, client) {
4
- const bindingsHolder = {
5
- bindings: [],
6
- };
7
- const builder = raw;
8
-
9
- const expectedBindings = raw.bindings.length;
10
- const values = raw.bindings;
11
- let index = 0;
12
-
13
- const sql = raw.sql.replace(/\\?\?\??/g, function (match) {
14
- if (match === '\\?') {
15
- return match;
16
- }
17
-
18
- const value = values[index++];
19
-
20
- if (match === '??') {
21
- return columnize(value, builder, client, bindingsHolder);
22
- }
23
- return client.parameter(value, builder, bindingsHolder);
24
- });
25
-
26
- if (expectedBindings !== index) {
27
- throw new Error(`Expected ${expectedBindings} bindings, saw ${index}`);
28
- }
29
-
30
- return {
31
- method: 'raw',
32
- sql,
33
- bindings: bindingsHolder.bindings,
34
- };
35
- }
36
-
37
- function replaceKeyBindings(raw, client) {
38
- const bindingsHolder = {
39
- bindings: [],
40
- };
41
- const builder = raw;
42
-
43
- const values = raw.bindings;
44
- const regex = /\\?(:(\w+):(?=::)|:(\w+):(?!:)|:(\w+))/g;
45
-
46
- const sql = raw.sql.replace(regex, function (match, p1, p2, p3, p4) {
47
- if (match !== p1) {
48
- return p1;
49
- }
50
-
51
- const part = p2 || p3 || p4;
52
- const key = match.trim();
53
- const isIdentifier = key[key.length - 1] === ':';
54
- const value = values[part];
55
-
56
- if (value === undefined) {
57
- if (Object.prototype.hasOwnProperty.call(values, part)) {
58
- bindingsHolder.bindings.push(value);
59
- }
60
-
61
- return match;
62
- }
63
-
64
- if (isIdentifier) {
65
- return match.replace(
66
- p1,
67
- columnize(value, builder, client, bindingsHolder)
68
- );
69
- }
70
-
71
- return match.replace(p1, client.parameter(value, builder, bindingsHolder));
72
- });
73
-
74
- return {
75
- method: 'raw',
76
- sql,
77
- bindings: bindingsHolder.bindings,
78
- };
79
- }
80
-
81
- module.exports = {
82
- replaceKeyBindings,
83
- replaceRawArrBindings,
84
- };
1
+ const { columnize } = require('./wrappingFormatter');
2
+
3
+ function replaceRawArrBindings(raw, client) {
4
+ const bindingsHolder = {
5
+ bindings: [],
6
+ };
7
+ const builder = raw;
8
+
9
+ const expectedBindings = raw.bindings.length;
10
+ const values = raw.bindings;
11
+ let index = 0;
12
+
13
+ const sql = raw.sql.replace(/\\?\?\??/g, function (match) {
14
+ if (match === '\\?') {
15
+ return match;
16
+ }
17
+
18
+ const value = values[index++];
19
+
20
+ if (match === '??') {
21
+ return columnize(value, builder, client, bindingsHolder);
22
+ }
23
+ return client.parameter(value, builder, bindingsHolder);
24
+ });
25
+
26
+ if (expectedBindings !== index) {
27
+ throw new Error(`Expected ${expectedBindings} bindings, saw ${index}`);
28
+ }
29
+
30
+ return {
31
+ method: 'raw',
32
+ sql,
33
+ bindings: bindingsHolder.bindings,
34
+ };
35
+ }
36
+
37
+ function replaceKeyBindings(raw, client) {
38
+ const bindingsHolder = {
39
+ bindings: [],
40
+ };
41
+ const builder = raw;
42
+
43
+ const values = raw.bindings;
44
+ const regex = /\\?(:(\w+):(?=::)|:(\w+):(?!:)|:(\w+))/g;
45
+
46
+ const sql = raw.sql.replace(regex, function (match, p1, p2, p3, p4) {
47
+ if (match !== p1) {
48
+ return p1;
49
+ }
50
+
51
+ const part = p2 || p3 || p4;
52
+ const key = match.trim();
53
+ const isIdentifier = key[key.length - 1] === ':';
54
+ const value = values[part];
55
+
56
+ if (value === undefined) {
57
+ if (Object.prototype.hasOwnProperty.call(values, part)) {
58
+ bindingsHolder.bindings.push(value);
59
+ }
60
+
61
+ return match;
62
+ }
63
+
64
+ if (isIdentifier) {
65
+ return match.replace(
66
+ p1,
67
+ columnize(value, builder, client, bindingsHolder)
68
+ );
69
+ }
70
+
71
+ return match.replace(p1, client.parameter(value, builder, bindingsHolder));
72
+ });
73
+
74
+ return {
75
+ method: 'raw',
76
+ sql,
77
+ bindings: bindingsHolder.bindings,
78
+ };
79
+ }
80
+
81
+ module.exports = {
82
+ replaceKeyBindings,
83
+ replaceRawArrBindings,
84
+ };