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,59 +1,59 @@
1
- const chunk = require('lodash/chunk');
2
- const flatten = require('lodash/flatten');
3
- const delay = require('./delay');
4
- const { isNumber } = require('./is');
5
-
6
- module.exports = function batchInsert(
7
- client,
8
- tableName,
9
- batch,
10
- chunkSize = 1000
11
- ) {
12
- let returning = void 0;
13
- let transaction = null;
14
-
15
- const runInTransaction = (cb) => {
16
- if (transaction) {
17
- return cb(transaction);
18
- }
19
- return client.transaction(cb);
20
- };
21
-
22
- return Object.assign(
23
- Promise.resolve().then(async () => {
24
- if (!isNumber(chunkSize) || chunkSize < 1) {
25
- throw new TypeError(`Invalid chunkSize: ${chunkSize}`);
26
- }
27
-
28
- if (!Array.isArray(batch)) {
29
- throw new TypeError(
30
- `Invalid batch: Expected array, got ${typeof batch}`
31
- );
32
- }
33
-
34
- const chunks = chunk(batch, chunkSize);
35
-
36
- //Next tick to ensure wrapper functions are called if needed
37
- await delay(1);
38
- return runInTransaction(async (tr) => {
39
- const chunksResults = [];
40
- for (const items of chunks) {
41
- chunksResults.push(await tr(tableName).insert(items, returning));
42
- }
43
- return flatten(chunksResults);
44
- });
45
- }),
46
- {
47
- returning(columns) {
48
- returning = columns;
49
-
50
- return this;
51
- },
52
- transacting(tr) {
53
- transaction = tr;
54
-
55
- return this;
56
- },
57
- }
58
- );
59
- };
1
+ const chunk = require('lodash/chunk');
2
+ const flatten = require('lodash/flatten');
3
+ const delay = require('./delay');
4
+ const { isNumber } = require('./is');
5
+
6
+ module.exports = function batchInsert(
7
+ client,
8
+ tableName,
9
+ batch,
10
+ chunkSize = 1000
11
+ ) {
12
+ let returning = void 0;
13
+ let transaction = null;
14
+
15
+ const runInTransaction = (cb) => {
16
+ if (transaction) {
17
+ return cb(transaction);
18
+ }
19
+ return client.transaction(cb);
20
+ };
21
+
22
+ return Object.assign(
23
+ Promise.resolve().then(async () => {
24
+ if (!isNumber(chunkSize) || chunkSize < 1) {
25
+ throw new TypeError(`Invalid chunkSize: ${chunkSize}`);
26
+ }
27
+
28
+ if (!Array.isArray(batch)) {
29
+ throw new TypeError(
30
+ `Invalid batch: Expected array, got ${typeof batch}`
31
+ );
32
+ }
33
+
34
+ const chunks = chunk(batch, chunkSize);
35
+
36
+ //Next tick to ensure wrapper functions are called if needed
37
+ await delay(1);
38
+ return runInTransaction(async (tr) => {
39
+ const chunksResults = [];
40
+ for (const items of chunks) {
41
+ chunksResults.push(await tr(tableName).insert(items, returning));
42
+ }
43
+ return flatten(chunksResults);
44
+ });
45
+ }),
46
+ {
47
+ returning(columns) {
48
+ returning = columns;
49
+
50
+ return this;
51
+ },
52
+ transacting(tr) {
53
+ transaction = tr;
54
+
55
+ return this;
56
+ },
57
+ }
58
+ );
59
+ };
package/lib/util/delay.js CHANGED
@@ -1,6 +1,6 @@
1
- /**
2
- * @param {number} delay
3
- * @returns {Promise<void>}
4
- */
5
- module.exports = (delay) =>
6
- new Promise((resolve) => setTimeout(resolve, delay));
1
+ /**
2
+ * @param {number} delay
3
+ * @returns {Promise<void>}
4
+ */
5
+ module.exports = (delay) =>
6
+ new Promise((resolve) => setTimeout(resolve, delay));
@@ -1,9 +1,9 @@
1
- const Formatter = require('../formatter');
2
-
3
- const fakeClient = {
4
- formatter(builder) {
5
- return new Formatter(fakeClient, builder);
6
- },
7
- };
8
-
9
- module.exports = fakeClient;
1
+ const Formatter = require('../formatter');
2
+
3
+ const fakeClient = {
4
+ formatter(builder) {
5
+ return new Formatter(fakeClient, builder);
6
+ },
7
+ };
8
+
9
+ module.exports = fakeClient;
@@ -1,13 +1,13 @@
1
- const noop = require('./noop');
2
-
3
- const finallyMixin = (prototype) =>
4
- Object.assign(prototype, {
5
- finally(onFinally) {
6
- return this.then().finally(onFinally);
7
- },
8
- });
9
-
10
- // FYI: Support for `Promise.prototype.finally` was not introduced until Node 9.
11
- // Therefore, Knex will need to conditionally inject support for `.finally(..)`
12
- // until support for Node 8 is officially dropped.
13
- module.exports = Promise.prototype.finally ? finallyMixin : noop;
1
+ const noop = require('./noop');
2
+
3
+ const finallyMixin = (prototype) =>
4
+ Object.assign(prototype, {
5
+ finally(onFinally) {
6
+ return this.then().finally(onFinally);
7
+ },
8
+ });
9
+
10
+ // FYI: Support for `Promise.prototype.finally` was not introduced until Node 9.
11
+ // Therefore, Knex will need to conditionally inject support for `.finally(..)`
12
+ // until support for Node 8 is officially dropped.
13
+ module.exports = Promise.prototype.finally ? finallyMixin : noop;
package/lib/util/fs.js CHANGED
@@ -1,76 +1,76 @@
1
- const fs = require('fs');
2
- const flatten = require('lodash/flatten');
3
- const os = require('os');
4
- const path = require('path');
5
- const { promisify } = require('util');
6
-
7
- // Promisify common fs functions.
8
- const stat = promisify(fs.stat);
9
- const readFile = promisify(fs.readFile);
10
- const writeFile = promisify(fs.writeFile);
11
- const readdir = promisify(fs.readdir);
12
- const mkdir = promisify(fs.mkdir);
13
-
14
- /**
15
- * Creates a temporary directory and returns it path.
16
- *
17
- * @returns {Promise<string>}
18
- */
19
- function createTemp() {
20
- return promisify(fs.mkdtemp)(`${os.tmpdir()}${path.sep}`);
21
- }
22
-
23
- /**
24
- * Ensures the given path exists.
25
- * - If the path already exist, it's fine - it does nothing.
26
- * - If the path doesn't exist, it will create it.
27
- *
28
- * @param {string} path
29
- * @returns {Promise}
30
- */
31
- function ensureDirectoryExists(dir) {
32
- return stat(dir).catch(() => mkdir(dir, { recursive: true }));
33
- }
34
-
35
- /**
36
- * Read a directory,
37
- * sorting folders and files by alphabetically order.
38
- * Can be browsed recursively.
39
- *
40
- * @param {string} dir
41
- * The directory to analyse
42
- *
43
- * @param {boolean} recursive
44
- * Browse directory recursively
45
- *
46
- * @returns {Promise<[string]>}
47
- * All found files, concatenated to the current dir
48
- */
49
- async function getFilepathsInFolder(dir, recursive = false) {
50
- const pathsList = await readdir(dir);
51
- return flatten(
52
- await Promise.all(
53
- pathsList.sort().map(async (currentPath) => {
54
- const currentFile = path.resolve(dir, currentPath);
55
- const statFile = await stat(currentFile);
56
- if (statFile && statFile.isDirectory()) {
57
- if (recursive) {
58
- return await getFilepathsInFolder(currentFile, true);
59
- }
60
- return [];
61
- }
62
- return [currentFile];
63
- })
64
- )
65
- );
66
- }
67
-
68
- module.exports = {
69
- stat,
70
- readdir,
71
- readFile,
72
- writeFile,
73
- createTemp,
74
- ensureDirectoryExists,
75
- getFilepathsInFolder,
76
- };
1
+ const fs = require('fs');
2
+ const flatten = require('lodash/flatten');
3
+ const os = require('os');
4
+ const path = require('path');
5
+ const { promisify } = require('util');
6
+
7
+ // Promisify common fs functions.
8
+ const stat = promisify(fs.stat);
9
+ const readFile = promisify(fs.readFile);
10
+ const writeFile = promisify(fs.writeFile);
11
+ const readdir = promisify(fs.readdir);
12
+ const mkdir = promisify(fs.mkdir);
13
+
14
+ /**
15
+ * Creates a temporary directory and returns it path.
16
+ *
17
+ * @returns {Promise<string>}
18
+ */
19
+ function createTemp() {
20
+ return promisify(fs.mkdtemp)(`${os.tmpdir()}${path.sep}`);
21
+ }
22
+
23
+ /**
24
+ * Ensures the given path exists.
25
+ * - If the path already exist, it's fine - it does nothing.
26
+ * - If the path doesn't exist, it will create it.
27
+ *
28
+ * @param {string} path
29
+ * @returns {Promise}
30
+ */
31
+ function ensureDirectoryExists(dir) {
32
+ return stat(dir).catch(() => mkdir(dir, { recursive: true }));
33
+ }
34
+
35
+ /**
36
+ * Read a directory,
37
+ * sorting folders and files by alphabetically order.
38
+ * Can be browsed recursively.
39
+ *
40
+ * @param {string} dir
41
+ * The directory to analyse
42
+ *
43
+ * @param {boolean} recursive
44
+ * Browse directory recursively
45
+ *
46
+ * @returns {Promise<[string]>}
47
+ * All found files, concatenated to the current dir
48
+ */
49
+ async function getFilepathsInFolder(dir, recursive = false) {
50
+ const pathsList = await readdir(dir);
51
+ return flatten(
52
+ await Promise.all(
53
+ pathsList.sort().map(async (currentPath) => {
54
+ const currentFile = path.resolve(dir, currentPath);
55
+ const statFile = await stat(currentFile);
56
+ if (statFile && statFile.isDirectory()) {
57
+ if (recursive) {
58
+ return await getFilepathsInFolder(currentFile, true);
59
+ }
60
+ return [];
61
+ }
62
+ return [currentFile];
63
+ })
64
+ )
65
+ );
66
+ }
67
+
68
+ module.exports = {
69
+ stat,
70
+ readdir,
71
+ readFile,
72
+ writeFile,
73
+ createTemp,
74
+ ensureDirectoryExists,
75
+ getFilepathsInFolder,
76
+ };
@@ -1,13 +1,13 @@
1
- const isModuleType = require('./is-module-type');
2
-
3
- /**
4
- * imports 'mjs', else requires.
5
- * NOTE: require me late!
6
- * @param {string} filepath
7
- * @todo WARN on version 10 and '--experimental-modules' and '--esm'
8
- */
9
- module.exports = async function importFile(filepath) {
10
- return (await isModuleType(filepath))
11
- ? import(require('url').pathToFileURL(filepath))
12
- : require(filepath);
13
- };
1
+ const isModuleType = require('./is-module-type');
2
+
3
+ /**
4
+ * imports 'mjs', else requires.
5
+ * NOTE: require me late!
6
+ * @param {string} filepath
7
+ * @todo WARN on version 10 and '--experimental-modules' and '--esm'
8
+ */
9
+ module.exports = async function importFile(filepath) {
10
+ return (await isModuleType(filepath))
11
+ ? import(require('url').pathToFileURL(filepath))
12
+ : require(filepath);
13
+ };
@@ -1,14 +1,14 @@
1
- const { readFile } = require('./fs');
2
-
3
- module.exports = async function isModuleType(filepath) {
4
- if (process.env.npm_package_json) {
5
- // npm >= 7.0.0
6
- const packageJson = JSON.parse(
7
- await readFile(process.env.npm_package_json, 'utf-8')
8
- );
9
- if (packageJson.type === 'module') {
10
- return true;
11
- }
12
- }
13
- return process.env.npm_package_type === 'module' || filepath.endsWith('.mjs');
14
- };
1
+ const { readFile } = require('./fs');
2
+
3
+ module.exports = async function isModuleType(filepath) {
4
+ if (process.env.npm_package_json) {
5
+ // npm >= 7.0.0
6
+ const packageJson = JSON.parse(
7
+ await readFile(process.env.npm_package_json, 'utf-8')
8
+ );
9
+ if (packageJson.type === 'module') {
10
+ return true;
11
+ }
12
+ }
13
+ return process.env.npm_package_type === 'module' || filepath.endsWith('.mjs');
14
+ };
package/lib/util/is.js CHANGED
@@ -1,32 +1,32 @@
1
- function isString(value) {
2
- return typeof value === 'string';
3
- }
4
-
5
- function isNumber(value) {
6
- return typeof value === 'number';
7
- }
8
-
9
- function isBoolean(value) {
10
- return typeof value === 'boolean';
11
- }
12
-
13
- function isUndefined(value) {
14
- return typeof value === 'undefined';
15
- }
16
-
17
- function isObject(value) {
18
- return typeof value === 'object' && value !== null;
19
- }
20
-
21
- function isFunction(value) {
22
- return typeof value === 'function';
23
- }
24
-
25
- module.exports = {
26
- isString,
27
- isNumber,
28
- isBoolean,
29
- isUndefined,
30
- isObject,
31
- isFunction,
32
- };
1
+ function isString(value) {
2
+ return typeof value === 'string';
3
+ }
4
+
5
+ function isNumber(value) {
6
+ return typeof value === 'number';
7
+ }
8
+
9
+ function isBoolean(value) {
10
+ return typeof value === 'boolean';
11
+ }
12
+
13
+ function isUndefined(value) {
14
+ return typeof value === 'undefined';
15
+ }
16
+
17
+ function isObject(value) {
18
+ return typeof value === 'object' && value !== null;
19
+ }
20
+
21
+ function isFunction(value) {
22
+ return typeof value === 'function';
23
+ }
24
+
25
+ module.exports = {
26
+ isString,
27
+ isNumber,
28
+ isBoolean,
29
+ isUndefined,
30
+ isObject,
31
+ isFunction,
32
+ };