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
|
@@ -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
|
*/
|
|
@@ -579,6 +579,109 @@ export class SelectQueryBuilder {
|
|
|
579
579
|
queryNode: SelectQueryNode.cloneWithSetOperation(this.#props.queryNode, parseSetOperation('except', expression, true)),
|
|
580
580
|
});
|
|
581
581
|
}
|
|
582
|
+
/**
|
|
583
|
+
* Clears all select clauses from the query.
|
|
584
|
+
*
|
|
585
|
+
* ### Examples
|
|
586
|
+
*
|
|
587
|
+
* ```ts
|
|
588
|
+
* db.selectFrom('person')
|
|
589
|
+
* .select(['id', 'first_name'])
|
|
590
|
+
* .clearSelect()
|
|
591
|
+
* .select(['id','gender'])
|
|
592
|
+
* ```
|
|
593
|
+
*
|
|
594
|
+
* The generated SQL(PostgreSQL):
|
|
595
|
+
*
|
|
596
|
+
* ```sql
|
|
597
|
+
* select "id", "gender" from "person"
|
|
598
|
+
* ```
|
|
599
|
+
*/
|
|
600
|
+
clearSelect() {
|
|
601
|
+
return new SelectQueryBuilder({
|
|
602
|
+
...this.#props,
|
|
603
|
+
queryNode: SelectQueryNode.cloneWithoutSelections(this.#props.queryNode),
|
|
604
|
+
});
|
|
605
|
+
}
|
|
606
|
+
clearWhere() {
|
|
607
|
+
return new SelectQueryBuilder({
|
|
608
|
+
...this.#props,
|
|
609
|
+
queryNode: QueryNode.cloneWithoutWhere(this.#props.queryNode),
|
|
610
|
+
});
|
|
611
|
+
}
|
|
612
|
+
/**
|
|
613
|
+
* Clears limit clause from the query.
|
|
614
|
+
*
|
|
615
|
+
* ### Examples
|
|
616
|
+
*
|
|
617
|
+
* ```ts
|
|
618
|
+
* db.selectFrom('person')
|
|
619
|
+
* .selectAll()
|
|
620
|
+
* .limit(10)
|
|
621
|
+
* .clearLimit()
|
|
622
|
+
* ```
|
|
623
|
+
*
|
|
624
|
+
* The generated SQL(PostgreSQL):
|
|
625
|
+
*
|
|
626
|
+
* ```sql
|
|
627
|
+
* select * from "person"
|
|
628
|
+
* ```
|
|
629
|
+
*/
|
|
630
|
+
clearLimit() {
|
|
631
|
+
return new SelectQueryBuilder({
|
|
632
|
+
...this.#props,
|
|
633
|
+
queryNode: SelectQueryNode.cloneWithoutLimit(this.#props.queryNode),
|
|
634
|
+
});
|
|
635
|
+
}
|
|
636
|
+
/**
|
|
637
|
+
* Clears offset clause from the query.
|
|
638
|
+
*
|
|
639
|
+
* ### Examples
|
|
640
|
+
*
|
|
641
|
+
* ```ts
|
|
642
|
+
* db.selectFrom('person')
|
|
643
|
+
* .selectAll()
|
|
644
|
+
* .limit(10)
|
|
645
|
+
* .offset(20)
|
|
646
|
+
* .clearOffset()
|
|
647
|
+
* ```
|
|
648
|
+
*
|
|
649
|
+
* The generated SQL(PostgreSQL):
|
|
650
|
+
*
|
|
651
|
+
* ```sql
|
|
652
|
+
* select * from "person" limit 10
|
|
653
|
+
* ```
|
|
654
|
+
*/
|
|
655
|
+
clearOffset() {
|
|
656
|
+
return new SelectQueryBuilder({
|
|
657
|
+
...this.#props,
|
|
658
|
+
queryNode: SelectQueryNode.cloneWithoutOffset(this.#props.queryNode),
|
|
659
|
+
});
|
|
660
|
+
}
|
|
661
|
+
/**
|
|
662
|
+
* Clears all `order by` clauses from the query.
|
|
663
|
+
*
|
|
664
|
+
* ### Examples
|
|
665
|
+
*
|
|
666
|
+
* ```ts
|
|
667
|
+
* db.selectFrom('person')
|
|
668
|
+
* .selectAll()
|
|
669
|
+
* .orderBy('id')
|
|
670
|
+
* .clearOrderBy()
|
|
671
|
+
* ```
|
|
672
|
+
*
|
|
673
|
+
* The generated SQL(PostgreSQL):
|
|
674
|
+
*
|
|
675
|
+
* ```sql
|
|
676
|
+
* select * from "person"
|
|
677
|
+
* ```
|
|
678
|
+
*/
|
|
679
|
+
clearOrderBy() {
|
|
680
|
+
return new SelectQueryBuilder({
|
|
681
|
+
...this.#props,
|
|
682
|
+
queryNode: SelectQueryNode.cloneWithoutOrderBy(this.#props.queryNode),
|
|
683
|
+
});
|
|
684
|
+
}
|
|
582
685
|
/**
|
|
583
686
|
* Simply calls the given function passing `this` as the only argument.
|
|
584
687
|
*
|
|
@@ -587,7 +690,7 @@ export class SelectQueryBuilder {
|
|
|
587
690
|
*
|
|
588
691
|
* ### Examples
|
|
589
692
|
*
|
|
590
|
-
* The next example uses a helper
|
|
693
|
+
* The next example uses a helper function `log` to log a query:
|
|
591
694
|
*
|
|
592
695
|
* ```ts
|
|
593
696
|
* function log<T extends Compilable>(qb: T): T {
|
|
@@ -693,6 +796,48 @@ export class SelectQueryBuilder {
|
|
|
693
796
|
castTo() {
|
|
694
797
|
return new SelectQueryBuilder(this.#props);
|
|
695
798
|
}
|
|
799
|
+
/**
|
|
800
|
+
* Asserts that query's output row type equals the given type `T`.
|
|
801
|
+
*
|
|
802
|
+
* This method can be used to simplify excessively complex types to make typescript happy
|
|
803
|
+
* and much faster.
|
|
804
|
+
*
|
|
805
|
+
* Kysely uses complex type magic to achieve its type safety. This complexity is sometimes too much
|
|
806
|
+
* for typescript and you get errors like this:
|
|
807
|
+
*
|
|
808
|
+
* ```
|
|
809
|
+
* error TS2589: Type instantiation is excessively deep and possibly infinite.
|
|
810
|
+
* ```
|
|
811
|
+
*
|
|
812
|
+
* In these case you can often use this method to help typescript a little bit. When you use this
|
|
813
|
+
* method to assert the output type of a query, Kysely can drop the complex output type that
|
|
814
|
+
* consists of multiple nested helper types and replace it with the simple asserted type.
|
|
815
|
+
*
|
|
816
|
+
* Using this method doesn't reduce type safety at all. You have to pass in a type that is
|
|
817
|
+
* structurally equal to the current type.
|
|
818
|
+
*
|
|
819
|
+
* ### Examples
|
|
820
|
+
*
|
|
821
|
+
* ```ts
|
|
822
|
+
* const result = await db
|
|
823
|
+
* .with('first_and_last', (qb) => qb
|
|
824
|
+
* .selectFrom('person')
|
|
825
|
+
* .select(['first_name', 'last_name'])
|
|
826
|
+
* .assertType<{ first_name: string, last_name: string }>()
|
|
827
|
+
* )
|
|
828
|
+
* .with('age', (qb) => qb
|
|
829
|
+
* .selectFrom('person')
|
|
830
|
+
* .select('age')
|
|
831
|
+
* .assertType<{ age: number }>()
|
|
832
|
+
* )
|
|
833
|
+
* .selectFrom(['first_and_last', 'age'])
|
|
834
|
+
* .selectAll()
|
|
835
|
+
* .executeTakeFirstOrThrow()
|
|
836
|
+
* ```
|
|
837
|
+
*/
|
|
838
|
+
assertType() {
|
|
839
|
+
return new SelectQueryBuilder(this.#props);
|
|
840
|
+
}
|
|
696
841
|
/**
|
|
697
842
|
* Returns a copy of this SelectQueryBuilder instance with the given plugin installed.
|
|
698
843
|
*/
|
|
@@ -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 UpdateQueryBuilder<DB, UT extends keyof 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: UpdateQueryBuilderProps);
|
|
@@ -408,6 +409,25 @@ export declare class UpdateQueryBuilder<DB, UT extends keyof DB, TB extends keyo
|
|
|
408
409
|
* Just like {@link whereExists} but creates an `or not exists` clause.
|
|
409
410
|
*/
|
|
410
411
|
orWhereNotExists(arg: ExistsExpression<DB, TB>): UpdateQueryBuilder<DB, UT, 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(): UpdateQueryBuilder<DB, UT, TB, O>;
|
|
411
431
|
/**
|
|
412
432
|
* Adds a from clause to the update query.
|
|
413
433
|
*
|
|
@@ -725,7 +745,7 @@ export declare class UpdateQueryBuilder<DB, UT extends keyof DB, TB extends keyo
|
|
|
725
745
|
*
|
|
726
746
|
* ### Examples
|
|
727
747
|
*
|
|
728
|
-
* The next example uses a helper
|
|
748
|
+
* The next example uses a helper function `log` to log a query:
|
|
729
749
|
*
|
|
730
750
|
* ```ts
|
|
731
751
|
* function log<T extends Compilable>(qb: T): T {
|
|
@@ -784,6 +804,50 @@ export declare class UpdateQueryBuilder<DB, UT extends keyof DB, TB extends keyo
|
|
|
784
804
|
* don't support your use case.
|
|
785
805
|
*/
|
|
786
806
|
castTo<T>(): UpdateQueryBuilder<DB, UT, TB, T>;
|
|
807
|
+
/**
|
|
808
|
+
* Asserts that query's output row type equals the given type `T`.
|
|
809
|
+
*
|
|
810
|
+
* This method can be used to simplify excessively complex types to make typescript happy
|
|
811
|
+
* and much faster.
|
|
812
|
+
*
|
|
813
|
+
* Kysely uses complex type magic to achieve its type safety. This complexity is sometimes too much
|
|
814
|
+
* for typescript and you get errors like this:
|
|
815
|
+
*
|
|
816
|
+
* ```
|
|
817
|
+
* error TS2589: Type instantiation is excessively deep and possibly infinite.
|
|
818
|
+
* ```
|
|
819
|
+
*
|
|
820
|
+
* In these case you can often use this method to help typescript a little bit. When you use this
|
|
821
|
+
* method to assert the output type of a query, Kysely can drop the complex output type that
|
|
822
|
+
* consists of multiple nested helper types and replace it with the simple asserted type.
|
|
823
|
+
*
|
|
824
|
+
* Using this method doesn't reduce type safety at all. You have to pass in a type that is
|
|
825
|
+
* structurally equal to the current type.
|
|
826
|
+
*
|
|
827
|
+
* ### Examples
|
|
828
|
+
*
|
|
829
|
+
* ```ts
|
|
830
|
+
* const result = await db
|
|
831
|
+
* .with('updated_person', (qb) => qb
|
|
832
|
+
* .updateTable('person')
|
|
833
|
+
* .set(person)
|
|
834
|
+
* .where('id', '=', person.id)
|
|
835
|
+
* .returning('first_name')
|
|
836
|
+
* .assertType<{ first_name: string }>()
|
|
837
|
+
* )
|
|
838
|
+
* .with('updated_pet', (qb) => qb
|
|
839
|
+
* .updateTable('pet')
|
|
840
|
+
* .set(pet)
|
|
841
|
+
* .where('owner_id', '=', person.id)
|
|
842
|
+
* .returning(['name as pet_name', 'species'])
|
|
843
|
+
* .assertType<{ pet_name: string, species: Species }>()
|
|
844
|
+
* )
|
|
845
|
+
* .selectFrom(['updated_person', 'updated_pet'])
|
|
846
|
+
* .selectAll()
|
|
847
|
+
* .executeTakeFirstOrThrow()
|
|
848
|
+
* ```
|
|
849
|
+
*/
|
|
850
|
+
assertType<T extends O>(): O extends T ? UpdateQueryBuilder<DB, UT, TB, T> : KyselyTypeError<`assertType() call failed: The type passed in is not equal to the output type of the query.`>;
|
|
787
851
|
/**
|
|
788
852
|
* Returns a copy of this UpdateQueryBuilder instance with the given plugin installed.
|
|
789
853
|
*/
|
|
@@ -65,6 +65,12 @@ export class UpdateQueryBuilder {
|
|
|
65
65
|
queryNode: QueryNode.cloneWithOrWhere(this.#props.queryNode, parseNotExists(arg)),
|
|
66
66
|
});
|
|
67
67
|
}
|
|
68
|
+
clearWhere() {
|
|
69
|
+
return new UpdateQueryBuilder({
|
|
70
|
+
...this.#props,
|
|
71
|
+
queryNode: QueryNode.cloneWithoutWhere(this.#props.queryNode),
|
|
72
|
+
});
|
|
73
|
+
}
|
|
68
74
|
from(from) {
|
|
69
75
|
return new UpdateQueryBuilder({
|
|
70
76
|
...this.#props,
|
|
@@ -208,7 +214,7 @@ export class UpdateQueryBuilder {
|
|
|
208
214
|
*
|
|
209
215
|
* ### Examples
|
|
210
216
|
*
|
|
211
|
-
* The next example uses a helper
|
|
217
|
+
* The next example uses a helper function `log` to log a query:
|
|
212
218
|
*
|
|
213
219
|
* ```ts
|
|
214
220
|
* function log<T extends Compilable>(qb: T): T {
|
|
@@ -278,6 +284,52 @@ export class UpdateQueryBuilder {
|
|
|
278
284
|
castTo() {
|
|
279
285
|
return new UpdateQueryBuilder(this.#props);
|
|
280
286
|
}
|
|
287
|
+
/**
|
|
288
|
+
* Asserts that query's output row type equals the given type `T`.
|
|
289
|
+
*
|
|
290
|
+
* This method can be used to simplify excessively complex types to make typescript happy
|
|
291
|
+
* and much faster.
|
|
292
|
+
*
|
|
293
|
+
* Kysely uses complex type magic to achieve its type safety. This complexity is sometimes too much
|
|
294
|
+
* for typescript and you get errors like this:
|
|
295
|
+
*
|
|
296
|
+
* ```
|
|
297
|
+
* error TS2589: Type instantiation is excessively deep and possibly infinite.
|
|
298
|
+
* ```
|
|
299
|
+
*
|
|
300
|
+
* In these case you can often use this method to help typescript a little bit. When you use this
|
|
301
|
+
* method to assert the output type of a query, Kysely can drop the complex output type that
|
|
302
|
+
* consists of multiple nested helper types and replace it with the simple asserted type.
|
|
303
|
+
*
|
|
304
|
+
* Using this method doesn't reduce type safety at all. You have to pass in a type that is
|
|
305
|
+
* structurally equal to the current type.
|
|
306
|
+
*
|
|
307
|
+
* ### Examples
|
|
308
|
+
*
|
|
309
|
+
* ```ts
|
|
310
|
+
* const result = await db
|
|
311
|
+
* .with('updated_person', (qb) => qb
|
|
312
|
+
* .updateTable('person')
|
|
313
|
+
* .set(person)
|
|
314
|
+
* .where('id', '=', person.id)
|
|
315
|
+
* .returning('first_name')
|
|
316
|
+
* .assertType<{ first_name: string }>()
|
|
317
|
+
* )
|
|
318
|
+
* .with('updated_pet', (qb) => qb
|
|
319
|
+
* .updateTable('pet')
|
|
320
|
+
* .set(pet)
|
|
321
|
+
* .where('owner_id', '=', person.id)
|
|
322
|
+
* .returning(['name as pet_name', 'species'])
|
|
323
|
+
* .assertType<{ pet_name: string, species: Species }>()
|
|
324
|
+
* )
|
|
325
|
+
* .selectFrom(['updated_person', 'updated_pet'])
|
|
326
|
+
* .selectAll()
|
|
327
|
+
* .executeTakeFirstOrThrow()
|
|
328
|
+
* ```
|
|
329
|
+
*/
|
|
330
|
+
assertType() {
|
|
331
|
+
return new UpdateQueryBuilder(this.#props);
|
|
332
|
+
}
|
|
281
333
|
/**
|
|
282
334
|
* Returns a copy of this UpdateQueryBuilder instance with the given plugin installed.
|
|
283
335
|
*/
|
|
@@ -387,4 +387,23 @@ export interface WhereInterface<DB, TB extends keyof DB> {
|
|
|
387
387
|
* Just like {@link whereExists} but creates an `or not exists` clause.
|
|
388
388
|
*/
|
|
389
389
|
orWhereNotExists(arg: ExistsExpression<DB, TB>): WhereInterface<DB, TB>;
|
|
390
|
+
/**
|
|
391
|
+
* Clears all where clauses from the query.
|
|
392
|
+
*
|
|
393
|
+
* ### Examples
|
|
394
|
+
*
|
|
395
|
+
* ```ts
|
|
396
|
+
* db.selectFrom('person')
|
|
397
|
+
* .selectAll()
|
|
398
|
+
* .where('id','=',42)
|
|
399
|
+
* .clearWhere()
|
|
400
|
+
* ```
|
|
401
|
+
*
|
|
402
|
+
* The generated SQL(PostgreSQL):
|
|
403
|
+
*
|
|
404
|
+
* ```sql
|
|
405
|
+
* select * from "person"
|
|
406
|
+
* ```
|
|
407
|
+
*/
|
|
408
|
+
clearWhere(): WhereInterface<DB, TB>;
|
|
390
409
|
}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import { AlterTableNode } from '../operation-node/alter-table-node.js';
|
|
2
|
+
import { OperationNodeSource } from '../operation-node/operation-node-source.js';
|
|
3
|
+
import { OnModifyForeignAction } from '../operation-node/references-node.js';
|
|
4
|
+
import { CompiledQuery } from '../query-compiler/compiled-query.js';
|
|
5
|
+
import { QueryExecutor } from '../query-executor/query-executor.js';
|
|
6
|
+
import { Compilable } from '../util/compilable.js';
|
|
7
|
+
import { QueryId } from '../util/query-id.js';
|
|
8
|
+
import { ForeignKeyConstraintBuilder, ForeignKeyConstraintBuilderInterface } from './foreign-key-constraint-builder.js';
|
|
9
|
+
export declare class AlterTableAddForeignKeyConstraintBuilder implements ForeignKeyConstraintBuilderInterface<AlterTableAddForeignKeyConstraintBuilder>, OperationNodeSource, Compilable {
|
|
10
|
+
#private;
|
|
11
|
+
constructor(props: AlterTableAddForeignKeyConstraintBuilderProps);
|
|
12
|
+
onDelete(onDelete: OnModifyForeignAction): AlterTableAddForeignKeyConstraintBuilder;
|
|
13
|
+
onUpdate(onUpdate: OnModifyForeignAction): AlterTableAddForeignKeyConstraintBuilder;
|
|
14
|
+
toOperationNode(): AlterTableNode;
|
|
15
|
+
compile(): CompiledQuery;
|
|
16
|
+
execute(): Promise<void>;
|
|
17
|
+
}
|
|
18
|
+
export interface AlterTableAddForeignKeyConstraintBuilderProps {
|
|
19
|
+
readonly queryId: QueryId;
|
|
20
|
+
readonly executor: QueryExecutor;
|
|
21
|
+
readonly node: AlterTableNode;
|
|
22
|
+
readonly constraintBuilder: ForeignKeyConstraintBuilder;
|
|
23
|
+
}
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
/// <reference types="./alter-table-add-foreign-key-constraint-builder.d.ts" />
|
|
2
|
+
import { AddConstraintNode } from '../operation-node/add-constraint-node.js';
|
|
3
|
+
import { AlterTableNode } from '../operation-node/alter-table-node.js';
|
|
4
|
+
import { freeze } from '../util/object-utils.js';
|
|
5
|
+
import { preventAwait } from '../util/prevent-await.js';
|
|
6
|
+
export class AlterTableAddForeignKeyConstraintBuilder {
|
|
7
|
+
#props;
|
|
8
|
+
constructor(props) {
|
|
9
|
+
this.#props = freeze(props);
|
|
10
|
+
}
|
|
11
|
+
onDelete(onDelete) {
|
|
12
|
+
return new AlterTableAddForeignKeyConstraintBuilder({
|
|
13
|
+
...this.#props,
|
|
14
|
+
constraintBuilder: this.#props.constraintBuilder.onDelete(onDelete),
|
|
15
|
+
});
|
|
16
|
+
}
|
|
17
|
+
onUpdate(onUpdate) {
|
|
18
|
+
return new AlterTableAddForeignKeyConstraintBuilder({
|
|
19
|
+
...this.#props,
|
|
20
|
+
constraintBuilder: this.#props.constraintBuilder.onUpdate(onUpdate),
|
|
21
|
+
});
|
|
22
|
+
}
|
|
23
|
+
toOperationNode() {
|
|
24
|
+
return this.#props.executor.transformQuery(AlterTableNode.cloneWithTableProps(this.#props.node, {
|
|
25
|
+
addConstraint: AddConstraintNode.create(this.#props.constraintBuilder.toOperationNode()),
|
|
26
|
+
}), this.#props.queryId);
|
|
27
|
+
}
|
|
28
|
+
compile() {
|
|
29
|
+
return this.#props.executor.compileQuery(this.toOperationNode(), this.#props.queryId);
|
|
30
|
+
}
|
|
31
|
+
async execute() {
|
|
32
|
+
await this.#props.executor.executeQuery(this.compile(), this.#props.queryId);
|
|
33
|
+
}
|
|
34
|
+
}
|
|
35
|
+
preventAwait(AlterTableAddForeignKeyConstraintBuilder, "don't await AlterTableAddForeignKeyConstraintBuilder instances directly. To execute the query you need to call `execute`");
|
|
@@ -1,15 +1,16 @@
|
|
|
1
1
|
import { AlterTableNode } from '../operation-node/alter-table-node.js';
|
|
2
2
|
import { OperationNodeSource } from '../operation-node/operation-node-source.js';
|
|
3
|
-
import { OnModifyForeignAction } from '../operation-node/references-node.js';
|
|
4
3
|
import { CompiledQuery } from '../query-compiler/compiled-query.js';
|
|
5
4
|
import { Compilable } from '../util/compilable.js';
|
|
6
5
|
import { ColumnDefinitionBuilderCallback } from './column-definition-builder.js';
|
|
7
6
|
import { QueryId } from '../util/query-id.js';
|
|
8
7
|
import { QueryExecutor } from '../query-executor/query-executor.js';
|
|
9
8
|
import { DataTypeExpression } from '../parser/data-type-parser.js';
|
|
10
|
-
import { ForeignKeyConstraintBuilder, ForeignKeyConstraintBuilderInterface } from './foreign-key-constraint-builder.js';
|
|
11
9
|
import { Expression } from '../expression/expression.js';
|
|
12
10
|
import { AlterColumnBuilderCallback } from './alter-column-builder.js';
|
|
11
|
+
import { AlterTableExecutor } from './alter-table-executor.js';
|
|
12
|
+
import { AlterTableAddForeignKeyConstraintBuilder } from './alter-table-add-foreign-key-constraint-builder.js';
|
|
13
|
+
import { AlterTableDropConstraintBuilder } from './alter-table-drop-constraint-builder.js';
|
|
13
14
|
/**
|
|
14
15
|
* This builder can be used to create a `alter table` query.
|
|
15
16
|
*/
|
|
@@ -60,15 +61,6 @@ export interface AlterTableBuilderProps {
|
|
|
60
61
|
readonly executor: QueryExecutor;
|
|
61
62
|
readonly node: AlterTableNode;
|
|
62
63
|
}
|
|
63
|
-
export declare class AlterTableExecutor implements OperationNodeSource, Compilable {
|
|
64
|
-
#private;
|
|
65
|
-
constructor(props: AlterTableExecutorProps);
|
|
66
|
-
toOperationNode(): AlterTableNode;
|
|
67
|
-
compile(): CompiledQuery;
|
|
68
|
-
execute(): Promise<void>;
|
|
69
|
-
}
|
|
70
|
-
export interface AlterTableExecutorProps extends AlterTableBuilderProps {
|
|
71
|
-
}
|
|
72
64
|
export interface ColumnAlteringInterface {
|
|
73
65
|
alterColumn(column: string, alteration: AlterColumnBuilderCallback): ColumnAlteringInterface;
|
|
74
66
|
dropColumn(column: string): ColumnAlteringInterface;
|
|
@@ -106,27 +98,3 @@ export declare class AlterTableColumnAlteringBuilder implements ColumnAlteringIn
|
|
|
106
98
|
}
|
|
107
99
|
export interface AlterTableColumnAlteringBuilderProps extends AlterTableBuilderProps {
|
|
108
100
|
}
|
|
109
|
-
export declare class AlterTableAddForeignKeyConstraintBuilder implements ForeignKeyConstraintBuilderInterface<AlterTableAddForeignKeyConstraintBuilder>, OperationNodeSource, Compilable {
|
|
110
|
-
#private;
|
|
111
|
-
constructor(props: AlterTableAddForeignKeyConstraintBuilderProps);
|
|
112
|
-
onDelete(onDelete: OnModifyForeignAction): AlterTableAddForeignKeyConstraintBuilder;
|
|
113
|
-
onUpdate(onUpdate: OnModifyForeignAction): AlterTableAddForeignKeyConstraintBuilder;
|
|
114
|
-
toOperationNode(): AlterTableNode;
|
|
115
|
-
compile(): CompiledQuery;
|
|
116
|
-
execute(): Promise<void>;
|
|
117
|
-
}
|
|
118
|
-
export interface AlterTableAddForeignKeyConstraintBuilderProps extends AlterTableBuilderProps {
|
|
119
|
-
readonly constraintBuilder: ForeignKeyConstraintBuilder;
|
|
120
|
-
}
|
|
121
|
-
export declare class AlterTableDropConstraintBuilder implements OperationNodeSource, Compilable {
|
|
122
|
-
#private;
|
|
123
|
-
constructor(props: AlterTableDropConstraintBuilderProps);
|
|
124
|
-
ifExists(): AlterTableDropConstraintBuilder;
|
|
125
|
-
cascade(): AlterTableDropConstraintBuilder;
|
|
126
|
-
restrict(): AlterTableDropConstraintBuilder;
|
|
127
|
-
toOperationNode(): AlterTableNode;
|
|
128
|
-
compile(): CompiledQuery;
|
|
129
|
-
execute(): Promise<void>;
|
|
130
|
-
}
|
|
131
|
-
export interface AlterTableDropConstraintBuilderProps extends AlterTableBuilderProps {
|
|
132
|
-
}
|