knex 3.2.3 → 3.2.5

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 +2447 -2441
  2. package/CONTRIBUTING.md +190 -190
  3. package/LICENSE +22 -22
  4. package/README.md +177 -156
  5. package/UPGRADING.md +245 -245
  6. package/bin/cli.js +516 -516
  7. package/bin/knexfile-runtime-error.js +27 -27
  8. package/bin/utils/cli-config-utils.js +217 -217
  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 -585
  15. package/lib/constants.js +61 -61
  16. package/lib/dialects/better-sqlite3/index.js +101 -101
  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 -46
  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 -498
  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 -393
  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 -317
  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 -426
  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 -210
  52. package/lib/dialects/oracle/utils.js +107 -107
  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 -373
  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 -162
  67. package/lib/dialects/postgres/schema/pg-compiler.js +138 -138
  68. package/lib/dialects/postgres/schema/pg-tablecompiler.js +331 -331
  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 -134
  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 -172
  80. package/lib/dialects/sqlite3/index.js +263 -263
  81. package/lib/dialects/sqlite3/query/sqlite-querybuilder.js +33 -33
  82. package/lib/dialects/sqlite3/query/sqlite-querycompiler.js +341 -341
  83. package/lib/dialects/sqlite3/schema/ddl.js +380 -380
  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 -364
  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 -417
  100. package/lib/formatter/formatterUtils.js +42 -42
  101. package/lib/formatter/rawFormatter.js +84 -84
  102. package/lib/formatter/wrappingFormatter.js +253 -253
  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 -632
  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 -1634
  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 -379
  163. package/lib/schema/tablecompiler.js +450 -450
  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 -32
  173. package/lib/util/string.js +190 -190
  174. package/lib/util/timeout.js +29 -29
  175. package/package.json +295 -293
  176. package/scripts/act-testing/act.sh +19 -19
  177. package/scripts/act-testing/merged-no-label.json +11 -11
  178. package/scripts/act-testing/merged-patch-labeled.json +12 -12
  179. package/scripts/act-testing/merged-skip-labeled.json +12 -12
  180. package/scripts/act-testing/not-merged-patch-labeled.json +12 -12
  181. package/scripts/build-for-release.sh +121 -121
  182. package/scripts/build.js +125 -125
  183. package/scripts/clean.js +31 -31
  184. package/scripts/docker-compose.yml +150 -150
  185. package/scripts/format-changelog.js +55 -55
  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 -55
  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.mts +14 -0
  197. package/types/index.d.ts +3321 -3321
  198. package/types/result.d.ts +27 -27
  199. package/types/tables.d.ts +4 -4
@@ -1,13 +1,13 @@
1
- /**
2
- * @param { import("knex").Knex } knex
3
- * @returns { Promise<void> }
4
- */
5
- exports.seed = async function(knex) {
6
- // Deletes ALL existing entries
7
- await knex('table_name').del()
8
- await knex('table_name').insert([
9
- {id: 1, colName: 'rowValue1'},
10
- {id: 2, colName: 'rowValue2'},
11
- {id: 3, colName: 'rowValue3'}
12
- ]);
13
- };
1
+ /**
2
+ * @param { import("knex").Knex } knex
3
+ * @returns { Promise<void> }
4
+ */
5
+ exports.seed = async function(knex) {
6
+ // Deletes ALL existing entries
7
+ await knex('table_name').del()
8
+ await knex('table_name').insert([
9
+ {id: 1, colName: 'rowValue1'},
10
+ {id: 2, colName: 'rowValue2'},
11
+ {id: 3, colName: 'rowValue3'}
12
+ ]);
13
+ };
@@ -1,11 +1,11 @@
1
- exports.seed = (knex) ->
2
- # Deletes ALL existing entries
3
- knex('table_name').del()
4
- .then(() ->
5
- # Inserts seed entries
6
- knex('table_name').insert([
7
- {id: 1, colName: 'rowValue1'},
8
- {id: 2, colName: 'rowValue2'},
9
- {id: 3, colName: 'rowValue3'}
10
- ])
11
- )
1
+ exports.seed = (knex) ->
2
+ # Deletes ALL existing entries
3
+ knex('table_name').del()
4
+ .then(() ->
5
+ # Inserts seed entries
6
+ knex('table_name').insert([
7
+ {id: 1, colName: 'rowValue1'},
8
+ {id: 2, colName: 'rowValue2'},
9
+ {id: 3, colName: 'rowValue3'}
10
+ ])
11
+ )
@@ -1,12 +1,12 @@
1
-
2
- export const seed = async (knex) => {
3
- // Deletes ALL existing entries
4
- await knex('table_name').del();
5
-
6
- // Inserts seed entries
7
- await knex('table_name').insert([
8
- {id: 1, colName: 'rowValue1'},
9
- {id: 2, colName: 'rowValue2'},
10
- {id: 3, colName: 'rowValue3'}
11
- ]);
12
- };
1
+
2
+ export const seed = async (knex) => {
3
+ // Deletes ALL existing entries
4
+ await knex('table_name').del();
5
+
6
+ // Inserts seed entries
7
+ await knex('table_name').insert([
8
+ {id: 1, colName: 'rowValue1'},
9
+ {id: 2, colName: 'rowValue2'},
10
+ {id: 3, colName: 'rowValue3'}
11
+ ]);
12
+ };
@@ -1,13 +1,13 @@
1
- import type { Knex } from "knex";
2
-
3
- export async function seed(knex: Knex): Promise<void> {
4
- // Deletes ALL existing entries
5
- await knex("table_name").del();
6
-
7
- // Inserts seed entries
8
- await knex("table_name").insert([
9
- { id: 1, colName: "rowValue1" },
10
- { id: 2, colName: "rowValue2" },
11
- { id: 3, colName: "rowValue3" }
12
- ]);
13
- };
1
+ import type { Knex } from "knex";
2
+
3
+ export async function seed(knex: Knex): Promise<void> {
4
+ // Deletes ALL existing entries
5
+ await knex("table_name").del();
6
+
7
+ // Inserts seed entries
8
+ await knex("table_name").insert([
9
+ { id: 1, colName: "rowValue1" },
10
+ { id: 2, colName: "rowValue2" },
11
+ { id: 3, colName: "rowValue3" }
12
+ ]);
13
+ };
@@ -1,86 +1,86 @@
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
- function existsSync(path) {
15
- try {
16
- fs.accessSync(path);
17
- return true;
18
- } catch (e) {
19
- return false;
20
- }
21
- }
22
-
23
- /**
24
- * Creates a temporary directory and returns it path.
25
- *
26
- * @returns {Promise<string>}
27
- */
28
- function createTemp() {
29
- return promisify(fs.mkdtemp)(`${os.tmpdir()}${path.sep}`);
30
- }
31
-
32
- /**
33
- * Ensures the given path exists.
34
- * - If the path already exist, it's fine - it does nothing.
35
- * - If the path doesn't exist, it will create it.
36
- *
37
- * @param {string} path
38
- * @returns {Promise}
39
- */
40
- function ensureDirectoryExists(dir) {
41
- return stat(dir).catch(() => mkdir(dir, { recursive: true }));
42
- }
43
-
44
- /**
45
- * Read a directory,
46
- * sorting folders and files by alphabetically order.
47
- * Can be browsed recursively.
48
- *
49
- * @param {string} dir
50
- * The directory to analyse
51
- *
52
- * @param {boolean} recursive
53
- * Browse directory recursively
54
- *
55
- * @returns {Promise<[string]>}
56
- * All found files, concatenated to the current dir
57
- */
58
- async function getFilepathsInFolder(dir, recursive = false) {
59
- const pathsList = await readdir(dir);
60
- return flatten(
61
- await Promise.all(
62
- pathsList.sort().map(async (currentPath) => {
63
- const currentFile = path.resolve(dir, currentPath);
64
- const statFile = await stat(currentFile);
65
- if (statFile && statFile.isDirectory()) {
66
- if (recursive) {
67
- return await getFilepathsInFolder(currentFile, true);
68
- }
69
- return [];
70
- }
71
- return [currentFile];
72
- })
73
- )
74
- );
75
- }
76
-
77
- module.exports = {
78
- existsSync,
79
- stat,
80
- readdir,
81
- readFile,
82
- writeFile,
83
- createTemp,
84
- ensureDirectoryExists,
85
- getFilepathsInFolder,
86
- };
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
+ function existsSync(path) {
15
+ try {
16
+ fs.accessSync(path);
17
+ return true;
18
+ } catch (e) {
19
+ return false;
20
+ }
21
+ }
22
+
23
+ /**
24
+ * Creates a temporary directory and returns it path.
25
+ *
26
+ * @returns {Promise<string>}
27
+ */
28
+ function createTemp() {
29
+ return promisify(fs.mkdtemp)(`${os.tmpdir()}${path.sep}`);
30
+ }
31
+
32
+ /**
33
+ * Ensures the given path exists.
34
+ * - If the path already exist, it's fine - it does nothing.
35
+ * - If the path doesn't exist, it will create it.
36
+ *
37
+ * @param {string} path
38
+ * @returns {Promise}
39
+ */
40
+ function ensureDirectoryExists(dir) {
41
+ return stat(dir).catch(() => mkdir(dir, { recursive: true }));
42
+ }
43
+
44
+ /**
45
+ * Read a directory,
46
+ * sorting folders and files by alphabetically order.
47
+ * Can be browsed recursively.
48
+ *
49
+ * @param {string} dir
50
+ * The directory to analyse
51
+ *
52
+ * @param {boolean} recursive
53
+ * Browse directory recursively
54
+ *
55
+ * @returns {Promise<[string]>}
56
+ * All found files, concatenated to the current dir
57
+ */
58
+ async function getFilepathsInFolder(dir, recursive = false) {
59
+ const pathsList = await readdir(dir);
60
+ return flatten(
61
+ await Promise.all(
62
+ pathsList.sort().map(async (currentPath) => {
63
+ const currentFile = path.resolve(dir, currentPath);
64
+ const statFile = await stat(currentFile);
65
+ if (statFile && statFile.isDirectory()) {
66
+ if (recursive) {
67
+ return await getFilepathsInFolder(currentFile, true);
68
+ }
69
+ return [];
70
+ }
71
+ return [currentFile];
72
+ })
73
+ )
74
+ );
75
+ }
76
+
77
+ module.exports = {
78
+ existsSync,
79
+ stat,
80
+ readdir,
81
+ readFile,
82
+ writeFile,
83
+ createTemp,
84
+ ensureDirectoryExists,
85
+ getFilepathsInFolder,
86
+ };
@@ -1,12 +1,12 @@
1
- const isModuleType = require('./is-module-type');
2
-
3
- /**
4
- * imports 'mjs', else requires.
5
- * NOTE: require me late!
6
- * @param {string} filepath
7
- */
8
- module.exports = async function importFile(filepath) {
9
- return (await isModuleType(filepath))
10
- ? import(require('url').pathToFileURL(filepath))
11
- : require(filepath);
12
- };
1
+ const isModuleType = require('./is-module-type');
2
+
3
+ /**
4
+ * imports 'mjs', else requires.
5
+ * NOTE: require me late!
6
+ * @param {string} filepath
7
+ */
8
+ module.exports = async function importFile(filepath) {
9
+ return (await isModuleType(filepath))
10
+ ? import(require('url').pathToFileURL(filepath))
11
+ : require(filepath);
12
+ };
@@ -1,9 +1,9 @@
1
- const getPackageType = require('get-package-type');
2
-
3
- module.exports = async function isModuleType(filepath) {
4
- return (
5
- filepath.endsWith('.mjs') ||
6
- (!filepath.endsWith('.cjs') &&
7
- (await getPackageType(filepath)) === 'module')
8
- );
9
- };
1
+ const getPackageType = require('get-package-type');
2
+
3
+ module.exports = async function isModuleType(filepath) {
4
+ return (
5
+ filepath.endsWith('.mjs') ||
6
+ (!filepath.endsWith('.cjs') &&
7
+ (await getPackageType(filepath)) === 'module')
8
+ );
9
+ };
@@ -1,52 +1,52 @@
1
- const template = require('lodash/template');
2
-
3
- const { readFile, writeFile } = require('./fs');
4
-
5
- /**
6
- * Light wrapper over lodash templates making it safer to be used with javascript source code.
7
- *
8
- * In particular, doesn't interfere with use of interpolated strings in javascript.
9
- *
10
- * @param {string} content Template source
11
- * @param {_.TemplateOptions} options Template options
12
- */
13
- const jsSourceTemplate = (content, options) =>
14
- template(content, {
15
- interpolate: /<%=([\s\S]+?)%>/g,
16
- ...options,
17
- });
18
-
19
- /**
20
- * Compile the contents of specified (javascript) file as a lodash template
21
- *
22
- * @param {string} filePath Path of file to be used as template
23
- * @param {_.TemplateOptions} options Lodash template options
24
- */
25
- const jsFileTemplate = async (filePath, options) => {
26
- const contentBuffer = await readFile(filePath);
27
- return jsSourceTemplate(contentBuffer.toString(), options);
28
- };
29
-
30
- /**
31
- * Write a javascript file using another file as a (lodash) template
32
- *
33
- * @param {string} targetFilePath
34
- * @param {string} sourceFilePath
35
- * @param {_.TemplateOptions} options options passed to lodash templates
36
- */
37
- const writeJsFileUsingTemplate = async (
38
- targetFilePath,
39
- sourceFilePath,
40
- options,
41
- variables
42
- ) =>
43
- writeFile(
44
- targetFilePath,
45
- (await jsFileTemplate(sourceFilePath, options))(variables)
46
- );
47
-
48
- module.exports = {
49
- jsSourceTemplate,
50
- jsFileTemplate,
51
- writeJsFileUsingTemplate,
52
- };
1
+ const template = require('lodash/template');
2
+
3
+ const { readFile, writeFile } = require('./fs');
4
+
5
+ /**
6
+ * Light wrapper over lodash templates making it safer to be used with javascript source code.
7
+ *
8
+ * In particular, doesn't interfere with use of interpolated strings in javascript.
9
+ *
10
+ * @param {string} content Template source
11
+ * @param {_.TemplateOptions} options Template options
12
+ */
13
+ const jsSourceTemplate = (content, options) =>
14
+ template(content, {
15
+ interpolate: /<%=([\s\S]+?)%>/g,
16
+ ...options,
17
+ });
18
+
19
+ /**
20
+ * Compile the contents of specified (javascript) file as a lodash template
21
+ *
22
+ * @param {string} filePath Path of file to be used as template
23
+ * @param {_.TemplateOptions} options Lodash template options
24
+ */
25
+ const jsFileTemplate = async (filePath, options) => {
26
+ const contentBuffer = await readFile(filePath);
27
+ return jsSourceTemplate(contentBuffer.toString(), options);
28
+ };
29
+
30
+ /**
31
+ * Write a javascript file using another file as a (lodash) template
32
+ *
33
+ * @param {string} targetFilePath
34
+ * @param {string} sourceFilePath
35
+ * @param {_.TemplateOptions} options options passed to lodash templates
36
+ */
37
+ const writeJsFileUsingTemplate = async (
38
+ targetFilePath,
39
+ sourceFilePath,
40
+ options,
41
+ variables
42
+ ) =>
43
+ writeFile(
44
+ targetFilePath,
45
+ (await jsFileTemplate(sourceFilePath, options))(variables)
46
+ );
47
+
48
+ module.exports = {
49
+ jsSourceTemplate,
50
+ jsFileTemplate,
51
+ writeJsFileUsingTemplate,
52
+ };
@@ -1,14 +1,14 @@
1
- function yyyymmddhhmmss() {
2
- const now = new Date();
3
-
4
- return (
5
- now.getUTCFullYear().toString() +
6
- (now.getUTCMonth() + 1).toString().padStart(2, '0') +
7
- now.getUTCDate().toString().padStart(2, '0') +
8
- now.getUTCHours().toString().padStart(2, '0') +
9
- now.getUTCMinutes().toString().padStart(2, '0') +
10
- now.getUTCSeconds().toString().padStart(2, '0')
11
- );
12
- }
13
-
14
- module.exports = { yyyymmddhhmmss };
1
+ function yyyymmddhhmmss() {
2
+ const now = new Date();
3
+
4
+ return (
5
+ now.getUTCFullYear().toString() +
6
+ (now.getUTCMonth() + 1).toString().padStart(2, '0') +
7
+ now.getUTCDate().toString().padStart(2, '0') +
8
+ now.getUTCHours().toString().padStart(2, '0') +
9
+ now.getUTCMinutes().toString().padStart(2, '0') +
10
+ now.getUTCSeconds().toString().padStart(2, '0')
11
+ );
12
+ }
13
+
14
+ module.exports = { yyyymmddhhmmss };
@@ -1,52 +1,52 @@
1
- const assert = require('assert');
2
-
3
- // Analytic
4
- // -------
5
-
6
- // The "Analytic" is an object holding any necessary info about a analytic function
7
- // e.g row_number, rank, dense_rank,
8
- class Analytic {
9
- constructor(method, schema, alias, orderBy, partitions) {
10
- this.schema = schema;
11
- this.type = 'analytic';
12
- this.method = method;
13
- this.order = orderBy || [];
14
- this.partitions = partitions || [];
15
- this.alias = alias;
16
- this.and = this;
17
-
18
- this.grouping = 'columns';
19
- }
20
-
21
- partitionBy(column, direction) {
22
- assert(
23
- Array.isArray(column) || typeof column === 'string',
24
- `The argument to an analytic partitionBy function must be either a string
25
- or an array of string.`
26
- );
27
-
28
- if (Array.isArray(column)) {
29
- this.partitions = this.partitions.concat(column);
30
- } else {
31
- this.partitions.push({ column: column, order: direction });
32
- }
33
- return this;
34
- }
35
-
36
- orderBy(column, direction) {
37
- assert(
38
- Array.isArray(column) || typeof column === 'string',
39
- `The argument to an analytic orderBy function must be either a string
40
- or an array of string.`
41
- );
42
-
43
- if (Array.isArray(column)) {
44
- this.order = this.order.concat(column);
45
- } else {
46
- this.order.push({ column: column, order: direction });
47
- }
48
- return this;
49
- }
50
- }
51
-
52
- module.exports = Analytic;
1
+ const assert = require('assert');
2
+
3
+ // Analytic
4
+ // -------
5
+
6
+ // The "Analytic" is an object holding any necessary info about a analytic function
7
+ // e.g row_number, rank, dense_rank,
8
+ class Analytic {
9
+ constructor(method, schema, alias, orderBy, partitions) {
10
+ this.schema = schema;
11
+ this.type = 'analytic';
12
+ this.method = method;
13
+ this.order = orderBy || [];
14
+ this.partitions = partitions || [];
15
+ this.alias = alias;
16
+ this.and = this;
17
+
18
+ this.grouping = 'columns';
19
+ }
20
+
21
+ partitionBy(column, direction) {
22
+ assert(
23
+ Array.isArray(column) || typeof column === 'string',
24
+ `The argument to an analytic partitionBy function must be either a string
25
+ or an array of string.`
26
+ );
27
+
28
+ if (Array.isArray(column)) {
29
+ this.partitions = this.partitions.concat(column);
30
+ } else {
31
+ this.partitions.push({ column: column, order: direction });
32
+ }
33
+ return this;
34
+ }
35
+
36
+ orderBy(column, direction) {
37
+ assert(
38
+ Array.isArray(column) || typeof column === 'string',
39
+ `The argument to an analytic orderBy function must be either a string
40
+ or an array of string.`
41
+ );
42
+
43
+ if (Array.isArray(column)) {
44
+ this.order = this.order.concat(column);
45
+ } else {
46
+ this.order.push({ column: column, order: direction });
47
+ }
48
+ return this;
49
+ }
50
+ }
51
+
52
+ module.exports = Analytic;
@@ -1,15 +1,15 @@
1
- /**
2
- * internal constants, do not use in application code
3
- */
4
- module.exports = {
5
- lockMode: {
6
- forShare: 'forShare',
7
- forUpdate: 'forUpdate',
8
- forNoKeyUpdate: 'forNoKeyUpdate',
9
- forKeyShare: 'forKeyShare',
10
- },
11
- waitMode: {
12
- skipLocked: 'skipLocked',
13
- noWait: 'noWait',
14
- },
15
- };
1
+ /**
2
+ * internal constants, do not use in application code
3
+ */
4
+ module.exports = {
5
+ lockMode: {
6
+ forShare: 'forShare',
7
+ forUpdate: 'forUpdate',
8
+ forNoKeyUpdate: 'forNoKeyUpdate',
9
+ forKeyShare: 'forKeyShare',
10
+ },
11
+ waitMode: {
12
+ skipLocked: 'skipLocked',
13
+ noWait: 'noWait',
14
+ },
15
+ };