kysely 0.23.1 → 0.23.2
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/README.md +5 -0
- package/dist/cjs/operation-node/on-conflict-node.d.ts +2 -0
- package/dist/cjs/operation-node/on-conflict-node.js +12 -0
- package/dist/cjs/operation-node/query-node.d.ts +1 -0
- package/dist/cjs/operation-node/query-node.js +6 -0
- package/dist/cjs/operation-node/select-query-node.d.ts +4 -0
- package/dist/cjs/operation-node/select-query-node.js +24 -0
- package/dist/cjs/query-builder/delete-query-builder.d.ts +63 -1
- package/dist/cjs/query-builder/delete-query-builder.js +51 -1
- package/dist/cjs/query-builder/insert-query-builder.d.ts +44 -1
- package/dist/cjs/query-builder/insert-query-builder.js +45 -1
- package/dist/cjs/query-builder/on-conflict-builder.d.ts +38 -0
- package/dist/cjs/query-builder/on-conflict-builder.js +12 -0
- package/dist/cjs/query-builder/select-query-builder.d.ts +138 -1
- package/dist/cjs/query-builder/select-query-builder.js +146 -1
- package/dist/cjs/query-builder/update-query-builder.d.ts +65 -1
- package/dist/cjs/query-builder/update-query-builder.js +53 -1
- package/dist/cjs/query-builder/where-interface.d.ts +19 -0
- package/dist/cjs/schema/alter-table-add-foreign-key-constraint-builder.d.ts +23 -0
- package/dist/cjs/schema/alter-table-add-foreign-key-constraint-builder.js +38 -0
- package/dist/cjs/schema/alter-table-builder.d.ts +3 -35
- package/dist/cjs/schema/alter-table-builder.js +10 -102
- package/dist/cjs/schema/alter-table-drop-constraint-builder.d.ts +21 -0
- package/dist/cjs/schema/alter-table-drop-constraint-builder.js +54 -0
- package/dist/cjs/schema/alter-table-executor.d.ts +18 -0
- package/dist/cjs/schema/alter-table-executor.js +22 -0
- package/dist/cjs/util/type-error.d.ts +3 -0
- package/dist/cjs/util/type-error.js +2 -0
- package/dist/esm/operation-node/on-conflict-node.d.ts +2 -0
- package/dist/esm/operation-node/on-conflict-node.js +12 -0
- package/dist/esm/operation-node/query-node.d.ts +1 -0
- package/dist/esm/operation-node/query-node.js +6 -0
- package/dist/esm/operation-node/select-query-node.d.ts +4 -0
- package/dist/esm/operation-node/select-query-node.js +24 -0
- package/dist/esm/query-builder/delete-query-builder.d.ts +63 -1
- package/dist/esm/query-builder/delete-query-builder.js +51 -1
- package/dist/esm/query-builder/insert-query-builder.d.ts +44 -1
- package/dist/esm/query-builder/insert-query-builder.js +45 -1
- package/dist/esm/query-builder/on-conflict-builder.d.ts +38 -0
- package/dist/esm/query-builder/on-conflict-builder.js +12 -0
- package/dist/esm/query-builder/select-query-builder.d.ts +138 -1
- package/dist/esm/query-builder/select-query-builder.js +146 -1
- package/dist/esm/query-builder/update-query-builder.d.ts +65 -1
- package/dist/esm/query-builder/update-query-builder.js +53 -1
- package/dist/esm/query-builder/where-interface.d.ts +19 -0
- package/dist/esm/schema/alter-table-add-foreign-key-constraint-builder.d.ts +23 -0
- package/dist/esm/schema/alter-table-add-foreign-key-constraint-builder.js +35 -0
- package/dist/esm/schema/alter-table-builder.d.ts +3 -35
- package/dist/esm/schema/alter-table-builder.js +4 -93
- package/dist/esm/schema/alter-table-drop-constraint-builder.d.ts +21 -0
- package/dist/esm/schema/alter-table-drop-constraint-builder.js +51 -0
- package/dist/esm/schema/alter-table-executor.d.ts +18 -0
- package/dist/esm/schema/alter-table-executor.js +19 -0
- package/dist/esm/util/type-error.d.ts +3 -0
- package/dist/esm/util/type-error.js +2 -0
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -37,6 +37,7 @@ You can find a more thorough introduction [here](https://www.jakso.me/blog/kysel
|
|
|
37
37
|
- [Installation](#installation)
|
|
38
38
|
- [3rd party dialects](#3rd-party-dialects)
|
|
39
39
|
- [Minimal example](#minimal-example)
|
|
40
|
+
- [Playground](#playground)
|
|
40
41
|
- [Generating types](#generating-types)
|
|
41
42
|
- [Query examples](#query-examples)
|
|
42
43
|
- [Select queries](#select-queries)
|
|
@@ -180,6 +181,10 @@ type InsertablePerson = Insertable<PersonTable>
|
|
|
180
181
|
type UpdateablePerson = Updateable<PersonTable>
|
|
181
182
|
```
|
|
182
183
|
|
|
184
|
+
# Playground
|
|
185
|
+
|
|
186
|
+
[@wirekang](https://github.com/wirekang) has created a [playground for Kysely](https://wirekang.github.io/kysely-playground/#eyJkaWFsZWN0IjoibXlzcWwiLCJ0cyI6ImludGVyZmFjZSBEQiB7XG4gIHVzZXI6IFVzZXJUYWJsZVxufVxuXG5pbnRlcmZhY2UgVXNlclRhYmxlIHtcbiAgaWQ6IEdlbmVyYXRlZDxzdHJpbmc+XG4gIGZpcnN0X25hbWU6IHN0cmluZyB8IG51bGxcbiAgbGFzdF9uYW1lOiBzdHJpbmcgfCBudWxsXG4gIGNyZWF0ZWRfYXQ6IEdlbmVyYXRlZDxEYXRlPlxufVxuXG5yZXN1bHQgPSBreXNlbHlcbiAgLnNlbGVjdEZyb20oXCJ1c2VyXCIpXG4gIC5zZWxlY3RBbGwoKVxuICAub3JkZXJCeShcImNyZWF0ZWRfYXRcIikifQ==). You can use to quickly test stuff out and for creating code examples for your issues, PRs and discord messages.
|
|
187
|
+
|
|
183
188
|
# Generating types
|
|
184
189
|
|
|
185
190
|
If you want to generate the table types automatically from the database schema please
|
|
@@ -25,4 +25,6 @@ export declare const OnConflictNode: Readonly<{
|
|
|
25
25
|
cloneWithIndexOrWhere(node: OnConflictNode, operation: OperationNode): OnConflictNode;
|
|
26
26
|
cloneWithUpdateWhere(node: OnConflictNode, operation: OperationNode): OnConflictNode;
|
|
27
27
|
cloneWithUpdateOrWhere(node: OnConflictNode, operation: OperationNode): OnConflictNode;
|
|
28
|
+
cloneWithoutIndexWhere(node: OnConflictNode): OnConflictNode;
|
|
29
|
+
cloneWithoutUpdateWhere(node: OnConflictNode): OnConflictNode;
|
|
28
30
|
}>;
|
|
@@ -53,4 +53,16 @@ exports.OnConflictNode = (0, object_utils_js_1.freeze)({
|
|
|
53
53
|
: where_node_js_1.WhereNode.create(operation),
|
|
54
54
|
});
|
|
55
55
|
},
|
|
56
|
+
cloneWithoutIndexWhere(node) {
|
|
57
|
+
return (0, object_utils_js_1.freeze)({
|
|
58
|
+
...node,
|
|
59
|
+
indexWhere: undefined,
|
|
60
|
+
});
|
|
61
|
+
},
|
|
62
|
+
cloneWithoutUpdateWhere(node) {
|
|
63
|
+
return (0, object_utils_js_1.freeze)({
|
|
64
|
+
...node,
|
|
65
|
+
updateWhere: undefined,
|
|
66
|
+
});
|
|
67
|
+
},
|
|
56
68
|
});
|
|
@@ -17,4 +17,5 @@ export declare const QueryNode: Readonly<{
|
|
|
17
17
|
cloneWithOrWhere<T_1 extends FilterableQueryNode>(node: T_1, operation: OperationNode): T_1;
|
|
18
18
|
cloneWithJoin<T_2 extends FilterableQueryNode>(node: T_2, join: JoinNode): T_2;
|
|
19
19
|
cloneWithReturning<T_3 extends MutatingQueryNode>(node: T_3, selections: ReadonlyArray<SelectionNode>): T_3;
|
|
20
|
+
cloneWithoutWhere<T_4 extends FilterableQueryNode>(node: T_4): T_4;
|
|
20
21
|
}>;
|
|
@@ -50,4 +50,8 @@ export declare const SelectQueryNode: Readonly<{
|
|
|
50
50
|
cloneWithOrHaving(selectNode: SelectQueryNode, operation: OperationNode): SelectQueryNode;
|
|
51
51
|
cloneWithSetOperation(selectNode: SelectQueryNode, setOperation: SetOperationNode): SelectQueryNode;
|
|
52
52
|
cloneWithExplain(selectNode: SelectQueryNode, explain: ExplainNode): SelectQueryNode;
|
|
53
|
+
cloneWithoutSelections(select: SelectQueryNode): SelectQueryNode;
|
|
54
|
+
cloneWithoutLimit(select: SelectQueryNode): SelectQueryNode;
|
|
55
|
+
cloneWithoutOffset(select: SelectQueryNode): SelectQueryNode;
|
|
56
|
+
cloneWithoutOrderBy(select: SelectQueryNode): SelectQueryNode;
|
|
53
57
|
}>;
|
|
@@ -110,4 +110,28 @@ exports.SelectQueryNode = (0, object_utils_js_1.freeze)({
|
|
|
110
110
|
explain,
|
|
111
111
|
});
|
|
112
112
|
},
|
|
113
|
+
cloneWithoutSelections(select) {
|
|
114
|
+
return (0, object_utils_js_1.freeze)({
|
|
115
|
+
...select,
|
|
116
|
+
selections: [],
|
|
117
|
+
});
|
|
118
|
+
},
|
|
119
|
+
cloneWithoutLimit(select) {
|
|
120
|
+
return (0, object_utils_js_1.freeze)({
|
|
121
|
+
...select,
|
|
122
|
+
limit: undefined,
|
|
123
|
+
});
|
|
124
|
+
},
|
|
125
|
+
cloneWithoutOffset(select) {
|
|
126
|
+
return (0, object_utils_js_1.freeze)({
|
|
127
|
+
...select,
|
|
128
|
+
offset: undefined,
|
|
129
|
+
});
|
|
130
|
+
},
|
|
131
|
+
cloneWithoutOrderBy(select) {
|
|
132
|
+
return (0, object_utils_js_1.freeze)({
|
|
133
|
+
...select,
|
|
134
|
+
orderBy: undefined,
|
|
135
|
+
});
|
|
136
|
+
},
|
|
113
137
|
});
|
|
@@ -21,6 +21,7 @@ import { Explainable, ExplainFormat } from '../util/explainable.js';
|
|
|
21
21
|
import { AliasedExpression, Expression } from '../expression/expression.js';
|
|
22
22
|
import { ComparisonOperatorExpression, OperandValueExpressionOrList, WhereGrouper } from '../parser/binary-operation-parser.js';
|
|
23
23
|
import { ExistsExpression } from '../parser/unary-operation-parser.js';
|
|
24
|
+
import { KyselyTypeError } from '../util/type-error.js';
|
|
24
25
|
export declare class DeleteQueryBuilder<DB, TB extends keyof DB, O> implements WhereInterface<DB, TB>, ReturningInterface<DB, TB, O>, OperationNodeSource, Compilable<O>, Explainable {
|
|
25
26
|
#private;
|
|
26
27
|
constructor(props: DeleteQueryBuilderProps);
|
|
@@ -408,6 +409,25 @@ export declare class DeleteQueryBuilder<DB, TB extends keyof DB, O> implements W
|
|
|
408
409
|
* Just like {@link whereExists} but creates an `or not exists` clause.
|
|
409
410
|
*/
|
|
410
411
|
orWhereNotExists(arg: ExistsExpression<DB, TB>): DeleteQueryBuilder<DB, TB, O>;
|
|
412
|
+
/**
|
|
413
|
+
* Clears all where clauses from the query.
|
|
414
|
+
*
|
|
415
|
+
* ### Examples
|
|
416
|
+
*
|
|
417
|
+
* ```ts
|
|
418
|
+
* db.selectFrom('person')
|
|
419
|
+
* .selectAll()
|
|
420
|
+
* .where('id','=',42)
|
|
421
|
+
* .clearWhere()
|
|
422
|
+
* ```
|
|
423
|
+
*
|
|
424
|
+
* The generated SQL(PostgreSQL):
|
|
425
|
+
*
|
|
426
|
+
* ```sql
|
|
427
|
+
* select * from "person"
|
|
428
|
+
* ```
|
|
429
|
+
*/
|
|
430
|
+
clearWhere(): DeleteQueryBuilder<DB, TB, O>;
|
|
411
431
|
/**
|
|
412
432
|
* Joins another table to the query using an inner join.
|
|
413
433
|
*
|
|
@@ -662,7 +682,7 @@ export declare class DeleteQueryBuilder<DB, TB extends keyof DB, O> implements W
|
|
|
662
682
|
*
|
|
663
683
|
* ### Examples
|
|
664
684
|
*
|
|
665
|
-
* The next example uses a helper
|
|
685
|
+
* The next example uses a helper function `log` to log a query:
|
|
666
686
|
*
|
|
667
687
|
* ```ts
|
|
668
688
|
* function log<T extends Compilable>(qb: T): T {
|
|
@@ -719,6 +739,48 @@ export declare class DeleteQueryBuilder<DB, TB extends keyof DB, O> implements W
|
|
|
719
739
|
* don't support your use case.
|
|
720
740
|
*/
|
|
721
741
|
castTo<T>(): DeleteQueryBuilder<DB, TB, T>;
|
|
742
|
+
/**
|
|
743
|
+
* Asserts that query's output row type equals the given type `T`.
|
|
744
|
+
*
|
|
745
|
+
* This method can be used to simplify excessively complex types to make typescript happy
|
|
746
|
+
* and much faster.
|
|
747
|
+
*
|
|
748
|
+
* Kysely uses complex type magic to achieve its type safety. This complexity is sometimes too much
|
|
749
|
+
* for typescript and you get errors like this:
|
|
750
|
+
*
|
|
751
|
+
* ```
|
|
752
|
+
* error TS2589: Type instantiation is excessively deep and possibly infinite.
|
|
753
|
+
* ```
|
|
754
|
+
*
|
|
755
|
+
* In these case you can often use this method to help typescript a little bit. When you use this
|
|
756
|
+
* method to assert the output type of a query, Kysely can drop the complex output type that
|
|
757
|
+
* consists of multiple nested helper types and replace it with the simple asserted type.
|
|
758
|
+
*
|
|
759
|
+
* Using this method doesn't reduce type safety at all. You have to pass in a type that is
|
|
760
|
+
* structurally equal to the current type.
|
|
761
|
+
*
|
|
762
|
+
* ### Examples
|
|
763
|
+
*
|
|
764
|
+
* ```ts
|
|
765
|
+
* const result = await db
|
|
766
|
+
* .with('deleted_person', (qb) => qb
|
|
767
|
+
* .deleteFrom('person')
|
|
768
|
+
* .where('id', '=', person.id)
|
|
769
|
+
* .returning('first_name')
|
|
770
|
+
* .assertType<{ first_name: string }>()
|
|
771
|
+
* )
|
|
772
|
+
* .with('deleted_pet', (qb) => qb
|
|
773
|
+
* .deleteFrom('pet')
|
|
774
|
+
* .where('owner_id', '=', person.id)
|
|
775
|
+
* .returning(['name as pet_name', 'species'])
|
|
776
|
+
* .assertType<{ pet_name: string, species: Species }>()
|
|
777
|
+
* )
|
|
778
|
+
* .selectFrom(['deleted_person', 'deleted_pet'])
|
|
779
|
+
* .selectAll()
|
|
780
|
+
* .executeTakeFirstOrThrow()
|
|
781
|
+
* ```
|
|
782
|
+
*/
|
|
783
|
+
assertType<T extends O>(): O extends T ? DeleteQueryBuilder<DB, TB, T> : KyselyTypeError<`assertType() call failed: The type passed in is not equal to the output type of the query.`>;
|
|
722
784
|
/**
|
|
723
785
|
* Returns a copy of this DeleteQueryBuilder instance with the given plugin installed.
|
|
724
786
|
*/
|
|
@@ -67,6 +67,12 @@ class DeleteQueryBuilder {
|
|
|
67
67
|
queryNode: query_node_js_1.QueryNode.cloneWithOrWhere(this.#props.queryNode, (0, unary_operation_parser_js_1.parseNotExists)(arg)),
|
|
68
68
|
});
|
|
69
69
|
}
|
|
70
|
+
clearWhere() {
|
|
71
|
+
return new DeleteQueryBuilder({
|
|
72
|
+
...this.#props,
|
|
73
|
+
queryNode: query_node_js_1.QueryNode.cloneWithoutWhere(this.#props.queryNode),
|
|
74
|
+
});
|
|
75
|
+
}
|
|
70
76
|
innerJoin(...args) {
|
|
71
77
|
return new DeleteQueryBuilder({
|
|
72
78
|
...this.#props,
|
|
@@ -175,7 +181,7 @@ class DeleteQueryBuilder {
|
|
|
175
181
|
*
|
|
176
182
|
* ### Examples
|
|
177
183
|
*
|
|
178
|
-
* The next example uses a helper
|
|
184
|
+
* The next example uses a helper function `log` to log a query:
|
|
179
185
|
*
|
|
180
186
|
* ```ts
|
|
181
187
|
* function log<T extends Compilable>(qb: T): T {
|
|
@@ -243,6 +249,50 @@ class DeleteQueryBuilder {
|
|
|
243
249
|
castTo() {
|
|
244
250
|
return new DeleteQueryBuilder(this.#props);
|
|
245
251
|
}
|
|
252
|
+
/**
|
|
253
|
+
* Asserts that query's output row type equals the given type `T`.
|
|
254
|
+
*
|
|
255
|
+
* This method can be used to simplify excessively complex types to make typescript happy
|
|
256
|
+
* and much faster.
|
|
257
|
+
*
|
|
258
|
+
* Kysely uses complex type magic to achieve its type safety. This complexity is sometimes too much
|
|
259
|
+
* for typescript and you get errors like this:
|
|
260
|
+
*
|
|
261
|
+
* ```
|
|
262
|
+
* error TS2589: Type instantiation is excessively deep and possibly infinite.
|
|
263
|
+
* ```
|
|
264
|
+
*
|
|
265
|
+
* In these case you can often use this method to help typescript a little bit. When you use this
|
|
266
|
+
* method to assert the output type of a query, Kysely can drop the complex output type that
|
|
267
|
+
* consists of multiple nested helper types and replace it with the simple asserted type.
|
|
268
|
+
*
|
|
269
|
+
* Using this method doesn't reduce type safety at all. You have to pass in a type that is
|
|
270
|
+
* structurally equal to the current type.
|
|
271
|
+
*
|
|
272
|
+
* ### Examples
|
|
273
|
+
*
|
|
274
|
+
* ```ts
|
|
275
|
+
* const result = await db
|
|
276
|
+
* .with('deleted_person', (qb) => qb
|
|
277
|
+
* .deleteFrom('person')
|
|
278
|
+
* .where('id', '=', person.id)
|
|
279
|
+
* .returning('first_name')
|
|
280
|
+
* .assertType<{ first_name: string }>()
|
|
281
|
+
* )
|
|
282
|
+
* .with('deleted_pet', (qb) => qb
|
|
283
|
+
* .deleteFrom('pet')
|
|
284
|
+
* .where('owner_id', '=', person.id)
|
|
285
|
+
* .returning(['name as pet_name', 'species'])
|
|
286
|
+
* .assertType<{ pet_name: string, species: Species }>()
|
|
287
|
+
* )
|
|
288
|
+
* .selectFrom(['deleted_person', 'deleted_pet'])
|
|
289
|
+
* .selectAll()
|
|
290
|
+
* .executeTakeFirstOrThrow()
|
|
291
|
+
* ```
|
|
292
|
+
*/
|
|
293
|
+
assertType() {
|
|
294
|
+
return new DeleteQueryBuilder(this.#props);
|
|
295
|
+
}
|
|
246
296
|
/**
|
|
247
297
|
* Returns a copy of this DeleteQueryBuilder instance with the given plugin installed.
|
|
248
298
|
*/
|
|
@@ -18,6 +18,7 @@ import { OnConflictBuilder, OnConflictDoNothingBuilder, OnConflictUpdateBuilder
|
|
|
18
18
|
import { Selectable } from '../util/column-type.js';
|
|
19
19
|
import { Explainable, ExplainFormat } from '../util/explainable.js';
|
|
20
20
|
import { Expression } from '../expression/expression.js';
|
|
21
|
+
import { KyselyTypeError } from '../util/type-error.js';
|
|
21
22
|
export declare class InsertQueryBuilder<DB, TB extends keyof DB, O> implements ReturningInterface<DB, TB, O>, OperationNodeSource, Compilable<O>, Explainable {
|
|
22
23
|
#private;
|
|
23
24
|
constructor(props: InsertQueryBuilderProps);
|
|
@@ -459,7 +460,7 @@ export declare class InsertQueryBuilder<DB, TB extends keyof DB, O> implements R
|
|
|
459
460
|
*
|
|
460
461
|
* ### Examples
|
|
461
462
|
*
|
|
462
|
-
* The next example uses a helper
|
|
463
|
+
* The next example uses a helper function `log` to log a query:
|
|
463
464
|
*
|
|
464
465
|
* ```ts
|
|
465
466
|
* function log<T extends Compilable>(qb: T): T {
|
|
@@ -517,6 +518,48 @@ export declare class InsertQueryBuilder<DB, TB extends keyof DB, O> implements R
|
|
|
517
518
|
* don't support your use case.
|
|
518
519
|
*/
|
|
519
520
|
castTo<T>(): InsertQueryBuilder<DB, TB, T>;
|
|
521
|
+
/**
|
|
522
|
+
* Asserts that query's output row type equals the given type `T`.
|
|
523
|
+
*
|
|
524
|
+
* This method can be used to simplify excessively complex types to make typescript happy
|
|
525
|
+
* and much faster.
|
|
526
|
+
*
|
|
527
|
+
* Kysely uses complex type magic to achieve its type safety. This complexity is sometimes too much
|
|
528
|
+
* for typescript and you get errors like this:
|
|
529
|
+
*
|
|
530
|
+
* ```
|
|
531
|
+
* error TS2589: Type instantiation is excessively deep and possibly infinite.
|
|
532
|
+
* ```
|
|
533
|
+
*
|
|
534
|
+
* In these case you can often use this method to help typescript a little bit. When you use this
|
|
535
|
+
* method to assert the output type of a query, Kysely can drop the complex output type that
|
|
536
|
+
* consists of multiple nested helper types and replace it with the simple asserted type.
|
|
537
|
+
*
|
|
538
|
+
* Using this method doesn't reduce type safety at all. You have to pass in a type that is
|
|
539
|
+
* structurally equal to the current type.
|
|
540
|
+
*
|
|
541
|
+
* ### Examples
|
|
542
|
+
*
|
|
543
|
+
* ```ts
|
|
544
|
+
* const result = await db
|
|
545
|
+
* .with('new_person', (qb) => qb
|
|
546
|
+
* .insertInto('person')
|
|
547
|
+
* .values(person)
|
|
548
|
+
* .returning('id')
|
|
549
|
+
* .assertType<{ id: string }>()
|
|
550
|
+
* )
|
|
551
|
+
* .with('new_pet', (qb) => qb
|
|
552
|
+
* .insertInto('pet')
|
|
553
|
+
* .values({ owner_id: (eb) => eb.selectFrom('new_person').select('id'), ...pet })
|
|
554
|
+
* .returning(['name as pet_name', 'species'])
|
|
555
|
+
* .assertType<{ pet_name: string, species: Species }>()
|
|
556
|
+
* )
|
|
557
|
+
* .selectFrom(['new_person', 'new_pet'])
|
|
558
|
+
* .selectAll()
|
|
559
|
+
* .executeTakeFirstOrThrow()
|
|
560
|
+
* ```
|
|
561
|
+
*/
|
|
562
|
+
assertType<T extends O>(): O extends T ? InsertQueryBuilder<DB, TB, T> : KyselyTypeError<`assertType() call failed: The type passed in is not equal to the output type of the query.`>;
|
|
520
563
|
/**
|
|
521
564
|
* Returns a copy of this InsertQueryBuilder instance with the given plugin installed.
|
|
522
565
|
*/
|
|
@@ -324,7 +324,7 @@ class InsertQueryBuilder {
|
|
|
324
324
|
*
|
|
325
325
|
* ### Examples
|
|
326
326
|
*
|
|
327
|
-
* The next example uses a helper
|
|
327
|
+
* The next example uses a helper function `log` to log a query:
|
|
328
328
|
*
|
|
329
329
|
* ```ts
|
|
330
330
|
* function log<T extends Compilable>(qb: T): T {
|
|
@@ -393,6 +393,50 @@ class InsertQueryBuilder {
|
|
|
393
393
|
castTo() {
|
|
394
394
|
return new InsertQueryBuilder(this.#props);
|
|
395
395
|
}
|
|
396
|
+
/**
|
|
397
|
+
* Asserts that query's output row type equals the given type `T`.
|
|
398
|
+
*
|
|
399
|
+
* This method can be used to simplify excessively complex types to make typescript happy
|
|
400
|
+
* and much faster.
|
|
401
|
+
*
|
|
402
|
+
* Kysely uses complex type magic to achieve its type safety. This complexity is sometimes too much
|
|
403
|
+
* for typescript and you get errors like this:
|
|
404
|
+
*
|
|
405
|
+
* ```
|
|
406
|
+
* error TS2589: Type instantiation is excessively deep and possibly infinite.
|
|
407
|
+
* ```
|
|
408
|
+
*
|
|
409
|
+
* In these case you can often use this method to help typescript a little bit. When you use this
|
|
410
|
+
* method to assert the output type of a query, Kysely can drop the complex output type that
|
|
411
|
+
* consists of multiple nested helper types and replace it with the simple asserted type.
|
|
412
|
+
*
|
|
413
|
+
* Using this method doesn't reduce type safety at all. You have to pass in a type that is
|
|
414
|
+
* structurally equal to the current type.
|
|
415
|
+
*
|
|
416
|
+
* ### Examples
|
|
417
|
+
*
|
|
418
|
+
* ```ts
|
|
419
|
+
* const result = await db
|
|
420
|
+
* .with('new_person', (qb) => qb
|
|
421
|
+
* .insertInto('person')
|
|
422
|
+
* .values(person)
|
|
423
|
+
* .returning('id')
|
|
424
|
+
* .assertType<{ id: string }>()
|
|
425
|
+
* )
|
|
426
|
+
* .with('new_pet', (qb) => qb
|
|
427
|
+
* .insertInto('pet')
|
|
428
|
+
* .values({ owner_id: (eb) => eb.selectFrom('new_person').select('id'), ...pet })
|
|
429
|
+
* .returning(['name as pet_name', 'species'])
|
|
430
|
+
* .assertType<{ pet_name: string, species: Species }>()
|
|
431
|
+
* )
|
|
432
|
+
* .selectFrom(['new_person', 'new_pet'])
|
|
433
|
+
* .selectAll()
|
|
434
|
+
* .executeTakeFirstOrThrow()
|
|
435
|
+
* ```
|
|
436
|
+
*/
|
|
437
|
+
assertType() {
|
|
438
|
+
return new InsertQueryBuilder(this.#props);
|
|
439
|
+
}
|
|
396
440
|
/**
|
|
397
441
|
* Returns a copy of this InsertQueryBuilder instance with the given plugin installed.
|
|
398
442
|
*/
|
|
@@ -339,6 +339,25 @@ export declare class OnConflictBuilder<DB, TB extends keyof DB> implements Where
|
|
|
339
339
|
* See {@link WhereInterface.orWhereNotExists} for more info.
|
|
340
340
|
*/
|
|
341
341
|
orWhereNotExists(arg: ExpressionOrFactory<DB, TB, any>): OnConflictBuilder<DB, TB>;
|
|
342
|
+
/**
|
|
343
|
+
* Clears all where clauses from the query.
|
|
344
|
+
*
|
|
345
|
+
* ### Examples
|
|
346
|
+
*
|
|
347
|
+
* ```ts
|
|
348
|
+
* db.selectFrom('person')
|
|
349
|
+
* .selectAll()
|
|
350
|
+
* .where('id','=',42)
|
|
351
|
+
* .clearWhere()
|
|
352
|
+
* ```
|
|
353
|
+
*
|
|
354
|
+
* The generated SQL(PostgreSQL):
|
|
355
|
+
*
|
|
356
|
+
* ```sql
|
|
357
|
+
* select * from "person"
|
|
358
|
+
* ```
|
|
359
|
+
*/
|
|
360
|
+
clearWhere(): OnConflictBuilder<DB, TB>;
|
|
342
361
|
/**
|
|
343
362
|
* Adds the "do nothing" conflict action.
|
|
344
363
|
*
|
|
@@ -703,5 +722,24 @@ export declare class OnConflictUpdateBuilder<DB, TB extends keyof DB> implements
|
|
|
703
722
|
* See {@link WhereInterface.orWhereNotExists} for more info.
|
|
704
723
|
*/
|
|
705
724
|
orWhereNotExists(arg: ExpressionOrFactory<DB, TB, any>): OnConflictUpdateBuilder<DB, TB>;
|
|
725
|
+
/**
|
|
726
|
+
* Clears all where clauses from the query.
|
|
727
|
+
*
|
|
728
|
+
* ### Examples
|
|
729
|
+
*
|
|
730
|
+
* ```ts
|
|
731
|
+
* db.selectFrom('person')
|
|
732
|
+
* .selectAll()
|
|
733
|
+
* .where('id','=',42)
|
|
734
|
+
* .clearWhere()
|
|
735
|
+
* ```
|
|
736
|
+
*
|
|
737
|
+
* The generated SQL(PostgreSQL):
|
|
738
|
+
*
|
|
739
|
+
* ```sql
|
|
740
|
+
* select * from "person"
|
|
741
|
+
* ```
|
|
742
|
+
*/
|
|
743
|
+
clearWhere(): OnConflictUpdateBuilder<DB, TB>;
|
|
706
744
|
toOperationNode(): OnConflictNode;
|
|
707
745
|
}
|
|
@@ -156,6 +156,12 @@ class OnConflictBuilder {
|
|
|
156
156
|
onConflictNode: on_conflict_node_js_1.OnConflictNode.cloneWithIndexOrWhere(this.#props.onConflictNode, (0, unary_operation_parser_js_1.parseNotExists)(arg)),
|
|
157
157
|
});
|
|
158
158
|
}
|
|
159
|
+
clearWhere() {
|
|
160
|
+
return new OnConflictBuilder({
|
|
161
|
+
...this.#props,
|
|
162
|
+
onConflictNode: on_conflict_node_js_1.OnConflictNode.cloneWithoutIndexWhere(this.#props.onConflictNode),
|
|
163
|
+
});
|
|
164
|
+
}
|
|
159
165
|
/**
|
|
160
166
|
* Adds the "do nothing" conflict action.
|
|
161
167
|
*
|
|
@@ -316,6 +322,12 @@ class OnConflictUpdateBuilder {
|
|
|
316
322
|
onConflictNode: on_conflict_node_js_1.OnConflictNode.cloneWithUpdateOrWhere(this.#props.onConflictNode, (0, unary_operation_parser_js_1.parseNotExists)(arg)),
|
|
317
323
|
});
|
|
318
324
|
}
|
|
325
|
+
clearWhere() {
|
|
326
|
+
return new OnConflictUpdateBuilder({
|
|
327
|
+
...this.#props,
|
|
328
|
+
onConflictNode: on_conflict_node_js_1.OnConflictNode.cloneWithoutUpdateWhere(this.#props.onConflictNode),
|
|
329
|
+
});
|
|
330
|
+
}
|
|
319
331
|
toOperationNode() {
|
|
320
332
|
return this.#props.onConflictNode;
|
|
321
333
|
}
|
|
@@ -19,6 +19,7 @@ import { Explainable, ExplainFormat } from '../util/explainable.js';
|
|
|
19
19
|
import { AliasedExpression, Expression } from '../expression/expression.js';
|
|
20
20
|
import { ComparisonOperatorExpression, HavingGrouper, OperandValueExpressionOrList, WhereGrouper } from '../parser/binary-operation-parser.js';
|
|
21
21
|
import { ExistsExpression } from '../parser/unary-operation-parser.js';
|
|
22
|
+
import { KyselyTypeError } from '../util/type-error.js';
|
|
22
23
|
export declare class SelectQueryBuilder<DB, TB extends keyof DB, O> implements WhereInterface<DB, TB>, HavingInterface<DB, TB>, Expression<O>, Compilable<O>, Explainable {
|
|
23
24
|
#private;
|
|
24
25
|
constructor(props: SelectQueryBuilderProps);
|
|
@@ -1291,6 +1292,102 @@ export declare class SelectQueryBuilder<DB, TB extends keyof DB, O> implements W
|
|
|
1291
1292
|
* ```
|
|
1292
1293
|
*/
|
|
1293
1294
|
exceptAll(expression: Expression<O>): SelectQueryBuilder<DB, TB, O>;
|
|
1295
|
+
/**
|
|
1296
|
+
* Clears all select clauses from the query.
|
|
1297
|
+
*
|
|
1298
|
+
* ### Examples
|
|
1299
|
+
*
|
|
1300
|
+
* ```ts
|
|
1301
|
+
* db.selectFrom('person')
|
|
1302
|
+
* .select(['id', 'first_name'])
|
|
1303
|
+
* .clearSelect()
|
|
1304
|
+
* .select(['id','gender'])
|
|
1305
|
+
* ```
|
|
1306
|
+
*
|
|
1307
|
+
* The generated SQL(PostgreSQL):
|
|
1308
|
+
*
|
|
1309
|
+
* ```sql
|
|
1310
|
+
* select "id", "gender" from "person"
|
|
1311
|
+
* ```
|
|
1312
|
+
*/
|
|
1313
|
+
clearSelect(): SelectQueryBuilder<DB, TB, {}>;
|
|
1314
|
+
/**
|
|
1315
|
+
* Clears all where clauses from the query.
|
|
1316
|
+
*
|
|
1317
|
+
* ### Examples
|
|
1318
|
+
*
|
|
1319
|
+
* ```ts
|
|
1320
|
+
* db.selectFrom('person')
|
|
1321
|
+
* .selectAll()
|
|
1322
|
+
* .where('id','=',42)
|
|
1323
|
+
* .clearWhere()
|
|
1324
|
+
* ```
|
|
1325
|
+
*
|
|
1326
|
+
* The generated SQL(PostgreSQL):
|
|
1327
|
+
*
|
|
1328
|
+
* ```sql
|
|
1329
|
+
* select * from "person"
|
|
1330
|
+
* ```
|
|
1331
|
+
*/
|
|
1332
|
+
clearWhere(): SelectQueryBuilder<DB, TB, O>;
|
|
1333
|
+
/**
|
|
1334
|
+
* Clears limit clause from the query.
|
|
1335
|
+
*
|
|
1336
|
+
* ### Examples
|
|
1337
|
+
*
|
|
1338
|
+
* ```ts
|
|
1339
|
+
* db.selectFrom('person')
|
|
1340
|
+
* .selectAll()
|
|
1341
|
+
* .limit(10)
|
|
1342
|
+
* .clearLimit()
|
|
1343
|
+
* ```
|
|
1344
|
+
*
|
|
1345
|
+
* The generated SQL(PostgreSQL):
|
|
1346
|
+
*
|
|
1347
|
+
* ```sql
|
|
1348
|
+
* select * from "person"
|
|
1349
|
+
* ```
|
|
1350
|
+
*/
|
|
1351
|
+
clearLimit(): SelectQueryBuilder<DB, TB, O>;
|
|
1352
|
+
/**
|
|
1353
|
+
* Clears offset clause from the query.
|
|
1354
|
+
*
|
|
1355
|
+
* ### Examples
|
|
1356
|
+
*
|
|
1357
|
+
* ```ts
|
|
1358
|
+
* db.selectFrom('person')
|
|
1359
|
+
* .selectAll()
|
|
1360
|
+
* .limit(10)
|
|
1361
|
+
* .offset(20)
|
|
1362
|
+
* .clearOffset()
|
|
1363
|
+
* ```
|
|
1364
|
+
*
|
|
1365
|
+
* The generated SQL(PostgreSQL):
|
|
1366
|
+
*
|
|
1367
|
+
* ```sql
|
|
1368
|
+
* select * from "person" limit 10
|
|
1369
|
+
* ```
|
|
1370
|
+
*/
|
|
1371
|
+
clearOffset(): SelectQueryBuilder<DB, TB, O>;
|
|
1372
|
+
/**
|
|
1373
|
+
* Clears all `order by` clauses from the query.
|
|
1374
|
+
*
|
|
1375
|
+
* ### Examples
|
|
1376
|
+
*
|
|
1377
|
+
* ```ts
|
|
1378
|
+
* db.selectFrom('person')
|
|
1379
|
+
* .selectAll()
|
|
1380
|
+
* .orderBy('id')
|
|
1381
|
+
* .clearOrderBy()
|
|
1382
|
+
* ```
|
|
1383
|
+
*
|
|
1384
|
+
* The generated SQL(PostgreSQL):
|
|
1385
|
+
*
|
|
1386
|
+
* ```sql
|
|
1387
|
+
* select * from "person"
|
|
1388
|
+
* ```
|
|
1389
|
+
*/
|
|
1390
|
+
clearOrderBy(): SelectQueryBuilder<DB, TB, O>;
|
|
1294
1391
|
/**
|
|
1295
1392
|
* Simply calls the given function passing `this` as the only argument.
|
|
1296
1393
|
*
|
|
@@ -1299,7 +1396,7 @@ export declare class SelectQueryBuilder<DB, TB extends keyof DB, O> implements W
|
|
|
1299
1396
|
*
|
|
1300
1397
|
* ### Examples
|
|
1301
1398
|
*
|
|
1302
|
-
* The next example uses a helper
|
|
1399
|
+
* The next example uses a helper function `log` to log a query:
|
|
1303
1400
|
*
|
|
1304
1401
|
* ```ts
|
|
1305
1402
|
* function log<T extends Compilable>(qb: T): T {
|
|
@@ -1392,6 +1489,46 @@ export declare class SelectQueryBuilder<DB, TB extends keyof DB, O> implements W
|
|
|
1392
1489
|
* don't support your use case.
|
|
1393
1490
|
*/
|
|
1394
1491
|
castTo<T>(): SelectQueryBuilder<DB, TB, T>;
|
|
1492
|
+
/**
|
|
1493
|
+
* Asserts that query's output row type equals the given type `T`.
|
|
1494
|
+
*
|
|
1495
|
+
* This method can be used to simplify excessively complex types to make typescript happy
|
|
1496
|
+
* and much faster.
|
|
1497
|
+
*
|
|
1498
|
+
* Kysely uses complex type magic to achieve its type safety. This complexity is sometimes too much
|
|
1499
|
+
* for typescript and you get errors like this:
|
|
1500
|
+
*
|
|
1501
|
+
* ```
|
|
1502
|
+
* error TS2589: Type instantiation is excessively deep and possibly infinite.
|
|
1503
|
+
* ```
|
|
1504
|
+
*
|
|
1505
|
+
* In these case you can often use this method to help typescript a little bit. When you use this
|
|
1506
|
+
* method to assert the output type of a query, Kysely can drop the complex output type that
|
|
1507
|
+
* consists of multiple nested helper types and replace it with the simple asserted type.
|
|
1508
|
+
*
|
|
1509
|
+
* Using this method doesn't reduce type safety at all. You have to pass in a type that is
|
|
1510
|
+
* structurally equal to the current type.
|
|
1511
|
+
*
|
|
1512
|
+
* ### Examples
|
|
1513
|
+
*
|
|
1514
|
+
* ```ts
|
|
1515
|
+
* const result = await db
|
|
1516
|
+
* .with('first_and_last', (qb) => qb
|
|
1517
|
+
* .selectFrom('person')
|
|
1518
|
+
* .select(['first_name', 'last_name'])
|
|
1519
|
+
* .assertType<{ first_name: string, last_name: string }>()
|
|
1520
|
+
* )
|
|
1521
|
+
* .with('age', (qb) => qb
|
|
1522
|
+
* .selectFrom('person')
|
|
1523
|
+
* .select('age')
|
|
1524
|
+
* .assertType<{ age: number }>()
|
|
1525
|
+
* )
|
|
1526
|
+
* .selectFrom(['first_and_last', 'age'])
|
|
1527
|
+
* .selectAll()
|
|
1528
|
+
* .executeTakeFirstOrThrow()
|
|
1529
|
+
* ```
|
|
1530
|
+
*/
|
|
1531
|
+
assertType<T extends O>(): O extends T ? SelectQueryBuilder<DB, TB, T> : KyselyTypeError<`assertType() call failed: The type passed in is not equal to the output type of the query.`>;
|
|
1395
1532
|
/**
|
|
1396
1533
|
* Returns a copy of this SelectQueryBuilder instance with the given plugin installed.
|
|
1397
1534
|
*/
|