knex 2.5.0 → 2.5.1

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 (167) hide show
  1. package/CHANGELOG.md +64 -58
  2. package/CONTRIBUTING.md +194 -194
  3. package/README.md +149 -147
  4. package/UPGRADING.md +245 -233
  5. package/bin/cli.js +475 -473
  6. package/bin/utils/cli-config-utils.js +212 -210
  7. package/bin/utils/constants.js +7 -7
  8. package/bin/utils/migrationsLister.js +37 -37
  9. package/knex.js +23 -23
  10. package/knex.mjs +11 -11
  11. package/lib/builder-interface-augmenter.js +120 -120
  12. package/lib/client.js +495 -495
  13. package/lib/constants.js +61 -61
  14. package/lib/dialects/better-sqlite3/index.js +77 -77
  15. package/lib/dialects/cockroachdb/crdb-columncompiler.js +14 -14
  16. package/lib/dialects/cockroachdb/crdb-querybuilder.js +11 -11
  17. package/lib/dialects/cockroachdb/crdb-querycompiler.js +122 -122
  18. package/lib/dialects/cockroachdb/crdb-tablecompiler.js +37 -37
  19. package/lib/dialects/cockroachdb/crdb-viewcompiler.js +15 -15
  20. package/lib/dialects/cockroachdb/index.js +86 -86
  21. package/lib/dialects/index.js +20 -20
  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 +598 -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/table-creator.js +77 -77
  116. package/lib/migrations/migrate/table-resolver.js +27 -27
  117. package/lib/migrations/seed/Seeder.js +137 -137
  118. package/lib/migrations/seed/seed-stub.js +13 -13
  119. package/lib/migrations/seed/seeder-configuration-merger.js +60 -60
  120. package/lib/migrations/seed/sources/fs-seeds.js +65 -65
  121. package/lib/migrations/util/fs.js +86 -86
  122. package/lib/migrations/util/import-file.js +12 -12
  123. package/lib/migrations/util/is-module-type.js +9 -9
  124. package/lib/migrations/util/template.js +52 -52
  125. package/lib/migrations/util/timestamp.js +14 -14
  126. package/lib/query/analytic.js +52 -52
  127. package/lib/query/constants.js +15 -15
  128. package/lib/query/joinclause.js +270 -270
  129. package/lib/query/method-constants.js +136 -136
  130. package/lib/query/querybuilder.js +1793 -1793
  131. package/lib/query/querycompiler.js +1591 -1591
  132. package/lib/raw.js +139 -139
  133. package/lib/ref.js +39 -39
  134. package/lib/schema/builder.js +115 -115
  135. package/lib/schema/columnbuilder.js +146 -146
  136. package/lib/schema/columncompiler.js +307 -307
  137. package/lib/schema/compiler.js +187 -187
  138. package/lib/schema/internal/helpers.js +55 -55
  139. package/lib/schema/tablebuilder.js +376 -376
  140. package/lib/schema/tablecompiler.js +433 -433
  141. package/lib/schema/viewbuilder.js +92 -92
  142. package/lib/schema/viewcompiler.js +138 -138
  143. package/lib/util/finally-mixin.js +13 -13
  144. package/lib/util/helpers.js +95 -95
  145. package/lib/util/is.js +32 -32
  146. package/lib/util/nanoid.js +40 -40
  147. package/lib/util/noop.js +1 -1
  148. package/lib/util/save-async-stack.js +14 -14
  149. package/lib/util/security.js +26 -26
  150. package/lib/util/string.js +190 -190
  151. package/lib/util/timeout.js +29 -29
  152. package/package.json +11 -10
  153. package/scripts/build.js +125 -125
  154. package/scripts/clean.js +31 -31
  155. package/scripts/docker-compose.yml +152 -152
  156. package/scripts/next-release-howto.md +24 -24
  157. package/scripts/release.sh +2 -0
  158. package/scripts/runkit-example.js +35 -34
  159. package/scripts/stress-test/docker-compose.yml +57 -57
  160. package/scripts/stress-test/knex-stress-test.js +212 -208
  161. package/scripts/stress-test/mysql2-random-hanging-every-now-and-then.js +149 -145
  162. package/scripts/stress-test/mysql2-sudden-exit-without-error.js +101 -100
  163. package/scripts/stress-test/reconnect-test-mysql-based-drivers.js +188 -184
  164. package/scripts/update_gitignore_for_tsc_output.js +90 -90
  165. package/types/index.d.ts +3274 -3273
  166. package/types/result.d.ts +27 -27
  167. package/types/tables.d.ts +4 -4
@@ -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
+ };