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
@@ -2,24 +2,25 @@ import { CheckConstraintNode } from './check-constraint-node.js';
2
2
  import { ColumnNode } from './column-node.js';
3
3
  import { DataTypeNode } from './data-type-node.js';
4
4
  import { DefaultValueNode } from './default-value-node.js';
5
- import { GeneratedAlwaysAsNode } from './generated-always-as-node.js';
5
+ import { GeneratedNode } from './generated-node.js';
6
6
  import { OperationNode } from './operation-node.js';
7
7
  import { RawNode } from './raw-node.js';
8
8
  import { ReferencesNode } from './references-node.js';
9
- export declare type ColumnDefinitionNodeProps = Omit<Partial<ColumnDefinitionNode>, 'kind'>;
9
+ export declare type ColumnDefinitionNodeProps = Omit<Partial<ColumnDefinitionNode>, 'kind' | 'dataType'>;
10
10
  export declare type ColumnDataTypeNode = DataTypeNode | RawNode;
11
11
  export interface ColumnDefinitionNode extends OperationNode {
12
12
  readonly kind: 'ColumnDefinitionNode';
13
13
  readonly column: ColumnNode;
14
14
  readonly dataType: ColumnDataTypeNode;
15
15
  readonly references?: ReferencesNode;
16
- readonly primaryKey: boolean;
17
- readonly autoIncrement: boolean;
18
- readonly unique: boolean;
19
- readonly nullable: boolean;
16
+ readonly primaryKey?: boolean;
17
+ readonly autoIncrement?: boolean;
18
+ readonly unique?: boolean;
19
+ readonly notNull?: boolean;
20
20
  readonly defaultTo?: DefaultValueNode;
21
21
  readonly check?: CheckConstraintNode;
22
- readonly generatedAlwaysAs?: GeneratedAlwaysAsNode;
22
+ readonly generated?: GeneratedNode;
23
+ readonly unsigned?: boolean;
23
24
  }
24
25
  /**
25
26
  * @internal
@@ -12,10 +12,6 @@ export const ColumnDefinitionNode = freeze({
12
12
  kind: 'ColumnDefinitionNode',
13
13
  column: ColumnNode.create(column),
14
14
  dataType,
15
- primaryKey: false,
16
- autoIncrement: false,
17
- unique: false,
18
- nullable: true,
19
15
  });
20
16
  },
21
17
  cloneWith(node, props) {
@@ -0,0 +1,15 @@
1
+ import { ColumnNode } from './column-node.js';
2
+ import { OperationNode } from './operation-node.js';
3
+ import { TableNode } from './table-node.js';
4
+ export interface CommonTableExpressionNameNode extends OperationNode {
5
+ readonly kind: 'CommonTableExpressionNameNode';
6
+ readonly table: TableNode;
7
+ readonly columns?: ReadonlyArray<ColumnNode>;
8
+ }
9
+ /**
10
+ * @internal
11
+ */
12
+ export declare const CommonTableExpressionNameNode: Readonly<{
13
+ is(node: OperationNode): node is CommonTableExpressionNameNode;
14
+ create(tableName: string, columnNames?: readonly string[] | undefined): CommonTableExpressionNameNode;
15
+ }>;
@@ -0,0 +1,20 @@
1
+ import { freeze } from '../util/object-utils.js';
2
+ import { ColumnNode } from './column-node.js';
3
+ import { TableNode } from './table-node.js';
4
+ /**
5
+ * @internal
6
+ */
7
+ export const CommonTableExpressionNameNode = freeze({
8
+ is(node) {
9
+ return node.kind === 'CommonTableExpressionNameNode';
10
+ },
11
+ create(tableName, columnNames) {
12
+ return freeze({
13
+ kind: 'CommonTableExpressionNameNode',
14
+ table: TableNode.create(tableName),
15
+ columns: columnNames
16
+ ? freeze(columnNames.map(ColumnNode.create))
17
+ : undefined,
18
+ });
19
+ },
20
+ });
@@ -1,10 +1,10 @@
1
- import { IdentifierNode } from './identifier-node.js';
1
+ import { CommonTableExpressionNameNode } from './common-table-expression-name-node.js';
2
2
  import { OperationNode } from './operation-node.js';
3
3
  import { QueryNode } from './query-node.js';
4
4
  import { RawNode } from './raw-node.js';
5
5
  export interface CommonTableExpressionNode extends OperationNode {
6
6
  readonly kind: 'CommonTableExpressionNode';
7
- readonly name: IdentifierNode;
7
+ readonly name: CommonTableExpressionNameNode;
8
8
  readonly expression: QueryNode | RawNode;
9
9
  }
10
10
  /**
@@ -12,5 +12,5 @@ export interface CommonTableExpressionNode extends OperationNode {
12
12
  */
13
13
  export declare const CommonTableExpressionNode: Readonly<{
14
14
  is(node: OperationNode): node is CommonTableExpressionNode;
15
- create(name: IdentifierNode, expression: QueryNode | RawNode): CommonTableExpressionNode;
15
+ create(name: CommonTableExpressionNameNode, expression: QueryNode | RawNode): CommonTableExpressionNode;
16
16
  }>;
@@ -1,5 +1,5 @@
1
1
  import { OperationNode } from './operation-node.js';
2
- export declare type ColumnDataType = 'varchar' | `varchar(${number})` | 'text' | 'integer' | 'int2' | 'int4' | 'int8' | 'bigint' | 'boolean' | 'real' | 'double precision' | 'float4' | 'float8' | 'decimal' | `decimal(${number}, ${number})` | 'numeric' | `numeric(${number}, ${number})` | 'binary' | 'date' | 'datetime' | 'time' | 'timetz' | 'timestamp' | 'timestamptz' | 'serial' | 'bigserial' | 'uuid' | 'json' | 'jsonb';
2
+ export declare type ColumnDataType = 'varchar' | `varchar(${number})` | 'text' | 'integer' | 'int2' | 'int4' | 'int8' | 'bigint' | 'boolean' | 'real' | 'double precision' | 'float4' | 'float8' | 'decimal' | `decimal(${number}, ${number})` | 'numeric' | `numeric(${number}, ${number})` | 'binary' | 'date' | 'datetime' | 'time' | 'timetz' | 'timestamp' | 'timestamptz' | 'serial' | 'bigserial' | 'uuid' | 'json' | 'jsonb' | 'blob';
3
3
  export declare type DataTypeParams = Omit<DataTypeNode, 'kind' | 'dataType'>;
4
4
  export interface DataTypeNode extends OperationNode {
5
5
  readonly kind: 'DataTypeNode';
@@ -0,0 +1,20 @@
1
+ import { OperationNode } from './operation-node.js';
2
+ import { RawNode } from './raw-node.js';
3
+ export declare type GeneratedNodeParams = Omit<GeneratedNode, 'kind' | 'expression'>;
4
+ export interface GeneratedNode extends OperationNode {
5
+ readonly kind: 'GeneratedNode';
6
+ readonly byDefault?: boolean;
7
+ readonly always?: boolean;
8
+ readonly identity?: boolean;
9
+ readonly stored?: boolean;
10
+ readonly expression?: RawNode;
11
+ }
12
+ /**
13
+ * @internal
14
+ */
15
+ export declare const GeneratedNode: Readonly<{
16
+ is(node: OperationNode): node is GeneratedNode;
17
+ create(params: GeneratedNodeParams): GeneratedNode;
18
+ createWithExpression(expression: RawNode): GeneratedNode;
19
+ cloneWith(node: GeneratedNode, params: GeneratedNodeParams): GeneratedNode;
20
+ }>;
@@ -0,0 +1,28 @@
1
+ import { freeze } from '../util/object-utils.js';
2
+ /**
3
+ * @internal
4
+ */
5
+ export const GeneratedNode = freeze({
6
+ is(node) {
7
+ return node.kind === 'GeneratedNode';
8
+ },
9
+ create(params) {
10
+ return freeze({
11
+ kind: 'GeneratedNode',
12
+ ...params,
13
+ });
14
+ },
15
+ createWithExpression(expression) {
16
+ return freeze({
17
+ kind: 'GeneratedNode',
18
+ always: true,
19
+ expression,
20
+ });
21
+ },
22
+ cloneWith(node, params) {
23
+ return freeze({
24
+ ...node,
25
+ ...params,
26
+ });
27
+ },
28
+ });
@@ -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
  }>;
@@ -1,4 +1,5 @@
1
1
  import { freeze } from '../util/object-utils.js';
2
+ import { WhereNode } from './where-node.js';
2
3
  /**
3
4
  * @internal
4
5
  */
@@ -6,10 +7,47 @@ export const OnConflictNode = freeze({
6
7
  is(node) {
7
8
  return node.kind === 'OnConflictNode';
8
9
  },
9
- create(props) {
10
+ create() {
10
11
  return freeze({
11
12
  kind: 'OnConflictNode',
13
+ });
14
+ },
15
+ cloneWith(node, props) {
16
+ return freeze({
17
+ ...node,
12
18
  ...props,
13
19
  });
14
20
  },
21
+ cloneWithIndexWhere(node, filter) {
22
+ return freeze({
23
+ ...node,
24
+ indexWhere: node.indexWhere
25
+ ? WhereNode.cloneWithFilter(node.indexWhere, 'And', filter)
26
+ : WhereNode.create(filter),
27
+ });
28
+ },
29
+ cloneWithIndexOrWhere(node, filter) {
30
+ return freeze({
31
+ ...node,
32
+ indexWhere: node.indexWhere
33
+ ? WhereNode.cloneWithFilter(node.indexWhere, 'Or', filter)
34
+ : WhereNode.create(filter),
35
+ });
36
+ },
37
+ cloneWithUpdateWhere(node, filter) {
38
+ return freeze({
39
+ ...node,
40
+ updateWhere: node.updateWhere
41
+ ? WhereNode.cloneWithFilter(node.updateWhere, 'And', filter)
42
+ : WhereNode.create(filter),
43
+ });
44
+ },
45
+ cloneWithUpdateOrWhere(node, filter) {
46
+ return freeze({
47
+ ...node,
48
+ updateWhere: node.updateWhere
49
+ ? WhereNode.cloneWithFilter(node.updateWhere, 'Or', filter)
50
+ : WhereNode.create(filter),
51
+ });
52
+ },
15
53
  });
@@ -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;
@@ -78,6 +78,7 @@ export class OperationNodeTransformer {
78
78
  CheckConstraintNode: this.transformCheckConstraint.bind(this),
79
79
  WithNode: this.transformWith.bind(this),
80
80
  CommonTableExpressionNode: this.transformCommonTableExpression.bind(this),
81
+ CommonTableExpressionNameNode: this.transformCommonTableExpressionName.bind(this),
81
82
  HavingNode: this.transformHaving.bind(this),
82
83
  CreateSchemaNode: this.transformCreateSchema.bind(this),
83
84
  DropSchemaNode: this.transformDropSchema.bind(this),
@@ -92,7 +93,7 @@ export class OperationNodeTransformer {
92
93
  UnionNode: this.transformUnion.bind(this),
93
94
  CreateViewNode: this.transformCreateView.bind(this),
94
95
  DropViewNode: this.transformDropView.bind(this),
95
- GeneratedAlwaysAsNode: this.transformGeneratedAlwaysAs.bind(this),
96
+ GeneratedNode: this.transformGenerated.bind(this),
96
97
  DefaultValueNode: this.transformDefaultValue.bind(this),
97
98
  OnNode: this.transformOn.bind(this),
98
99
  ValuesNode: this.transformValues.bind(this),
@@ -280,10 +281,11 @@ export class OperationNodeTransformer {
280
281
  primaryKey: node.primaryKey,
281
282
  autoIncrement: node.autoIncrement,
282
283
  unique: node.unique,
283
- nullable: node.nullable,
284
+ notNull: node.notNull,
285
+ unsigned: node.unsigned,
284
286
  defaultTo: this.transformNode(node.defaultTo),
285
287
  check: this.transformNode(node.check),
286
- generatedAlwaysAs: this.transformNode(node.generatedAlwaysAs),
288
+ generated: this.transformNode(node.generated),
287
289
  };
288
290
  }
289
291
  transformAddColumn(node) {
@@ -359,7 +361,10 @@ export class OperationNodeTransformer {
359
361
  kind: 'OnConflictNode',
360
362
  columns: this.transformNodeList(node.columns),
361
363
  constraint: this.transformNode(node.constraint),
364
+ indexExpression: this.transformNode(node.indexExpression),
365
+ indexWhere: this.transformNode(node.indexWhere),
362
366
  updates: this.transformNodeList(node.updates),
367
+ updateWhere: this.transformNode(node.updateWhere),
363
368
  doNothing: node.doNothing,
364
369
  };
365
370
  }
@@ -444,6 +449,7 @@ export class OperationNodeTransformer {
444
449
  return {
445
450
  kind: 'WithNode',
446
451
  expressions: this.transformNodeList(node.expressions),
452
+ recursive: node.recursive,
447
453
  };
448
454
  }
449
455
  transformCommonTableExpression(node) {
@@ -453,6 +459,13 @@ export class OperationNodeTransformer {
453
459
  expression: this.transformNode(node.expression),
454
460
  };
455
461
  }
462
+ transformCommonTableExpressionName(node) {
463
+ return {
464
+ kind: 'CommonTableExpressionNameNode',
465
+ table: this.transformNode(node.table),
466
+ columns: this.transformNodeList(node.columns),
467
+ };
468
+ }
456
469
  transformHaving(node) {
457
470
  return {
458
471
  kind: 'HavingNode',
@@ -550,11 +563,14 @@ export class OperationNodeTransformer {
550
563
  materialized: node.materialized,
551
564
  };
552
565
  }
553
- transformGeneratedAlwaysAs(node) {
566
+ transformGenerated(node) {
554
567
  return {
555
- kind: 'GeneratedAlwaysAsNode',
556
- expression: this.transformNode(node.expression),
568
+ kind: 'GeneratedNode',
569
+ byDefault: node.byDefault,
570
+ always: node.always,
571
+ identity: node.identity,
557
572
  stored: node.stored,
573
+ expression: this.transformNode(node.expression),
558
574
  };
559
575
  }
560
576
  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;
@@ -52,6 +52,7 @@ export class OperationNodeVisitor {
52
52
  CheckConstraintNode: this.visitCheckConstraint.bind(this),
53
53
  WithNode: this.visitWith.bind(this),
54
54
  CommonTableExpressionNode: this.visitCommonTableExpression.bind(this),
55
+ CommonTableExpressionNameNode: this.visitCommonTableExpressionName.bind(this),
55
56
  HavingNode: this.visitHaving.bind(this),
56
57
  CreateSchemaNode: this.visitCreateSchema.bind(this),
57
58
  DropSchemaNode: this.visitDropSchema.bind(this),
@@ -66,7 +67,7 @@ export class OperationNodeVisitor {
66
67
  UnionNode: this.visitUnion.bind(this),
67
68
  CreateViewNode: this.visitCreateView.bind(this),
68
69
  DropViewNode: this.visitDropView.bind(this),
69
- GeneratedAlwaysAsNode: this.visitGeneratedAlwaysAs.bind(this),
70
+ GeneratedNode: this.visitGenerated.bind(this),
70
71
  DefaultValueNode: this.visitDefaultValue.bind(this),
71
72
  OnNode: this.visitOn.bind(this),
72
73
  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
  }>;
@@ -6,10 +6,11 @@ export const WithNode = freeze({
6
6
  is(node) {
7
7
  return node.kind === 'WithNode';
8
8
  },
9
- create(expression) {
9
+ create(expression, params) {
10
10
  return freeze({
11
11
  kind: 'WithNode',
12
12
  expressions: freeze([expression]),
13
+ ...params,
13
14
  });
14
15
  },
15
16
  cloneWithExpression(withNode, expression) {
@@ -1,3 +1 @@
1
- {
2
- "type": "module"
3
- }
1
+ {"type":"module"}
@@ -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,6 +1,17 @@
1
- import { IdentifierNode } from '../operation-node/identifier-node.js';
2
1
  import { CommonTableExpressionNode } from '../operation-node/common-table-expression-node.js';
2
+ import { CommonTableExpressionNameNode } from '../operation-node/common-table-expression-name-node.js';
3
3
  export function parseCommonTableExpression(ctx, name, expression) {
4
4
  const builder = expression(ctx.createQueryCreator());
5
- return CommonTableExpressionNode.create(IdentifierNode.create(name), builder.toOperationNode());
5
+ return CommonTableExpressionNode.create(parseCommonTableExpressionName(name), builder.toOperationNode());
6
+ }
7
+ function parseCommonTableExpressionName(name) {
8
+ if (name.includes('(')) {
9
+ const parts = name.split(/[\(\)]/);
10
+ const table = parts[0];
11
+ const columns = parts[1].split(',').map((it) => it.trim());
12
+ return CommonTableExpressionNameNode.create(table, columns);
13
+ }
14
+ else {
15
+ return CommonTableExpressionNameNode.create(name);
16
+ }
6
17
  }
@@ -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;