kysely 0.12.0 → 0.14.0

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.
Files changed (172) hide show
  1. package/README.md +34 -10
  2. package/dist/cjs/{introspection → dialect}/database-introspector.d.ts +0 -0
  3. package/dist/cjs/{introspection → dialect}/database-introspector.js +0 -0
  4. package/dist/cjs/dialect/dialect-adapter-base.d.ts +36 -0
  5. package/dist/cjs/dialect/dialect.d.ts +1 -1
  6. package/dist/cjs/dialect/mysql/mysql-adapter.d.ts +38 -2
  7. package/dist/cjs/dialect/mysql/mysql-adapter.js +2 -1
  8. package/dist/cjs/dialect/mysql/mysql-dialect.d.ts +17 -1
  9. package/dist/cjs/dialect/mysql/mysql-driver.d.ts +29 -0
  10. package/dist/cjs/dialect/mysql/mysql-introspector.d.ts +4 -1
  11. package/dist/cjs/dialect/postgres/postgres-adapter.d.ts +38 -2
  12. package/dist/cjs/dialect/postgres/postgres-adapter.js +2 -1
  13. package/dist/cjs/dialect/postgres/postgres-dialect.d.ts +17 -1
  14. package/dist/cjs/dialect/postgres/postgres-driver.d.ts +29 -0
  15. package/dist/cjs/dialect/postgres/postgres-introspector.d.ts +4 -1
  16. package/dist/cjs/dialect/sqlite/sqlite-adapter.d.ts +38 -2
  17. package/dist/cjs/dialect/sqlite/sqlite-dialect.d.ts +17 -1
  18. package/dist/cjs/dialect/sqlite/sqlite-driver.d.ts +29 -0
  19. package/dist/cjs/dialect/sqlite/sqlite-introspector.d.ts +4 -1
  20. package/dist/cjs/driver/default-connection-provider.d.ts +4 -0
  21. package/dist/cjs/driver/runtime-driver.d.ts +29 -0
  22. package/dist/cjs/driver/single-connection-provider.d.ts +4 -0
  23. package/dist/cjs/index.d.ts +4 -3
  24. package/dist/cjs/index.js +3 -2
  25. package/dist/cjs/kysely.d.ts +152 -1
  26. package/dist/cjs/kysely.js +37 -0
  27. package/dist/cjs/migration/migration.d.ts +154 -11
  28. package/dist/cjs/migration/migration.js +256 -135
  29. package/dist/cjs/operation-node/check-constraint-node.d.ts +1 -1
  30. package/dist/cjs/operation-node/check-constraint-node.js +2 -3
  31. package/dist/cjs/operation-node/column-definition-node.d.ts +8 -7
  32. package/dist/cjs/operation-node/column-definition-node.js +0 -4
  33. package/dist/cjs/operation-node/common-table-expression-name-node.d.ts +15 -0
  34. package/dist/cjs/operation-node/common-table-expression-name-node.js +23 -0
  35. package/dist/cjs/operation-node/common-table-expression-node.d.ts +3 -3
  36. package/dist/cjs/operation-node/data-type-node.d.ts +1 -1
  37. package/dist/cjs/operation-node/generated-node.d.ts +20 -0
  38. package/dist/cjs/operation-node/generated-node.js +31 -0
  39. package/dist/cjs/operation-node/on-conflict-node.d.ts +13 -2
  40. package/dist/cjs/operation-node/on-conflict-node.js +39 -1
  41. package/dist/cjs/operation-node/operation-node-transformer.d.ts +4 -2
  42. package/dist/cjs/operation-node/operation-node-transformer.js +22 -6
  43. package/dist/cjs/operation-node/operation-node-visitor.d.ts +4 -2
  44. package/dist/cjs/operation-node/operation-node-visitor.js +2 -1
  45. package/dist/cjs/operation-node/operation-node.d.ts +1 -1
  46. package/dist/cjs/operation-node/with-node.d.ts +3 -1
  47. package/dist/cjs/operation-node/with-node.js +2 -1
  48. package/dist/cjs/package.json +1 -3
  49. package/dist/cjs/parser/parse-context.d.ts +14 -0
  50. package/dist/cjs/parser/with-parser.d.ts +32 -5
  51. package/dist/cjs/parser/with-parser.js +13 -2
  52. package/dist/cjs/plugin/camel-case/camel-case-plugin.d.ts +36 -2
  53. package/dist/cjs/plugin/immediate-value.ts/immediate-value-plugin.d.ts +34 -0
  54. package/dist/cjs/plugin/with-schema/with-schema-plugin.d.ts +34 -0
  55. package/dist/cjs/plugin/with-schema/with-schema-transformer.js +8 -0
  56. package/dist/cjs/query-builder/delete-query-builder.d.ts +545 -0
  57. package/dist/cjs/query-builder/insert-query-builder.d.ts +142 -76
  58. package/dist/cjs/query-builder/insert-query-builder.js +150 -15
  59. package/dist/cjs/query-builder/join-interface.d.ts +3 -6
  60. package/dist/cjs/query-builder/on-conflict-builder.d.ts +684 -0
  61. package/dist/cjs/query-builder/on-conflict-builder.js +323 -0
  62. package/dist/cjs/query-builder/returning-interface.d.ts +1 -1
  63. package/dist/cjs/query-builder/select-query-builder.d.ts +513 -2
  64. package/dist/cjs/query-builder/select-query-builder.js +2 -2
  65. package/dist/cjs/query-builder/update-query-builder.d.ts +547 -2
  66. package/dist/cjs/query-builder/update-query-builder.js +2 -2
  67. package/dist/cjs/query-builder/where-interface.d.ts +7 -10
  68. package/dist/cjs/query-compiler/default-query-compiler.d.ts +4 -2
  69. package/dist/cjs/query-compiler/default-query-compiler.js +48 -8
  70. package/dist/cjs/query-creator.d.ts +27 -3
  71. package/dist/cjs/query-creator.js +33 -1
  72. package/dist/cjs/query-executor/default-query-executor.d.ts +19 -0
  73. package/dist/cjs/query-executor/noop-query-executor.d.ts +19 -0
  74. package/dist/cjs/raw-builder/raw-builder.js +1 -1
  75. package/dist/cjs/schema/alter-table-builder.d.ts +253 -5
  76. package/dist/cjs/schema/alter-table-builder.js +45 -9
  77. package/dist/cjs/schema/column-definition-builder.d.ts +146 -6
  78. package/dist/cjs/schema/column-definition-builder.js +21 -8
  79. package/dist/cjs/schema/create-index-builder.d.ts +3 -2
  80. package/dist/cjs/schema/create-index-builder.js +2 -2
  81. package/dist/cjs/schema/create-table-builder.d.ts +3 -2
  82. package/dist/cjs/schema/create-table-builder.js +2 -2
  83. package/dist/esm/{introspection → dialect}/database-introspector.d.ts +0 -0
  84. package/dist/esm/{introspection → dialect}/database-introspector.js +0 -0
  85. package/dist/esm/dialect/dialect-adapter-base.d.ts +36 -0
  86. package/dist/esm/dialect/dialect.d.ts +1 -1
  87. package/dist/esm/dialect/mysql/mysql-adapter.d.ts +38 -2
  88. package/dist/esm/dialect/mysql/mysql-adapter.js +2 -1
  89. package/dist/esm/dialect/mysql/mysql-dialect.d.ts +17 -1
  90. package/dist/esm/dialect/mysql/mysql-driver.d.ts +29 -0
  91. package/dist/esm/dialect/mysql/mysql-introspector.d.ts +4 -1
  92. package/dist/esm/dialect/postgres/postgres-adapter.d.ts +38 -2
  93. package/dist/esm/dialect/postgres/postgres-adapter.js +2 -1
  94. package/dist/esm/dialect/postgres/postgres-dialect.d.ts +17 -1
  95. package/dist/esm/dialect/postgres/postgres-driver.d.ts +29 -0
  96. package/dist/esm/dialect/postgres/postgres-introspector.d.ts +4 -1
  97. package/dist/esm/dialect/sqlite/sqlite-adapter.d.ts +38 -2
  98. package/dist/esm/dialect/sqlite/sqlite-dialect.d.ts +17 -1
  99. package/dist/esm/dialect/sqlite/sqlite-driver.d.ts +29 -0
  100. package/dist/esm/dialect/sqlite/sqlite-introspector.d.ts +4 -1
  101. package/dist/esm/driver/default-connection-provider.d.ts +4 -0
  102. package/dist/esm/driver/runtime-driver.d.ts +29 -0
  103. package/dist/esm/driver/single-connection-provider.d.ts +4 -0
  104. package/dist/esm/index.d.ts +4 -3
  105. package/dist/esm/index.js +3 -2
  106. package/dist/esm/kysely.d.ts +152 -1
  107. package/dist/esm/kysely.js +37 -0
  108. package/dist/esm/migration/migration.d.ts +154 -11
  109. package/dist/esm/migration/migration.js +255 -134
  110. package/dist/esm/operation-node/check-constraint-node.d.ts +1 -1
  111. package/dist/esm/operation-node/check-constraint-node.js +2 -3
  112. package/dist/esm/operation-node/column-definition-node.d.ts +8 -7
  113. package/dist/esm/operation-node/column-definition-node.js +0 -4
  114. package/dist/esm/operation-node/common-table-expression-name-node.d.ts +15 -0
  115. package/dist/esm/operation-node/common-table-expression-name-node.js +20 -0
  116. package/dist/esm/operation-node/common-table-expression-node.d.ts +3 -3
  117. package/dist/esm/operation-node/data-type-node.d.ts +1 -1
  118. package/dist/esm/operation-node/generated-node.d.ts +20 -0
  119. package/dist/esm/operation-node/generated-node.js +28 -0
  120. package/dist/esm/operation-node/on-conflict-node.d.ts +13 -2
  121. package/dist/esm/operation-node/on-conflict-node.js +39 -1
  122. package/dist/esm/operation-node/operation-node-transformer.d.ts +4 -2
  123. package/dist/esm/operation-node/operation-node-transformer.js +22 -6
  124. package/dist/esm/operation-node/operation-node-visitor.d.ts +4 -2
  125. package/dist/esm/operation-node/operation-node-visitor.js +2 -1
  126. package/dist/esm/operation-node/operation-node.d.ts +1 -1
  127. package/dist/esm/operation-node/with-node.d.ts +3 -1
  128. package/dist/esm/operation-node/with-node.js +2 -1
  129. package/dist/esm/package.json +1 -3
  130. package/dist/esm/parser/parse-context.d.ts +14 -0
  131. package/dist/esm/parser/with-parser.d.ts +32 -5
  132. package/dist/esm/parser/with-parser.js +13 -2
  133. package/dist/esm/plugin/camel-case/camel-case-plugin.d.ts +36 -2
  134. package/dist/esm/plugin/immediate-value.ts/immediate-value-plugin.d.ts +34 -0
  135. package/dist/esm/plugin/with-schema/with-schema-plugin.d.ts +34 -0
  136. package/dist/esm/plugin/with-schema/with-schema-transformer.js +8 -0
  137. package/dist/esm/query-builder/delete-query-builder.d.ts +545 -0
  138. package/dist/esm/query-builder/insert-query-builder.d.ts +142 -76
  139. package/dist/esm/query-builder/insert-query-builder.js +150 -15
  140. package/dist/esm/query-builder/join-interface.d.ts +3 -6
  141. package/dist/esm/query-builder/on-conflict-builder.d.ts +684 -0
  142. package/dist/esm/query-builder/on-conflict-builder.js +317 -0
  143. package/dist/esm/query-builder/returning-interface.d.ts +1 -1
  144. package/dist/esm/query-builder/select-query-builder.d.ts +513 -2
  145. package/dist/esm/query-builder/select-query-builder.js +2 -2
  146. package/dist/esm/query-builder/update-query-builder.d.ts +547 -2
  147. package/dist/esm/query-builder/update-query-builder.js +2 -2
  148. package/dist/esm/query-builder/where-interface.d.ts +7 -10
  149. package/dist/esm/query-compiler/default-query-compiler.d.ts +4 -2
  150. package/dist/esm/query-compiler/default-query-compiler.js +48 -8
  151. package/dist/esm/query-creator.d.ts +27 -3
  152. package/dist/esm/query-creator.js +33 -1
  153. package/dist/esm/query-executor/default-query-executor.d.ts +19 -0
  154. package/dist/esm/query-executor/noop-query-executor.d.ts +19 -0
  155. package/dist/esm/raw-builder/raw-builder.js +1 -1
  156. package/dist/esm/schema/alter-table-builder.d.ts +253 -5
  157. package/dist/esm/schema/alter-table-builder.js +45 -9
  158. package/dist/esm/schema/column-definition-builder.d.ts +146 -6
  159. package/dist/esm/schema/column-definition-builder.js +21 -8
  160. package/dist/esm/schema/create-index-builder.d.ts +3 -2
  161. package/dist/esm/schema/create-index-builder.js +2 -2
  162. package/dist/esm/schema/create-table-builder.d.ts +3 -2
  163. package/dist/esm/schema/create-table-builder.js +2 -2
  164. package/package.json +8 -6
  165. package/dist/cjs/operation-node/generated-always-as-node.d.ts +0 -16
  166. package/dist/cjs/operation-node/generated-always-as-node.js +0 -25
  167. package/dist/cjs/parser/on-conflict-parser.d.ts +0 -10
  168. package/dist/cjs/parser/on-conflict-parser.js +0 -35
  169. package/dist/esm/operation-node/generated-always-as-node.d.ts +0 -16
  170. package/dist/esm/operation-node/generated-always-as-node.js +0 -22
  171. package/dist/esm/parser/on-conflict-parser.d.ts +0 -10
  172. package/dist/esm/parser/on-conflict-parser.js +0 -30
@@ -1,13 +1,19 @@
1
1
  import { ColumnNode } from './column-node.js';
2
2
  import { ColumnUpdateNode } from './column-update-node.js';
3
3
  import { IdentifierNode } from './identifier-node.js';
4
+ import { FilterExpressionNode } from './operation-node-utils.js';
4
5
  import { OperationNode } from './operation-node.js';
5
- export declare type OnConflictNodeProps = Omit<OnConflictNode, 'kind'>;
6
+ import { RawNode } from './raw-node.js';
7
+ import { WhereNode } from './where-node.js';
8
+ export declare type OnConflictNodeProps = Omit<OnConflictNode, 'kind' | 'indexWhere' | 'updateWhere'>;
6
9
  export interface OnConflictNode extends OperationNode {
7
10
  readonly kind: 'OnConflictNode';
8
11
  readonly columns?: ReadonlyArray<ColumnNode>;
9
12
  readonly constraint?: IdentifierNode;
13
+ readonly indexExpression?: RawNode;
14
+ readonly indexWhere?: WhereNode;
10
15
  readonly updates?: ReadonlyArray<ColumnUpdateNode>;
16
+ readonly updateWhere?: WhereNode;
11
17
  readonly doNothing?: boolean;
12
18
  }
13
19
  /**
@@ -15,5 +21,10 @@ export interface OnConflictNode extends OperationNode {
15
21
  */
16
22
  export declare const OnConflictNode: Readonly<{
17
23
  is(node: OperationNode): node is OnConflictNode;
18
- create(props: OnConflictNodeProps): OnConflictNode;
24
+ create(): OnConflictNode;
25
+ cloneWith(node: OnConflictNode, props: OnConflictNodeProps): OnConflictNode;
26
+ cloneWithIndexWhere(node: OnConflictNode, filter: FilterExpressionNode): OnConflictNode;
27
+ cloneWithIndexOrWhere(node: OnConflictNode, filter: FilterExpressionNode): OnConflictNode;
28
+ cloneWithUpdateWhere(node: OnConflictNode, filter: FilterExpressionNode): OnConflictNode;
29
+ cloneWithUpdateOrWhere(node: OnConflictNode, filter: FilterExpressionNode): OnConflictNode;
19
30
  }>;
@@ -2,6 +2,7 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.OnConflictNode = void 0;
4
4
  const object_utils_js_1 = require("../util/object-utils.js");
5
+ const where_node_js_1 = require("./where-node.js");
5
6
  /**
6
7
  * @internal
7
8
  */
@@ -9,10 +10,47 @@ exports.OnConflictNode = (0, object_utils_js_1.freeze)({
9
10
  is(node) {
10
11
  return node.kind === 'OnConflictNode';
11
12
  },
12
- create(props) {
13
+ create() {
13
14
  return (0, object_utils_js_1.freeze)({
14
15
  kind: 'OnConflictNode',
16
+ });
17
+ },
18
+ cloneWith(node, props) {
19
+ return (0, object_utils_js_1.freeze)({
20
+ ...node,
15
21
  ...props,
16
22
  });
17
23
  },
24
+ cloneWithIndexWhere(node, filter) {
25
+ return (0, object_utils_js_1.freeze)({
26
+ ...node,
27
+ indexWhere: node.indexWhere
28
+ ? where_node_js_1.WhereNode.cloneWithFilter(node.indexWhere, 'And', filter)
29
+ : where_node_js_1.WhereNode.create(filter),
30
+ });
31
+ },
32
+ cloneWithIndexOrWhere(node, filter) {
33
+ return (0, object_utils_js_1.freeze)({
34
+ ...node,
35
+ indexWhere: node.indexWhere
36
+ ? where_node_js_1.WhereNode.cloneWithFilter(node.indexWhere, 'Or', filter)
37
+ : where_node_js_1.WhereNode.create(filter),
38
+ });
39
+ },
40
+ cloneWithUpdateWhere(node, filter) {
41
+ return (0, object_utils_js_1.freeze)({
42
+ ...node,
43
+ updateWhere: node.updateWhere
44
+ ? where_node_js_1.WhereNode.cloneWithFilter(node.updateWhere, 'And', filter)
45
+ : where_node_js_1.WhereNode.create(filter),
46
+ });
47
+ },
48
+ cloneWithUpdateOrWhere(node, filter) {
49
+ return (0, object_utils_js_1.freeze)({
50
+ ...node,
51
+ updateWhere: node.updateWhere
52
+ ? where_node_js_1.WhereNode.cloneWithFilter(node.updateWhere, 'Or', filter)
53
+ : where_node_js_1.WhereNode.create(filter),
54
+ });
55
+ },
18
56
  });
@@ -44,6 +44,7 @@ import { ReferencesNode } from './references-node.js';
44
44
  import { CheckConstraintNode } from './check-constraint-node.js';
45
45
  import { WithNode } from './with-node.js';
46
46
  import { CommonTableExpressionNode } from './common-table-expression-node.js';
47
+ import { CommonTableExpressionNameNode } from './common-table-expression-name-node.js';
47
48
  import { HavingNode } from './having-node.js';
48
49
  import { CreateSchemaNode } from './create-schema-node.js';
49
50
  import { DropSchemaNode } from './drop-schema-node.js';
@@ -60,7 +61,7 @@ import { OnDuplicateKeyNode } from './on-duplicate-key-node.js';
60
61
  import { UnionNode } from './union-node.js';
61
62
  import { CreateViewNode } from './create-view-node.js';
62
63
  import { DropViewNode } from './drop-view-node.js';
63
- import { GeneratedAlwaysAsNode } from './generated-always-as-node.js';
64
+ import { GeneratedNode } from './generated-node.js';
64
65
  import { DefaultValueNode } from './default-value-node.js';
65
66
  import { OnNode } from './on-node.js';
66
67
  import { ValuesNode } from './values-node.js';
@@ -142,6 +143,7 @@ export declare class OperationNodeTransformer {
142
143
  protected transformCheckConstraint(node: CheckConstraintNode): CheckConstraintNode;
143
144
  protected transformWith(node: WithNode): WithNode;
144
145
  protected transformCommonTableExpression(node: CommonTableExpressionNode): CommonTableExpressionNode;
146
+ protected transformCommonTableExpressionName(node: CommonTableExpressionNameNode): CommonTableExpressionNameNode;
145
147
  protected transformHaving(node: HavingNode): HavingNode;
146
148
  protected transformCreateSchema(node: CreateSchemaNode): CreateSchemaNode;
147
149
  protected transformDropSchema(node: DropSchemaNode): DropSchemaNode;
@@ -154,7 +156,7 @@ export declare class OperationNodeTransformer {
154
156
  protected transformDropConstraint(node: DropConstraintNode): DropConstraintNode;
155
157
  protected transformCreateView(node: CreateViewNode): CreateViewNode;
156
158
  protected transformDropView(node: DropViewNode): DropViewNode;
157
- protected transformGeneratedAlwaysAs(node: GeneratedAlwaysAsNode): GeneratedAlwaysAsNode;
159
+ protected transformGenerated(node: GeneratedNode): GeneratedNode;
158
160
  protected transformDefaultValue(node: DefaultValueNode): DefaultValueNode;
159
161
  protected transformOn(node: OnNode): OnNode;
160
162
  protected transformDataType(node: DataTypeNode): DataTypeNode;
@@ -81,6 +81,7 @@ class OperationNodeTransformer {
81
81
  CheckConstraintNode: this.transformCheckConstraint.bind(this),
82
82
  WithNode: this.transformWith.bind(this),
83
83
  CommonTableExpressionNode: this.transformCommonTableExpression.bind(this),
84
+ CommonTableExpressionNameNode: this.transformCommonTableExpressionName.bind(this),
84
85
  HavingNode: this.transformHaving.bind(this),
85
86
  CreateSchemaNode: this.transformCreateSchema.bind(this),
86
87
  DropSchemaNode: this.transformDropSchema.bind(this),
@@ -95,7 +96,7 @@ class OperationNodeTransformer {
95
96
  UnionNode: this.transformUnion.bind(this),
96
97
  CreateViewNode: this.transformCreateView.bind(this),
97
98
  DropViewNode: this.transformDropView.bind(this),
98
- GeneratedAlwaysAsNode: this.transformGeneratedAlwaysAs.bind(this),
99
+ GeneratedNode: this.transformGenerated.bind(this),
99
100
  DefaultValueNode: this.transformDefaultValue.bind(this),
100
101
  OnNode: this.transformOn.bind(this),
101
102
  ValuesNode: this.transformValues.bind(this),
@@ -283,10 +284,11 @@ class OperationNodeTransformer {
283
284
  primaryKey: node.primaryKey,
284
285
  autoIncrement: node.autoIncrement,
285
286
  unique: node.unique,
286
- nullable: node.nullable,
287
+ notNull: node.notNull,
288
+ unsigned: node.unsigned,
287
289
  defaultTo: this.transformNode(node.defaultTo),
288
290
  check: this.transformNode(node.check),
289
- generatedAlwaysAs: this.transformNode(node.generatedAlwaysAs),
291
+ generated: this.transformNode(node.generated),
290
292
  };
291
293
  }
292
294
  transformAddColumn(node) {
@@ -362,7 +364,10 @@ class OperationNodeTransformer {
362
364
  kind: 'OnConflictNode',
363
365
  columns: this.transformNodeList(node.columns),
364
366
  constraint: this.transformNode(node.constraint),
367
+ indexExpression: this.transformNode(node.indexExpression),
368
+ indexWhere: this.transformNode(node.indexWhere),
365
369
  updates: this.transformNodeList(node.updates),
370
+ updateWhere: this.transformNode(node.updateWhere),
366
371
  doNothing: node.doNothing,
367
372
  };
368
373
  }
@@ -447,6 +452,7 @@ class OperationNodeTransformer {
447
452
  return {
448
453
  kind: 'WithNode',
449
454
  expressions: this.transformNodeList(node.expressions),
455
+ recursive: node.recursive,
450
456
  };
451
457
  }
452
458
  transformCommonTableExpression(node) {
@@ -456,6 +462,13 @@ class OperationNodeTransformer {
456
462
  expression: this.transformNode(node.expression),
457
463
  };
458
464
  }
465
+ transformCommonTableExpressionName(node) {
466
+ return {
467
+ kind: 'CommonTableExpressionNameNode',
468
+ table: this.transformNode(node.table),
469
+ columns: this.transformNodeList(node.columns),
470
+ };
471
+ }
459
472
  transformHaving(node) {
460
473
  return {
461
474
  kind: 'HavingNode',
@@ -553,11 +566,14 @@ class OperationNodeTransformer {
553
566
  materialized: node.materialized,
554
567
  };
555
568
  }
556
- transformGeneratedAlwaysAs(node) {
569
+ transformGenerated(node) {
557
570
  return {
558
- kind: 'GeneratedAlwaysAsNode',
559
- expression: this.transformNode(node.expression),
571
+ kind: 'GeneratedNode',
572
+ byDefault: node.byDefault,
573
+ always: node.always,
574
+ identity: node.identity,
560
575
  stored: node.stored,
576
+ expression: this.transformNode(node.expression),
561
577
  };
562
578
  }
563
579
  transformDefaultValue(node) {
@@ -44,6 +44,7 @@ import { ReferencesNode } from './references-node.js';
44
44
  import { CheckConstraintNode } from './check-constraint-node.js';
45
45
  import { WithNode } from './with-node.js';
46
46
  import { CommonTableExpressionNode } from './common-table-expression-node.js';
47
+ import { CommonTableExpressionNameNode } from './common-table-expression-name-node.js';
47
48
  import { HavingNode } from './having-node.js';
48
49
  import { CreateSchemaNode } from './create-schema-node.js';
49
50
  import { DropSchemaNode } from './drop-schema-node.js';
@@ -60,7 +61,7 @@ import { OnDuplicateKeyNode } from './on-duplicate-key-node.js';
60
61
  import { UnionNode } from './union-node.js';
61
62
  import { CreateViewNode } from './create-view-node.js';
62
63
  import { DropViewNode } from './drop-view-node.js';
63
- import { GeneratedAlwaysAsNode } from './generated-always-as-node.js';
64
+ import { GeneratedNode } from './generated-node.js';
64
65
  import { DefaultValueNode } from './default-value-node.js';
65
66
  import { OnNode } from './on-node.js';
66
67
  import { ValuesNode } from './values-node.js';
@@ -110,6 +111,7 @@ export declare abstract class OperationNodeVisitor {
110
111
  protected abstract visitCheckConstraint(node: CheckConstraintNode): void;
111
112
  protected abstract visitWith(node: WithNode): void;
112
113
  protected abstract visitCommonTableExpression(node: CommonTableExpressionNode): void;
114
+ protected abstract visitCommonTableExpressionName(node: CommonTableExpressionNameNode): void;
113
115
  protected abstract visitHaving(node: HavingNode): void;
114
116
  protected abstract visitCreateSchema(node: CreateSchemaNode): void;
115
117
  protected abstract visitDropSchema(node: DropSchemaNode): void;
@@ -130,7 +132,7 @@ export declare abstract class OperationNodeVisitor {
130
132
  protected abstract visitOperator(node: OperatorNode): void;
131
133
  protected abstract visitCreateView(node: CreateViewNode): void;
132
134
  protected abstract visitDropView(node: DropViewNode): void;
133
- protected abstract visitGeneratedAlwaysAs(node: GeneratedAlwaysAsNode): void;
135
+ protected abstract visitGenerated(node: GeneratedNode): void;
134
136
  protected abstract visitDefaultValue(node: DefaultValueNode): void;
135
137
  protected abstract visitOn(node: OnNode): void;
136
138
  protected abstract visitValues(node: ValuesNode): void;
@@ -55,6 +55,7 @@ class OperationNodeVisitor {
55
55
  CheckConstraintNode: this.visitCheckConstraint.bind(this),
56
56
  WithNode: this.visitWith.bind(this),
57
57
  CommonTableExpressionNode: this.visitCommonTableExpression.bind(this),
58
+ CommonTableExpressionNameNode: this.visitCommonTableExpressionName.bind(this),
58
59
  HavingNode: this.visitHaving.bind(this),
59
60
  CreateSchemaNode: this.visitCreateSchema.bind(this),
60
61
  DropSchemaNode: this.visitDropSchema.bind(this),
@@ -69,7 +70,7 @@ class OperationNodeVisitor {
69
70
  UnionNode: this.visitUnion.bind(this),
70
71
  CreateViewNode: this.visitCreateView.bind(this),
71
72
  DropViewNode: this.visitDropView.bind(this),
72
- GeneratedAlwaysAsNode: this.visitGeneratedAlwaysAs.bind(this),
73
+ GeneratedNode: this.visitGenerated.bind(this),
73
74
  DefaultValueNode: this.visitDefaultValue.bind(this),
74
75
  OnNode: this.visitOn.bind(this),
75
76
  ValuesNode: this.visitValues.bind(this),
@@ -1,4 +1,4 @@
1
- export declare type OperationNodeKind = 'IdentifierNode' | 'RawNode' | 'SelectQueryNode' | 'SelectionNode' | 'ReferenceNode' | 'ColumnNode' | 'TableNode' | 'AliasNode' | 'FromNode' | 'SelectAllNode' | 'FilterNode' | 'AndNode' | 'OrNode' | 'ParensNode' | 'ValueNode' | 'ValueListNode' | 'PrimitiveValueListNode' | 'JoinNode' | 'OperatorNode' | 'WhereNode' | 'InsertQueryNode' | 'DeleteQueryNode' | 'ReturningNode' | 'CreateTableNode' | 'ColumnDefinitionNode' | 'AddColumnNode' | 'DropTableNode' | 'DataTypeNode' | 'OrderByNode' | 'OrderByItemNode' | 'GroupByNode' | 'GroupByItemNode' | 'UpdateQueryNode' | 'ColumnUpdateNode' | 'LimitNode' | 'OffsetNode' | 'OnConflictNode' | 'OnDuplicateKeyNode' | 'CreateIndexNode' | 'DropIndexNode' | 'ListNode' | 'ReferencesNode' | 'PrimaryKeyConstraintNode' | 'UniqueConstraintNode' | 'CheckConstraintNode' | 'ForeignKeyConstraintNode' | 'WithNode' | 'CommonTableExpressionNode' | 'HavingNode' | 'CreateSchemaNode' | 'DropSchemaNode' | 'AlterTableNode' | 'ModifyColumnNode' | 'DropColumnNode' | 'RenameColumnNode' | 'AlterColumnNode' | 'AddConstraintNode' | 'DropConstraintNode' | 'UnionNode' | 'CreateViewNode' | 'DropViewNode' | 'GeneratedAlwaysAsNode' | 'DefaultValueNode' | 'OnNode' | 'ValuesNode';
1
+ export declare type OperationNodeKind = 'IdentifierNode' | 'RawNode' | 'SelectQueryNode' | 'SelectionNode' | 'ReferenceNode' | 'ColumnNode' | 'TableNode' | 'AliasNode' | 'FromNode' | 'SelectAllNode' | 'FilterNode' | 'AndNode' | 'OrNode' | 'ParensNode' | 'ValueNode' | 'ValueListNode' | 'PrimitiveValueListNode' | 'JoinNode' | 'OperatorNode' | 'WhereNode' | 'InsertQueryNode' | 'DeleteQueryNode' | 'ReturningNode' | 'CreateTableNode' | 'ColumnDefinitionNode' | 'AddColumnNode' | 'DropTableNode' | 'DataTypeNode' | 'OrderByNode' | 'OrderByItemNode' | 'GroupByNode' | 'GroupByItemNode' | 'UpdateQueryNode' | 'ColumnUpdateNode' | 'LimitNode' | 'OffsetNode' | 'OnConflictNode' | 'OnDuplicateKeyNode' | 'CreateIndexNode' | 'DropIndexNode' | 'ListNode' | 'ReferencesNode' | 'PrimaryKeyConstraintNode' | 'UniqueConstraintNode' | 'CheckConstraintNode' | 'ForeignKeyConstraintNode' | 'WithNode' | 'CommonTableExpressionNode' | 'HavingNode' | 'CreateSchemaNode' | 'DropSchemaNode' | 'AlterTableNode' | 'ModifyColumnNode' | 'DropColumnNode' | 'RenameColumnNode' | 'AlterColumnNode' | 'AddConstraintNode' | 'DropConstraintNode' | 'UnionNode' | 'CreateViewNode' | 'DropViewNode' | 'GeneratedNode' | 'DefaultValueNode' | 'OnNode' | 'ValuesNode' | 'CommonTableExpressionNameNode';
2
2
  export interface OperationNode {
3
3
  readonly kind: OperationNodeKind;
4
4
  }
@@ -1,14 +1,16 @@
1
1
  import { OperationNode } from './operation-node.js';
2
2
  import { CommonTableExpressionNode } from './common-table-expression-node.js';
3
+ export declare type WithNodeParams = Omit<WithNode, 'kind' | 'expressions'>;
3
4
  export interface WithNode extends OperationNode {
4
5
  readonly kind: 'WithNode';
5
6
  readonly expressions: ReadonlyArray<CommonTableExpressionNode>;
7
+ readonly recursive?: boolean;
6
8
  }
7
9
  /**
8
10
  * @internal
9
11
  */
10
12
  export declare const WithNode: Readonly<{
11
13
  is(node: OperationNode): node is WithNode;
12
- create(expression: CommonTableExpressionNode): WithNode;
14
+ create(expression: CommonTableExpressionNode, params?: WithNodeParams | undefined): WithNode;
13
15
  cloneWithExpression(withNode: WithNode, expression: CommonTableExpressionNode): WithNode;
14
16
  }>;
@@ -9,10 +9,11 @@ exports.WithNode = (0, object_utils_js_1.freeze)({
9
9
  is(node) {
10
10
  return node.kind === 'WithNode';
11
11
  },
12
- create(expression) {
12
+ create(expression, params) {
13
13
  return (0, object_utils_js_1.freeze)({
14
14
  kind: 'WithNode',
15
15
  expressions: (0, object_utils_js_1.freeze)([expression]),
16
+ ...params,
16
17
  });
17
18
  },
18
19
  cloneWithExpression(withNode, expression) {
@@ -1,3 +1 @@
1
- {
2
- "type": "commonjs"
3
- }
1
+ {"type":"commonjs"}
@@ -34,8 +34,22 @@ export declare class DefaultParseContext implements ParseContext {
34
34
  #private;
35
35
  constructor(adapter: DialectAdapter);
36
36
  get adapter(): DialectAdapter;
37
+ /**
38
+ * Creates a select query builder with a {@link NoopQueryExecutor}.
39
+ */
37
40
  createSelectQueryBuilder(): SelectQueryBuilder<any, any, any>;
41
+ /**
42
+ * Creates an expression builder for building stuff like subqueries.
43
+ * {@link NoopQueryExecutor} is used as the executor and the queries
44
+ * built using the returned builder can never be executed.
45
+ */
38
46
  createExpressionBuilder(): ExpressionBuilder<any, any>;
47
+ /**
48
+ * Creates a query creator with a {@link NoopQueryExecutor}.
49
+ */
39
50
  createQueryCreator(): QueryCreator<any>;
51
+ /**
52
+ * Creates an instance of a join builder.
53
+ */
40
54
  createJoinBuilder(joinType: JoinType, table: TableExpression<any, any>): JoinBuilder<any, any>;
41
55
  }
@@ -5,10 +5,37 @@ import { InsertQueryBuilder } from '../query-builder/insert-query-builder.js';
5
5
  import { CommonTableExpressionNode } from '../operation-node/common-table-expression-node.js';
6
6
  import { QueryCreator } from '../query-creator.js';
7
7
  import { RawBuilder } from '../raw-builder/raw-builder.js';
8
- import { AnyRawBuilder } from '../util/type-utils.js';
9
8
  import { ParseContext } from './parse-context.js';
10
- export declare type CommonTableExpression<DB> = (creator: QueryCreator<DB>) => SelectQueryBuilder<DB, any, any> | InsertQueryBuilder<DB, any, any> | UpdateQueryBuilder<DB, any, any> | DeleteQueryBuilder<DB, any, any> | AnyRawBuilder;
11
- export declare type QueryCreatorWithCommonTableExpression<DB, N extends string, E extends CommonTableExpression<DB>> = QueryCreator<DB & Record<N, ExtractRowTypeFromCommonTableExpression<E>>>;
12
- declare type ExtractRowTypeFromCommonTableExpression<E> = E extends (creator: QueryCreator<any>) => infer Q ? Q extends SelectQueryBuilder<any, any, infer QO> ? QO : Q extends InsertQueryBuilder<any, any, infer QO> ? QO : Q extends UpdateQueryBuilder<any, any, infer QO> ? QO : Q extends DeleteQueryBuilder<any, any, infer QO> ? QO : Q extends RawBuilder<infer RO> ? RO : never : never;
13
- export declare function parseCommonTableExpression(ctx: ParseContext, name: string, expression: CommonTableExpression<any>): CommonTableExpressionNode;
9
+ export declare type CommonTableExpression<DB, CN extends string> = (creator: QueryCreator<DB>) => CommonTableExpressionOutput<DB, CN>;
10
+ export declare type RecursiveCommonTableExpression<DB, CN extends string> = (creator: QueryCreator<DB & Record<ExtractTableFromCommonTableExpressionName<CN>, ExtractRowFromCommonTableExpressionName<CN>>>) => CommonTableExpressionOutput<DB, CN>;
11
+ export declare type QueryCreatorWithCommonTableExpression<DB, CN extends string, CTE> = QueryCreator<DB & Record<ExtractTableFromCommonTableExpressionName<CN>, ExtractRowFromCommonTableExpression<CTE>>>;
12
+ declare type CommonTableExpressionOutput<DB, CN extends string> = SelectQueryBuilder<DB, any, ExtractRowFromCommonTableExpressionName<CN>> | InsertQueryBuilder<DB, any, ExtractRowFromCommonTableExpressionName<CN>> | UpdateQueryBuilder<DB, any, ExtractRowFromCommonTableExpressionName<CN>> | DeleteQueryBuilder<DB, any, ExtractRowFromCommonTableExpressionName<CN>> | RawBuilder<ExtractRowFromCommonTableExpressionName<CN>>;
13
+ /**
14
+ * Given a common CommonTableExpression CTE extracts the row type from it.
15
+ *
16
+ * For example a CTE `(db) => db.selectFrom('person').select(['id', 'first_name'])`
17
+ * would result in `Pick<Person, 'id' | 'first_name'>`.
18
+ */
19
+ declare type ExtractRowFromCommonTableExpression<CTE> = CTE extends (creator: QueryCreator<any>) => infer Q ? Q extends SelectQueryBuilder<any, any, infer QO> ? QO : Q extends InsertQueryBuilder<any, any, infer QO> ? QO : Q extends UpdateQueryBuilder<any, any, infer QO> ? QO : Q extends DeleteQueryBuilder<any, any, infer QO> ? QO : Q extends RawBuilder<infer RO> ? RO : never : never;
20
+ /**
21
+ * Extracts 'person' from a string like 'person(id, first_name)'.
22
+ */
23
+ declare type ExtractTableFromCommonTableExpressionName<CN extends string> = CN extends `${infer TB}(${string})` ? TB : CN;
24
+ /**
25
+ * Parses a string like 'person(id, first_name)' into a type:
26
+ *
27
+ * {
28
+ * id: any,
29
+ * first_name: any
30
+ * }
31
+ *
32
+ */
33
+ declare type ExtractRowFromCommonTableExpressionName<CN extends string> = CN extends `${string}(${infer CL})` ? {
34
+ [C in ExtractColumnNamesFromColumnList<CL>]: any;
35
+ } : Record<string, any>;
36
+ /**
37
+ * Parses a string like 'id, first_name' into a type 'id' | 'first_name'
38
+ */
39
+ declare type ExtractColumnNamesFromColumnList<R extends string> = R extends `${infer C}, ${infer RS}` ? C | ExtractColumnNamesFromColumnList<RS> : R;
40
+ export declare function parseCommonTableExpression(ctx: ParseContext, name: string, expression: CommonTableExpression<any, any>): CommonTableExpressionNode;
14
41
  export {};
@@ -1,10 +1,21 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.parseCommonTableExpression = void 0;
4
- const identifier_node_js_1 = require("../operation-node/identifier-node.js");
5
4
  const common_table_expression_node_js_1 = require("../operation-node/common-table-expression-node.js");
5
+ const common_table_expression_name_node_js_1 = require("../operation-node/common-table-expression-name-node.js");
6
6
  function parseCommonTableExpression(ctx, name, expression) {
7
7
  const builder = expression(ctx.createQueryCreator());
8
- return common_table_expression_node_js_1.CommonTableExpressionNode.create(identifier_node_js_1.IdentifierNode.create(name), builder.toOperationNode());
8
+ return common_table_expression_node_js_1.CommonTableExpressionNode.create(parseCommonTableExpressionName(name), builder.toOperationNode());
9
9
  }
10
10
  exports.parseCommonTableExpression = parseCommonTableExpression;
11
+ function parseCommonTableExpressionName(name) {
12
+ if (name.includes('(')) {
13
+ const parts = name.split(/[\(\)]/);
14
+ const table = parts[0];
15
+ const columns = parts[1].split(',').map((it) => it.trim());
16
+ return common_table_expression_name_node_js_1.CommonTableExpressionNameNode.create(table, columns);
17
+ }
18
+ else {
19
+ return common_table_expression_name_node_js_1.CommonTableExpressionNameNode.create(name);
20
+ }
21
+ }
@@ -12,8 +12,8 @@ export interface CamelCasePluginOptions {
12
12
  upperCase?: boolean;
13
13
  /**
14
14
  * If true, an underscore is added before each digit when converting
15
- * camelCase to snake_case. For example `foo1Bar => foo_1_bar` and
16
- * `foo_1_bar => foo1Bar`
15
+ * camelCase to snake_case. For example `foo12Bar => foo_12_bar` and
16
+ * `foo_12_bar => foo12Bar`
17
17
  *
18
18
  * Defaults to false.
19
19
  */
@@ -94,7 +94,41 @@ export interface CamelCasePluginOptions {
94
94
  export declare class CamelCasePlugin implements KyselyPlugin {
95
95
  #private;
96
96
  constructor(opt?: CamelCasePluginOptions);
97
+ /**
98
+ * This is called for each query before it is executed. You can modify the query by
99
+ * transforming its {@link OperationNode} tree provided in {@link PluginTransformQueryArgs.node | args.node}
100
+ * and returning the transformed tree. You'd usually want to use an {@link OperationNodeTransformer}
101
+ * for this.
102
+ *
103
+ * If you need to pass some query-related data between this method and `transformResult` you
104
+ * can use a `WeakMap` with {@link PluginTransformQueryArgs.queryId | args.queryId} as the key:
105
+ *
106
+ * ```ts
107
+ * const plugin = {
108
+ * data: new WeakMap<QueryId, SomeData>(),
109
+ *
110
+ * transformQuery(args: PluginTransformQueryArgs): RootOperationNode {
111
+ * this.data.set(args.queryId, something)
112
+ * return args.node
113
+ * },
114
+ *
115
+ * transformResult(args: PluginTransformResultArgs): QueryResult<UnknownRow> {
116
+ * const data = this.data.get(args.queryId)
117
+ * return args.result
118
+ * }
119
+ * }
120
+ * ```
121
+ *
122
+ * You should use a `WeakMap` instead of a `Map` or some other strong references because `transformQuery`
123
+ * is not always matched by a call to `transformResult` which would leave orphaned items in the map
124
+ * and cause a memory leak.
125
+ */
97
126
  transformQuery(args: PluginTransformQueryArgs): RootOperationNode;
127
+ /**
128
+ * This method is called for each query after it has been executed. The result
129
+ * of the query can be accessed through {@link PluginTransformResultArgs.result | args.result}.
130
+ * You can modify the result and return the modifier result.
131
+ */
98
132
  transformResult(args: PluginTransformResultArgs): Promise<QueryResult<UnknownRow>>;
99
133
  protected mapRow(row: UnknownRow): UnknownRow;
100
134
  protected snakeCase(str: string): string;
@@ -12,6 +12,40 @@ import { KyselyPlugin, PluginTransformQueryArgs, PluginTransformResultArgs } fro
12
12
  */
13
13
  export declare class ImmediateValuePlugin implements KyselyPlugin {
14
14
  #private;
15
+ /**
16
+ * This is called for each query before it is executed. You can modify the query by
17
+ * transforming its {@link OperationNode} tree provided in {@link PluginTransformQueryArgs.node | args.node}
18
+ * and returning the transformed tree. You'd usually want to use an {@link OperationNodeTransformer}
19
+ * for this.
20
+ *
21
+ * If you need to pass some query-related data between this method and `transformResult` you
22
+ * can use a `WeakMap` with {@link PluginTransformQueryArgs.queryId | args.queryId} as the key:
23
+ *
24
+ * ```ts
25
+ * const plugin = {
26
+ * data: new WeakMap<QueryId, SomeData>(),
27
+ *
28
+ * transformQuery(args: PluginTransformQueryArgs): RootOperationNode {
29
+ * this.data.set(args.queryId, something)
30
+ * return args.node
31
+ * },
32
+ *
33
+ * transformResult(args: PluginTransformResultArgs): QueryResult<UnknownRow> {
34
+ * const data = this.data.get(args.queryId)
35
+ * return args.result
36
+ * }
37
+ * }
38
+ * ```
39
+ *
40
+ * You should use a `WeakMap` instead of a `Map` or some other strong references because `transformQuery`
41
+ * is not always matched by a call to `transformResult` which would leave orphaned items in the map
42
+ * and cause a memory leak.
43
+ */
15
44
  transformQuery(args: PluginTransformQueryArgs): RootOperationNode;
45
+ /**
46
+ * This method is called for each query after it has been executed. The result
47
+ * of the query can be accessed through {@link PluginTransformResultArgs.result | args.result}.
48
+ * You can modify the result and return the modifier result.
49
+ */
16
50
  transformResult(args: PluginTransformResultArgs): Promise<QueryResult<UnknownRow>>;
17
51
  }
@@ -5,6 +5,40 @@ import { UnknownRow } from '../../util/type-utils.js';
5
5
  export declare class WithSchemaPlugin implements KyselyPlugin {
6
6
  #private;
7
7
  constructor(schema: string);
8
+ /**
9
+ * This is called for each query before it is executed. You can modify the query by
10
+ * transforming its {@link OperationNode} tree provided in {@link PluginTransformQueryArgs.node | args.node}
11
+ * and returning the transformed tree. You'd usually want to use an {@link OperationNodeTransformer}
12
+ * for this.
13
+ *
14
+ * If you need to pass some query-related data between this method and `transformResult` you
15
+ * can use a `WeakMap` with {@link PluginTransformQueryArgs.queryId | args.queryId} as the key:
16
+ *
17
+ * ```ts
18
+ * const plugin = {
19
+ * data: new WeakMap<QueryId, SomeData>(),
20
+ *
21
+ * transformQuery(args: PluginTransformQueryArgs): RootOperationNode {
22
+ * this.data.set(args.queryId, something)
23
+ * return args.node
24
+ * },
25
+ *
26
+ * transformResult(args: PluginTransformResultArgs): QueryResult<UnknownRow> {
27
+ * const data = this.data.get(args.queryId)
28
+ * return args.result
29
+ * }
30
+ * }
31
+ * ```
32
+ *
33
+ * You should use a `WeakMap` instead of a `Map` or some other strong references because `transformQuery`
34
+ * is not always matched by a call to `transformResult` which would leave orphaned items in the map
35
+ * and cause a memory leak.
36
+ */
8
37
  transformQuery(args: PluginTransformQueryArgs): RootOperationNode;
38
+ /**
39
+ * This method is called for each query after it has been executed. The result
40
+ * of the query can be accessed through {@link PluginTransformResultArgs.result | args.result}.
41
+ * You can modify the result and return the modifier result.
42
+ */
9
43
  transformResult(args: PluginTransformResultArgs): Promise<QueryResult<UnknownRow>>;
10
44
  }
@@ -82,6 +82,9 @@ class WithSchemaTransformer extends operation_node_transformer_js_1.OperationNod
82
82
  if ('joins' in node && node.joins) {
83
83
  this.#collectTablesFromJoins(node.joins, tables);
84
84
  }
85
+ if ('with' in node && node.with) {
86
+ this.#removeCommonTableExpressionTables(node.with, tables);
87
+ }
85
88
  return tables;
86
89
  }
87
90
  #collectTablesFromTableExpressionNodes(nodes, tables) {
@@ -104,5 +107,10 @@ class WithSchemaTransformer extends operation_node_transformer_js_1.OperationNod
104
107
  tables.add(table.table.identifier);
105
108
  }
106
109
  }
110
+ #removeCommonTableExpressionTables(node, tables) {
111
+ for (const expr of node.expressions) {
112
+ tables.delete(expr.name.table.table.identifier);
113
+ }
114
+ }
107
115
  }
108
116
  exports.WithSchemaTransformer = WithSchemaTransformer;