knex 2.4.2 → 2.5.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 +54 -18
  2. package/CONTRIBUTING.md +194 -194
  3. package/LICENSE +22 -22
  4. package/README.md +147 -148
  5. package/UPGRADING.md +233 -233
  6. package/bin/cli.js +473 -473
  7. package/bin/utils/cli-config-utils.js +210 -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 -0
  12. package/lib/builder-interface-augmenter.js +120 -120
  13. package/lib/client.js +495 -475
  14. package/lib/constants.js +61 -61
  15. package/lib/dialects/better-sqlite3/index.js +77 -72
  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/index.js +33 -33
  23. package/lib/dialects/mssql/index.js +500 -495
  24. package/lib/dialects/mssql/mssql-formatter.js +34 -34
  25. package/lib/dialects/mssql/query/mssql-querycompiler.js +601 -600
  26. package/lib/dialects/mssql/schema/mssql-columncompiler.js +185 -185
  27. package/lib/dialects/mssql/schema/mssql-compiler.js +91 -91
  28. package/lib/dialects/mssql/schema/mssql-tablecompiler.js +378 -378
  29. package/lib/dialects/mssql/schema/mssql-viewcompiler.js +55 -55
  30. package/lib/dialects/mssql/transaction.js +176 -176
  31. package/lib/dialects/mysql/index.js +201 -201
  32. package/lib/dialects/mysql/query/mysql-querycompiler.js +274 -274
  33. package/lib/dialects/mysql/schema/mysql-columncompiler.js +193 -193
  34. package/lib/dialects/mysql/schema/mysql-compiler.js +60 -60
  35. package/lib/dialects/mysql/schema/mysql-tablecompiler.js +381 -381
  36. package/lib/dialects/mysql/schema/mysql-viewbuilder.js +21 -21
  37. package/lib/dialects/mysql/schema/mysql-viewcompiler.js +15 -15
  38. package/lib/dialects/mysql/transaction.js +46 -46
  39. package/lib/dialects/mysql2/index.js +53 -33
  40. package/lib/dialects/mysql2/transaction.js +44 -44
  41. package/lib/dialects/oracle/DEAD_CODE.md +5 -5
  42. package/lib/dialects/oracle/index.js +92 -92
  43. package/lib/dialects/oracle/query/oracle-querycompiler.js +343 -342
  44. package/lib/dialects/oracle/schema/internal/incrementUtils.js +20 -20
  45. package/lib/dialects/oracle/schema/internal/trigger.js +135 -135
  46. package/lib/dialects/oracle/schema/oracle-columnbuilder.js +17 -17
  47. package/lib/dialects/oracle/schema/oracle-columncompiler.js +126 -126
  48. package/lib/dialects/oracle/schema/oracle-compiler.js +122 -122
  49. package/lib/dialects/oracle/schema/oracle-tablecompiler.js +190 -190
  50. package/lib/dialects/oracle/utils.js +87 -87
  51. package/lib/dialects/oracledb/index.js +327 -327
  52. package/lib/dialects/oracledb/query/oracledb-querycompiler.js +481 -481
  53. package/lib/dialects/oracledb/schema/oracledb-columncompiler.js +61 -55
  54. package/lib/dialects/oracledb/schema/oracledb-tablecompiler.js +19 -19
  55. package/lib/dialects/oracledb/schema/oracledb-viewbuilder.js +13 -13
  56. package/lib/dialects/oracledb/schema/oracledb-viewcompiler.js +19 -19
  57. package/lib/dialects/oracledb/transaction.js +98 -98
  58. package/lib/dialects/oracledb/utils.js +208 -208
  59. package/lib/dialects/pgnative/index.js +60 -60
  60. package/lib/dialects/postgres/execution/pg-transaction.js +19 -12
  61. package/lib/dialects/postgres/index.js +358 -358
  62. package/lib/dialects/postgres/query/pg-querybuilder.js +43 -38
  63. package/lib/dialects/postgres/query/pg-querycompiler.js +400 -395
  64. package/lib/dialects/postgres/schema/pg-columncompiler.js +156 -156
  65. package/lib/dialects/postgres/schema/pg-compiler.js +138 -138
  66. package/lib/dialects/postgres/schema/pg-tablecompiler.js +304 -299
  67. package/lib/dialects/postgres/schema/pg-viewbuilder.js +21 -21
  68. package/lib/dialects/postgres/schema/pg-viewcompiler.js +35 -35
  69. package/lib/dialects/redshift/index.js +86 -86
  70. package/lib/dialects/redshift/query/redshift-querycompiler.js +163 -163
  71. package/lib/dialects/redshift/schema/redshift-columnbuilder.js +22 -22
  72. package/lib/dialects/redshift/schema/redshift-columncompiler.js +67 -67
  73. package/lib/dialects/redshift/schema/redshift-compiler.js +14 -14
  74. package/lib/dialects/redshift/schema/redshift-tablecompiler.js +122 -122
  75. package/lib/dialects/redshift/schema/redshift-viewcompiler.js +11 -11
  76. package/lib/dialects/redshift/transaction.js +32 -25
  77. package/lib/dialects/sqlite3/execution/sqlite-transaction.js +25 -18
  78. package/lib/dialects/sqlite3/index.js +250 -250
  79. package/lib/dialects/sqlite3/query/sqlite-querybuilder.js +33 -33
  80. package/lib/dialects/sqlite3/query/sqlite-querycompiler.js +334 -334
  81. package/lib/dialects/sqlite3/schema/ddl.js +400 -400
  82. package/lib/dialects/sqlite3/schema/internal/compiler.js +327 -327
  83. package/lib/dialects/sqlite3/schema/internal/parser-combinator.js +161 -161
  84. package/lib/dialects/sqlite3/schema/internal/parser.js +638 -638
  85. package/lib/dialects/sqlite3/schema/internal/sqlite-ddl-operations.js +41 -41
  86. package/lib/dialects/sqlite3/schema/internal/tokenizer.js +38 -38
  87. package/lib/dialects/sqlite3/schema/internal/utils.js +12 -12
  88. package/lib/dialects/sqlite3/schema/sqlite-columncompiler.js +50 -50
  89. package/lib/dialects/sqlite3/schema/sqlite-compiler.js +80 -80
  90. package/lib/dialects/sqlite3/schema/sqlite-tablecompiler.js +347 -347
  91. package/lib/dialects/sqlite3/schema/sqlite-viewcompiler.js +40 -40
  92. package/lib/execution/batch-insert.js +51 -51
  93. package/lib/execution/internal/delay.js +6 -6
  94. package/lib/execution/internal/ensure-connection-callback.js +41 -41
  95. package/lib/execution/internal/query-executioner.js +62 -62
  96. package/lib/execution/runner.js +325 -307
  97. package/lib/execution/transaction.js +409 -401
  98. package/lib/formatter/formatterUtils.js +42 -42
  99. package/lib/formatter/rawFormatter.js +84 -84
  100. package/lib/formatter/wrappingFormatter.js +250 -250
  101. package/lib/formatter.js +25 -25
  102. package/lib/index.js +3 -3
  103. package/lib/knex-builder/FunctionHelper.js +80 -54
  104. package/lib/knex-builder/Knex.js +59 -59
  105. package/lib/knex-builder/internal/config-resolver.js +57 -57
  106. package/lib/knex-builder/internal/parse-connection.js +87 -87
  107. package/lib/knex-builder/make-knex.js +345 -340
  108. package/lib/logger.js +76 -76
  109. package/lib/migrations/common/MigrationsLoader.js +36 -36
  110. package/lib/migrations/migrate/MigrationGenerator.js +84 -84
  111. package/lib/migrations/migrate/Migrator.js +598 -598
  112. package/lib/migrations/migrate/migrate-stub.js +17 -17
  113. package/lib/migrations/migrate/migration-list-resolver.js +33 -33
  114. package/lib/migrations/migrate/migrator-configuration-merger.js +58 -58
  115. package/lib/migrations/migrate/sources/fs-migrations.js +74 -74
  116. package/lib/migrations/migrate/stub/cjs.stub +15 -15
  117. package/lib/migrations/migrate/stub/coffee.stub +13 -13
  118. package/lib/migrations/migrate/stub/eg.stub +14 -14
  119. package/lib/migrations/migrate/stub/js-schema.stub +22 -22
  120. package/lib/migrations/migrate/stub/js.stub +22 -22
  121. package/lib/migrations/migrate/stub/knexfile-coffee.stub +34 -34
  122. package/lib/migrations/migrate/stub/knexfile-eg.stub +43 -43
  123. package/lib/migrations/migrate/stub/knexfile-js.stub +47 -47
  124. package/lib/migrations/migrate/stub/knexfile-ls.stub +35 -35
  125. package/lib/migrations/migrate/stub/knexfile-ts.stub +47 -47
  126. package/lib/migrations/migrate/stub/ls.stub +14 -14
  127. package/lib/migrations/migrate/stub/mjs.stub +23 -23
  128. package/lib/migrations/migrate/stub/ts-schema.stub +21 -21
  129. package/lib/migrations/migrate/stub/ts.stub +21 -21
  130. package/lib/migrations/migrate/table-creator.js +77 -77
  131. package/lib/migrations/migrate/table-resolver.js +27 -27
  132. package/lib/migrations/seed/Seeder.js +137 -137
  133. package/lib/migrations/seed/seed-stub.js +13 -13
  134. package/lib/migrations/seed/seeder-configuration-merger.js +60 -60
  135. package/lib/migrations/seed/sources/fs-seeds.js +65 -65
  136. package/lib/migrations/seed/stub/coffee.stub +9 -9
  137. package/lib/migrations/seed/stub/eg.stub +11 -11
  138. package/lib/migrations/seed/stub/js.stub +13 -13
  139. package/lib/migrations/seed/stub/ls.stub +11 -11
  140. package/lib/migrations/seed/stub/mjs.stub +12 -12
  141. package/lib/migrations/seed/stub/ts.stub +13 -13
  142. package/lib/migrations/util/fs.js +86 -86
  143. package/lib/migrations/util/import-file.js +12 -12
  144. package/lib/migrations/util/is-module-type.js +9 -9
  145. package/lib/migrations/util/template.js +52 -52
  146. package/lib/migrations/util/timestamp.js +14 -14
  147. package/lib/query/analytic.js +52 -52
  148. package/lib/query/constants.js +15 -15
  149. package/lib/query/joinclause.js +270 -270
  150. package/lib/query/method-constants.js +136 -135
  151. package/lib/query/querybuilder.js +1793 -1794
  152. package/lib/query/querycompiler.js +1591 -1580
  153. package/lib/raw.js +139 -139
  154. package/lib/ref.js +39 -39
  155. package/lib/schema/builder.js +115 -115
  156. package/lib/schema/columnbuilder.js +146 -146
  157. package/lib/schema/columncompiler.js +307 -307
  158. package/lib/schema/compiler.js +187 -187
  159. package/lib/schema/internal/helpers.js +55 -55
  160. package/lib/schema/tablebuilder.js +376 -376
  161. package/lib/schema/tablecompiler.js +433 -433
  162. package/lib/schema/viewbuilder.js +92 -92
  163. package/lib/schema/viewcompiler.js +138 -138
  164. package/lib/util/finally-mixin.js +13 -13
  165. package/lib/util/helpers.js +95 -95
  166. package/lib/util/is.js +32 -32
  167. package/lib/util/nanoid.js +40 -40
  168. package/lib/util/noop.js +1 -1
  169. package/lib/util/save-async-stack.js +14 -14
  170. package/lib/util/security.js +26 -0
  171. package/lib/util/string.js +190 -190
  172. package/lib/util/timeout.js +29 -29
  173. package/package.json +12 -10
  174. package/scripts/build.js +125 -125
  175. package/scripts/clean.js +31 -31
  176. package/scripts/docker-compose.yml +152 -152
  177. package/scripts/next-release-howto.md +24 -24
  178. package/scripts/oracledb-install-driver-libs.sh +82 -82
  179. package/scripts/release.sh +34 -34
  180. package/scripts/runkit-example.js +34 -34
  181. package/scripts/stress-test/README.txt +18 -18
  182. package/scripts/stress-test/docker-compose.yml +57 -57
  183. package/scripts/stress-test/knex-stress-test.js +208 -208
  184. package/scripts/stress-test/mysql2-random-hanging-every-now-and-then.js +145 -145
  185. package/scripts/stress-test/mysql2-sudden-exit-without-error.js +100 -100
  186. package/scripts/stress-test/reconnect-test-mysql-based-drivers.js +184 -184
  187. package/scripts/update_gitignore_for_tsc_output.js +90 -90
  188. package/types/index.d.ts +3273 -3233
  189. package/types/result.d.ts +27 -27
  190. package/types/tables.d.ts +4 -4
@@ -1,35 +1,35 @@
1
- /* eslint max-len: 0 */
2
-
3
- const ViewCompiler = require('../../../schema/viewcompiler.js');
4
-
5
- class ViewCompiler_PG extends ViewCompiler {
6
- constructor(client, viewCompiler) {
7
- super(client, viewCompiler);
8
- }
9
-
10
- renameColumn(from, to) {
11
- return this.pushQuery({
12
- sql: `alter view ${this.viewName()} rename ${this.formatter.wrap(
13
- from
14
- )} to ${this.formatter.wrap(to)}`,
15
- });
16
- }
17
-
18
- defaultTo(column, defaultValue) {
19
- return this.pushQuery({
20
- sql: `alter view ${this.viewName()} alter ${this.formatter.wrap(
21
- column
22
- )} set default ${defaultValue}`,
23
- });
24
- }
25
-
26
- createOrReplace() {
27
- this.createQuery(this.columns, this.selectQuery, false, true);
28
- }
29
-
30
- createMaterializedView() {
31
- this.createQuery(this.columns, this.selectQuery, true);
32
- }
33
- }
34
-
35
- module.exports = ViewCompiler_PG;
1
+ /* eslint max-len: 0 */
2
+
3
+ const ViewCompiler = require('../../../schema/viewcompiler.js');
4
+
5
+ class ViewCompiler_PG extends ViewCompiler {
6
+ constructor(client, viewCompiler) {
7
+ super(client, viewCompiler);
8
+ }
9
+
10
+ renameColumn(from, to) {
11
+ return this.pushQuery({
12
+ sql: `alter view ${this.viewName()} rename ${this.formatter.wrap(
13
+ from
14
+ )} to ${this.formatter.wrap(to)}`,
15
+ });
16
+ }
17
+
18
+ defaultTo(column, defaultValue) {
19
+ return this.pushQuery({
20
+ sql: `alter view ${this.viewName()} alter ${this.formatter.wrap(
21
+ column
22
+ )} set default ${defaultValue}`,
23
+ });
24
+ }
25
+
26
+ createOrReplace() {
27
+ this.createQuery(this.columns, this.selectQuery, false, true);
28
+ }
29
+
30
+ createMaterializedView() {
31
+ this.createQuery(this.columns, this.selectQuery, true);
32
+ }
33
+ }
34
+
35
+ module.exports = ViewCompiler_PG;
@@ -1,86 +1,86 @@
1
- // Redshift
2
- // -------
3
- const Client_PG = require('../postgres');
4
- const map = require('lodash/map');
5
-
6
- const Transaction = require('./transaction');
7
- const QueryCompiler = require('./query/redshift-querycompiler');
8
- const ColumnBuilder = require('./schema/redshift-columnbuilder');
9
- const ColumnCompiler = require('./schema/redshift-columncompiler');
10
- const TableCompiler = require('./schema/redshift-tablecompiler');
11
- const SchemaCompiler = require('./schema/redshift-compiler');
12
- const ViewCompiler = require('./schema/redshift-viewcompiler');
13
-
14
- class Client_Redshift extends Client_PG {
15
- transaction() {
16
- return new Transaction(this, ...arguments);
17
- }
18
-
19
- queryCompiler(builder, formatter) {
20
- return new QueryCompiler(this, builder, formatter);
21
- }
22
-
23
- columnBuilder() {
24
- return new ColumnBuilder(this, ...arguments);
25
- }
26
-
27
- columnCompiler() {
28
- return new ColumnCompiler(this, ...arguments);
29
- }
30
-
31
- tableCompiler() {
32
- return new TableCompiler(this, ...arguments);
33
- }
34
-
35
- schemaCompiler() {
36
- return new SchemaCompiler(this, ...arguments);
37
- }
38
-
39
- viewCompiler() {
40
- return new ViewCompiler(this, ...arguments);
41
- }
42
-
43
- _driver() {
44
- return require('pg');
45
- }
46
-
47
- // Ensures the response is returned in the same format as other clients.
48
- processResponse(obj, runner) {
49
- const resp = obj.response;
50
- if (obj.output) return obj.output.call(runner, resp);
51
- if (obj.method === 'raw') return resp;
52
- if (resp.command === 'SELECT') {
53
- if (obj.method === 'first') return resp.rows[0];
54
- if (obj.method === 'pluck') return map(resp.rows, obj.pluck);
55
- return resp.rows;
56
- }
57
- if (
58
- resp.command === 'INSERT' ||
59
- resp.command === 'UPDATE' ||
60
- resp.command === 'DELETE'
61
- ) {
62
- return resp.rowCount;
63
- }
64
- return resp;
65
- }
66
-
67
- toPathForJson(jsonPath, builder, bindingsHolder) {
68
- return jsonPath
69
- .replace(/^(\$\.)/, '') // remove the first dollar
70
- .split('.')
71
- .map(
72
- function (v) {
73
- return this.parameter(v, builder, bindingsHolder);
74
- }.bind(this)
75
- )
76
- .join(', ');
77
- }
78
- }
79
-
80
- Object.assign(Client_Redshift.prototype, {
81
- dialect: 'redshift',
82
-
83
- driverName: 'pg-redshift',
84
- });
85
-
86
- module.exports = Client_Redshift;
1
+ // Redshift
2
+ // -------
3
+ const Client_PG = require('../postgres');
4
+ const map = require('lodash/map');
5
+
6
+ const Transaction = require('./transaction');
7
+ const QueryCompiler = require('./query/redshift-querycompiler');
8
+ const ColumnBuilder = require('./schema/redshift-columnbuilder');
9
+ const ColumnCompiler = require('./schema/redshift-columncompiler');
10
+ const TableCompiler = require('./schema/redshift-tablecompiler');
11
+ const SchemaCompiler = require('./schema/redshift-compiler');
12
+ const ViewCompiler = require('./schema/redshift-viewcompiler');
13
+
14
+ class Client_Redshift extends Client_PG {
15
+ transaction() {
16
+ return new Transaction(this, ...arguments);
17
+ }
18
+
19
+ queryCompiler(builder, formatter) {
20
+ return new QueryCompiler(this, builder, formatter);
21
+ }
22
+
23
+ columnBuilder() {
24
+ return new ColumnBuilder(this, ...arguments);
25
+ }
26
+
27
+ columnCompiler() {
28
+ return new ColumnCompiler(this, ...arguments);
29
+ }
30
+
31
+ tableCompiler() {
32
+ return new TableCompiler(this, ...arguments);
33
+ }
34
+
35
+ schemaCompiler() {
36
+ return new SchemaCompiler(this, ...arguments);
37
+ }
38
+
39
+ viewCompiler() {
40
+ return new ViewCompiler(this, ...arguments);
41
+ }
42
+
43
+ _driver() {
44
+ return require('pg');
45
+ }
46
+
47
+ // Ensures the response is returned in the same format as other clients.
48
+ processResponse(obj, runner) {
49
+ const resp = obj.response;
50
+ if (obj.output) return obj.output.call(runner, resp);
51
+ if (obj.method === 'raw') return resp;
52
+ if (resp.command === 'SELECT') {
53
+ if (obj.method === 'first') return resp.rows[0];
54
+ if (obj.method === 'pluck') return map(resp.rows, obj.pluck);
55
+ return resp.rows;
56
+ }
57
+ if (
58
+ resp.command === 'INSERT' ||
59
+ resp.command === 'UPDATE' ||
60
+ resp.command === 'DELETE'
61
+ ) {
62
+ return resp.rowCount;
63
+ }
64
+ return resp;
65
+ }
66
+
67
+ toPathForJson(jsonPath, builder, bindingsHolder) {
68
+ return jsonPath
69
+ .replace(/^(\$\.)/, '') // remove the first dollar
70
+ .split('.')
71
+ .map(
72
+ function (v) {
73
+ return this.parameter(v, builder, bindingsHolder);
74
+ }.bind(this)
75
+ )
76
+ .join(', ');
77
+ }
78
+ }
79
+
80
+ Object.assign(Client_Redshift.prototype, {
81
+ dialect: 'redshift',
82
+
83
+ driverName: 'pg-redshift',
84
+ });
85
+
86
+ module.exports = Client_Redshift;
@@ -1,163 +1,163 @@
1
- // Redshift Query Builder & Compiler
2
- // ------
3
- const QueryCompiler = require('../../../query/querycompiler');
4
- const QueryCompiler_PG = require('../../postgres/query/pg-querycompiler');
5
-
6
- const identity = require('lodash/identity');
7
- const {
8
- columnize: columnize_,
9
- } = require('../../../formatter/wrappingFormatter');
10
-
11
- class QueryCompiler_Redshift extends QueryCompiler_PG {
12
- truncate() {
13
- return `truncate ${this.tableName.toLowerCase()}`;
14
- }
15
-
16
- // Compiles an `insert` query, allowing for multiple
17
- // inserts using a single query statement.
18
- insert() {
19
- const sql = QueryCompiler.prototype.insert.apply(this, arguments);
20
- if (sql === '') return sql;
21
- this._slightReturn();
22
- return {
23
- sql,
24
- };
25
- }
26
-
27
- // Compiles an `update` query, warning on unsupported returning
28
- update() {
29
- const sql = QueryCompiler.prototype.update.apply(this, arguments);
30
- this._slightReturn();
31
- return {
32
- sql,
33
- };
34
- }
35
-
36
- // Compiles an `delete` query, warning on unsupported returning
37
- del() {
38
- const sql = QueryCompiler.prototype.del.apply(this, arguments);
39
- this._slightReturn();
40
- return {
41
- sql,
42
- };
43
- }
44
-
45
- // simple: if trying to return, warn
46
- _slightReturn() {
47
- if (this.single.isReturning) {
48
- this.client.logger.warn(
49
- 'insert/update/delete returning is not supported by redshift dialect'
50
- );
51
- }
52
- }
53
-
54
- forUpdate() {
55
- this.client.logger.warn('table lock is not supported by redshift dialect');
56
- return '';
57
- }
58
-
59
- forShare() {
60
- this.client.logger.warn(
61
- 'lock for share is not supported by redshift dialect'
62
- );
63
- return '';
64
- }
65
-
66
- forNoKeyUpdate() {
67
- this.client.logger.warn('table lock is not supported by redshift dialect');
68
- return '';
69
- }
70
-
71
- forKeyShare() {
72
- this.client.logger.warn(
73
- 'lock for share is not supported by redshift dialect'
74
- );
75
- return '';
76
- }
77
-
78
- // Compiles a columnInfo query
79
- columnInfo() {
80
- const column = this.single.columnInfo;
81
- let schema = this.single.schema;
82
-
83
- // The user may have specified a custom wrapIdentifier function in the config. We
84
- // need to run the identifiers through that function, but not format them as
85
- // identifiers otherwise.
86
- const table = this.client.customWrapIdentifier(this.single.table, identity);
87
-
88
- if (schema) {
89
- schema = this.client.customWrapIdentifier(schema, identity);
90
- }
91
-
92
- const sql =
93
- 'select * from information_schema.columns where table_name = ? and table_catalog = ?';
94
- const bindings = [
95
- table.toLowerCase(),
96
- this.client.database().toLowerCase(),
97
- ];
98
-
99
- return this._buildColumnInfoQuery(schema, sql, bindings, column);
100
- }
101
-
102
- jsonExtract(params) {
103
- let extractions;
104
- if (Array.isArray(params.column)) {
105
- extractions = params.column;
106
- } else {
107
- extractions = [params];
108
- }
109
- return extractions
110
- .map((extraction) => {
111
- const jsonCol = `json_extract_path_text(${columnize_(
112
- extraction.column || extraction[0],
113
- this.builder,
114
- this.client,
115
- this.bindingsHolder
116
- )}, ${this.client.toPathForJson(
117
- params.path || extraction[1],
118
- this.builder,
119
- this.bindingsHolder
120
- )})`;
121
- const alias = extraction.alias || extraction[2];
122
- return alias
123
- ? this.client.alias(jsonCol, this.formatter.wrap(alias))
124
- : jsonCol;
125
- })
126
- .join(', ');
127
- }
128
-
129
- jsonSet(params) {
130
- throw new Error('Json set is not supported by Redshift');
131
- }
132
-
133
- jsonInsert(params) {
134
- throw new Error('Json insert is not supported by Redshift');
135
- }
136
-
137
- jsonRemove(params) {
138
- throw new Error('Json remove is not supported by Redshift');
139
- }
140
-
141
- whereJsonPath(statement) {
142
- return this._whereJsonPath(
143
- 'json_extract_path_text',
144
- Object.assign({}, statement, {
145
- path: this.client.toPathForJson(statement.path),
146
- })
147
- );
148
- }
149
-
150
- whereJsonSupersetOf(statement) {
151
- throw new Error('Json superset is not supported by Redshift');
152
- }
153
-
154
- whereJsonSubsetOf(statement) {
155
- throw new Error('Json subset is not supported by Redshift');
156
- }
157
-
158
- onJsonPathEquals(clause) {
159
- return this._onJsonPathEquals('json_extract_path_text', clause);
160
- }
161
- }
162
-
163
- module.exports = QueryCompiler_Redshift;
1
+ // Redshift Query Builder & Compiler
2
+ // ------
3
+ const QueryCompiler = require('../../../query/querycompiler');
4
+ const QueryCompiler_PG = require('../../postgres/query/pg-querycompiler');
5
+
6
+ const identity = require('lodash/identity');
7
+ const {
8
+ columnize: columnize_,
9
+ } = require('../../../formatter/wrappingFormatter');
10
+
11
+ class QueryCompiler_Redshift extends QueryCompiler_PG {
12
+ truncate() {
13
+ return `truncate ${this.tableName.toLowerCase()}`;
14
+ }
15
+
16
+ // Compiles an `insert` query, allowing for multiple
17
+ // inserts using a single query statement.
18
+ insert() {
19
+ const sql = QueryCompiler.prototype.insert.apply(this, arguments);
20
+ if (sql === '') return sql;
21
+ this._slightReturn();
22
+ return {
23
+ sql,
24
+ };
25
+ }
26
+
27
+ // Compiles an `update` query, warning on unsupported returning
28
+ update() {
29
+ const sql = QueryCompiler.prototype.update.apply(this, arguments);
30
+ this._slightReturn();
31
+ return {
32
+ sql,
33
+ };
34
+ }
35
+
36
+ // Compiles an `delete` query, warning on unsupported returning
37
+ del() {
38
+ const sql = QueryCompiler.prototype.del.apply(this, arguments);
39
+ this._slightReturn();
40
+ return {
41
+ sql,
42
+ };
43
+ }
44
+
45
+ // simple: if trying to return, warn
46
+ _slightReturn() {
47
+ if (this.single.isReturning) {
48
+ this.client.logger.warn(
49
+ 'insert/update/delete returning is not supported by redshift dialect'
50
+ );
51
+ }
52
+ }
53
+
54
+ forUpdate() {
55
+ this.client.logger.warn('table lock is not supported by redshift dialect');
56
+ return '';
57
+ }
58
+
59
+ forShare() {
60
+ this.client.logger.warn(
61
+ 'lock for share is not supported by redshift dialect'
62
+ );
63
+ return '';
64
+ }
65
+
66
+ forNoKeyUpdate() {
67
+ this.client.logger.warn('table lock is not supported by redshift dialect');
68
+ return '';
69
+ }
70
+
71
+ forKeyShare() {
72
+ this.client.logger.warn(
73
+ 'lock for share is not supported by redshift dialect'
74
+ );
75
+ return '';
76
+ }
77
+
78
+ // Compiles a columnInfo query
79
+ columnInfo() {
80
+ const column = this.single.columnInfo;
81
+ let schema = this.single.schema;
82
+
83
+ // The user may have specified a custom wrapIdentifier function in the config. We
84
+ // need to run the identifiers through that function, but not format them as
85
+ // identifiers otherwise.
86
+ const table = this.client.customWrapIdentifier(this.single.table, identity);
87
+
88
+ if (schema) {
89
+ schema = this.client.customWrapIdentifier(schema, identity);
90
+ }
91
+
92
+ const sql =
93
+ 'select * from information_schema.columns where table_name = ? and table_catalog = ?';
94
+ const bindings = [
95
+ table.toLowerCase(),
96
+ this.client.database().toLowerCase(),
97
+ ];
98
+
99
+ return this._buildColumnInfoQuery(schema, sql, bindings, column);
100
+ }
101
+
102
+ jsonExtract(params) {
103
+ let extractions;
104
+ if (Array.isArray(params.column)) {
105
+ extractions = params.column;
106
+ } else {
107
+ extractions = [params];
108
+ }
109
+ return extractions
110
+ .map((extraction) => {
111
+ const jsonCol = `json_extract_path_text(${columnize_(
112
+ extraction.column || extraction[0],
113
+ this.builder,
114
+ this.client,
115
+ this.bindingsHolder
116
+ )}, ${this.client.toPathForJson(
117
+ params.path || extraction[1],
118
+ this.builder,
119
+ this.bindingsHolder
120
+ )})`;
121
+ const alias = extraction.alias || extraction[2];
122
+ return alias
123
+ ? this.client.alias(jsonCol, this.formatter.wrap(alias))
124
+ : jsonCol;
125
+ })
126
+ .join(', ');
127
+ }
128
+
129
+ jsonSet(params) {
130
+ throw new Error('Json set is not supported by Redshift');
131
+ }
132
+
133
+ jsonInsert(params) {
134
+ throw new Error('Json insert is not supported by Redshift');
135
+ }
136
+
137
+ jsonRemove(params) {
138
+ throw new Error('Json remove is not supported by Redshift');
139
+ }
140
+
141
+ whereJsonPath(statement) {
142
+ return this._whereJsonPath(
143
+ 'json_extract_path_text',
144
+ Object.assign({}, statement, {
145
+ path: this.client.toPathForJson(statement.path),
146
+ })
147
+ );
148
+ }
149
+
150
+ whereJsonSupersetOf(statement) {
151
+ throw new Error('Json superset is not supported by Redshift');
152
+ }
153
+
154
+ whereJsonSubsetOf(statement) {
155
+ throw new Error('Json subset is not supported by Redshift');
156
+ }
157
+
158
+ onJsonPathEquals(clause) {
159
+ return this._onJsonPathEquals('json_extract_path_text', clause);
160
+ }
161
+ }
162
+
163
+ module.exports = QueryCompiler_Redshift;
@@ -1,22 +1,22 @@
1
- const ColumnBuilder = require('../../../schema/columnbuilder');
2
-
3
- class ColumnBuilder_Redshift extends ColumnBuilder {
4
- constructor() {
5
- super(...arguments);
6
- }
7
-
8
- // primary needs to set not null on non-preexisting columns, or fail
9
- primary() {
10
- this.notNullable();
11
- return super.primary(...arguments);
12
- }
13
-
14
- index() {
15
- this.client.logger.warn(
16
- 'Redshift does not support the creation of indexes.'
17
- );
18
- return this;
19
- }
20
- }
21
-
22
- module.exports = ColumnBuilder_Redshift;
1
+ const ColumnBuilder = require('../../../schema/columnbuilder');
2
+
3
+ class ColumnBuilder_Redshift extends ColumnBuilder {
4
+ constructor() {
5
+ super(...arguments);
6
+ }
7
+
8
+ // primary needs to set not null on non-preexisting columns, or fail
9
+ primary() {
10
+ this.notNullable();
11
+ return super.primary(...arguments);
12
+ }
13
+
14
+ index() {
15
+ this.client.logger.warn(
16
+ 'Redshift does not support the creation of indexes.'
17
+ );
18
+ return this;
19
+ }
20
+ }
21
+
22
+ module.exports = ColumnBuilder_Redshift;