kysely 0.19.11 → 0.20.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/dist/cjs/dialect/mysql/mysql-introspector.js +2 -0
- package/dist/cjs/dialect/mysql/mysql-query-compiler.d.ts +5 -0
- package/dist/cjs/dialect/mysql/mysql-query-compiler.js +16 -0
- package/dist/cjs/dialect/postgres/postgres-introspector.js +17 -9
- package/dist/cjs/dialect/postgres/postgres-query-compiler.d.ts +1 -3
- package/dist/cjs/dialect/postgres/postgres-query-compiler.js +3 -8
- package/dist/cjs/dialect/sqlite/sqlite-introspector.js +2 -0
- package/dist/cjs/dialect/sqlite/sqlite-query-compiler.d.ts +3 -0
- package/dist/cjs/dialect/sqlite/sqlite-query-compiler.js +10 -0
- package/dist/cjs/index.d.ts +3 -0
- package/dist/cjs/index.js +3 -0
- package/dist/cjs/operation-node/create-table-node.d.ts +9 -2
- package/dist/cjs/operation-node/create-table-node.js +18 -1
- package/dist/cjs/operation-node/delete-query-node.d.ts +3 -0
- package/dist/cjs/operation-node/delete-query-node.js +6 -0
- package/dist/cjs/operation-node/explain-node.d.ts +16 -0
- package/dist/cjs/operation-node/explain-node.js +19 -0
- package/dist/cjs/operation-node/foreign-key-constraint-node.d.ts +2 -2
- package/dist/cjs/operation-node/insert-query-node.d.ts +2 -0
- package/dist/cjs/operation-node/operation-node-transformer.d.ts +2 -0
- package/dist/cjs/operation-node/operation-node-transformer.js +14 -0
- package/dist/cjs/operation-node/operation-node-visitor.d.ts +2 -0
- package/dist/cjs/operation-node/operation-node-visitor.js +1 -0
- package/dist/cjs/operation-node/operation-node.d.ts +1 -1
- package/dist/cjs/operation-node/reference-node.d.ts +1 -1
- package/dist/cjs/operation-node/reference-node.js +1 -2
- package/dist/cjs/operation-node/references-node.d.ts +3 -1
- package/dist/cjs/operation-node/references-node.js +8 -1
- package/dist/cjs/operation-node/select-query-node.d.ts +3 -0
- package/dist/cjs/operation-node/select-query-node.js +6 -0
- package/dist/cjs/operation-node/selection-node.d.ts +2 -1
- package/dist/cjs/operation-node/update-query-node.d.ts +3 -0
- package/dist/cjs/operation-node/update-query-node.js +6 -0
- package/dist/cjs/parser/on-commit-action-parse.d.ts +2 -0
- package/dist/cjs/parser/on-commit-action-parse.js +11 -0
- package/dist/cjs/parser/on-modify-action-parser.d.ts +2 -0
- package/dist/cjs/parser/on-modify-action-parser.js +11 -0
- package/dist/cjs/parser/select-parser.js +2 -1
- package/dist/cjs/query-builder/delete-query-builder.d.ts +19 -1
- package/dist/cjs/query-builder/delete-query-builder.js +24 -0
- package/dist/cjs/query-builder/function-builder.d.ts +3 -3
- package/dist/cjs/query-builder/insert-query-builder.d.ts +20 -2
- package/dist/cjs/query-builder/insert-query-builder.js +26 -0
- package/dist/cjs/query-builder/select-query-builder.d.ts +38 -1
- package/dist/cjs/query-builder/select-query-builder.js +45 -2
- package/dist/cjs/query-builder/update-query-builder.d.ts +20 -1
- package/dist/cjs/query-builder/update-query-builder.js +25 -0
- package/dist/cjs/query-compiler/default-query-compiler.d.ts +7 -0
- package/dist/cjs/query-compiler/default-query-compiler.js +74 -1
- package/dist/cjs/raw-builder/sql.d.ts +96 -96
- package/dist/cjs/raw-builder/sql.js +0 -96
- package/dist/cjs/schema/column-definition-builder.js +3 -2
- package/dist/cjs/schema/create-table-builder.d.ts +54 -0
- package/dist/cjs/schema/create-table-builder.js +66 -1
- package/dist/cjs/schema/foreign-key-constraint-builder.js +3 -2
- package/dist/cjs/util/explainable.d.ts +5 -0
- package/dist/cjs/util/explainable.js +2 -0
- package/dist/esm/dialect/mysql/mysql-introspector.js +2 -0
- package/dist/esm/dialect/mysql/mysql-query-compiler.d.ts +5 -0
- package/dist/esm/dialect/mysql/mysql-query-compiler.js +16 -0
- package/dist/esm/dialect/postgres/postgres-introspector.js +17 -9
- package/dist/esm/dialect/postgres/postgres-query-compiler.d.ts +1 -3
- package/dist/esm/dialect/postgres/postgres-query-compiler.js +3 -8
- package/dist/esm/dialect/sqlite/sqlite-introspector.js +2 -0
- package/dist/esm/dialect/sqlite/sqlite-query-compiler.d.ts +3 -0
- package/dist/esm/dialect/sqlite/sqlite-query-compiler.js +10 -0
- package/dist/esm/index.d.ts +3 -0
- package/dist/esm/index.js +3 -0
- package/dist/esm/operation-node/create-table-node.d.ts +9 -2
- package/dist/esm/operation-node/create-table-node.js +17 -0
- package/dist/esm/operation-node/delete-query-node.d.ts +3 -0
- package/dist/esm/operation-node/delete-query-node.js +6 -0
- package/dist/esm/operation-node/explain-node.d.ts +16 -0
- package/dist/esm/operation-node/explain-node.js +17 -0
- package/dist/esm/operation-node/foreign-key-constraint-node.d.ts +2 -2
- package/dist/esm/operation-node/insert-query-node.d.ts +2 -0
- package/dist/esm/operation-node/operation-node-transformer.d.ts +2 -0
- package/dist/esm/operation-node/operation-node-transformer.js +14 -0
- package/dist/esm/operation-node/operation-node-visitor.d.ts +2 -0
- package/dist/esm/operation-node/operation-node-visitor.js +1 -0
- package/dist/esm/operation-node/operation-node.d.ts +1 -1
- package/dist/esm/operation-node/reference-node.d.ts +1 -1
- package/dist/esm/operation-node/reference-node.js +1 -2
- package/dist/esm/operation-node/references-node.d.ts +3 -1
- package/dist/esm/operation-node/references-node.js +7 -0
- package/dist/esm/operation-node/select-query-node.d.ts +3 -0
- package/dist/esm/operation-node/select-query-node.js +6 -0
- package/dist/esm/operation-node/selection-node.d.ts +2 -1
- package/dist/esm/operation-node/update-query-node.d.ts +3 -0
- package/dist/esm/operation-node/update-query-node.js +6 -0
- package/dist/esm/parser/on-commit-action-parse.d.ts +2 -0
- package/dist/esm/parser/on-commit-action-parse.js +8 -0
- package/dist/esm/parser/on-modify-action-parser.d.ts +2 -0
- package/dist/esm/parser/on-modify-action-parser.js +8 -0
- package/dist/esm/parser/select-parser.js +2 -1
- package/dist/esm/query-builder/delete-query-builder.d.ts +19 -1
- package/dist/esm/query-builder/delete-query-builder.js +24 -0
- package/dist/esm/query-builder/function-builder.d.ts +3 -3
- package/dist/esm/query-builder/insert-query-builder.d.ts +20 -2
- package/dist/esm/query-builder/insert-query-builder.js +26 -0
- package/dist/esm/query-builder/select-query-builder.d.ts +38 -1
- package/dist/esm/query-builder/select-query-builder.js +45 -2
- package/dist/esm/query-builder/update-query-builder.d.ts +20 -1
- package/dist/esm/query-builder/update-query-builder.js +25 -0
- package/dist/esm/query-compiler/default-query-compiler.d.ts +7 -0
- package/dist/esm/query-compiler/default-query-compiler.js +74 -1
- package/dist/esm/raw-builder/sql.d.ts +96 -96
- package/dist/esm/raw-builder/sql.js +0 -96
- package/dist/esm/schema/column-definition-builder.js +3 -2
- package/dist/esm/schema/create-table-builder.d.ts +54 -0
- package/dist/esm/schema/create-table-builder.js +66 -1
- package/dist/esm/schema/foreign-key-constraint-builder.js +3 -2
- package/dist/esm/util/explainable.d.ts +5 -0
- package/dist/esm/util/explainable.js +2 -0
- package/package.json +3 -1
|
@@ -8,6 +8,7 @@ import { ValueListNode } from './value-list-node.js';
|
|
|
8
8
|
import { WhereNode } from './where-node.js';
|
|
9
9
|
import { WithNode } from './with-node.js';
|
|
10
10
|
import { FromNode } from './from-node.js';
|
|
11
|
+
import { ExplainNode } from './explain-node.js';
|
|
11
12
|
export declare type UpdateValuesNode = ValueListNode | PrimitiveValueListNode;
|
|
12
13
|
export interface UpdateQueryNode extends OperationNode {
|
|
13
14
|
readonly kind: 'UpdateQueryNode';
|
|
@@ -18,6 +19,7 @@ export interface UpdateQueryNode extends OperationNode {
|
|
|
18
19
|
readonly updates?: ReadonlyArray<ColumnUpdateNode>;
|
|
19
20
|
readonly returning?: ReturningNode;
|
|
20
21
|
readonly with?: WithNode;
|
|
22
|
+
readonly explain?: ExplainNode;
|
|
21
23
|
}
|
|
22
24
|
/**
|
|
23
25
|
* @internal
|
|
@@ -27,4 +29,5 @@ export declare const UpdateQueryNode: Readonly<{
|
|
|
27
29
|
create(table: TableExpressionNode, withNode?: WithNode): UpdateQueryNode;
|
|
28
30
|
cloneWithFromItems(updateQuery: UpdateQueryNode, fromItems: ReadonlyArray<TableExpressionNode>): UpdateQueryNode;
|
|
29
31
|
cloneWithUpdates(updateQuery: UpdateQueryNode, updates: ReadonlyArray<ColumnUpdateNode>): UpdateQueryNode;
|
|
32
|
+
cloneWithExplain(updateQuery: UpdateQueryNode, explain: ExplainNode): UpdateQueryNode;
|
|
30
33
|
}>;
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.parseOnCommitAction = void 0;
|
|
4
|
+
const create_table_node_js_1 = require("../operation-node/create-table-node.js");
|
|
5
|
+
function parseOnCommitAction(action) {
|
|
6
|
+
if (create_table_node_js_1.ON_COMMIT_ACTIONS.includes(action)) {
|
|
7
|
+
return action;
|
|
8
|
+
}
|
|
9
|
+
throw new Error(`invalid OnCommitAction ${action}`);
|
|
10
|
+
}
|
|
11
|
+
exports.parseOnCommitAction = parseOnCommitAction;
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.parseOnModifyForeignAction = void 0;
|
|
4
|
+
const references_node_js_1 = require("../operation-node/references-node.js");
|
|
5
|
+
function parseOnModifyForeignAction(action) {
|
|
6
|
+
if (references_node_js_1.ON_MODIFY_FOREIGN_ACTIONS.includes(action)) {
|
|
7
|
+
return action;
|
|
8
|
+
}
|
|
9
|
+
throw new Error(`invalid OnModifyForeignAction ${action}`);
|
|
10
|
+
}
|
|
11
|
+
exports.parseOnModifyForeignAction = parseOnModifyForeignAction;
|
|
@@ -6,6 +6,7 @@ const selection_node_js_1 = require("../operation-node/selection-node.js");
|
|
|
6
6
|
const reference_parser_js_1 = require("./reference-parser.js");
|
|
7
7
|
const dynamic_reference_builder_js_1 = require("../dynamic/dynamic-reference-builder.js");
|
|
8
8
|
const complex_expression_parser_js_1 = require("./complex-expression-parser.js");
|
|
9
|
+
const table_parser_js_1 = require("./table-parser.js");
|
|
9
10
|
function parseSelectExpressionOrList(selection) {
|
|
10
11
|
if ((0, object_utils_js_1.isReadonlyArray)(selection)) {
|
|
11
12
|
return selection.map((it) => parseSelectExpression(it));
|
|
@@ -40,7 +41,7 @@ function parseSelectAll(table) {
|
|
|
40
41
|
exports.parseSelectAll = parseSelectAll;
|
|
41
42
|
function parseSelectAllArg(table) {
|
|
42
43
|
if ((0, object_utils_js_1.isString)(table)) {
|
|
43
|
-
return selection_node_js_1.SelectionNode.createSelectAllFromTable(table);
|
|
44
|
+
return selection_node_js_1.SelectionNode.createSelectAllFromTable((0, table_parser_js_1.parseTable)(table));
|
|
44
45
|
}
|
|
45
46
|
throw new Error(`invalid value selectAll expression: ${JSON.stringify(table)}`);
|
|
46
47
|
}
|
|
@@ -20,7 +20,8 @@ import { Selectable } from '../util/column-type.js';
|
|
|
20
20
|
import { OrderByDirectionExpression, OrderByExpression } from '../parser/order-by-parser.js';
|
|
21
21
|
import { AliasedQueryBuilder } from './select-query-builder.js';
|
|
22
22
|
import { AliasedRawBuilder } from '../raw-builder/raw-builder.js';
|
|
23
|
-
|
|
23
|
+
import { Explainable, ExplainFormat } from '../util/explainable.js';
|
|
24
|
+
export declare class DeleteQueryBuilder<DB, TB extends keyof DB, O> implements WhereInterface<DB, TB>, ReturningInterface<DB, TB, O>, OperationNodeSource, Compilable, Explainable {
|
|
24
25
|
#private;
|
|
25
26
|
constructor(props: DeleteQueryBuilderProps);
|
|
26
27
|
/**
|
|
@@ -744,6 +745,23 @@ export declare class DeleteQueryBuilder<DB, TB extends keyof DB, O> implements W
|
|
|
744
745
|
* error.
|
|
745
746
|
*/
|
|
746
747
|
executeTakeFirstOrThrow(errorConstructor?: NoResultErrorConstructor): Promise<O>;
|
|
748
|
+
/**
|
|
749
|
+
* Executes query with `explain` statement before `delete` keyword.
|
|
750
|
+
*
|
|
751
|
+
* ```ts
|
|
752
|
+
* const explained = await db
|
|
753
|
+
* .deleteFrom('person')
|
|
754
|
+
* .where('id', '=', 123)
|
|
755
|
+
* .explain('json')
|
|
756
|
+
* ```
|
|
757
|
+
*
|
|
758
|
+
* The generated SQL (MySQL):
|
|
759
|
+
*
|
|
760
|
+
* ```sql
|
|
761
|
+
* explain format=json delete from `person` where `id` = ?
|
|
762
|
+
* ```
|
|
763
|
+
*/
|
|
764
|
+
explain<ER extends Record<string, any> = Record<string, any>>(format?: ExplainFormat, options?: AnyRawBuilder): Promise<ER[]>;
|
|
747
765
|
}
|
|
748
766
|
export interface DeleteQueryBuilderProps {
|
|
749
767
|
readonly queryId: QueryId;
|
|
@@ -12,6 +12,7 @@ const delete_result_js_1 = require("./delete-result.js");
|
|
|
12
12
|
const delete_query_node_js_1 = require("../operation-node/delete-query-node.js");
|
|
13
13
|
const limit_node_js_1 = require("../operation-node/limit-node.js");
|
|
14
14
|
const order_by_parser_js_1 = require("../parser/order-by-parser.js");
|
|
15
|
+
const explain_node_js_1 = require("../operation-node/explain-node.js");
|
|
15
16
|
class DeleteQueryBuilder {
|
|
16
17
|
#props;
|
|
17
18
|
constructor(props) {
|
|
@@ -295,6 +296,29 @@ class DeleteQueryBuilder {
|
|
|
295
296
|
}
|
|
296
297
|
return result;
|
|
297
298
|
}
|
|
299
|
+
/**
|
|
300
|
+
* Executes query with `explain` statement before `delete` keyword.
|
|
301
|
+
*
|
|
302
|
+
* ```ts
|
|
303
|
+
* const explained = await db
|
|
304
|
+
* .deleteFrom('person')
|
|
305
|
+
* .where('id', '=', 123)
|
|
306
|
+
* .explain('json')
|
|
307
|
+
* ```
|
|
308
|
+
*
|
|
309
|
+
* The generated SQL (MySQL):
|
|
310
|
+
*
|
|
311
|
+
* ```sql
|
|
312
|
+
* explain format=json delete from `person` where `id` = ?
|
|
313
|
+
* ```
|
|
314
|
+
*/
|
|
315
|
+
async explain(format, options) {
|
|
316
|
+
const builder = new DeleteQueryBuilder({
|
|
317
|
+
...this.#props,
|
|
318
|
+
queryNode: delete_query_node_js_1.DeleteQueryNode.cloneWithExplain(this.#props.queryNode, explain_node_js_1.ExplainNode.create(format, options)),
|
|
319
|
+
});
|
|
320
|
+
return await builder.execute();
|
|
321
|
+
}
|
|
298
322
|
}
|
|
299
323
|
exports.DeleteQueryBuilder = DeleteQueryBuilder;
|
|
300
324
|
(0, prevent_await_js_1.preventAwait)(DeleteQueryBuilder, "don't await DeleteQueryBuilder instances directly. To execute the query you need to call `execute` or `executeTakeFirst`.");
|
|
@@ -85,7 +85,7 @@ export declare class FunctionBuilder<DB, TB extends keyof DB> {
|
|
|
85
85
|
* .execute()
|
|
86
86
|
* ```
|
|
87
87
|
*/
|
|
88
|
-
avg<O extends number | string, C extends StringReference<DB, TB> =
|
|
88
|
+
avg<O extends number | string, C extends StringReference<DB, TB> = StringReference<DB, TB>>(column: C): RawBuilder<O>;
|
|
89
89
|
/**
|
|
90
90
|
* Calls the `sum` function for the column given as the argument.
|
|
91
91
|
*
|
|
@@ -107,7 +107,7 @@ export declare class FunctionBuilder<DB, TB extends keyof DB> {
|
|
|
107
107
|
* .execute()
|
|
108
108
|
* ```
|
|
109
109
|
*/
|
|
110
|
-
sum<O extends number | string | bigint, C extends StringReference<DB, TB> =
|
|
110
|
+
sum<O extends number | string | bigint, C extends StringReference<DB, TB> = StringReference<DB, TB>>(column: C): RawBuilder<O>;
|
|
111
111
|
/**
|
|
112
112
|
* Calls the `count` function for the column given as the argument.
|
|
113
113
|
*
|
|
@@ -129,5 +129,5 @@ export declare class FunctionBuilder<DB, TB extends keyof DB> {
|
|
|
129
129
|
* .execute()
|
|
130
130
|
* ```
|
|
131
131
|
*/
|
|
132
|
-
count<O extends number | string | bigint, C extends StringReference<DB, TB> =
|
|
132
|
+
count<O extends number | string | bigint, C extends StringReference<DB, TB> = StringReference<DB, TB>>(column: C): RawBuilder<O>;
|
|
133
133
|
}
|
|
@@ -3,7 +3,7 @@ import { CompiledQuery } from '../query-compiler/compiled-query.js';
|
|
|
3
3
|
import { SelectExpression } from '../parser/select-parser.js';
|
|
4
4
|
import { InsertObject } from '../parser/insert-values-parser.js';
|
|
5
5
|
import { InsertQueryNode } from '../operation-node/insert-query-node.js';
|
|
6
|
-
import { MergePartial, SingleResultType } from '../util/type-utils.js';
|
|
6
|
+
import { AnyRawBuilder, MergePartial, SingleResultType } from '../util/type-utils.js';
|
|
7
7
|
import { MutationObject } from '../parser/update-set-parser.js';
|
|
8
8
|
import { Compilable } from '../util/compilable.js';
|
|
9
9
|
import { QueryExecutor } from '../query-executor/query-executor.js';
|
|
@@ -16,7 +16,8 @@ import { ComplexExpression } from '../parser/complex-expression-parser.js';
|
|
|
16
16
|
import { ReturningInterface } from './returning-interface.js';
|
|
17
17
|
import { OnConflictBuilder, OnConflictDoNothingBuilder, OnConflictUpdateBuilder } from './on-conflict-builder.js';
|
|
18
18
|
import { Selectable } from '../util/column-type.js';
|
|
19
|
-
|
|
19
|
+
import { Explainable, ExplainFormat } from '../util/explainable.js';
|
|
20
|
+
export declare class InsertQueryBuilder<DB, TB extends keyof DB, O> implements ReturningInterface<DB, TB, O>, OperationNodeSource, Compilable, Explainable {
|
|
20
21
|
#private;
|
|
21
22
|
constructor(props: InsertQueryBuilderProps);
|
|
22
23
|
/**
|
|
@@ -541,6 +542,23 @@ export declare class InsertQueryBuilder<DB, TB extends keyof DB, O> implements R
|
|
|
541
542
|
* error.
|
|
542
543
|
*/
|
|
543
544
|
executeTakeFirstOrThrow(errorConstructor?: NoResultErrorConstructor): Promise<O>;
|
|
545
|
+
/**
|
|
546
|
+
* Executes query with `explain` statement before `insert` keyword.
|
|
547
|
+
*
|
|
548
|
+
* ```ts
|
|
549
|
+
* const explained = await db
|
|
550
|
+
* .insertInto('person')
|
|
551
|
+
* .values(values)
|
|
552
|
+
* .explain('json')
|
|
553
|
+
* ```
|
|
554
|
+
*
|
|
555
|
+
* The generated SQL (MySQL):
|
|
556
|
+
*
|
|
557
|
+
* ```sql
|
|
558
|
+
* explain format=json insert into `person` (`id`, `first_name`, `last_name`) values (?, ?, ?) (?, ?, ?)
|
|
559
|
+
* ```
|
|
560
|
+
*/
|
|
561
|
+
explain<ER extends Record<string, any> = Record<string, any>>(format?: ExplainFormat, options?: AnyRawBuilder): Promise<ER[]>;
|
|
544
562
|
}
|
|
545
563
|
export interface InsertQueryBuilderProps {
|
|
546
564
|
readonly queryId: QueryId;
|
|
@@ -15,6 +15,7 @@ const complex_expression_parser_js_1 = require("../parser/complex-expression-par
|
|
|
15
15
|
const column_node_js_1 = require("../operation-node/column-node.js");
|
|
16
16
|
const on_conflict_builder_js_1 = require("./on-conflict-builder.js");
|
|
17
17
|
const on_conflict_node_js_1 = require("../operation-node/on-conflict-node.js");
|
|
18
|
+
const explain_node_js_1 = require("../operation-node/explain-node.js");
|
|
18
19
|
class InsertQueryBuilder {
|
|
19
20
|
#props;
|
|
20
21
|
constructor(props) {
|
|
@@ -446,6 +447,31 @@ class InsertQueryBuilder {
|
|
|
446
447
|
}
|
|
447
448
|
return result;
|
|
448
449
|
}
|
|
450
|
+
/**
|
|
451
|
+
* Executes query with `explain` statement before `insert` keyword.
|
|
452
|
+
*
|
|
453
|
+
* ```ts
|
|
454
|
+
* const explained = await db
|
|
455
|
+
* .insertInto('person')
|
|
456
|
+
* .values(values)
|
|
457
|
+
* .explain('json')
|
|
458
|
+
* ```
|
|
459
|
+
*
|
|
460
|
+
* The generated SQL (MySQL):
|
|
461
|
+
*
|
|
462
|
+
* ```sql
|
|
463
|
+
* explain format=json insert into `person` (`id`, `first_name`, `last_name`) values (?, ?, ?) (?, ?, ?)
|
|
464
|
+
* ```
|
|
465
|
+
*/
|
|
466
|
+
async explain(format, options) {
|
|
467
|
+
const builder = new InsertQueryBuilder({
|
|
468
|
+
...this.#props,
|
|
469
|
+
queryNode: insert_query_node_js_1.InsertQueryNode.cloneWith(this.#props.queryNode, {
|
|
470
|
+
explain: explain_node_js_1.ExplainNode.create(format, options),
|
|
471
|
+
}),
|
|
472
|
+
});
|
|
473
|
+
return await builder.execute();
|
|
474
|
+
}
|
|
449
475
|
}
|
|
450
476
|
exports.InsertQueryBuilder = InsertQueryBuilder;
|
|
451
477
|
(0, prevent_await_js_1.preventAwait)(InsertQueryBuilder, "don't await InsertQueryBuilder instances directly. To execute the query you need to call `execute` or `executeTakeFirst`.");
|
|
@@ -18,7 +18,8 @@ import { WhereInterface } from './where-interface.js';
|
|
|
18
18
|
import { NoResultErrorConstructor } from './no-result-error.js';
|
|
19
19
|
import { HavingInterface } from './having-interface.js';
|
|
20
20
|
import { AliasedRawBuilder } from '../raw-builder/raw-builder.js';
|
|
21
|
-
|
|
21
|
+
import { Explainable, ExplainFormat } from '../util/explainable.js';
|
|
22
|
+
export declare class SelectQueryBuilder<DB, TB extends keyof DB, O> implements WhereInterface<DB, TB>, HavingInterface<DB, TB>, OperationNodeSource, Compilable, Explainable {
|
|
22
23
|
#private;
|
|
23
24
|
constructor(props: SelectQueryBuilderProps);
|
|
24
25
|
/**
|
|
@@ -1370,6 +1371,42 @@ export declare class SelectQueryBuilder<DB, TB extends keyof DB, O> implements W
|
|
|
1370
1371
|
* ```
|
|
1371
1372
|
*/
|
|
1372
1373
|
stream(chunkSize?: number): AsyncIterableIterator<O>;
|
|
1374
|
+
/**
|
|
1375
|
+
* Executes query with `explain` statement before `select` keyword.
|
|
1376
|
+
*
|
|
1377
|
+
* ```ts
|
|
1378
|
+
* const explained = await db
|
|
1379
|
+
* .selectFrom('person')
|
|
1380
|
+
* .where('gender', '=', 'female')
|
|
1381
|
+
* .selectAll()
|
|
1382
|
+
* .explain('json')
|
|
1383
|
+
* ```
|
|
1384
|
+
*
|
|
1385
|
+
* The generated SQL (MySQL):
|
|
1386
|
+
*
|
|
1387
|
+
* ```sql
|
|
1388
|
+
* explain format=json select * from `person` where `gender` = ?
|
|
1389
|
+
* ```
|
|
1390
|
+
*
|
|
1391
|
+
* You can also execute `explain analyze` statements.
|
|
1392
|
+
*
|
|
1393
|
+
* ```ts
|
|
1394
|
+
* import { sql } from 'kysely'
|
|
1395
|
+
*
|
|
1396
|
+
* const explained = await db
|
|
1397
|
+
* .selectFrom('person')
|
|
1398
|
+
* .where('gender', '=', 'female')
|
|
1399
|
+
* .selectAll()
|
|
1400
|
+
* .explain('json', sql`analyze`)
|
|
1401
|
+
* ```
|
|
1402
|
+
*
|
|
1403
|
+
* The generated SQL (PostgreSQL):
|
|
1404
|
+
*
|
|
1405
|
+
* ```sql
|
|
1406
|
+
* explain (analyze, format json) select * from "person" where "gender" = $1
|
|
1407
|
+
* ```
|
|
1408
|
+
*/
|
|
1409
|
+
explain<ER extends Record<string, any> = Record<string, any>>(format?: ExplainFormat, options?: AnyRawBuilder): Promise<ER[]>;
|
|
1373
1410
|
}
|
|
1374
1411
|
export interface SelectQueryBuilderProps {
|
|
1375
1412
|
readonly queryId: QueryId;
|
|
@@ -17,6 +17,7 @@ const group_by_parser_js_1 = require("../parser/group-by-parser.js");
|
|
|
17
17
|
const union_parser_js_1 = require("../parser/union-parser.js");
|
|
18
18
|
const no_result_error_js_1 = require("./no-result-error.js");
|
|
19
19
|
const identifier_node_js_1 = require("../operation-node/identifier-node.js");
|
|
20
|
+
const explain_node_js_1 = require("../operation-node/explain-node.js");
|
|
20
21
|
class SelectQueryBuilder {
|
|
21
22
|
#props;
|
|
22
23
|
constructor(props) {
|
|
@@ -629,8 +630,8 @@ class SelectQueryBuilder {
|
|
|
629
630
|
* Also see the {@link executeTakeFirst} and {@link executeTakeFirstOrThrow} methods.
|
|
630
631
|
*/
|
|
631
632
|
async execute() {
|
|
632
|
-
const
|
|
633
|
-
const result = await this.#props.executor.executeQuery(
|
|
633
|
+
const compiledQuery = this.compile();
|
|
634
|
+
const result = await this.#props.executor.executeQuery(compiledQuery, this.#props.queryId);
|
|
634
635
|
return result.rows;
|
|
635
636
|
}
|
|
636
637
|
/**
|
|
@@ -689,6 +690,48 @@ class SelectQueryBuilder {
|
|
|
689
690
|
yield* item.rows;
|
|
690
691
|
}
|
|
691
692
|
}
|
|
693
|
+
/**
|
|
694
|
+
* Executes query with `explain` statement before `select` keyword.
|
|
695
|
+
*
|
|
696
|
+
* ```ts
|
|
697
|
+
* const explained = await db
|
|
698
|
+
* .selectFrom('person')
|
|
699
|
+
* .where('gender', '=', 'female')
|
|
700
|
+
* .selectAll()
|
|
701
|
+
* .explain('json')
|
|
702
|
+
* ```
|
|
703
|
+
*
|
|
704
|
+
* The generated SQL (MySQL):
|
|
705
|
+
*
|
|
706
|
+
* ```sql
|
|
707
|
+
* explain format=json select * from `person` where `gender` = ?
|
|
708
|
+
* ```
|
|
709
|
+
*
|
|
710
|
+
* You can also execute `explain analyze` statements.
|
|
711
|
+
*
|
|
712
|
+
* ```ts
|
|
713
|
+
* import { sql } from 'kysely'
|
|
714
|
+
*
|
|
715
|
+
* const explained = await db
|
|
716
|
+
* .selectFrom('person')
|
|
717
|
+
* .where('gender', '=', 'female')
|
|
718
|
+
* .selectAll()
|
|
719
|
+
* .explain('json', sql`analyze`)
|
|
720
|
+
* ```
|
|
721
|
+
*
|
|
722
|
+
* The generated SQL (PostgreSQL):
|
|
723
|
+
*
|
|
724
|
+
* ```sql
|
|
725
|
+
* explain (analyze, format json) select * from "person" where "gender" = $1
|
|
726
|
+
* ```
|
|
727
|
+
*/
|
|
728
|
+
async explain(format, options) {
|
|
729
|
+
const builder = new SelectQueryBuilder({
|
|
730
|
+
...this.#props,
|
|
731
|
+
queryNode: select_query_node_js_1.SelectQueryNode.cloneWithExplain(this.#props.queryNode, explain_node_js_1.ExplainNode.create(format, options)),
|
|
732
|
+
});
|
|
733
|
+
return await builder.execute();
|
|
734
|
+
}
|
|
692
735
|
}
|
|
693
736
|
exports.SelectQueryBuilder = SelectQueryBuilder;
|
|
694
737
|
(0, prevent_await_js_1.preventAwait)(SelectQueryBuilder, "don't await SelectQueryBuilder instances directly. To execute the query you need to call `execute` or `executeTakeFirst`.");
|
|
@@ -20,7 +20,8 @@ import { NoResultErrorConstructor } from './no-result-error.js';
|
|
|
20
20
|
import { Selectable } from '../util/column-type.js';
|
|
21
21
|
import { AliasedQueryBuilder } from './select-query-builder.js';
|
|
22
22
|
import { AliasedRawBuilder } from '../raw-builder/raw-builder.js';
|
|
23
|
-
|
|
23
|
+
import { Explainable, ExplainFormat } from '../util/explainable.js';
|
|
24
|
+
export declare class UpdateQueryBuilder<DB, UT extends keyof DB, TB extends keyof DB, O> implements WhereInterface<DB, TB>, ReturningInterface<DB, TB, O>, OperationNodeSource, Compilable, Explainable {
|
|
24
25
|
#private;
|
|
25
26
|
constructor(props: UpdateQueryBuilderProps);
|
|
26
27
|
/**
|
|
@@ -809,6 +810,24 @@ export declare class UpdateQueryBuilder<DB, UT extends keyof DB, TB extends keyo
|
|
|
809
810
|
* error.
|
|
810
811
|
*/
|
|
811
812
|
executeTakeFirstOrThrow(errorConstructor?: NoResultErrorConstructor): Promise<O>;
|
|
813
|
+
/**
|
|
814
|
+
* Executes query with `explain` statement before `update` keyword.
|
|
815
|
+
*
|
|
816
|
+
* ```ts
|
|
817
|
+
* const explained = await db
|
|
818
|
+
* .updateTable('person')
|
|
819
|
+
* .set(updates)
|
|
820
|
+
* .where('id', '=', 123)
|
|
821
|
+
* .explain('json')
|
|
822
|
+
* ```
|
|
823
|
+
*
|
|
824
|
+
* The generated SQL (MySQL):
|
|
825
|
+
*
|
|
826
|
+
* ```sql
|
|
827
|
+
* explain format=json update `person` set `first_name` = ?, `last_name` = ? where `id` = ?
|
|
828
|
+
* ```
|
|
829
|
+
*/
|
|
830
|
+
explain<ER extends Record<string, any> = Record<string, any>>(format?: ExplainFormat, options?: AnyRawBuilder): Promise<ER[]>;
|
|
812
831
|
}
|
|
813
832
|
export interface UpdateQueryBuilderProps {
|
|
814
833
|
readonly queryId: QueryId;
|
|
@@ -12,6 +12,7 @@ const prevent_await_js_1 = require("../util/prevent-await.js");
|
|
|
12
12
|
const object_utils_js_1 = require("../util/object-utils.js");
|
|
13
13
|
const update_result_js_1 = require("./update-result.js");
|
|
14
14
|
const no_result_error_js_1 = require("./no-result-error.js");
|
|
15
|
+
const explain_node_js_1 = require("../operation-node/explain-node.js");
|
|
15
16
|
class UpdateQueryBuilder {
|
|
16
17
|
#props;
|
|
17
18
|
constructor(props) {
|
|
@@ -332,6 +333,30 @@ class UpdateQueryBuilder {
|
|
|
332
333
|
}
|
|
333
334
|
return result;
|
|
334
335
|
}
|
|
336
|
+
/**
|
|
337
|
+
* Executes query with `explain` statement before `update` keyword.
|
|
338
|
+
*
|
|
339
|
+
* ```ts
|
|
340
|
+
* const explained = await db
|
|
341
|
+
* .updateTable('person')
|
|
342
|
+
* .set(updates)
|
|
343
|
+
* .where('id', '=', 123)
|
|
344
|
+
* .explain('json')
|
|
345
|
+
* ```
|
|
346
|
+
*
|
|
347
|
+
* The generated SQL (MySQL):
|
|
348
|
+
*
|
|
349
|
+
* ```sql
|
|
350
|
+
* explain format=json update `person` set `first_name` = ?, `last_name` = ? where `id` = ?
|
|
351
|
+
* ```
|
|
352
|
+
*/
|
|
353
|
+
async explain(format, options) {
|
|
354
|
+
const builder = new UpdateQueryBuilder({
|
|
355
|
+
...this.#props,
|
|
356
|
+
queryNode: update_query_node_js_1.UpdateQueryNode.cloneWithExplain(this.#props.queryNode, explain_node_js_1.ExplainNode.create(format, options)),
|
|
357
|
+
});
|
|
358
|
+
return await builder.execute();
|
|
359
|
+
}
|
|
335
360
|
}
|
|
336
361
|
exports.UpdateQueryBuilder = UpdateQueryBuilder;
|
|
337
362
|
(0, prevent_await_js_1.preventAwait)(UpdateQueryBuilder, "don't await UpdateQueryBuilder instances directly. To execute the query you need to call `execute` or `executeTakeFirst`.");
|
|
@@ -71,6 +71,7 @@ import { CommonTableExpressionNameNode } from '../operation-node/common-table-ex
|
|
|
71
71
|
import { SelectModifierNode } from '../operation-node/select-modifier-node.js';
|
|
72
72
|
import { CreateTypeNode } from '../operation-node/create-type-node.js';
|
|
73
73
|
import { DropTypeNode } from '../operation-node/drop-type-node.js';
|
|
74
|
+
import { ExplainNode } from '../operation-node/explain-node.js';
|
|
74
75
|
export declare class DefaultQueryCompiler extends OperationNodeVisitor implements QueryCompiler {
|
|
75
76
|
#private;
|
|
76
77
|
protected get numParameters(): number;
|
|
@@ -149,11 +150,17 @@ export declare class DefaultQueryCompiler extends OperationNodeVisitor implement
|
|
|
149
150
|
protected visitSelectModifier(node: SelectModifierNode): void;
|
|
150
151
|
protected visitCreateType(node: CreateTypeNode): void;
|
|
151
152
|
protected visitDropType(node: DropTypeNode): void;
|
|
153
|
+
protected visitExplain(node: ExplainNode): void;
|
|
152
154
|
protected append(str: string): void;
|
|
153
155
|
protected appendValue(parameter: unknown): void;
|
|
154
156
|
protected getLeftIdentifierWrapper(): string;
|
|
155
157
|
protected getRightIdentifierWrapper(): string;
|
|
156
158
|
protected getCurrentParameterPlaceholder(): string;
|
|
159
|
+
protected getLeftExplainOptionsWrapper(): string;
|
|
160
|
+
protected getExplainOptionAssignment(): string;
|
|
161
|
+
protected getExplainOptionsDelimiter(): string;
|
|
162
|
+
protected getRightExplainOptionsWrapper(): string;
|
|
163
|
+
protected sanitizeIdentifier(identifier: string): string;
|
|
157
164
|
protected addParameter(parameter: unknown): void;
|
|
158
165
|
protected appendImmediateValue(value: unknown): void;
|
|
159
166
|
}
|
|
@@ -32,6 +32,10 @@ class DefaultQueryCompiler extends operation_node_visitor_js_1.OperationNodeVisi
|
|
|
32
32
|
!insert_query_node_js_1.InsertQueryNode.is(this.parentNode) &&
|
|
33
33
|
!create_view_node_js_1.CreateViewNode.is(this.parentNode) &&
|
|
34
34
|
!union_node_js_1.UnionNode.is(this.parentNode);
|
|
35
|
+
if (this.parentNode === undefined && node.explain) {
|
|
36
|
+
this.visitNode(node.explain);
|
|
37
|
+
this.append(' ');
|
|
38
|
+
}
|
|
35
39
|
if (wrapInParens) {
|
|
36
40
|
this.append('(');
|
|
37
41
|
}
|
|
@@ -127,6 +131,10 @@ class DefaultQueryCompiler extends operation_node_visitor_js_1.OperationNodeVisi
|
|
|
127
131
|
}
|
|
128
132
|
visitInsertQuery(node) {
|
|
129
133
|
const isSubQuery = this.nodeStack.find(query_node_js_1.QueryNode.is) !== node;
|
|
134
|
+
if (!isSubQuery && node.explain) {
|
|
135
|
+
this.visitNode(node.explain);
|
|
136
|
+
this.append(' ');
|
|
137
|
+
}
|
|
130
138
|
if (isSubQuery) {
|
|
131
139
|
this.append('(');
|
|
132
140
|
}
|
|
@@ -171,6 +179,10 @@ class DefaultQueryCompiler extends operation_node_visitor_js_1.OperationNodeVisi
|
|
|
171
179
|
}
|
|
172
180
|
visitDeleteQuery(node) {
|
|
173
181
|
const isSubQuery = this.nodeStack.find(query_node_js_1.QueryNode.is) !== node;
|
|
182
|
+
if (!isSubQuery && node.explain) {
|
|
183
|
+
this.visitNode(node.explain);
|
|
184
|
+
this.append(' ');
|
|
185
|
+
}
|
|
174
186
|
if (isSubQuery) {
|
|
175
187
|
this.append('(');
|
|
176
188
|
}
|
|
@@ -227,7 +239,10 @@ class DefaultQueryCompiler extends operation_node_visitor_js_1.OperationNodeVisi
|
|
|
227
239
|
this.append(this.getRightIdentifierWrapper());
|
|
228
240
|
}
|
|
229
241
|
compileUnwrappedIdentifier(node) {
|
|
230
|
-
|
|
242
|
+
if (!(0, object_utils_js_1.isString)(node.identifier)) {
|
|
243
|
+
throw new Error('a non-string identifier was passed to compileUnwrappedIdentifier.');
|
|
244
|
+
}
|
|
245
|
+
this.append(this.sanitizeIdentifier(node.identifier));
|
|
231
246
|
}
|
|
232
247
|
visitFilter(node) {
|
|
233
248
|
if (node.left) {
|
|
@@ -311,6 +326,10 @@ class DefaultQueryCompiler extends operation_node_visitor_js_1.OperationNodeVisi
|
|
|
311
326
|
}
|
|
312
327
|
visitCreateTable(node) {
|
|
313
328
|
this.append('create ');
|
|
329
|
+
if (node.frontModifiers) {
|
|
330
|
+
this.compileList(node.frontModifiers, ' ');
|
|
331
|
+
this.append(' ');
|
|
332
|
+
}
|
|
314
333
|
if (node.temporary) {
|
|
315
334
|
this.append('temporary ');
|
|
316
335
|
}
|
|
@@ -326,6 +345,10 @@ class DefaultQueryCompiler extends operation_node_visitor_js_1.OperationNodeVisi
|
|
|
326
345
|
this.append(' on commit ');
|
|
327
346
|
this.append(node.onCommit);
|
|
328
347
|
}
|
|
348
|
+
if (node.endModifiers) {
|
|
349
|
+
this.append(' ');
|
|
350
|
+
this.compileList(node.endModifiers, ' ');
|
|
351
|
+
}
|
|
329
352
|
}
|
|
330
353
|
visitColumnDefinition(node) {
|
|
331
354
|
this.visitNode(node.column);
|
|
@@ -412,6 +435,10 @@ class DefaultQueryCompiler extends operation_node_visitor_js_1.OperationNodeVisi
|
|
|
412
435
|
}
|
|
413
436
|
visitUpdateQuery(node) {
|
|
414
437
|
const isSubQuery = this.nodeStack.find(query_node_js_1.QueryNode.is) !== node;
|
|
438
|
+
if (!isSubQuery && node.explain) {
|
|
439
|
+
this.visitNode(node.explain);
|
|
440
|
+
this.append(' ');
|
|
441
|
+
}
|
|
415
442
|
if (isSubQuery) {
|
|
416
443
|
this.append('(');
|
|
417
444
|
}
|
|
@@ -806,6 +833,25 @@ class DefaultQueryCompiler extends operation_node_visitor_js_1.OperationNodeVisi
|
|
|
806
833
|
}
|
|
807
834
|
this.visitNode(node.name);
|
|
808
835
|
}
|
|
836
|
+
visitExplain(node) {
|
|
837
|
+
this.append('explain');
|
|
838
|
+
if (node.options || node.format) {
|
|
839
|
+
this.append(' ');
|
|
840
|
+
this.append(this.getLeftExplainOptionsWrapper());
|
|
841
|
+
if (node.options) {
|
|
842
|
+
this.visitNode(node.options);
|
|
843
|
+
if (node.format) {
|
|
844
|
+
this.append(this.getExplainOptionsDelimiter());
|
|
845
|
+
}
|
|
846
|
+
}
|
|
847
|
+
if (node.format) {
|
|
848
|
+
this.append('format');
|
|
849
|
+
this.append(this.getExplainOptionAssignment());
|
|
850
|
+
this.append(node.format);
|
|
851
|
+
}
|
|
852
|
+
this.append(this.getRightExplainOptionsWrapper());
|
|
853
|
+
}
|
|
854
|
+
}
|
|
809
855
|
append(str) {
|
|
810
856
|
this.#sql += str;
|
|
811
857
|
}
|
|
@@ -822,6 +868,33 @@ class DefaultQueryCompiler extends operation_node_visitor_js_1.OperationNodeVisi
|
|
|
822
868
|
getCurrentParameterPlaceholder() {
|
|
823
869
|
return '$' + this.numParameters;
|
|
824
870
|
}
|
|
871
|
+
getLeftExplainOptionsWrapper() {
|
|
872
|
+
return '(';
|
|
873
|
+
}
|
|
874
|
+
getExplainOptionAssignment() {
|
|
875
|
+
return ' ';
|
|
876
|
+
}
|
|
877
|
+
getExplainOptionsDelimiter() {
|
|
878
|
+
return ', ';
|
|
879
|
+
}
|
|
880
|
+
getRightExplainOptionsWrapper() {
|
|
881
|
+
return ')';
|
|
882
|
+
}
|
|
883
|
+
sanitizeIdentifier(identifier) {
|
|
884
|
+
const leftWrap = this.getLeftIdentifierWrapper();
|
|
885
|
+
const rightWrap = this.getRightIdentifierWrapper();
|
|
886
|
+
let sanitized = '';
|
|
887
|
+
for (const c of identifier) {
|
|
888
|
+
sanitized += c;
|
|
889
|
+
if (c === leftWrap) {
|
|
890
|
+
sanitized += leftWrap;
|
|
891
|
+
}
|
|
892
|
+
else if (c === rightWrap) {
|
|
893
|
+
sanitized += rightWrap;
|
|
894
|
+
}
|
|
895
|
+
}
|
|
896
|
+
return sanitized;
|
|
897
|
+
}
|
|
825
898
|
addParameter(parameter) {
|
|
826
899
|
this.#parameters.push(parameter);
|
|
827
900
|
}
|