kysely 0.13.0 → 0.15.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 +92 -32
- package/dist/cjs/{introspection → dialect}/database-introspector.d.ts +0 -0
- package/dist/cjs/{introspection → dialect}/database-introspector.js +0 -0
- package/dist/cjs/dialect/dialect.d.ts +1 -1
- package/dist/cjs/dialect/mysql/mysql-dialect.d.ts +1 -1
- package/dist/cjs/dialect/mysql/mysql-introspector.d.ts +1 -1
- package/dist/cjs/dialect/mysql/mysql-introspector.js +3 -3
- package/dist/cjs/dialect/postgres/postgres-dialect.d.ts +1 -1
- package/dist/cjs/dialect/postgres/postgres-introspector.d.ts +1 -1
- package/dist/cjs/dialect/postgres/postgres-introspector.js +3 -3
- package/dist/cjs/dialect/sqlite/sqlite-dialect.d.ts +1 -1
- package/dist/cjs/dialect/sqlite/sqlite-introspector.d.ts +1 -1
- package/dist/cjs/dialect/sqlite/sqlite-introspector.js +3 -3
- package/dist/cjs/index.d.ts +6 -3
- package/dist/cjs/index.js +6 -3
- package/dist/cjs/kysely.d.ts +8 -40
- package/dist/cjs/kysely.js +8 -40
- package/dist/cjs/migration/file-migration-provider.d.ts +52 -0
- package/dist/cjs/migration/file-migration-provider.js +52 -0
- package/dist/{esm/migration/migration.d.ts → cjs/migration/migrator.d.ts} +159 -134
- package/dist/cjs/migration/{migration.js → migrator.js} +166 -57
- package/dist/cjs/operation-node/check-constraint-node.d.ts +1 -1
- package/dist/cjs/operation-node/check-constraint-node.js +2 -3
- package/dist/cjs/operation-node/column-definition-node.d.ts +2 -2
- package/dist/cjs/operation-node/data-type-node.d.ts +1 -1
- package/dist/cjs/operation-node/generated-node.d.ts +20 -0
- package/dist/cjs/operation-node/generated-node.js +31 -0
- package/dist/cjs/operation-node/on-conflict-node.d.ts +13 -2
- package/dist/cjs/operation-node/on-conflict-node.js +39 -1
- package/dist/cjs/operation-node/operation-node-transformer.d.ts +2 -2
- package/dist/cjs/operation-node/operation-node-transformer.js +11 -5
- package/dist/cjs/operation-node/operation-node-visitor.d.ts +2 -2
- package/dist/cjs/operation-node/operation-node-visitor.js +1 -1
- package/dist/cjs/operation-node/operation-node.d.ts +1 -1
- package/dist/cjs/parser/insert-values-parser.d.ts +4 -4
- package/dist/cjs/parser/insert-values-parser.js +2 -3
- package/dist/cjs/parser/reference-parser.d.ts +4 -3
- package/dist/cjs/parser/select-parser.d.ts +10 -4
- package/dist/cjs/parser/update-set-parser.d.ts +2 -1
- package/dist/cjs/query-builder/delete-query-builder.d.ts +2 -4
- package/dist/cjs/query-builder/insert-query-builder.d.ts +80 -95
- package/dist/cjs/query-builder/insert-query-builder.js +145 -15
- package/dist/cjs/query-builder/on-conflict-builder.d.ts +686 -0
- package/dist/cjs/query-builder/on-conflict-builder.js +323 -0
- package/dist/cjs/query-builder/returning-interface.d.ts +2 -4
- package/dist/cjs/query-builder/select-query-builder.d.ts +1 -1
- package/dist/cjs/query-builder/update-query-builder.d.ts +2 -4
- package/dist/cjs/query-compiler/default-query-compiler.d.ts +2 -2
- package/dist/cjs/query-compiler/default-query-compiler.js +33 -7
- package/dist/cjs/query-creator.d.ts +0 -2
- package/dist/cjs/query-creator.js +0 -2
- package/dist/cjs/schema/alter-table-builder.d.ts +29 -9
- package/dist/cjs/schema/alter-table-builder.js +33 -9
- package/dist/cjs/schema/column-definition-builder.d.ts +28 -8
- package/dist/cjs/schema/column-definition-builder.js +17 -7
- package/dist/cjs/schema/create-index-builder.d.ts +3 -2
- package/dist/cjs/schema/create-index-builder.js +2 -2
- package/dist/cjs/schema/create-table-builder.d.ts +3 -2
- package/dist/cjs/schema/create-table-builder.js +2 -2
- package/dist/cjs/util/column-type.d.ts +165 -0
- package/dist/cjs/util/column-type.js +2 -0
- package/dist/cjs/util/private-symbols.d.ts +5 -0
- package/dist/cjs/util/private-symbols.js +8 -0
- package/dist/cjs/util/type-utils.d.ts +6 -42
- package/dist/esm/{introspection → dialect}/database-introspector.d.ts +0 -0
- package/dist/esm/{introspection → dialect}/database-introspector.js +0 -0
- package/dist/esm/dialect/dialect.d.ts +1 -1
- package/dist/esm/dialect/mysql/mysql-dialect.d.ts +1 -1
- package/dist/esm/dialect/mysql/mysql-introspector.d.ts +1 -1
- package/dist/esm/dialect/mysql/mysql-introspector.js +1 -1
- package/dist/esm/dialect/postgres/postgres-dialect.d.ts +1 -1
- package/dist/esm/dialect/postgres/postgres-introspector.d.ts +1 -1
- package/dist/esm/dialect/postgres/postgres-introspector.js +1 -1
- package/dist/esm/dialect/sqlite/sqlite-dialect.d.ts +1 -1
- package/dist/esm/dialect/sqlite/sqlite-introspector.d.ts +1 -1
- package/dist/esm/dialect/sqlite/sqlite-introspector.js +1 -1
- package/dist/esm/index.d.ts +6 -3
- package/dist/esm/index.js +6 -3
- package/dist/esm/kysely.d.ts +8 -40
- package/dist/esm/kysely.js +8 -40
- package/dist/esm/migration/file-migration-provider.d.ts +52 -0
- package/dist/esm/migration/file-migration-provider.js +48 -0
- package/dist/{cjs/migration/migration.d.ts → esm/migration/migrator.d.ts} +159 -134
- package/dist/esm/migration/{migration.js → migrator.js} +165 -56
- package/dist/esm/operation-node/check-constraint-node.d.ts +1 -1
- package/dist/esm/operation-node/check-constraint-node.js +2 -3
- package/dist/esm/operation-node/column-definition-node.d.ts +2 -2
- package/dist/esm/operation-node/data-type-node.d.ts +1 -1
- package/dist/esm/operation-node/generated-node.d.ts +20 -0
- package/dist/esm/operation-node/generated-node.js +28 -0
- package/dist/esm/operation-node/on-conflict-node.d.ts +13 -2
- package/dist/esm/operation-node/on-conflict-node.js +39 -1
- package/dist/esm/operation-node/operation-node-transformer.d.ts +2 -2
- package/dist/esm/operation-node/operation-node-transformer.js +11 -5
- package/dist/esm/operation-node/operation-node-visitor.d.ts +2 -2
- package/dist/esm/operation-node/operation-node-visitor.js +1 -1
- package/dist/esm/operation-node/operation-node.d.ts +1 -1
- package/dist/esm/parser/insert-values-parser.d.ts +4 -4
- package/dist/esm/parser/insert-values-parser.js +2 -3
- package/dist/esm/parser/reference-parser.d.ts +4 -3
- package/dist/esm/parser/select-parser.d.ts +10 -4
- package/dist/esm/parser/update-set-parser.d.ts +2 -1
- package/dist/esm/query-builder/delete-query-builder.d.ts +2 -4
- package/dist/esm/query-builder/insert-query-builder.d.ts +80 -95
- package/dist/esm/query-builder/insert-query-builder.js +145 -15
- package/dist/esm/query-builder/on-conflict-builder.d.ts +686 -0
- package/dist/esm/query-builder/on-conflict-builder.js +317 -0
- package/dist/esm/query-builder/returning-interface.d.ts +2 -4
- package/dist/esm/query-builder/select-query-builder.d.ts +1 -1
- package/dist/esm/query-builder/update-query-builder.d.ts +2 -4
- package/dist/esm/query-compiler/default-query-compiler.d.ts +2 -2
- package/dist/esm/query-compiler/default-query-compiler.js +33 -7
- package/dist/esm/query-creator.d.ts +0 -2
- package/dist/esm/query-creator.js +0 -2
- package/dist/esm/schema/alter-table-builder.d.ts +29 -9
- package/dist/esm/schema/alter-table-builder.js +33 -9
- package/dist/esm/schema/column-definition-builder.d.ts +28 -8
- package/dist/esm/schema/column-definition-builder.js +17 -7
- package/dist/esm/schema/create-index-builder.d.ts +3 -2
- package/dist/esm/schema/create-index-builder.js +2 -2
- package/dist/esm/schema/create-table-builder.d.ts +3 -2
- package/dist/esm/schema/create-table-builder.js +2 -2
- package/dist/esm/util/column-type.d.ts +165 -0
- package/dist/esm/util/column-type.js +1 -0
- package/dist/esm/util/private-symbols.d.ts +5 -0
- package/dist/esm/util/private-symbols.js +5 -0
- package/dist/esm/util/type-utils.d.ts +6 -42
- package/package.json +1 -1
- package/dist/cjs/operation-node/generated-always-as-node.d.ts +0 -16
- package/dist/cjs/operation-node/generated-always-as-node.js +0 -25
- package/dist/cjs/parser/on-conflict-parser.d.ts +0 -10
- package/dist/cjs/parser/on-conflict-parser.js +0 -35
- package/dist/cjs/util/generated-placeholder.d.ts +0 -3
- package/dist/cjs/util/generated-placeholder.js +0 -11
- package/dist/esm/operation-node/generated-always-as-node.d.ts +0 -16
- package/dist/esm/operation-node/generated-always-as-node.js +0 -22
- package/dist/esm/parser/on-conflict-parser.d.ts +0 -10
- package/dist/esm/parser/on-conflict-parser.js +0 -30
- package/dist/esm/util/generated-placeholder.d.ts +0 -3
- package/dist/esm/util/generated-placeholder.js +0 -7
|
@@ -95,7 +95,7 @@ export class AlterTableBuilder {
|
|
|
95
95
|
return new AlterTableExecutor({
|
|
96
96
|
...this.#props,
|
|
97
97
|
alterTableNode: AlterTableNode.cloneWith(this.#props.alterTableNode, {
|
|
98
|
-
addConstraint: AddConstraintNode.create(CheckConstraintNode.create(checkExpression, constraintName)),
|
|
98
|
+
addConstraint: AddConstraintNode.create(CheckConstraintNode.create(checkExpression.toOperationNode(), constraintName)),
|
|
99
99
|
}),
|
|
100
100
|
});
|
|
101
101
|
}
|
|
@@ -238,16 +238,28 @@ export class AlterTableAddColumnBuilder {
|
|
|
238
238
|
columnBuilder: this.#props.columnBuilder.defaultTo(value),
|
|
239
239
|
});
|
|
240
240
|
}
|
|
241
|
-
check(
|
|
241
|
+
check(expression) {
|
|
242
242
|
return new AlterTableAddColumnBuilder({
|
|
243
243
|
...this.#props,
|
|
244
|
-
columnBuilder: this.#props.columnBuilder.check(
|
|
244
|
+
columnBuilder: this.#props.columnBuilder.check(expression),
|
|
245
245
|
});
|
|
246
246
|
}
|
|
247
|
-
generatedAlwaysAs(
|
|
247
|
+
generatedAlwaysAs(expression) {
|
|
248
248
|
return new AlterTableAddColumnBuilder({
|
|
249
249
|
...this.#props,
|
|
250
|
-
columnBuilder: this.#props.columnBuilder.generatedAlwaysAs(
|
|
250
|
+
columnBuilder: this.#props.columnBuilder.generatedAlwaysAs(expression),
|
|
251
|
+
});
|
|
252
|
+
}
|
|
253
|
+
generatedAlwaysAsIdentity() {
|
|
254
|
+
return new AlterTableAddColumnBuilder({
|
|
255
|
+
...this.#props,
|
|
256
|
+
columnBuilder: this.#props.columnBuilder.generatedAlwaysAsIdentity(),
|
|
257
|
+
});
|
|
258
|
+
}
|
|
259
|
+
generatedByDefaultAsIdentity() {
|
|
260
|
+
return new AlterTableAddColumnBuilder({
|
|
261
|
+
...this.#props,
|
|
262
|
+
columnBuilder: this.#props.columnBuilder.generatedByDefaultAsIdentity(),
|
|
251
263
|
});
|
|
252
264
|
}
|
|
253
265
|
stored() {
|
|
@@ -327,16 +339,28 @@ export class AlterTableModifyColumnBuilder {
|
|
|
327
339
|
columnBuilder: this.#props.columnBuilder.defaultTo(value),
|
|
328
340
|
});
|
|
329
341
|
}
|
|
330
|
-
check(
|
|
342
|
+
check(expression) {
|
|
343
|
+
return new AlterTableModifyColumnBuilder({
|
|
344
|
+
...this.#props,
|
|
345
|
+
columnBuilder: this.#props.columnBuilder.check(expression),
|
|
346
|
+
});
|
|
347
|
+
}
|
|
348
|
+
generatedAlwaysAs(expression) {
|
|
349
|
+
return new AlterTableModifyColumnBuilder({
|
|
350
|
+
...this.#props,
|
|
351
|
+
columnBuilder: this.#props.columnBuilder.generatedAlwaysAs(expression),
|
|
352
|
+
});
|
|
353
|
+
}
|
|
354
|
+
generatedAlwaysAsIdentity() {
|
|
331
355
|
return new AlterTableModifyColumnBuilder({
|
|
332
356
|
...this.#props,
|
|
333
|
-
columnBuilder: this.#props.columnBuilder.
|
|
357
|
+
columnBuilder: this.#props.columnBuilder.generatedAlwaysAsIdentity(),
|
|
334
358
|
});
|
|
335
359
|
}
|
|
336
|
-
|
|
360
|
+
generatedByDefaultAsIdentity() {
|
|
337
361
|
return new AlterTableModifyColumnBuilder({
|
|
338
362
|
...this.#props,
|
|
339
|
-
columnBuilder: this.#props.columnBuilder.
|
|
363
|
+
columnBuilder: this.#props.columnBuilder.generatedByDefaultAsIdentity(),
|
|
340
364
|
});
|
|
341
365
|
}
|
|
342
366
|
stored() {
|
|
@@ -93,11 +93,13 @@ export interface ColumnDefinitionBuilderInterface {
|
|
|
93
93
|
* ```ts
|
|
94
94
|
* db.schema
|
|
95
95
|
* .createTable('pet')
|
|
96
|
-
* .addColumn('number_of_legs', 'integer', (col) =>
|
|
96
|
+
* .addColumn('number_of_legs', 'integer', (col) =>
|
|
97
|
+
* col.check(db.raw('number_of_legs < 5'))
|
|
98
|
+
* )
|
|
97
99
|
* .execute()
|
|
98
100
|
* ```
|
|
99
101
|
*/
|
|
100
|
-
check(
|
|
102
|
+
check(expression: AnyRawBuilder): ColumnDefinitionBuilderInterface;
|
|
101
103
|
/**
|
|
102
104
|
* Makes the column a generated column using a `generated always as` statement.
|
|
103
105
|
*
|
|
@@ -107,12 +109,20 @@ export interface ColumnDefinitionBuilderInterface {
|
|
|
107
109
|
* db.schema
|
|
108
110
|
* .createTable('person')
|
|
109
111
|
* .addColumn('full_name', 'varchar(255)',
|
|
110
|
-
* (col) => col.generatedAlwaysAs("concat(first_name, ' ', last_name)")
|
|
112
|
+
* (col) => col.generatedAlwaysAs(db.raw("concat(first_name, ' ', last_name)"))
|
|
111
113
|
* )
|
|
112
114
|
* .execute()
|
|
113
115
|
* ```
|
|
114
116
|
*/
|
|
115
|
-
generatedAlwaysAs(
|
|
117
|
+
generatedAlwaysAs(expression: AnyRawBuilder): ColumnDefinitionBuilderInterface;
|
|
118
|
+
/**
|
|
119
|
+
* Adds the `generated always as identity` specifier on supported dialects.
|
|
120
|
+
*/
|
|
121
|
+
generatedAlwaysAsIdentity(): ColumnDefinitionBuilderInterface;
|
|
122
|
+
/**
|
|
123
|
+
* Adds the `generated by default as identity` specifier on supported dialects.
|
|
124
|
+
*/
|
|
125
|
+
generatedByDefaultAsIdentity(): ColumnDefinitionBuilderInterface;
|
|
116
126
|
/**
|
|
117
127
|
* Makes a generated column stored instead of virtual. This method can only
|
|
118
128
|
* be used with {@link generatedAlwaysAs}
|
|
@@ -222,11 +232,13 @@ export declare class ColumnDefinitionBuilder implements ColumnDefinitionBuilderI
|
|
|
222
232
|
* ```ts
|
|
223
233
|
* db.schema
|
|
224
234
|
* .createTable('pet')
|
|
225
|
-
* .addColumn('number_of_legs', 'integer', (col) =>
|
|
235
|
+
* .addColumn('number_of_legs', 'integer', (col) =>
|
|
236
|
+
* col.check(db.raw('number_of_legs < 5'))
|
|
237
|
+
* )
|
|
226
238
|
* .execute()
|
|
227
239
|
* ```
|
|
228
240
|
*/
|
|
229
|
-
check(
|
|
241
|
+
check(expression: AnyRawBuilder): ColumnDefinitionBuilder;
|
|
230
242
|
/**
|
|
231
243
|
* Makes the column a generated column using a `generated always as` statement.
|
|
232
244
|
*
|
|
@@ -236,12 +248,20 @@ export declare class ColumnDefinitionBuilder implements ColumnDefinitionBuilderI
|
|
|
236
248
|
* db.schema
|
|
237
249
|
* .createTable('person')
|
|
238
250
|
* .addColumn('full_name', 'varchar(255)',
|
|
239
|
-
* (col) => col.generatedAlwaysAs("concat(first_name, ' ', last_name)")
|
|
251
|
+
* (col) => col.generatedAlwaysAs(db.raw("concat(first_name, ' ', last_name)"))
|
|
240
252
|
* )
|
|
241
253
|
* .execute()
|
|
242
254
|
* ```
|
|
243
255
|
*/
|
|
244
|
-
generatedAlwaysAs(
|
|
256
|
+
generatedAlwaysAs(expression: AnyRawBuilder): ColumnDefinitionBuilder;
|
|
257
|
+
/**
|
|
258
|
+
* Adds the `generated always as identity` specifier on supported dialects.
|
|
259
|
+
*/
|
|
260
|
+
generatedAlwaysAsIdentity(): ColumnDefinitionBuilder;
|
|
261
|
+
/**
|
|
262
|
+
* Adds the `generated by default as identity` specifier on supported dialects.
|
|
263
|
+
*/
|
|
264
|
+
generatedByDefaultAsIdentity(): ColumnDefinitionBuilder;
|
|
245
265
|
/**
|
|
246
266
|
* Makes a generated column stored instead of virtual. This method can only
|
|
247
267
|
* be used with {@link generatedAlwaysAs}
|
|
@@ -6,7 +6,7 @@ import { parseStringReference } from '../parser/reference-parser.js';
|
|
|
6
6
|
import { preventAwait } from '../util/prevent-await.js';
|
|
7
7
|
import { ColumnDefinitionNode } from '../operation-node/column-definition-node.js';
|
|
8
8
|
import { parseDefaultValueExpression, } from '../parser/default-value-parser.js';
|
|
9
|
-
import {
|
|
9
|
+
import { GeneratedNode } from '../operation-node/generated-node.js';
|
|
10
10
|
import { DefaultValueNode } from '../operation-node/default-value-node.js';
|
|
11
11
|
export class ColumnDefinitionBuilder {
|
|
12
12
|
#node;
|
|
@@ -60,22 +60,32 @@ export class ColumnDefinitionBuilder {
|
|
|
60
60
|
defaultTo: DefaultValueNode.create(parseDefaultValueExpression(value)),
|
|
61
61
|
}));
|
|
62
62
|
}
|
|
63
|
-
check(
|
|
63
|
+
check(expression) {
|
|
64
64
|
return new ColumnDefinitionBuilder(ColumnDefinitionNode.cloneWith(this.#node, {
|
|
65
|
-
check: CheckConstraintNode.create(
|
|
65
|
+
check: CheckConstraintNode.create(expression.toOperationNode()),
|
|
66
66
|
}));
|
|
67
67
|
}
|
|
68
|
-
generatedAlwaysAs(
|
|
68
|
+
generatedAlwaysAs(expression) {
|
|
69
69
|
return new ColumnDefinitionBuilder(ColumnDefinitionNode.cloneWith(this.#node, {
|
|
70
|
-
|
|
70
|
+
generated: GeneratedNode.createWithExpression(expression.toOperationNode()),
|
|
71
|
+
}));
|
|
72
|
+
}
|
|
73
|
+
generatedAlwaysAsIdentity() {
|
|
74
|
+
return new ColumnDefinitionBuilder(ColumnDefinitionNode.cloneWith(this.#node, {
|
|
75
|
+
generated: GeneratedNode.create({ identity: true, always: true }),
|
|
76
|
+
}));
|
|
77
|
+
}
|
|
78
|
+
generatedByDefaultAsIdentity() {
|
|
79
|
+
return new ColumnDefinitionBuilder(ColumnDefinitionNode.cloneWith(this.#node, {
|
|
80
|
+
generated: GeneratedNode.create({ identity: true, byDefault: true }),
|
|
71
81
|
}));
|
|
72
82
|
}
|
|
73
83
|
stored() {
|
|
74
|
-
if (!this.#node.
|
|
84
|
+
if (!this.#node.generated) {
|
|
75
85
|
throw new Error('stored() can only be called after generatedAlwaysAs');
|
|
76
86
|
}
|
|
77
87
|
return new ColumnDefinitionBuilder(ColumnDefinitionNode.cloneWith(this.#node, {
|
|
78
|
-
|
|
88
|
+
generated: GeneratedNode.cloneWith(this.#node.generated, {
|
|
79
89
|
stored: true,
|
|
80
90
|
}),
|
|
81
91
|
}));
|
|
@@ -4,6 +4,7 @@ import { CompiledQuery } from '../query-compiler/compiled-query.js';
|
|
|
4
4
|
import { Compilable } from '../util/compilable.js';
|
|
5
5
|
import { QueryExecutor } from '../query-executor/query-executor.js';
|
|
6
6
|
import { QueryId } from '../util/query-id.js';
|
|
7
|
+
import { AnyRawBuilder } from '../util/type-utils.js';
|
|
7
8
|
export declare class CreateIndexBuilder implements OperationNodeSource, Compilable {
|
|
8
9
|
#private;
|
|
9
10
|
constructor(props: CreateIndexBuilderProps);
|
|
@@ -36,11 +37,11 @@ export declare class CreateIndexBuilder implements OperationNodeSource, Compilab
|
|
|
36
37
|
* await db.schema
|
|
37
38
|
* .createIndex('person_first_name_index')
|
|
38
39
|
* .on('person')
|
|
39
|
-
* .expression('first_name COLLATE "fi_FI"')
|
|
40
|
+
* .expression(db.raw('first_name COLLATE "fi_FI"'))
|
|
40
41
|
* .execute()
|
|
41
42
|
* ```
|
|
42
43
|
*/
|
|
43
|
-
expression(expression:
|
|
44
|
+
expression(expression: AnyRawBuilder): CreateIndexBuilder;
|
|
44
45
|
/**
|
|
45
46
|
* Specifies the index type.
|
|
46
47
|
*/
|
|
@@ -67,7 +67,7 @@ export class CreateIndexBuilder {
|
|
|
67
67
|
* await db.schema
|
|
68
68
|
* .createIndex('person_first_name_index')
|
|
69
69
|
* .on('person')
|
|
70
|
-
* .expression('first_name COLLATE "fi_FI"')
|
|
70
|
+
* .expression(db.raw('first_name COLLATE "fi_FI"'))
|
|
71
71
|
* .execute()
|
|
72
72
|
* ```
|
|
73
73
|
*/
|
|
@@ -75,7 +75,7 @@ export class CreateIndexBuilder {
|
|
|
75
75
|
return new CreateIndexBuilder({
|
|
76
76
|
...this.#props,
|
|
77
77
|
createIndexNode: CreateIndexNode.cloneWith(this.#props.createIndexNode, {
|
|
78
|
-
expression:
|
|
78
|
+
expression: expression.toOperationNode(),
|
|
79
79
|
}),
|
|
80
80
|
});
|
|
81
81
|
}
|
|
@@ -7,6 +7,7 @@ import { ColumnDefinitionBuilder } from './column-definition-builder.js';
|
|
|
7
7
|
import { QueryId } from '../util/query-id.js';
|
|
8
8
|
import { ForeignKeyConstraintBuilder } from './foreign-key-constraint-builder.js';
|
|
9
9
|
import { DataTypeExpression } from '../parser/data-type-parser.js';
|
|
10
|
+
import { AnyRawBuilder } from '../util/type-utils.js';
|
|
10
11
|
/**
|
|
11
12
|
* This builder can be used to create a `create table` query.
|
|
12
13
|
*/
|
|
@@ -110,10 +111,10 @@ export declare class CreateTableBuilder<TB extends string, C extends string = ne
|
|
|
110
111
|
* ### Examples
|
|
111
112
|
*
|
|
112
113
|
* ```ts
|
|
113
|
-
* addCheckConstraint('check_legs', 'number_of_legs < 5')
|
|
114
|
+
* addCheckConstraint('check_legs', db.raw('number_of_legs < 5'))
|
|
114
115
|
* ```
|
|
115
116
|
*/
|
|
116
|
-
addCheckConstraint(constraintName: string, checkExpression:
|
|
117
|
+
addCheckConstraint(constraintName: string, checkExpression: AnyRawBuilder): CreateTableBuilder<TB, C>;
|
|
117
118
|
/**
|
|
118
119
|
* Adds a foreign key constraint.
|
|
119
120
|
*
|
|
@@ -153,13 +153,13 @@ export class CreateTableBuilder {
|
|
|
153
153
|
* ### Examples
|
|
154
154
|
*
|
|
155
155
|
* ```ts
|
|
156
|
-
* addCheckConstraint('check_legs', 'number_of_legs < 5')
|
|
156
|
+
* addCheckConstraint('check_legs', db.raw('number_of_legs < 5'))
|
|
157
157
|
* ```
|
|
158
158
|
*/
|
|
159
159
|
addCheckConstraint(constraintName, checkExpression) {
|
|
160
160
|
return new CreateTableBuilder({
|
|
161
161
|
...this.#props,
|
|
162
|
-
createTableNode: CreateTableNode.cloneWithConstraint(this.#props.createTableNode, CheckConstraintNode.create(checkExpression, constraintName)),
|
|
162
|
+
createTableNode: CreateTableNode.cloneWithConstraint(this.#props.createTableNode, CheckConstraintNode.create(checkExpression.toOperationNode(), constraintName)),
|
|
163
163
|
});
|
|
164
164
|
}
|
|
165
165
|
/**
|
|
@@ -0,0 +1,165 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This type can be used to specify a different type for
|
|
3
|
+
* select, insert and update operations.
|
|
4
|
+
*
|
|
5
|
+
* Also see the {@link Generated} type.
|
|
6
|
+
*
|
|
7
|
+
* ### Examples
|
|
8
|
+
*
|
|
9
|
+
* The next example defines a number column that is optional
|
|
10
|
+
* in inserts and updates. All columns are always optional
|
|
11
|
+
* in updates so therefore we don't need to specify `undefined`
|
|
12
|
+
* for the update type. The type below is useful for all kinds of
|
|
13
|
+
* database generated columns like identifiers. The `Generated`
|
|
14
|
+
* type is actually just a shortcut for the type in this example:
|
|
15
|
+
*
|
|
16
|
+
* ```ts
|
|
17
|
+
* ColumnType<number, number | undefined, number>
|
|
18
|
+
* ```
|
|
19
|
+
*
|
|
20
|
+
* The above example makes the column optional in inserts
|
|
21
|
+
* and updates, but you can still choose to provide the
|
|
22
|
+
* column. If you want to prevent insertion/update you
|
|
23
|
+
* can se the type as `never`:
|
|
24
|
+
*
|
|
25
|
+
* ```ts
|
|
26
|
+
* ColumnType<number, never, never>
|
|
27
|
+
* ```
|
|
28
|
+
*
|
|
29
|
+
* Here's one more example where the type is different
|
|
30
|
+
* for each different operation:
|
|
31
|
+
*
|
|
32
|
+
* ```ts
|
|
33
|
+
* ColumnType<Date, string, never>
|
|
34
|
+
* ```
|
|
35
|
+
*/
|
|
36
|
+
export declare type ColumnType<SelectType, InsertType = SelectType, UpdateType = SelectType> = {
|
|
37
|
+
readonly __select__: SelectType;
|
|
38
|
+
readonly __insert__: InsertType;
|
|
39
|
+
readonly __update__: UpdateType;
|
|
40
|
+
};
|
|
41
|
+
/**
|
|
42
|
+
* A shortcut for defining database-generated columns. The type
|
|
43
|
+
* is the same for all selects, inserts and updates but the
|
|
44
|
+
* column is optional for inserts and updates.
|
|
45
|
+
*
|
|
46
|
+
* This is implemented using {@link ColumnType} like this:
|
|
47
|
+
*
|
|
48
|
+
* ```ts
|
|
49
|
+
* type Generated<S> = ColumnType<S, S | undefined, S>
|
|
50
|
+
* ```
|
|
51
|
+
*/
|
|
52
|
+
export declare type Generated<S> = ColumnType<S, S | undefined, S>;
|
|
53
|
+
/**
|
|
54
|
+
* Evaluates to `K` if `T` can be `null` or `undefined`.
|
|
55
|
+
*/
|
|
56
|
+
declare type IfNullable<T, K> = undefined extends T ? K : null extends T ? K : never;
|
|
57
|
+
/**
|
|
58
|
+
* Evaluates to `K` if `T` can't be `null` or `undefined`.
|
|
59
|
+
*/
|
|
60
|
+
declare type IfNotNullable<T, K> = undefined extends T ? never : null extends T ? never : T extends never ? never : K;
|
|
61
|
+
/**
|
|
62
|
+
* Evaluates to `K` if `T` isn't `never`.
|
|
63
|
+
*/
|
|
64
|
+
declare type IfNotNever<T, K> = T extends never ? never : K;
|
|
65
|
+
export declare type SelectType<T> = T extends ColumnType<infer S, any, any> ? S : T;
|
|
66
|
+
export declare type InsertType<T> = T extends ColumnType<any, infer I, any> ? I : T;
|
|
67
|
+
export declare type UpdateType<T> = T extends ColumnType<any, any, infer U> ? U : T;
|
|
68
|
+
/**
|
|
69
|
+
* Keys of `R` whose `InsertType` values can be `null` or `undefined`.
|
|
70
|
+
*/
|
|
71
|
+
export declare type NullableInsertKeys<R> = {
|
|
72
|
+
[K in keyof R]: IfNullable<InsertType<R[K]>, K>;
|
|
73
|
+
}[keyof R];
|
|
74
|
+
/**
|
|
75
|
+
* Keys of `R` whose `InsertType` values can't be `null` or `undefined`.
|
|
76
|
+
*/
|
|
77
|
+
export declare type NonNullableInsertKeys<R> = {
|
|
78
|
+
[K in keyof R]: IfNotNullable<InsertType<R[K]>, K>;
|
|
79
|
+
}[keyof R];
|
|
80
|
+
/**
|
|
81
|
+
* Keys of `R` whose `SelectType` values are not `never`
|
|
82
|
+
*/
|
|
83
|
+
declare type NonNeverSelectKeys<R> = {
|
|
84
|
+
[K in keyof R]: IfNotNever<SelectType<R[K]>, K>;
|
|
85
|
+
}[keyof R];
|
|
86
|
+
/**
|
|
87
|
+
* Keys of `R` whose `UpdateType` values are not `never`
|
|
88
|
+
*/
|
|
89
|
+
export declare type UpdateKeys<R> = {
|
|
90
|
+
[K in keyof R]: IfNotNever<UpdateType<R[K]>, K>;
|
|
91
|
+
}[keyof R];
|
|
92
|
+
/**
|
|
93
|
+
* Given a table interface, extracts the select type from all
|
|
94
|
+
* {@link ColumnType} types.
|
|
95
|
+
*
|
|
96
|
+
* ### Examples
|
|
97
|
+
*
|
|
98
|
+
* ```ts
|
|
99
|
+
* interface PersonTable {
|
|
100
|
+
* id: Generated<number>
|
|
101
|
+
* first_name: string
|
|
102
|
+
* modified_at: ColumnType<Date, string, never>
|
|
103
|
+
* }
|
|
104
|
+
*
|
|
105
|
+
* type Person = Selectable<PersonTable>
|
|
106
|
+
* // {
|
|
107
|
+
* // id: number,
|
|
108
|
+
* // first_name: string
|
|
109
|
+
* // modified_at: Date
|
|
110
|
+
* // }
|
|
111
|
+
* ```
|
|
112
|
+
*/
|
|
113
|
+
export declare type Selectable<R> = {
|
|
114
|
+
[K in NonNeverSelectKeys<R>]: SelectType<R[K]>;
|
|
115
|
+
};
|
|
116
|
+
/**
|
|
117
|
+
* Given a table interface, extracts the insert type from all
|
|
118
|
+
* {@link ColumnType} types.
|
|
119
|
+
*
|
|
120
|
+
* ### Examples
|
|
121
|
+
*
|
|
122
|
+
* ```ts
|
|
123
|
+
* interface PersonTable {
|
|
124
|
+
* id: Generated<number>
|
|
125
|
+
* first_name: string
|
|
126
|
+
* modified_at: ColumnType<Date, string, never>
|
|
127
|
+
* }
|
|
128
|
+
*
|
|
129
|
+
* type InsertablePerson = Insertable<PersonTable>
|
|
130
|
+
* // {
|
|
131
|
+
* // id?: number,
|
|
132
|
+
* // first_name: string
|
|
133
|
+
* // modified_at: string
|
|
134
|
+
* // }
|
|
135
|
+
* ```
|
|
136
|
+
*/
|
|
137
|
+
export declare type Insertable<R> = {
|
|
138
|
+
[K in NonNullableInsertKeys<R>]: InsertType<R[K]>;
|
|
139
|
+
} & {
|
|
140
|
+
[K in NullableInsertKeys<R>]?: InsertType<R[K]>;
|
|
141
|
+
};
|
|
142
|
+
/**
|
|
143
|
+
* Given a table interface, extracts the update type from all
|
|
144
|
+
* {@link ColumnType} types.
|
|
145
|
+
*
|
|
146
|
+
* ### Examples
|
|
147
|
+
*
|
|
148
|
+
* ```ts
|
|
149
|
+
* interface PersonTable {
|
|
150
|
+
* id: Generated<number>
|
|
151
|
+
* first_name: string
|
|
152
|
+
* modified_at: ColumnType<Date, string, never>
|
|
153
|
+
* }
|
|
154
|
+
*
|
|
155
|
+
* type UpdateablePerson = Updateable<PersonTable>
|
|
156
|
+
* // {
|
|
157
|
+
* // id?: number,
|
|
158
|
+
* // first_name?: string
|
|
159
|
+
* // }
|
|
160
|
+
* ```
|
|
161
|
+
*/
|
|
162
|
+
export declare type Updateable<R> = {
|
|
163
|
+
[K in UpdateKeys<R>]?: UpdateType<R[K]>;
|
|
164
|
+
};
|
|
165
|
+
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -8,43 +8,6 @@ import { UpdateResult } from '../query-builder/update-result.js';
|
|
|
8
8
|
* Given an object type, extracts the union of all value types.
|
|
9
9
|
*/
|
|
10
10
|
export declare type ValueType<T> = T[keyof T];
|
|
11
|
-
/**
|
|
12
|
-
* Given a database type and a union of table names returns the row type
|
|
13
|
-
* that you would get by selecting all columns from tables TB.
|
|
14
|
-
*
|
|
15
|
-
* Example:
|
|
16
|
-
*
|
|
17
|
-
* ```ts
|
|
18
|
-
* interface Person {
|
|
19
|
-
* id: number
|
|
20
|
-
* }
|
|
21
|
-
*
|
|
22
|
-
* interface Pet {
|
|
23
|
-
* name: string
|
|
24
|
-
* species: 'cat' | 'dog'
|
|
25
|
-
* }
|
|
26
|
-
*
|
|
27
|
-
* interface Movie {
|
|
28
|
-
* stars: number
|
|
29
|
-
* }
|
|
30
|
-
*
|
|
31
|
-
* interface Database {
|
|
32
|
-
* person: Person
|
|
33
|
-
* pet: Pet
|
|
34
|
-
* movie: Movie
|
|
35
|
-
* }
|
|
36
|
-
*
|
|
37
|
-
* type Row = RowType<Database, 'person' | 'movie'>
|
|
38
|
-
*
|
|
39
|
-
* // Row == Person & Movie
|
|
40
|
-
* ```
|
|
41
|
-
*/
|
|
42
|
-
export declare type RowType<DB, TB extends keyof DB> = UnionToIntersection<DB[TB]>;
|
|
43
|
-
/**
|
|
44
|
-
* Evil typescript magic to convert a union type `A | B | C` into an
|
|
45
|
-
* intersection type `A & B & C`.
|
|
46
|
-
*/
|
|
47
|
-
declare type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
|
|
48
11
|
/**
|
|
49
12
|
* Given a database type and a union of table names in that db, returns
|
|
50
13
|
* a union type with all possible column names.
|
|
@@ -79,6 +42,12 @@ declare type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) e
|
|
|
79
42
|
export declare type AnyColumn<DB, TB extends keyof DB> = {
|
|
80
43
|
[T in TB]: keyof DB[T];
|
|
81
44
|
}[TB] & string;
|
|
45
|
+
/**
|
|
46
|
+
* Extracts a column type.
|
|
47
|
+
*/
|
|
48
|
+
export declare type ExtractColumnType<DB, TB extends keyof DB, C> = {
|
|
49
|
+
[T in TB]: C extends keyof DB[T] ? DB[T][C] : never;
|
|
50
|
+
}[TB];
|
|
82
51
|
/**
|
|
83
52
|
* Given a database type and a union of table names in that db, returns
|
|
84
53
|
* a union type with all possible `table`.`column` combinations.
|
|
@@ -137,13 +106,8 @@ export declare type SelectQueryBuilderFactory<DB, TB extends keyof DB> = (qb: Ex
|
|
|
137
106
|
export declare type AliasedQueryBuilderFactory<DB, TB extends keyof DB> = (qb: ExpressionBuilder<DB, TB>) => AnyAliasedQueryBuilder;
|
|
138
107
|
export declare type RawBuilderFactory<DB, TB extends keyof DB> = (qb: ExpressionBuilder<DB, TB>) => AnyRawBuilder;
|
|
139
108
|
export declare type AliasedRawBuilderFactory<DB, TB extends keyof DB> = (qb: ExpressionBuilder<DB, TB>) => AnyAliasedRawBuilder;
|
|
140
|
-
export interface GeneratedPlaceholder {
|
|
141
|
-
/** @internal */
|
|
142
|
-
readonly __isGeneratedPlaceholder__: true;
|
|
143
|
-
}
|
|
144
109
|
export declare type SingleResultType<O> = O extends InsertResult ? O : O extends DeleteResult ? O : O extends UpdateResult ? O : O | undefined;
|
|
145
110
|
export declare type UnknownRow = Record<string, unknown>;
|
|
146
111
|
export declare type Nullable<T> = {
|
|
147
112
|
[P in keyof T]: T[P] | null;
|
|
148
113
|
};
|
|
149
|
-
export {};
|
package/package.json
CHANGED
|
@@ -1,16 +0,0 @@
|
|
|
1
|
-
import { OperationNode } from './operation-node.js';
|
|
2
|
-
import { RawNode } from './raw-node.js';
|
|
3
|
-
export declare type GeneratedAlwaysAsNodeParams = Omit<GeneratedAlwaysAsNode, 'kind' | 'expression'>;
|
|
4
|
-
export interface GeneratedAlwaysAsNode extends OperationNode {
|
|
5
|
-
readonly kind: 'GeneratedAlwaysAsNode';
|
|
6
|
-
readonly expression: RawNode;
|
|
7
|
-
readonly stored?: boolean;
|
|
8
|
-
}
|
|
9
|
-
/**
|
|
10
|
-
* @internal
|
|
11
|
-
*/
|
|
12
|
-
export declare const GeneratedAlwaysAsNode: Readonly<{
|
|
13
|
-
is(node: OperationNode): node is GeneratedAlwaysAsNode;
|
|
14
|
-
create(expression: string): GeneratedAlwaysAsNode;
|
|
15
|
-
cloneWith(node: GeneratedAlwaysAsNode, params: GeneratedAlwaysAsNodeParams): GeneratedAlwaysAsNode;
|
|
16
|
-
}>;
|
|
@@ -1,25 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.GeneratedAlwaysAsNode = void 0;
|
|
4
|
-
const object_utils_js_1 = require("../util/object-utils.js");
|
|
5
|
-
const raw_node_js_1 = require("./raw-node.js");
|
|
6
|
-
/**
|
|
7
|
-
* @internal
|
|
8
|
-
*/
|
|
9
|
-
exports.GeneratedAlwaysAsNode = (0, object_utils_js_1.freeze)({
|
|
10
|
-
is(node) {
|
|
11
|
-
return node.kind === 'GeneratedAlwaysAsNode';
|
|
12
|
-
},
|
|
13
|
-
create(expression) {
|
|
14
|
-
return (0, object_utils_js_1.freeze)({
|
|
15
|
-
kind: 'GeneratedAlwaysAsNode',
|
|
16
|
-
expression: raw_node_js_1.RawNode.createWithSql(expression),
|
|
17
|
-
});
|
|
18
|
-
},
|
|
19
|
-
cloneWith(node, params) {
|
|
20
|
-
return (0, object_utils_js_1.freeze)({
|
|
21
|
-
...node,
|
|
22
|
-
...params,
|
|
23
|
-
});
|
|
24
|
-
},
|
|
25
|
-
});
|
|
@@ -1,10 +0,0 @@
|
|
|
1
|
-
import { OnConflictNode } from '../operation-node/on-conflict-node.js';
|
|
2
|
-
import { AnyColumn } from '../util/type-utils.js';
|
|
3
|
-
import { ParseContext } from './parse-context.js';
|
|
4
|
-
import { MutationObject } from './update-set-parser.js';
|
|
5
|
-
export declare type OnConflictConstraintTarget = {
|
|
6
|
-
constraint: string;
|
|
7
|
-
};
|
|
8
|
-
export declare type OnConflictTargetExpression<DB, TB extends keyof DB> = AnyColumn<DB, TB> | ReadonlyArray<AnyColumn<DB, TB>> | OnConflictConstraintTarget;
|
|
9
|
-
export declare function parseOnConflictDoNothing(target: OnConflictTargetExpression<any, any>): OnConflictNode;
|
|
10
|
-
export declare function parseOnConflictUpdate(ctx: ParseContext, target: OnConflictTargetExpression<any, any>, updates: MutationObject<any, any>): OnConflictNode;
|
|
@@ -1,35 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.parseOnConflictUpdate = exports.parseOnConflictDoNothing = void 0;
|
|
4
|
-
const identifier_node_js_1 = require("../operation-node/identifier-node.js");
|
|
5
|
-
const on_conflict_node_js_1 = require("../operation-node/on-conflict-node.js");
|
|
6
|
-
const object_utils_js_1 = require("../util/object-utils.js");
|
|
7
|
-
const reference_parser_js_1 = require("./reference-parser.js");
|
|
8
|
-
const update_set_parser_js_1 = require("./update-set-parser.js");
|
|
9
|
-
function parseOnConflictDoNothing(target) {
|
|
10
|
-
return on_conflict_node_js_1.OnConflictNode.create({
|
|
11
|
-
...parseConflictTarget(target),
|
|
12
|
-
doNothing: true,
|
|
13
|
-
});
|
|
14
|
-
}
|
|
15
|
-
exports.parseOnConflictDoNothing = parseOnConflictDoNothing;
|
|
16
|
-
function parseOnConflictUpdate(ctx, target, updates) {
|
|
17
|
-
return on_conflict_node_js_1.OnConflictNode.create({
|
|
18
|
-
...parseConflictTarget(target),
|
|
19
|
-
updates: (0, update_set_parser_js_1.parseUpdateObject)(ctx, updates),
|
|
20
|
-
});
|
|
21
|
-
}
|
|
22
|
-
exports.parseOnConflictUpdate = parseOnConflictUpdate;
|
|
23
|
-
function parseConflictTarget(target) {
|
|
24
|
-
if ((0, object_utils_js_1.isString)(target) || (0, object_utils_js_1.isReadonlyArray)(target)) {
|
|
25
|
-
return {
|
|
26
|
-
columns: (0, object_utils_js_1.asReadonlyArray)(target).map(reference_parser_js_1.parseColumnName),
|
|
27
|
-
};
|
|
28
|
-
}
|
|
29
|
-
if ((0, object_utils_js_1.isObject)(target) && !(0, object_utils_js_1.isReadonlyArray)(target)) {
|
|
30
|
-
return {
|
|
31
|
-
constraint: identifier_node_js_1.IdentifierNode.create(target.constraint),
|
|
32
|
-
};
|
|
33
|
-
}
|
|
34
|
-
throw new Error(`invalid on conflict target ${JSON.stringify(target)}`);
|
|
35
|
-
}
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.isGeneratedPlaceholder = exports.GENERATED_PLACEHOLDER = void 0;
|
|
4
|
-
const object_utils_js_1 = require("./object-utils.js");
|
|
5
|
-
exports.GENERATED_PLACEHOLDER = (0, object_utils_js_1.freeze)({
|
|
6
|
-
__isGeneratedPlaceholder__: true,
|
|
7
|
-
});
|
|
8
|
-
function isGeneratedPlaceholder(obj) {
|
|
9
|
-
return (0, object_utils_js_1.isObject)(obj) && obj.__isGeneratedPlaceholder__ === true;
|
|
10
|
-
}
|
|
11
|
-
exports.isGeneratedPlaceholder = isGeneratedPlaceholder;
|
|
@@ -1,16 +0,0 @@
|
|
|
1
|
-
import { OperationNode } from './operation-node.js';
|
|
2
|
-
import { RawNode } from './raw-node.js';
|
|
3
|
-
export declare type GeneratedAlwaysAsNodeParams = Omit<GeneratedAlwaysAsNode, 'kind' | 'expression'>;
|
|
4
|
-
export interface GeneratedAlwaysAsNode extends OperationNode {
|
|
5
|
-
readonly kind: 'GeneratedAlwaysAsNode';
|
|
6
|
-
readonly expression: RawNode;
|
|
7
|
-
readonly stored?: boolean;
|
|
8
|
-
}
|
|
9
|
-
/**
|
|
10
|
-
* @internal
|
|
11
|
-
*/
|
|
12
|
-
export declare const GeneratedAlwaysAsNode: Readonly<{
|
|
13
|
-
is(node: OperationNode): node is GeneratedAlwaysAsNode;
|
|
14
|
-
create(expression: string): GeneratedAlwaysAsNode;
|
|
15
|
-
cloneWith(node: GeneratedAlwaysAsNode, params: GeneratedAlwaysAsNodeParams): GeneratedAlwaysAsNode;
|
|
16
|
-
}>;
|