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.
- package/CHANGELOG.md +2447 -2441
- package/CONTRIBUTING.md +190 -190
- package/LICENSE +22 -22
- package/README.md +177 -156
- package/UPGRADING.md +245 -245
- package/bin/cli.js +516 -516
- package/bin/knexfile-runtime-error.js +27 -27
- package/bin/utils/cli-config-utils.js +217 -217
- package/bin/utils/constants.js +7 -7
- package/bin/utils/migrationsLister.js +37 -37
- package/knex.js +23 -23
- package/knex.mjs +11 -11
- package/lib/builder-interface-augmenter.js +120 -120
- package/lib/client.js +585 -585
- package/lib/constants.js +61 -61
- package/lib/dialects/better-sqlite3/index.js +101 -101
- package/lib/dialects/cockroachdb/crdb-columncompiler.js +14 -14
- package/lib/dialects/cockroachdb/crdb-querybuilder.js +11 -11
- package/lib/dialects/cockroachdb/crdb-querycompiler.js +122 -122
- package/lib/dialects/cockroachdb/crdb-tablecompiler.js +46 -46
- package/lib/dialects/cockroachdb/crdb-viewcompiler.js +15 -15
- package/lib/dialects/cockroachdb/index.js +86 -86
- package/lib/dialects/index.js +34 -34
- package/lib/dialects/mssql/index.js +498 -498
- package/lib/dialects/mssql/mssql-formatter.js +34 -34
- package/lib/dialects/mssql/query/mssql-querycompiler.js +601 -601
- package/lib/dialects/mssql/schema/mssql-columncompiler.js +185 -185
- package/lib/dialects/mssql/schema/mssql-compiler.js +91 -91
- package/lib/dialects/mssql/schema/mssql-tablecompiler.js +393 -393
- package/lib/dialects/mssql/schema/mssql-viewcompiler.js +55 -55
- package/lib/dialects/mssql/transaction.js +176 -176
- package/lib/dialects/mysql/index.js +317 -317
- package/lib/dialects/mysql/query/mysql-querybuilder.js +14 -14
- package/lib/dialects/mysql/query/mysql-querycompiler.js +292 -292
- package/lib/dialects/mysql/schema/mysql-columncompiler.js +193 -193
- package/lib/dialects/mysql/schema/mysql-compiler.js +60 -60
- package/lib/dialects/mysql/schema/mysql-tablecompiler.js +426 -426
- package/lib/dialects/mysql/schema/mysql-viewbuilder.js +21 -21
- package/lib/dialects/mysql/schema/mysql-viewcompiler.js +15 -15
- package/lib/dialects/mysql/transaction.js +46 -46
- package/lib/dialects/mysql2/index.js +53 -53
- package/lib/dialects/mysql2/transaction.js +44 -44
- package/lib/dialects/oracle/DEAD_CODE.md +5 -5
- package/lib/dialects/oracle/index.js +92 -92
- package/lib/dialects/oracle/query/oracle-querycompiler.js +343 -343
- package/lib/dialects/oracle/schema/internal/incrementUtils.js +22 -22
- package/lib/dialects/oracle/schema/internal/trigger.js +155 -155
- package/lib/dialects/oracle/schema/oracle-columnbuilder.js +17 -17
- package/lib/dialects/oracle/schema/oracle-columncompiler.js +126 -126
- package/lib/dialects/oracle/schema/oracle-compiler.js +124 -124
- package/lib/dialects/oracle/schema/oracle-tablecompiler.js +210 -210
- package/lib/dialects/oracle/utils.js +107 -107
- package/lib/dialects/oracledb/index.js +381 -381
- package/lib/dialects/oracledb/query/oracledb-querycompiler.js +481 -481
- package/lib/dialects/oracledb/schema/oracledb-columncompiler.js +61 -61
- package/lib/dialects/oracledb/schema/oracledb-tablecompiler.js +19 -19
- package/lib/dialects/oracledb/schema/oracledb-viewbuilder.js +13 -13
- package/lib/dialects/oracledb/schema/oracledb-viewcompiler.js +19 -19
- package/lib/dialects/oracledb/transaction.js +98 -98
- package/lib/dialects/oracledb/utils.js +208 -208
- package/lib/dialects/pgnative/index.js +60 -60
- package/lib/dialects/postgres/execution/pg-transaction.js +19 -19
- package/lib/dialects/postgres/index.js +373 -373
- package/lib/dialects/postgres/query/pg-querybuilder.js +43 -43
- package/lib/dialects/postgres/query/pg-querycompiler.js +400 -400
- package/lib/dialects/postgres/schema/pg-columncompiler.js +162 -162
- package/lib/dialects/postgres/schema/pg-compiler.js +138 -138
- package/lib/dialects/postgres/schema/pg-tablecompiler.js +331 -331
- package/lib/dialects/postgres/schema/pg-viewbuilder.js +21 -21
- package/lib/dialects/postgres/schema/pg-viewcompiler.js +35 -35
- package/lib/dialects/redshift/index.js +86 -86
- package/lib/dialects/redshift/query/redshift-querycompiler.js +163 -163
- package/lib/dialects/redshift/schema/redshift-columnbuilder.js +22 -22
- package/lib/dialects/redshift/schema/redshift-columncompiler.js +67 -67
- package/lib/dialects/redshift/schema/redshift-compiler.js +14 -14
- package/lib/dialects/redshift/schema/redshift-tablecompiler.js +134 -134
- package/lib/dialects/redshift/schema/redshift-viewcompiler.js +11 -11
- package/lib/dialects/redshift/transaction.js +32 -32
- package/lib/dialects/sqlite3/execution/sqlite-transaction.js +172 -172
- package/lib/dialects/sqlite3/index.js +263 -263
- package/lib/dialects/sqlite3/query/sqlite-querybuilder.js +33 -33
- package/lib/dialects/sqlite3/query/sqlite-querycompiler.js +341 -341
- package/lib/dialects/sqlite3/schema/ddl.js +380 -380
- package/lib/dialects/sqlite3/schema/internal/compiler.js +327 -327
- package/lib/dialects/sqlite3/schema/internal/parser-combinator.js +161 -161
- package/lib/dialects/sqlite3/schema/internal/parser.js +638 -638
- package/lib/dialects/sqlite3/schema/internal/sqlite-ddl-operations.js +41 -41
- package/lib/dialects/sqlite3/schema/internal/tokenizer.js +38 -38
- package/lib/dialects/sqlite3/schema/internal/utils.js +12 -12
- package/lib/dialects/sqlite3/schema/sqlite-columncompiler.js +50 -50
- package/lib/dialects/sqlite3/schema/sqlite-compiler.js +80 -80
- package/lib/dialects/sqlite3/schema/sqlite-tablecompiler.js +364 -364
- package/lib/dialects/sqlite3/schema/sqlite-viewcompiler.js +40 -40
- package/lib/execution/batch-insert.js +51 -51
- package/lib/execution/internal/delay.js +6 -6
- package/lib/execution/internal/ensure-connection-callback.js +41 -41
- package/lib/execution/internal/query-executioner.js +62 -62
- package/lib/execution/runner.js +325 -325
- package/lib/execution/transaction.js +417 -417
- package/lib/formatter/formatterUtils.js +42 -42
- package/lib/formatter/rawFormatter.js +84 -84
- package/lib/formatter/wrappingFormatter.js +253 -253
- package/lib/formatter.js +25 -25
- package/lib/index.js +3 -3
- package/lib/knex-builder/FunctionHelper.js +80 -80
- package/lib/knex-builder/Knex.js +59 -59
- package/lib/knex-builder/internal/config-resolver.js +57 -57
- package/lib/knex-builder/internal/parse-connection.js +87 -87
- package/lib/knex-builder/make-knex.js +345 -345
- package/lib/logger.js +76 -76
- package/lib/migrations/common/MigrationsLoader.js +36 -36
- package/lib/migrations/migrate/MigrationGenerator.js +84 -84
- package/lib/migrations/migrate/Migrator.js +632 -632
- package/lib/migrations/migrate/migrate-stub.js +17 -17
- package/lib/migrations/migrate/migration-list-resolver.js +33 -33
- package/lib/migrations/migrate/migrator-configuration-merger.js +58 -58
- package/lib/migrations/migrate/sources/fs-migrations.js +74 -74
- package/lib/migrations/migrate/stub/cjs.stub +15 -15
- package/lib/migrations/migrate/stub/coffee.stub +13 -13
- package/lib/migrations/migrate/stub/eg.stub +14 -14
- package/lib/migrations/migrate/stub/js-schema.stub +22 -22
- package/lib/migrations/migrate/stub/js.stub +22 -22
- package/lib/migrations/migrate/stub/knexfile-coffee.stub +34 -34
- package/lib/migrations/migrate/stub/knexfile-eg.stub +43 -43
- package/lib/migrations/migrate/stub/knexfile-js.stub +47 -47
- package/lib/migrations/migrate/stub/knexfile-ls.stub +35 -35
- package/lib/migrations/migrate/stub/knexfile-ts.stub +47 -47
- package/lib/migrations/migrate/stub/ls.stub +14 -14
- package/lib/migrations/migrate/stub/mjs.stub +23 -23
- package/lib/migrations/migrate/stub/ts-schema.stub +21 -21
- package/lib/migrations/migrate/stub/ts.stub +21 -21
- package/lib/migrations/migrate/table-creator.js +77 -77
- package/lib/migrations/migrate/table-resolver.js +27 -27
- package/lib/migrations/seed/Seeder.js +137 -137
- package/lib/migrations/seed/seed-stub.js +13 -13
- package/lib/migrations/seed/seeder-configuration-merger.js +60 -60
- package/lib/migrations/seed/sources/fs-seeds.js +65 -65
- package/lib/migrations/seed/stub/coffee.stub +9 -9
- package/lib/migrations/seed/stub/eg.stub +11 -11
- package/lib/migrations/seed/stub/js.stub +13 -13
- package/lib/migrations/seed/stub/ls.stub +11 -11
- package/lib/migrations/seed/stub/mjs.stub +12 -12
- package/lib/migrations/seed/stub/ts.stub +13 -13
- package/lib/migrations/util/fs.js +86 -86
- package/lib/migrations/util/import-file.js +12 -12
- package/lib/migrations/util/is-module-type.js +9 -9
- package/lib/migrations/util/template.js +52 -52
- package/lib/migrations/util/timestamp.js +14 -14
- package/lib/query/analytic.js +52 -52
- package/lib/query/constants.js +15 -15
- package/lib/query/joinclause.js +270 -270
- package/lib/query/method-constants.js +136 -136
- package/lib/query/querybuilder.js +1793 -1793
- package/lib/query/querycompiler.js +1634 -1634
- package/lib/raw.js +139 -139
- package/lib/ref.js +39 -39
- package/lib/schema/builder.js +115 -115
- package/lib/schema/columnbuilder.js +146 -146
- package/lib/schema/columncompiler.js +307 -307
- package/lib/schema/compiler.js +187 -187
- package/lib/schema/internal/helpers.js +55 -55
- package/lib/schema/tablebuilder.js +379 -379
- package/lib/schema/tablecompiler.js +450 -450
- package/lib/schema/viewbuilder.js +92 -92
- package/lib/schema/viewcompiler.js +138 -138
- package/lib/util/finally-mixin.js +13 -13
- package/lib/util/helpers.js +95 -95
- package/lib/util/is.js +32 -32
- package/lib/util/nanoid.js +40 -40
- package/lib/util/noop.js +1 -1
- package/lib/util/save-async-stack.js +14 -14
- package/lib/util/security.js +32 -32
- package/lib/util/string.js +190 -190
- package/lib/util/timeout.js +29 -29
- package/package.json +295 -293
- package/scripts/act-testing/act.sh +19 -19
- package/scripts/act-testing/merged-no-label.json +11 -11
- package/scripts/act-testing/merged-patch-labeled.json +12 -12
- package/scripts/act-testing/merged-skip-labeled.json +12 -12
- package/scripts/act-testing/not-merged-patch-labeled.json +12 -12
- package/scripts/build-for-release.sh +121 -121
- package/scripts/build.js +125 -125
- package/scripts/clean.js +31 -31
- package/scripts/docker-compose.yml +150 -150
- package/scripts/format-changelog.js +55 -55
- package/scripts/next-release-howto.md +24 -24
- package/scripts/oracledb-install-driver-libs.sh +82 -82
- package/scripts/release.sh +36 -36
- package/scripts/runkit-example.js +35 -35
- package/scripts/stress-test/README.txt +18 -18
- package/scripts/stress-test/docker-compose.yml +55 -55
- package/scripts/stress-test/knex-stress-test.js +212 -212
- package/scripts/stress-test/mysql2-random-hanging-every-now-and-then.js +149 -149
- package/scripts/stress-test/mysql2-sudden-exit-without-error.js +101 -101
- package/scripts/stress-test/reconnect-test-mysql-based-drivers.js +188 -188
- package/types/index.d.mts +14 -0
- package/types/index.d.ts +3321 -3321
- package/types/result.d.ts +27 -27
- package/types/tables.d.ts +4 -4
package/lib/query/joinclause.js
CHANGED
|
@@ -1,270 +1,270 @@
|
|
|
1
|
-
const assert = require('assert');
|
|
2
|
-
|
|
3
|
-
// JoinClause
|
|
4
|
-
// -------
|
|
5
|
-
|
|
6
|
-
function getClauseFromArguments(compilerType, bool, first, operator, second) {
|
|
7
|
-
if (typeof first === 'function') {
|
|
8
|
-
return {
|
|
9
|
-
type: 'onWrapped',
|
|
10
|
-
value: first,
|
|
11
|
-
bool: bool,
|
|
12
|
-
};
|
|
13
|
-
}
|
|
14
|
-
|
|
15
|
-
switch (arguments.length) {
|
|
16
|
-
case 3:
|
|
17
|
-
return { type: 'onRaw', value: first, bool };
|
|
18
|
-
case 4:
|
|
19
|
-
return {
|
|
20
|
-
type: compilerType,
|
|
21
|
-
column: first,
|
|
22
|
-
operator: '=',
|
|
23
|
-
value: operator,
|
|
24
|
-
bool,
|
|
25
|
-
};
|
|
26
|
-
default:
|
|
27
|
-
return {
|
|
28
|
-
type: compilerType,
|
|
29
|
-
column: first,
|
|
30
|
-
operator,
|
|
31
|
-
value: second,
|
|
32
|
-
bool,
|
|
33
|
-
};
|
|
34
|
-
}
|
|
35
|
-
}
|
|
36
|
-
|
|
37
|
-
// The "JoinClause" is an object holding any necessary info about a join,
|
|
38
|
-
// including the type, and any associated tables & columns being joined.
|
|
39
|
-
class JoinClause {
|
|
40
|
-
constructor(table, type, schema) {
|
|
41
|
-
this.schema = schema;
|
|
42
|
-
this.table = table;
|
|
43
|
-
this.joinType = type;
|
|
44
|
-
this.and = this;
|
|
45
|
-
this.clauses = [];
|
|
46
|
-
}
|
|
47
|
-
|
|
48
|
-
get or() {
|
|
49
|
-
return this._bool('or');
|
|
50
|
-
}
|
|
51
|
-
|
|
52
|
-
// Adds an "on" clause to the current join object.
|
|
53
|
-
on(first) {
|
|
54
|
-
if (typeof first === 'object' && typeof first.toSQL !== 'function') {
|
|
55
|
-
const keys = Object.keys(first);
|
|
56
|
-
let i = -1;
|
|
57
|
-
const method = this._bool() === 'or' ? 'orOn' : 'on';
|
|
58
|
-
while (++i < keys.length) {
|
|
59
|
-
this[method](keys[i], first[keys[i]]);
|
|
60
|
-
}
|
|
61
|
-
return this;
|
|
62
|
-
}
|
|
63
|
-
|
|
64
|
-
const data = getClauseFromArguments('onBasic', this._bool(), ...arguments);
|
|
65
|
-
|
|
66
|
-
if (data) {
|
|
67
|
-
this.clauses.push(data);
|
|
68
|
-
}
|
|
69
|
-
|
|
70
|
-
return this;
|
|
71
|
-
}
|
|
72
|
-
|
|
73
|
-
// Adds an "or on" clause to the current join object.
|
|
74
|
-
orOn(first, operator, second) {
|
|
75
|
-
return this._bool('or').on.apply(this, arguments);
|
|
76
|
-
}
|
|
77
|
-
|
|
78
|
-
onJsonPathEquals(columnFirst, jsonPathFirst, columnSecond, jsonPathSecond) {
|
|
79
|
-
this.clauses.push({
|
|
80
|
-
type: 'onJsonPathEquals',
|
|
81
|
-
columnFirst: columnFirst,
|
|
82
|
-
jsonPathFirst: jsonPathFirst,
|
|
83
|
-
columnSecond: columnSecond,
|
|
84
|
-
jsonPathSecond: jsonPathSecond,
|
|
85
|
-
bool: this._bool(),
|
|
86
|
-
not: this._not(),
|
|
87
|
-
});
|
|
88
|
-
return this;
|
|
89
|
-
}
|
|
90
|
-
|
|
91
|
-
orOnJsonPathEquals(columnFirst, jsonPathFirst, columnSecond, jsonPathSecond) {
|
|
92
|
-
return this._bool('or').onJsonPathEquals.apply(this, arguments);
|
|
93
|
-
}
|
|
94
|
-
|
|
95
|
-
// Adds a "using" clause to the current join.
|
|
96
|
-
using(column) {
|
|
97
|
-
return this.clauses.push({ type: 'onUsing', column, bool: this._bool() });
|
|
98
|
-
}
|
|
99
|
-
|
|
100
|
-
onVal(first) {
|
|
101
|
-
if (typeof first === 'object' && typeof first.toSQL !== 'function') {
|
|
102
|
-
const keys = Object.keys(first);
|
|
103
|
-
let i = -1;
|
|
104
|
-
const method = this._bool() === 'or' ? 'orOnVal' : 'onVal';
|
|
105
|
-
while (++i < keys.length) {
|
|
106
|
-
this[method](keys[i], first[keys[i]]);
|
|
107
|
-
}
|
|
108
|
-
return this;
|
|
109
|
-
}
|
|
110
|
-
|
|
111
|
-
const data = getClauseFromArguments('onVal', this._bool(), ...arguments);
|
|
112
|
-
|
|
113
|
-
if (data) {
|
|
114
|
-
this.clauses.push(data);
|
|
115
|
-
}
|
|
116
|
-
|
|
117
|
-
return this;
|
|
118
|
-
}
|
|
119
|
-
|
|
120
|
-
andOnVal() {
|
|
121
|
-
return this.onVal(...arguments);
|
|
122
|
-
}
|
|
123
|
-
|
|
124
|
-
orOnVal() {
|
|
125
|
-
return this._bool('or').onVal(...arguments);
|
|
126
|
-
}
|
|
127
|
-
|
|
128
|
-
onBetween(column, values) {
|
|
129
|
-
assert(
|
|
130
|
-
Array.isArray(values),
|
|
131
|
-
'The second argument to onBetween must be an array.'
|
|
132
|
-
);
|
|
133
|
-
assert(
|
|
134
|
-
values.length === 2,
|
|
135
|
-
'You must specify 2 values for the onBetween clause'
|
|
136
|
-
);
|
|
137
|
-
this.clauses.push({
|
|
138
|
-
type: 'onBetween',
|
|
139
|
-
column,
|
|
140
|
-
value: values,
|
|
141
|
-
bool: this._bool(),
|
|
142
|
-
not: this._not(),
|
|
143
|
-
});
|
|
144
|
-
return this;
|
|
145
|
-
}
|
|
146
|
-
|
|
147
|
-
onNotBetween(column, values) {
|
|
148
|
-
return this._not(true).onBetween(column, values);
|
|
149
|
-
}
|
|
150
|
-
|
|
151
|
-
orOnBetween(column, values) {
|
|
152
|
-
return this._bool('or').onBetween(column, values);
|
|
153
|
-
}
|
|
154
|
-
|
|
155
|
-
orOnNotBetween(column, values) {
|
|
156
|
-
return this._bool('or')._not(true).onBetween(column, values);
|
|
157
|
-
}
|
|
158
|
-
|
|
159
|
-
onIn(column, values) {
|
|
160
|
-
if (Array.isArray(values) && values.length === 0) return this.on(1, '=', 0);
|
|
161
|
-
this.clauses.push({
|
|
162
|
-
type: 'onIn',
|
|
163
|
-
column,
|
|
164
|
-
value: values,
|
|
165
|
-
not: this._not(),
|
|
166
|
-
bool: this._bool(),
|
|
167
|
-
});
|
|
168
|
-
return this;
|
|
169
|
-
}
|
|
170
|
-
|
|
171
|
-
onNotIn(column, values) {
|
|
172
|
-
return this._not(true).onIn(column, values);
|
|
173
|
-
}
|
|
174
|
-
|
|
175
|
-
orOnIn(column, values) {
|
|
176
|
-
return this._bool('or').onIn(column, values);
|
|
177
|
-
}
|
|
178
|
-
|
|
179
|
-
orOnNotIn(column, values) {
|
|
180
|
-
return this._bool('or')._not(true).onIn(column, values);
|
|
181
|
-
}
|
|
182
|
-
|
|
183
|
-
onNull(column) {
|
|
184
|
-
this.clauses.push({
|
|
185
|
-
type: 'onNull',
|
|
186
|
-
column,
|
|
187
|
-
not: this._not(),
|
|
188
|
-
bool: this._bool(),
|
|
189
|
-
});
|
|
190
|
-
return this;
|
|
191
|
-
}
|
|
192
|
-
|
|
193
|
-
orOnNull(callback) {
|
|
194
|
-
return this._bool('or').onNull(callback);
|
|
195
|
-
}
|
|
196
|
-
|
|
197
|
-
onNotNull(callback) {
|
|
198
|
-
return this._not(true).onNull(callback);
|
|
199
|
-
}
|
|
200
|
-
|
|
201
|
-
orOnNotNull(callback) {
|
|
202
|
-
return this._not(true)._bool('or').onNull(callback);
|
|
203
|
-
}
|
|
204
|
-
|
|
205
|
-
onExists(callback) {
|
|
206
|
-
this.clauses.push({
|
|
207
|
-
type: 'onExists',
|
|
208
|
-
value: callback,
|
|
209
|
-
not: this._not(),
|
|
210
|
-
bool: this._bool(),
|
|
211
|
-
});
|
|
212
|
-
return this;
|
|
213
|
-
}
|
|
214
|
-
|
|
215
|
-
orOnExists(callback) {
|
|
216
|
-
return this._bool('or').onExists(callback);
|
|
217
|
-
}
|
|
218
|
-
|
|
219
|
-
onNotExists(callback) {
|
|
220
|
-
return this._not(true).onExists(callback);
|
|
221
|
-
}
|
|
222
|
-
|
|
223
|
-
orOnNotExists(callback) {
|
|
224
|
-
return this._not(true)._bool('or').onExists(callback);
|
|
225
|
-
}
|
|
226
|
-
|
|
227
|
-
// Explicitly set the type of join, useful within a function when creating a grouped join.
|
|
228
|
-
type(type) {
|
|
229
|
-
this.joinType = type;
|
|
230
|
-
return this;
|
|
231
|
-
}
|
|
232
|
-
|
|
233
|
-
_bool(bool) {
|
|
234
|
-
if (arguments.length === 1) {
|
|
235
|
-
this._boolFlag = bool;
|
|
236
|
-
return this;
|
|
237
|
-
}
|
|
238
|
-
const ret = this._boolFlag || 'and';
|
|
239
|
-
this._boolFlag = 'and';
|
|
240
|
-
return ret;
|
|
241
|
-
}
|
|
242
|
-
|
|
243
|
-
_not(val) {
|
|
244
|
-
if (arguments.length === 1) {
|
|
245
|
-
this._notFlag = val;
|
|
246
|
-
return this;
|
|
247
|
-
}
|
|
248
|
-
const ret = this._notFlag;
|
|
249
|
-
this._notFlag = false;
|
|
250
|
-
return ret;
|
|
251
|
-
}
|
|
252
|
-
}
|
|
253
|
-
|
|
254
|
-
Object.assign(JoinClause.prototype, {
|
|
255
|
-
grouping: 'join',
|
|
256
|
-
});
|
|
257
|
-
|
|
258
|
-
JoinClause.prototype.andOn = JoinClause.prototype.on;
|
|
259
|
-
JoinClause.prototype.andOnIn = JoinClause.prototype.onIn;
|
|
260
|
-
JoinClause.prototype.andOnNotIn = JoinClause.prototype.onNotIn;
|
|
261
|
-
JoinClause.prototype.andOnNull = JoinClause.prototype.onNull;
|
|
262
|
-
JoinClause.prototype.andOnNotNull = JoinClause.prototype.onNotNull;
|
|
263
|
-
JoinClause.prototype.andOnExists = JoinClause.prototype.onExists;
|
|
264
|
-
JoinClause.prototype.andOnNotExists = JoinClause.prototype.onNotExists;
|
|
265
|
-
JoinClause.prototype.andOnBetween = JoinClause.prototype.onBetween;
|
|
266
|
-
JoinClause.prototype.andOnNotBetween = JoinClause.prototype.onNotBetween;
|
|
267
|
-
JoinClause.prototype.andOnJsonPathEquals =
|
|
268
|
-
JoinClause.prototype.onJsonPathEquals;
|
|
269
|
-
|
|
270
|
-
module.exports = JoinClause;
|
|
1
|
+
const assert = require('assert');
|
|
2
|
+
|
|
3
|
+
// JoinClause
|
|
4
|
+
// -------
|
|
5
|
+
|
|
6
|
+
function getClauseFromArguments(compilerType, bool, first, operator, second) {
|
|
7
|
+
if (typeof first === 'function') {
|
|
8
|
+
return {
|
|
9
|
+
type: 'onWrapped',
|
|
10
|
+
value: first,
|
|
11
|
+
bool: bool,
|
|
12
|
+
};
|
|
13
|
+
}
|
|
14
|
+
|
|
15
|
+
switch (arguments.length) {
|
|
16
|
+
case 3:
|
|
17
|
+
return { type: 'onRaw', value: first, bool };
|
|
18
|
+
case 4:
|
|
19
|
+
return {
|
|
20
|
+
type: compilerType,
|
|
21
|
+
column: first,
|
|
22
|
+
operator: '=',
|
|
23
|
+
value: operator,
|
|
24
|
+
bool,
|
|
25
|
+
};
|
|
26
|
+
default:
|
|
27
|
+
return {
|
|
28
|
+
type: compilerType,
|
|
29
|
+
column: first,
|
|
30
|
+
operator,
|
|
31
|
+
value: second,
|
|
32
|
+
bool,
|
|
33
|
+
};
|
|
34
|
+
}
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
// The "JoinClause" is an object holding any necessary info about a join,
|
|
38
|
+
// including the type, and any associated tables & columns being joined.
|
|
39
|
+
class JoinClause {
|
|
40
|
+
constructor(table, type, schema) {
|
|
41
|
+
this.schema = schema;
|
|
42
|
+
this.table = table;
|
|
43
|
+
this.joinType = type;
|
|
44
|
+
this.and = this;
|
|
45
|
+
this.clauses = [];
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
get or() {
|
|
49
|
+
return this._bool('or');
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
// Adds an "on" clause to the current join object.
|
|
53
|
+
on(first) {
|
|
54
|
+
if (typeof first === 'object' && typeof first.toSQL !== 'function') {
|
|
55
|
+
const keys = Object.keys(first);
|
|
56
|
+
let i = -1;
|
|
57
|
+
const method = this._bool() === 'or' ? 'orOn' : 'on';
|
|
58
|
+
while (++i < keys.length) {
|
|
59
|
+
this[method](keys[i], first[keys[i]]);
|
|
60
|
+
}
|
|
61
|
+
return this;
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
const data = getClauseFromArguments('onBasic', this._bool(), ...arguments);
|
|
65
|
+
|
|
66
|
+
if (data) {
|
|
67
|
+
this.clauses.push(data);
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
return this;
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
// Adds an "or on" clause to the current join object.
|
|
74
|
+
orOn(first, operator, second) {
|
|
75
|
+
return this._bool('or').on.apply(this, arguments);
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
onJsonPathEquals(columnFirst, jsonPathFirst, columnSecond, jsonPathSecond) {
|
|
79
|
+
this.clauses.push({
|
|
80
|
+
type: 'onJsonPathEquals',
|
|
81
|
+
columnFirst: columnFirst,
|
|
82
|
+
jsonPathFirst: jsonPathFirst,
|
|
83
|
+
columnSecond: columnSecond,
|
|
84
|
+
jsonPathSecond: jsonPathSecond,
|
|
85
|
+
bool: this._bool(),
|
|
86
|
+
not: this._not(),
|
|
87
|
+
});
|
|
88
|
+
return this;
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
orOnJsonPathEquals(columnFirst, jsonPathFirst, columnSecond, jsonPathSecond) {
|
|
92
|
+
return this._bool('or').onJsonPathEquals.apply(this, arguments);
|
|
93
|
+
}
|
|
94
|
+
|
|
95
|
+
// Adds a "using" clause to the current join.
|
|
96
|
+
using(column) {
|
|
97
|
+
return this.clauses.push({ type: 'onUsing', column, bool: this._bool() });
|
|
98
|
+
}
|
|
99
|
+
|
|
100
|
+
onVal(first) {
|
|
101
|
+
if (typeof first === 'object' && typeof first.toSQL !== 'function') {
|
|
102
|
+
const keys = Object.keys(first);
|
|
103
|
+
let i = -1;
|
|
104
|
+
const method = this._bool() === 'or' ? 'orOnVal' : 'onVal';
|
|
105
|
+
while (++i < keys.length) {
|
|
106
|
+
this[method](keys[i], first[keys[i]]);
|
|
107
|
+
}
|
|
108
|
+
return this;
|
|
109
|
+
}
|
|
110
|
+
|
|
111
|
+
const data = getClauseFromArguments('onVal', this._bool(), ...arguments);
|
|
112
|
+
|
|
113
|
+
if (data) {
|
|
114
|
+
this.clauses.push(data);
|
|
115
|
+
}
|
|
116
|
+
|
|
117
|
+
return this;
|
|
118
|
+
}
|
|
119
|
+
|
|
120
|
+
andOnVal() {
|
|
121
|
+
return this.onVal(...arguments);
|
|
122
|
+
}
|
|
123
|
+
|
|
124
|
+
orOnVal() {
|
|
125
|
+
return this._bool('or').onVal(...arguments);
|
|
126
|
+
}
|
|
127
|
+
|
|
128
|
+
onBetween(column, values) {
|
|
129
|
+
assert(
|
|
130
|
+
Array.isArray(values),
|
|
131
|
+
'The second argument to onBetween must be an array.'
|
|
132
|
+
);
|
|
133
|
+
assert(
|
|
134
|
+
values.length === 2,
|
|
135
|
+
'You must specify 2 values for the onBetween clause'
|
|
136
|
+
);
|
|
137
|
+
this.clauses.push({
|
|
138
|
+
type: 'onBetween',
|
|
139
|
+
column,
|
|
140
|
+
value: values,
|
|
141
|
+
bool: this._bool(),
|
|
142
|
+
not: this._not(),
|
|
143
|
+
});
|
|
144
|
+
return this;
|
|
145
|
+
}
|
|
146
|
+
|
|
147
|
+
onNotBetween(column, values) {
|
|
148
|
+
return this._not(true).onBetween(column, values);
|
|
149
|
+
}
|
|
150
|
+
|
|
151
|
+
orOnBetween(column, values) {
|
|
152
|
+
return this._bool('or').onBetween(column, values);
|
|
153
|
+
}
|
|
154
|
+
|
|
155
|
+
orOnNotBetween(column, values) {
|
|
156
|
+
return this._bool('or')._not(true).onBetween(column, values);
|
|
157
|
+
}
|
|
158
|
+
|
|
159
|
+
onIn(column, values) {
|
|
160
|
+
if (Array.isArray(values) && values.length === 0) return this.on(1, '=', 0);
|
|
161
|
+
this.clauses.push({
|
|
162
|
+
type: 'onIn',
|
|
163
|
+
column,
|
|
164
|
+
value: values,
|
|
165
|
+
not: this._not(),
|
|
166
|
+
bool: this._bool(),
|
|
167
|
+
});
|
|
168
|
+
return this;
|
|
169
|
+
}
|
|
170
|
+
|
|
171
|
+
onNotIn(column, values) {
|
|
172
|
+
return this._not(true).onIn(column, values);
|
|
173
|
+
}
|
|
174
|
+
|
|
175
|
+
orOnIn(column, values) {
|
|
176
|
+
return this._bool('or').onIn(column, values);
|
|
177
|
+
}
|
|
178
|
+
|
|
179
|
+
orOnNotIn(column, values) {
|
|
180
|
+
return this._bool('or')._not(true).onIn(column, values);
|
|
181
|
+
}
|
|
182
|
+
|
|
183
|
+
onNull(column) {
|
|
184
|
+
this.clauses.push({
|
|
185
|
+
type: 'onNull',
|
|
186
|
+
column,
|
|
187
|
+
not: this._not(),
|
|
188
|
+
bool: this._bool(),
|
|
189
|
+
});
|
|
190
|
+
return this;
|
|
191
|
+
}
|
|
192
|
+
|
|
193
|
+
orOnNull(callback) {
|
|
194
|
+
return this._bool('or').onNull(callback);
|
|
195
|
+
}
|
|
196
|
+
|
|
197
|
+
onNotNull(callback) {
|
|
198
|
+
return this._not(true).onNull(callback);
|
|
199
|
+
}
|
|
200
|
+
|
|
201
|
+
orOnNotNull(callback) {
|
|
202
|
+
return this._not(true)._bool('or').onNull(callback);
|
|
203
|
+
}
|
|
204
|
+
|
|
205
|
+
onExists(callback) {
|
|
206
|
+
this.clauses.push({
|
|
207
|
+
type: 'onExists',
|
|
208
|
+
value: callback,
|
|
209
|
+
not: this._not(),
|
|
210
|
+
bool: this._bool(),
|
|
211
|
+
});
|
|
212
|
+
return this;
|
|
213
|
+
}
|
|
214
|
+
|
|
215
|
+
orOnExists(callback) {
|
|
216
|
+
return this._bool('or').onExists(callback);
|
|
217
|
+
}
|
|
218
|
+
|
|
219
|
+
onNotExists(callback) {
|
|
220
|
+
return this._not(true).onExists(callback);
|
|
221
|
+
}
|
|
222
|
+
|
|
223
|
+
orOnNotExists(callback) {
|
|
224
|
+
return this._not(true)._bool('or').onExists(callback);
|
|
225
|
+
}
|
|
226
|
+
|
|
227
|
+
// Explicitly set the type of join, useful within a function when creating a grouped join.
|
|
228
|
+
type(type) {
|
|
229
|
+
this.joinType = type;
|
|
230
|
+
return this;
|
|
231
|
+
}
|
|
232
|
+
|
|
233
|
+
_bool(bool) {
|
|
234
|
+
if (arguments.length === 1) {
|
|
235
|
+
this._boolFlag = bool;
|
|
236
|
+
return this;
|
|
237
|
+
}
|
|
238
|
+
const ret = this._boolFlag || 'and';
|
|
239
|
+
this._boolFlag = 'and';
|
|
240
|
+
return ret;
|
|
241
|
+
}
|
|
242
|
+
|
|
243
|
+
_not(val) {
|
|
244
|
+
if (arguments.length === 1) {
|
|
245
|
+
this._notFlag = val;
|
|
246
|
+
return this;
|
|
247
|
+
}
|
|
248
|
+
const ret = this._notFlag;
|
|
249
|
+
this._notFlag = false;
|
|
250
|
+
return ret;
|
|
251
|
+
}
|
|
252
|
+
}
|
|
253
|
+
|
|
254
|
+
Object.assign(JoinClause.prototype, {
|
|
255
|
+
grouping: 'join',
|
|
256
|
+
});
|
|
257
|
+
|
|
258
|
+
JoinClause.prototype.andOn = JoinClause.prototype.on;
|
|
259
|
+
JoinClause.prototype.andOnIn = JoinClause.prototype.onIn;
|
|
260
|
+
JoinClause.prototype.andOnNotIn = JoinClause.prototype.onNotIn;
|
|
261
|
+
JoinClause.prototype.andOnNull = JoinClause.prototype.onNull;
|
|
262
|
+
JoinClause.prototype.andOnNotNull = JoinClause.prototype.onNotNull;
|
|
263
|
+
JoinClause.prototype.andOnExists = JoinClause.prototype.onExists;
|
|
264
|
+
JoinClause.prototype.andOnNotExists = JoinClause.prototype.onNotExists;
|
|
265
|
+
JoinClause.prototype.andOnBetween = JoinClause.prototype.onBetween;
|
|
266
|
+
JoinClause.prototype.andOnNotBetween = JoinClause.prototype.onNotBetween;
|
|
267
|
+
JoinClause.prototype.andOnJsonPathEquals =
|
|
268
|
+
JoinClause.prototype.onJsonPathEquals;
|
|
269
|
+
|
|
270
|
+
module.exports = JoinClause;
|