kysely 0.11.4 → 0.12.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 (192) hide show
  1. package/README.md +1 -1
  2. package/dist/cjs/dynamic/dynamic-reference-builder.d.ts +1 -0
  3. package/dist/cjs/dynamic/dynamic-reference-builder.js +9 -1
  4. package/dist/cjs/dynamic/dynamic.d.ts +6 -7
  5. package/dist/cjs/dynamic/dynamic.js +6 -7
  6. package/dist/cjs/index.d.ts +13 -3
  7. package/dist/cjs/index.js +11 -1
  8. package/dist/cjs/kysely.d.ts +19 -11
  9. package/dist/cjs/kysely.js +32 -9
  10. package/dist/cjs/migration/migration.d.ts +2 -2
  11. package/dist/cjs/operation-node/create-table-node.d.ts +6 -2
  12. package/dist/cjs/operation-node/create-table-node.js +6 -6
  13. package/dist/cjs/operation-node/create-view-node.d.ts +1 -0
  14. package/dist/cjs/operation-node/insert-query-node.d.ts +4 -4
  15. package/dist/cjs/operation-node/operation-node-transformer.d.ts +2 -0
  16. package/dist/cjs/operation-node/operation-node-transformer.js +11 -1
  17. package/dist/cjs/operation-node/operation-node-visitor.d.ts +2 -0
  18. package/dist/cjs/operation-node/operation-node-visitor.js +1 -0
  19. package/dist/cjs/operation-node/operation-node.d.ts +1 -1
  20. package/dist/cjs/operation-node/query-node.d.ts +0 -2
  21. package/dist/cjs/operation-node/query-node.js +0 -10
  22. package/dist/cjs/operation-node/values-node.d.ts +15 -0
  23. package/dist/cjs/operation-node/values-node.js +18 -0
  24. package/dist/cjs/parser/complex-expression-parser.d.ts +9 -0
  25. package/dist/cjs/parser/complex-expression-parser.js +25 -0
  26. package/dist/cjs/parser/filter-parser.d.ts +13 -4
  27. package/dist/cjs/parser/filter-parser.js +21 -24
  28. package/dist/cjs/parser/insert-values-parser.d.ts +5 -9
  29. package/dist/cjs/parser/insert-values-parser.js +27 -41
  30. package/dist/cjs/parser/order-by-parser.d.ts +1 -1
  31. package/dist/cjs/parser/parse-context.d.ts +8 -8
  32. package/dist/cjs/parser/parse-context.js +10 -10
  33. package/dist/cjs/parser/reference-parser.d.ts +8 -7
  34. package/dist/cjs/parser/reference-parser.js +8 -17
  35. package/dist/cjs/parser/returning-parser.d.ts +1 -5
  36. package/dist/cjs/parser/select-parser.d.ts +12 -14
  37. package/dist/cjs/parser/select-parser.js +5 -9
  38. package/dist/cjs/parser/table-parser.d.ts +9 -11
  39. package/dist/cjs/parser/table-parser.js +2 -8
  40. package/dist/cjs/parser/union-parser.d.ts +2 -2
  41. package/dist/cjs/parser/union-parser.js +1 -6
  42. package/dist/cjs/parser/update-set-parser.d.ts +2 -8
  43. package/dist/cjs/parser/update-set-parser.js +6 -26
  44. package/dist/cjs/parser/value-parser.d.ts +9 -6
  45. package/dist/cjs/parser/value-parser.js +7 -30
  46. package/dist/cjs/parser/with-parser.d.ts +6 -3
  47. package/dist/cjs/plugin/immediate-value.ts/immediate-value-plugin.js +2 -2
  48. package/dist/cjs/query-builder/delete-query-builder.d.ts +102 -0
  49. package/dist/cjs/query-builder/delete-query-builder.js +185 -0
  50. package/dist/cjs/query-builder/expression-builder.d.ts +8 -6
  51. package/dist/cjs/query-builder/expression-builder.js +3 -3
  52. package/dist/cjs/query-builder/function-builder.d.ts +2 -1
  53. package/dist/cjs/query-builder/function-builder.js +2 -1
  54. package/dist/cjs/query-builder/having-interface.d.ts +49 -0
  55. package/dist/cjs/query-builder/having-interface.js +2 -0
  56. package/dist/cjs/query-builder/insert-query-builder.d.ts +439 -0
  57. package/dist/cjs/query-builder/insert-query-builder.js +256 -0
  58. package/dist/cjs/query-builder/insert-result.d.ts +3 -2
  59. package/dist/cjs/query-builder/insert-result.js +3 -2
  60. package/dist/cjs/query-builder/join-builder.d.ts +19 -20
  61. package/dist/cjs/query-builder/join-builder.js +12 -12
  62. package/dist/cjs/query-builder/join-interface.d.ts +133 -0
  63. package/dist/cjs/query-builder/join-interface.js +2 -0
  64. package/dist/cjs/query-builder/no-result-error.d.ts +9 -0
  65. package/dist/cjs/query-builder/no-result-error.js +14 -0
  66. package/dist/cjs/query-builder/returning-interface.d.ts +73 -0
  67. package/dist/cjs/query-builder/returning-interface.js +2 -0
  68. package/dist/cjs/query-builder/select-query-builder.d.ts +711 -0
  69. package/dist/cjs/query-builder/select-query-builder.js +571 -0
  70. package/dist/cjs/query-builder/update-query-builder.d.ts +190 -0
  71. package/dist/cjs/query-builder/update-query-builder.js +279 -0
  72. package/dist/cjs/query-builder/where-interface.d.ts +381 -0
  73. package/dist/cjs/query-builder/where-interface.js +2 -0
  74. package/dist/cjs/query-compiler/default-query-compiler.d.ts +2 -0
  75. package/dist/cjs/query-compiler/default-query-compiler.js +22 -5
  76. package/dist/cjs/query-creator.d.ts +42 -40
  77. package/dist/cjs/query-creator.js +33 -28
  78. package/dist/cjs/query-executor/query-executor.d.ts +1 -1
  79. package/dist/cjs/query-executor/query-executor.js +1 -1
  80. package/dist/cjs/raw-builder/raw-builder.d.ts +2 -0
  81. package/dist/cjs/raw-builder/raw-builder.js +6 -0
  82. package/dist/cjs/schema/alter-table-builder.d.ts +2 -2
  83. package/dist/cjs/schema/column-definition-builder.d.ts +27 -20
  84. package/dist/cjs/schema/create-index-builder.d.ts +2 -1
  85. package/dist/cjs/schema/create-index-builder.js +2 -1
  86. package/dist/cjs/schema/create-table-builder.d.ts +26 -9
  87. package/dist/cjs/schema/create-table-builder.js +42 -9
  88. package/dist/cjs/schema/create-view-builder.d.ts +17 -3
  89. package/dist/cjs/schema/create-view-builder.js +25 -16
  90. package/dist/cjs/schema/schema.d.ts +18 -11
  91. package/dist/cjs/schema/schema.js +18 -11
  92. package/dist/cjs/util/log.d.ts +3 -2
  93. package/dist/cjs/util/log.js +8 -15
  94. package/dist/cjs/util/type-utils.d.ts +7 -7
  95. package/dist/esm/dynamic/dynamic-reference-builder.d.ts +1 -0
  96. package/dist/esm/dynamic/dynamic-reference-builder.js +7 -0
  97. package/dist/esm/dynamic/dynamic.d.ts +6 -7
  98. package/dist/esm/dynamic/dynamic.js +6 -7
  99. package/dist/esm/index.d.ts +13 -3
  100. package/dist/esm/index.js +11 -1
  101. package/dist/esm/kysely.d.ts +19 -11
  102. package/dist/esm/kysely.js +32 -9
  103. package/dist/esm/migration/migration.d.ts +2 -2
  104. package/dist/esm/operation-node/create-table-node.d.ts +6 -2
  105. package/dist/esm/operation-node/create-table-node.js +6 -6
  106. package/dist/esm/operation-node/create-view-node.d.ts +1 -0
  107. package/dist/esm/operation-node/insert-query-node.d.ts +4 -4
  108. package/dist/esm/operation-node/operation-node-transformer.d.ts +2 -0
  109. package/dist/esm/operation-node/operation-node-transformer.js +11 -1
  110. package/dist/esm/operation-node/operation-node-visitor.d.ts +2 -0
  111. package/dist/esm/operation-node/operation-node-visitor.js +1 -0
  112. package/dist/esm/operation-node/operation-node.d.ts +1 -1
  113. package/dist/esm/operation-node/query-node.d.ts +0 -2
  114. package/dist/esm/operation-node/query-node.js +0 -10
  115. package/dist/esm/operation-node/values-node.d.ts +15 -0
  116. package/dist/esm/operation-node/values-node.js +15 -0
  117. package/dist/esm/parser/complex-expression-parser.d.ts +9 -0
  118. package/dist/esm/parser/complex-expression-parser.js +20 -0
  119. package/dist/esm/parser/filter-parser.d.ts +13 -4
  120. package/dist/esm/parser/filter-parser.js +21 -24
  121. package/dist/esm/parser/insert-values-parser.d.ts +5 -9
  122. package/dist/esm/parser/insert-values-parser.js +27 -40
  123. package/dist/esm/parser/order-by-parser.d.ts +1 -1
  124. package/dist/esm/parser/parse-context.d.ts +8 -8
  125. package/dist/esm/parser/parse-context.js +10 -10
  126. package/dist/esm/parser/reference-parser.d.ts +8 -7
  127. package/dist/esm/parser/reference-parser.js +9 -18
  128. package/dist/esm/parser/returning-parser.d.ts +1 -5
  129. package/dist/esm/parser/select-parser.d.ts +12 -14
  130. package/dist/esm/parser/select-parser.js +6 -10
  131. package/dist/esm/parser/table-parser.d.ts +9 -11
  132. package/dist/esm/parser/table-parser.js +3 -9
  133. package/dist/esm/parser/union-parser.d.ts +2 -2
  134. package/dist/esm/parser/union-parser.js +1 -6
  135. package/dist/esm/parser/update-set-parser.d.ts +2 -8
  136. package/dist/esm/parser/update-set-parser.js +5 -24
  137. package/dist/esm/parser/value-parser.d.ts +9 -6
  138. package/dist/esm/parser/value-parser.js +8 -31
  139. package/dist/esm/parser/with-parser.d.ts +6 -3
  140. package/dist/esm/plugin/immediate-value.ts/immediate-value-plugin.js +2 -2
  141. package/dist/esm/query-builder/delete-query-builder.d.ts +102 -0
  142. package/dist/esm/query-builder/delete-query-builder.js +181 -0
  143. package/dist/esm/query-builder/expression-builder.d.ts +8 -6
  144. package/dist/esm/query-builder/expression-builder.js +3 -3
  145. package/dist/esm/query-builder/function-builder.d.ts +2 -1
  146. package/dist/esm/query-builder/function-builder.js +2 -1
  147. package/dist/esm/query-builder/having-interface.d.ts +49 -0
  148. package/dist/esm/query-builder/having-interface.js +1 -0
  149. package/dist/esm/query-builder/insert-query-builder.d.ts +439 -0
  150. package/dist/esm/query-builder/insert-query-builder.js +252 -0
  151. package/dist/esm/query-builder/insert-result.d.ts +3 -2
  152. package/dist/esm/query-builder/insert-result.js +3 -2
  153. package/dist/esm/query-builder/join-builder.d.ts +19 -20
  154. package/dist/esm/query-builder/join-builder.js +12 -12
  155. package/dist/esm/query-builder/join-interface.d.ts +133 -0
  156. package/dist/esm/query-builder/join-interface.js +1 -0
  157. package/dist/esm/query-builder/no-result-error.d.ts +9 -0
  158. package/dist/esm/query-builder/no-result-error.js +10 -0
  159. package/dist/esm/query-builder/returning-interface.d.ts +73 -0
  160. package/dist/esm/query-builder/returning-interface.js +1 -0
  161. package/dist/esm/query-builder/select-query-builder.d.ts +711 -0
  162. package/dist/esm/query-builder/select-query-builder.js +566 -0
  163. package/dist/esm/query-builder/update-query-builder.d.ts +190 -0
  164. package/dist/esm/query-builder/update-query-builder.js +275 -0
  165. package/dist/esm/query-builder/where-interface.d.ts +381 -0
  166. package/dist/esm/query-builder/where-interface.js +1 -0
  167. package/dist/esm/query-compiler/default-query-compiler.d.ts +2 -0
  168. package/dist/esm/query-compiler/default-query-compiler.js +22 -5
  169. package/dist/esm/query-creator.d.ts +42 -40
  170. package/dist/esm/query-creator.js +33 -28
  171. package/dist/esm/query-executor/query-executor.d.ts +1 -1
  172. package/dist/esm/query-executor/query-executor.js +1 -1
  173. package/dist/esm/raw-builder/raw-builder.d.ts +2 -0
  174. package/dist/esm/raw-builder/raw-builder.js +6 -0
  175. package/dist/esm/schema/alter-table-builder.d.ts +2 -2
  176. package/dist/esm/schema/column-definition-builder.d.ts +27 -20
  177. package/dist/esm/schema/create-index-builder.d.ts +2 -1
  178. package/dist/esm/schema/create-index-builder.js +2 -1
  179. package/dist/esm/schema/create-table-builder.d.ts +26 -9
  180. package/dist/esm/schema/create-table-builder.js +43 -10
  181. package/dist/esm/schema/create-view-builder.d.ts +17 -3
  182. package/dist/esm/schema/create-view-builder.js +25 -16
  183. package/dist/esm/schema/schema.d.ts +18 -11
  184. package/dist/esm/schema/schema.js +18 -11
  185. package/dist/esm/util/log.d.ts +3 -2
  186. package/dist/esm/util/log.js +7 -14
  187. package/dist/esm/util/type-utils.d.ts +7 -7
  188. package/package.json +3 -3
  189. package/dist/cjs/query-builder/query-builder.d.ts +0 -1728
  190. package/dist/cjs/query-builder/query-builder.js +0 -1067
  191. package/dist/esm/query-builder/query-builder.d.ts +0 -1728
  192. package/dist/esm/query-builder/query-builder.js +0 -1061
@@ -20,7 +20,8 @@ export declare class DynamicModule {
20
20
  * `ref` to other methods as well. If the types allow you to pass a `ref`
21
21
  * value to some place, it should work.
22
22
  *
23
- * @example
23
+ * ### Examples
24
+ *
24
25
  * Filter by a column not know at compile time:
25
26
  *
26
27
  * ```ts
@@ -38,7 +39,6 @@ export declare class DynamicModule {
38
39
  * someQuery('person.last_name', 'Aniston')
39
40
  * ```
40
41
  *
41
- * @example
42
42
  * Order by a column not know at compile time:
43
43
  *
44
44
  * ```ts
@@ -55,7 +55,6 @@ export declare class DynamicModule {
55
55
  * someQuery('fn')
56
56
  * ```
57
57
  *
58
- * @example
59
58
  * In this example we add selections dynamically:
60
59
  *
61
60
  * ```ts
@@ -66,7 +65,7 @@ export declare class DynamicModule {
66
65
  *
67
66
  * // A type that lists all possible values `columnFromUserInput` can have.
68
67
  * // You can use `keyof Person` if any column of an interface is allowed.
69
- * type PossibleColumns = 'last_name' | 'first_name' | 'birth_date'
68
+ * type PossibleColumns = 'last_name' | 'first_name' | 'birth_date'
70
69
  *
71
70
  * const [person] = await db.selectFrom('person')
72
71
  * .select([
@@ -78,9 +77,9 @@ export declare class DynamicModule {
78
77
  * // The resulting type contains all `PossibleColumns` as optional fields
79
78
  * // because we cannot know which field was actually selected before
80
79
  * // running the code.
81
- * const lastName: string | undefined = person.last_name
82
- * const firstName: string | undefined = person.first_name
83
- * const birthDate: string | undefined = person.birth_date
80
+ * const lastName: string | undefined = person.last_name
81
+ * const firstName: string | undefined = person.first_name
82
+ * const birthDate: string | undefined = person.birth_date
84
83
  *
85
84
  * // The result type also contains the compile time selection `id`.
86
85
  * person.id
@@ -20,7 +20,8 @@ export class DynamicModule {
20
20
  * `ref` to other methods as well. If the types allow you to pass a `ref`
21
21
  * value to some place, it should work.
22
22
  *
23
- * @example
23
+ * ### Examples
24
+ *
24
25
  * Filter by a column not know at compile time:
25
26
  *
26
27
  * ```ts
@@ -38,7 +39,6 @@ export class DynamicModule {
38
39
  * someQuery('person.last_name', 'Aniston')
39
40
  * ```
40
41
  *
41
- * @example
42
42
  * Order by a column not know at compile time:
43
43
  *
44
44
  * ```ts
@@ -55,7 +55,6 @@ export class DynamicModule {
55
55
  * someQuery('fn')
56
56
  * ```
57
57
  *
58
- * @example
59
58
  * In this example we add selections dynamically:
60
59
  *
61
60
  * ```ts
@@ -66,7 +65,7 @@ export class DynamicModule {
66
65
  *
67
66
  * // A type that lists all possible values `columnFromUserInput` can have.
68
67
  * // You can use `keyof Person` if any column of an interface is allowed.
69
- * type PossibleColumns = 'last_name' | 'first_name' | 'birth_date'
68
+ * type PossibleColumns = 'last_name' | 'first_name' | 'birth_date'
70
69
  *
71
70
  * const [person] = await db.selectFrom('person')
72
71
  * .select([
@@ -78,9 +77,9 @@ export class DynamicModule {
78
77
  * // The resulting type contains all `PossibleColumns` as optional fields
79
78
  * // because we cannot know which field was actually selected before
80
79
  * // running the code.
81
- * const lastName: string | undefined = person.last_name
82
- * const firstName: string | undefined = person.first_name
83
- * const birthDate: string | undefined = person.birth_date
80
+ * const lastName: string | undefined = person.last_name
81
+ * const firstName: string | undefined = person.first_name
82
+ * const birthDate: string | undefined = person.birth_date
84
83
  *
85
84
  * // The result type also contains the compile time selection `id`.
86
85
  * person.id
@@ -1,8 +1,17 @@
1
1
  export * from './kysely.js';
2
2
  export * from './query-creator.js';
3
- export * from './query-builder/query-builder.js';
3
+ export * from './query-builder/where-interface.js';
4
+ export * from './query-builder/join-interface.js';
5
+ export * from './query-builder/returning-interface.js';
6
+ export * from './query-builder/having-interface.js';
7
+ export * from './query-builder/select-query-builder.js';
8
+ export * from './query-builder/insert-query-builder.js';
9
+ export * from './query-builder/update-query-builder.js';
10
+ export * from './query-builder/delete-query-builder.js';
11
+ export * from './query-builder/no-result-error.js';
4
12
  export * from './query-builder/join-builder.js';
5
13
  export * from './query-builder/expression-builder.js';
14
+ export * from './query-builder/function-builder.js';
6
15
  export * from './query-builder/insert-result.js';
7
16
  export * from './query-builder/delete-result.js';
8
17
  export * from './query-builder/update-result.js';
@@ -123,16 +132,17 @@ export * from './operation-node/unique-constraint-node.js';
123
132
  export * from './operation-node/update-query-node.js';
124
133
  export * from './operation-node/value-list-node.js';
125
134
  export * from './operation-node/value-node.js';
135
+ export * from './operation-node/values-node.js';
126
136
  export * from './operation-node/where-node.js';
127
137
  export * from './operation-node/with-node.js';
128
138
  export * from './introspection/database-introspector.js';
129
139
  export * from './util/compilable.js';
130
140
  export * from './util/log.js';
131
- export { AnyColumn, UnknownRow, AnyQueryBuilder } from './util/type-utils.js';
141
+ export { AnyColumn, UnknownRow, AnySelectQueryBuilder, } from './util/type-utils.js';
132
142
  export { SelectExpression, SelectExpressionOrList, } from './parser/select-parser.js';
133
143
  export { ReferenceExpression, ReferenceExpressionOrList, } from './parser/reference-parser.js';
134
144
  export { ValueExpression, ValueExpressionOrList, } from './parser/value-parser.js';
135
- export { ExistsExpression, FilterOperator } from './parser/filter-parser.js';
145
+ export { FilterValueExpression, FilterValueExpressionOrList, ExistsExpression, FilterOperator, } from './parser/filter-parser.js';
136
146
  export { TableExpression, TableExpressionOrList, } from './parser/table-parser.js';
137
147
  export { JoinReferenceExpression, JoinCallbackExpression, } from './parser/join-parser.js';
138
148
  export { InsertObject } from './parser/insert-values-parser.js';
package/dist/esm/index.js CHANGED
@@ -1,8 +1,17 @@
1
1
  export * from './kysely.js';
2
2
  export * from './query-creator.js';
3
- export * from './query-builder/query-builder.js';
3
+ export * from './query-builder/where-interface.js';
4
+ export * from './query-builder/join-interface.js';
5
+ export * from './query-builder/returning-interface.js';
6
+ export * from './query-builder/having-interface.js';
7
+ export * from './query-builder/select-query-builder.js';
8
+ export * from './query-builder/insert-query-builder.js';
9
+ export * from './query-builder/update-query-builder.js';
10
+ export * from './query-builder/delete-query-builder.js';
11
+ export * from './query-builder/no-result-error.js';
4
12
  export * from './query-builder/join-builder.js';
5
13
  export * from './query-builder/expression-builder.js';
14
+ export * from './query-builder/function-builder.js';
6
15
  export * from './query-builder/insert-result.js';
7
16
  export * from './query-builder/delete-result.js';
8
17
  export * from './query-builder/update-result.js';
@@ -123,6 +132,7 @@ export * from './operation-node/unique-constraint-node.js';
123
132
  export * from './operation-node/update-query-node.js';
124
133
  export * from './operation-node/value-list-node.js';
125
134
  export * from './operation-node/value-node.js';
135
+ export * from './operation-node/values-node.js';
126
136
  export * from './operation-node/where-node.js';
127
137
  export * from './operation-node/with-node.js';
128
138
  export * from './introspection/database-introspector.js';
@@ -17,7 +17,8 @@ import { LogConfig } from './util/log.js';
17
17
  * You should create one instance of `Kysely` per database using the {@link Kysely}
18
18
  * constructor. Each `Kysely` instance maintains it's own connection pool.
19
19
  *
20
- * @example
20
+ * ### Examples
21
+ *
21
22
  * This example assumes your database has tables `person` and `pet`:
22
23
  *
23
24
  * ```ts
@@ -31,7 +32,7 @@ import { LogConfig } from './util/log.js';
31
32
  * id: number
32
33
  * owner_id: number
33
34
  * name: string
34
- * species 'cat' | 'dog'
35
+ * species 'cat' | 'dog'
35
36
  * }
36
37
  *
37
38
  * interface Database {
@@ -78,10 +79,11 @@ export declare class Kysely<DB> extends QueryCreator<DB> {
78
79
  * A value to be used in place of columns that are generated in the database
79
80
  * when inserting rows.
80
81
  *
81
- * @example
82
+ * ### Examples
83
+ *
82
84
  * In this example the `Person` table has non-null properties `id` and `created_at`
83
85
  * which are both automatically genereted by the database. Since their types are
84
- * `number` and `string` respectively instead of `number | null` and `string | null`
86
+ * `number` and `string` respectively instead of `number | null` and `string | null`
85
87
  * the `values` method requires you to give a value for them. the `generated`
86
88
  * placeholder can be used in these cases.
87
89
  *
@@ -136,12 +138,13 @@ export declare class Kysely<DB> extends QueryCreator<DB> {
136
138
  * transaction. If the function throws, the transaction is rolled back. Otherwise
137
139
  * the transaction is committed.
138
140
  *
139
- * The callback function passed to the {@link TransactionBuilder.execute | execute}
141
+ * The callback function passed to the {@link TransactionBuilder.execute | execute}
140
142
  * method gets the transaction object as its only argument. The transaction is
141
143
  * of type {@link Transaction} which inherits {@link Kysely}. Any query
142
144
  * started through the transaction object is executed inside the transaction.
143
145
  *
144
- * @example
146
+ * ### Examples
147
+ *
145
148
  * ```ts
146
149
  * const catto = await db.transaction().execute(async (trx) => {
147
150
  * const jennifer = await trx.insertInto('person')
@@ -167,8 +170,7 @@ export declare class Kysely<DB> extends QueryCreator<DB> {
167
170
  * })
168
171
  * ```
169
172
  *
170
- * @example
171
- * Setting the isolation level.
173
+ * Setting the isolation level:
172
174
  *
173
175
  * ```ts
174
176
  * await db
@@ -183,7 +185,8 @@ export declare class Kysely<DB> extends QueryCreator<DB> {
183
185
  /**
184
186
  * Provides a kysely instance bound to a single database connection.
185
187
  *
186
- * @example
188
+ * ### Examples
189
+ *
187
190
  * ```ts
188
191
  * await db
189
192
  * .connection()
@@ -218,10 +221,15 @@ export declare class Kysely<DB> extends QueryCreator<DB> {
218
221
  get isTransaction(): boolean;
219
222
  }
220
223
  export declare class Transaction<DB> extends Kysely<DB> {
224
+ #private;
225
+ constructor(props: KyselyProps);
221
226
  get isTransaction(): true;
222
227
  get migration(): MigrationModule;
223
228
  transaction(): TransactionBuilder<DB>;
229
+ connection(): ConnectionBuilder<DB>;
224
230
  destroy(): Promise<void>;
231
+ withPlugin(plugin: KyselyPlugin): Transaction<DB>;
232
+ withoutPlugins(): Transaction<DB>;
225
233
  }
226
234
  export interface KyselyProps {
227
235
  readonly config: KyselyConfig;
@@ -240,7 +248,8 @@ export interface KyselyConfig {
240
248
  * Currently there's only two levels: `query` and `error`.
241
249
  * This will be expanded based on user feedback later.
242
250
  *
243
- * @example
251
+ * ### Examples
252
+ *
244
253
  * ```ts
245
254
  * const db = new Kysely<Database>({
246
255
  * dialect: new PostgresDialect(postgresConfig),
@@ -248,7 +257,6 @@ export interface KyselyConfig {
248
257
  * })
249
258
  * ```
250
259
  *
251
- * @example
252
260
  * ```ts
253
261
  * const db = new Kysely<Database>({
254
262
  * dialect: new PostgresDialect(postgresConfig),
@@ -19,7 +19,8 @@ import { Log } from './util/log.js';
19
19
  * You should create one instance of `Kysely` per database using the {@link Kysely}
20
20
  * constructor. Each `Kysely` instance maintains it's own connection pool.
21
21
  *
22
- * @example
22
+ * ### Examples
23
+ *
23
24
  * This example assumes your database has tables `person` and `pet`:
24
25
  *
25
26
  * ```ts
@@ -33,7 +34,7 @@ import { Log } from './util/log.js';
33
34
  * id: number
34
35
  * owner_id: number
35
36
  * name: string
36
- * species 'cat' | 'dog'
37
+ * species 'cat' | 'dog'
37
38
  * }
38
39
  *
39
40
  * interface Database {
@@ -111,10 +112,11 @@ export class Kysely extends QueryCreator {
111
112
  * A value to be used in place of columns that are generated in the database
112
113
  * when inserting rows.
113
114
  *
114
- * @example
115
+ * ### Examples
116
+ *
115
117
  * In this example the `Person` table has non-null properties `id` and `created_at`
116
118
  * which are both automatically genereted by the database. Since their types are
117
- * `number` and `string` respectively instead of `number | null` and `string | null`
119
+ * `number` and `string` respectively instead of `number | null` and `string | null`
118
120
  * the `values` method requires you to give a value for them. the `generated`
119
121
  * placeholder can be used in these cases.
120
122
  *
@@ -173,12 +175,13 @@ export class Kysely extends QueryCreator {
173
175
  * transaction. If the function throws, the transaction is rolled back. Otherwise
174
176
  * the transaction is committed.
175
177
  *
176
- * The callback function passed to the {@link TransactionBuilder.execute | execute}
178
+ * The callback function passed to the {@link TransactionBuilder.execute | execute}
177
179
  * method gets the transaction object as its only argument. The transaction is
178
180
  * of type {@link Transaction} which inherits {@link Kysely}. Any query
179
181
  * started through the transaction object is executed inside the transaction.
180
182
  *
181
- * @example
183
+ * ### Examples
184
+ *
182
185
  * ```ts
183
186
  * const catto = await db.transaction().execute(async (trx) => {
184
187
  * const jennifer = await trx.insertInto('person')
@@ -204,8 +207,7 @@ export class Kysely extends QueryCreator {
204
207
  * })
205
208
  * ```
206
209
  *
207
- * @example
208
- * Setting the isolation level.
210
+ * Setting the isolation level:
209
211
  *
210
212
  * ```ts
211
213
  * await db
@@ -222,7 +224,8 @@ export class Kysely extends QueryCreator {
222
224
  /**
223
225
  * Provides a kysely instance bound to a single database connection.
224
226
  *
225
- * @example
227
+ * ### Examples
228
+ *
226
229
  * ```ts
227
230
  * await db
228
231
  * .connection()
@@ -273,6 +276,11 @@ export class Kysely extends QueryCreator {
273
276
  }
274
277
  }
275
278
  export class Transaction extends Kysely {
279
+ #props;
280
+ constructor(props) {
281
+ super(props);
282
+ this.#props = props;
283
+ }
276
284
  // The return type is `true` instead of `boolean` to make Kysely<DB>
277
285
  // unassignable to Transaction<DB> while allowing assignment the
278
286
  // other way around.
@@ -285,9 +293,24 @@ export class Transaction extends Kysely {
285
293
  transaction() {
286
294
  throw new Error('calling the transaction method for a Transaction is not supported');
287
295
  }
296
+ connection() {
297
+ throw new Error('calling the connection method for a Transaction is not supported');
298
+ }
288
299
  async destroy() {
289
300
  throw new Error('calling the destroy method for a Transaction is not supported');
290
301
  }
302
+ withPlugin(plugin) {
303
+ return new Transaction({
304
+ ...this.#props,
305
+ executor: this.#props.executor.withPlugin(plugin),
306
+ });
307
+ }
308
+ withoutPlugins() {
309
+ return new Transaction({
310
+ ...this.#props,
311
+ executor: this.#props.executor.withoutPlugins(),
312
+ });
313
+ }
291
314
  }
292
315
  export function isKyselyProps(obj) {
293
316
  return (isObject(obj) &&
@@ -18,7 +18,8 @@ export declare class MigrationModule {
18
18
  * list of executed migrations doesn't match the list of possible migrations, and error
19
19
  * is thrown.
20
20
  *
21
- * @example
21
+ * ### Examples
22
+ *
22
23
  * ```ts
23
24
  * await db.migration.migrateToLatest(
24
25
  * path.join(__dirname, 'migrations')
@@ -30,7 +31,6 @@ export declare class MigrationModule {
30
31
  * the migrations is determined based on the alphabetical order of the keys in the record.
31
32
  * This can be useful if you are using a bundler like webpack or esbuild.
32
33
  *
33
- * @example
34
34
  * ```ts
35
35
  * await db.migration.migrateToLatest({
36
36
  * migration1: {
@@ -2,12 +2,16 @@ import { OperationNode } from './operation-node.js';
2
2
  import { TableNode } from './table-node.js';
3
3
  import { ConstraintNode } from './constraint-node.js';
4
4
  import { ColumnDefinitionNode } from './column-definition-node.js';
5
+ export declare type OnCommitAction = 'preserve rows' | 'delete rows' | 'drop';
6
+ export declare type CreateTableNodeParams = Omit<CreateTableNode, 'kind' | 'table' | 'columns' | 'constraints'>;
5
7
  export interface CreateTableNode extends OperationNode {
6
8
  readonly kind: 'CreateTableNode';
7
9
  readonly table: TableNode;
8
10
  readonly columns: ReadonlyArray<ColumnDefinitionNode>;
9
- readonly ifNotExists?: boolean;
10
11
  readonly constraints?: ReadonlyArray<ConstraintNode>;
12
+ readonly temporary?: boolean;
13
+ readonly ifNotExists?: boolean;
14
+ readonly onCommit?: OnCommitAction;
11
15
  }
12
16
  /**
13
17
  * @internal
@@ -16,6 +20,6 @@ export declare const CreateTableNode: Readonly<{
16
20
  is(node: OperationNode): node is CreateTableNode;
17
21
  create(table: TableNode): CreateTableNode;
18
22
  cloneWithColumn(createTable: CreateTableNode, column: ColumnDefinitionNode): CreateTableNode;
19
- cloneWithIfNotExists(createTable: CreateTableNode, ifNotExists: boolean): CreateTableNode;
20
23
  cloneWithConstraint(createTable: CreateTableNode, constraint: ConstraintNode): CreateTableNode;
24
+ cloneWith(createTable: CreateTableNode, params: CreateTableNodeParams): CreateTableNode;
21
25
  }>;
@@ -19,12 +19,6 @@ export const CreateTableNode = freeze({
19
19
  columns: freeze([...createTable.columns, column]),
20
20
  });
21
21
  },
22
- cloneWithIfNotExists(createTable, ifNotExists) {
23
- return freeze({
24
- ...createTable,
25
- ifNotExists,
26
- });
27
- },
28
22
  cloneWithConstraint(createTable, constraint) {
29
23
  return freeze({
30
24
  ...createTable,
@@ -33,4 +27,10 @@ export const CreateTableNode = freeze({
33
27
  : freeze([constraint]),
34
28
  });
35
29
  },
30
+ cloneWith(createTable, params) {
31
+ return freeze({
32
+ ...createTable,
33
+ ...params,
34
+ });
35
+ },
36
36
  });
@@ -7,6 +7,7 @@ export declare type CreateViewNodeParams = Omit<Partial<CreateViewNode>, 'kind'
7
7
  export interface CreateViewNode extends OperationNode {
8
8
  readonly kind: 'CreateViewNode';
9
9
  readonly name: IdentifierNode;
10
+ readonly temporary?: boolean;
10
11
  readonly materialized?: boolean;
11
12
  readonly orReplace?: boolean;
12
13
  readonly ifNotExists?: boolean;
@@ -2,18 +2,18 @@ import { ColumnNode } from './column-node.js';
2
2
  import { OnConflictNode } from './on-conflict-node.js';
3
3
  import { OnDuplicateKeyNode } from './on-duplicate-key-node.js';
4
4
  import { OperationNode } from './operation-node.js';
5
- import { PrimitiveValueListNode } from './primitive-value-list-node.js';
5
+ import { RawNode } from './raw-node.js';
6
6
  import { ReturningNode } from './returning-node.js';
7
+ import { SelectQueryNode } from './select-query-node.js';
7
8
  import { TableNode } from './table-node.js';
8
- import { ValueListNode } from './value-list-node.js';
9
+ import { ValuesNode } from './values-node.js';
9
10
  import { WithNode } from './with-node.js';
10
- export declare type InsertValuesNode = ValueListNode | PrimitiveValueListNode;
11
11
  export declare type InsertQueryNodeProps = Omit<InsertQueryNode, 'kind' | 'into'>;
12
12
  export interface InsertQueryNode extends OperationNode {
13
13
  readonly kind: 'InsertQueryNode';
14
14
  readonly into: TableNode;
15
15
  readonly columns?: ReadonlyArray<ColumnNode>;
16
- readonly values?: ReadonlyArray<InsertValuesNode>;
16
+ readonly values?: ValuesNode | SelectQueryNode | RawNode;
17
17
  readonly returning?: ReturningNode;
18
18
  readonly onConflict?: OnConflictNode;
19
19
  readonly onDuplicateKey?: OnDuplicateKeyNode;
@@ -63,6 +63,7 @@ import { DropViewNode } from './drop-view-node.js';
63
63
  import { GeneratedAlwaysAsNode } from './generated-always-as-node.js';
64
64
  import { DefaultValueNode } from './default-value-node.js';
65
65
  import { OnNode } from './on-node.js';
66
+ import { ValuesNode } from './values-node.js';
66
67
  /**
67
68
  * Transforms an operation node tree into another one.
68
69
  *
@@ -113,6 +114,7 @@ export declare class OperationNodeTransformer {
113
114
  protected transformRaw(node: RawNode): RawNode;
114
115
  protected transformWhere(node: WhereNode): WhereNode;
115
116
  protected transformInsertQuery(node: InsertQueryNode): InsertQueryNode;
117
+ protected transformValues(node: ValuesNode): ValuesNode;
116
118
  protected transformDeleteQuery(node: DeleteQueryNode): DeleteQueryNode;
117
119
  protected transformReturning(node: ReturningNode): ReturningNode;
118
120
  protected transformCreateTable(node: CreateTableNode): CreateTableNode;
@@ -95,6 +95,7 @@ export class OperationNodeTransformer {
95
95
  GeneratedAlwaysAsNode: this.transformGeneratedAlwaysAs.bind(this),
96
96
  DefaultValueNode: this.transformDefaultValue.bind(this),
97
97
  OnNode: this.transformOn.bind(this),
98
+ ValuesNode: this.transformValues.bind(this),
98
99
  });
99
100
  transformNode = (node) => {
100
101
  if (!node) {
@@ -229,7 +230,7 @@ export class OperationNodeTransformer {
229
230
  kind: 'InsertQueryNode',
230
231
  into: this.transformNode(node.into),
231
232
  columns: this.transformNodeList(node.columns),
232
- values: this.transformNodeList(node.values),
233
+ values: this.transformNode(node.values),
233
234
  returning: this.transformNode(node.returning),
234
235
  onConflict: this.transformNode(node.onConflict),
235
236
  onDuplicateKey: this.transformNode(node.onDuplicateKey),
@@ -237,6 +238,12 @@ export class OperationNodeTransformer {
237
238
  ignore: node.ignore,
238
239
  };
239
240
  }
241
+ transformValues(node) {
242
+ return {
243
+ kind: 'ValuesNode',
244
+ values: this.transformNodeList(node.values),
245
+ };
246
+ }
240
247
  transformDeleteQuery(node) {
241
248
  return {
242
249
  kind: 'DeleteQueryNode',
@@ -259,7 +266,9 @@ export class OperationNodeTransformer {
259
266
  table: this.transformNode(node.table),
260
267
  columns: this.transformNodeList(node.columns),
261
268
  constraints: this.transformNodeList(node.constraints),
269
+ temporary: node.temporary,
262
270
  ifNotExists: node.ifNotExists,
271
+ onCommit: node.onCommit,
263
272
  };
264
273
  }
265
274
  transformColumnDefinition(node) {
@@ -525,6 +534,7 @@ export class OperationNodeTransformer {
525
534
  return {
526
535
  kind: 'CreateViewNode',
527
536
  name: this.transformNode(node.name),
537
+ temporary: node.temporary,
528
538
  orReplace: node.orReplace,
529
539
  ifNotExists: node.ifNotExists,
530
540
  materialized: node.materialized,
@@ -63,6 +63,7 @@ import { DropViewNode } from './drop-view-node.js';
63
63
  import { GeneratedAlwaysAsNode } from './generated-always-as-node.js';
64
64
  import { DefaultValueNode } from './default-value-node.js';
65
65
  import { OnNode } from './on-node.js';
66
+ import { ValuesNode } from './values-node.js';
66
67
  export declare abstract class OperationNodeVisitor {
67
68
  #private;
68
69
  protected readonly nodeStack: OperationNode[];
@@ -132,4 +133,5 @@ export declare abstract class OperationNodeVisitor {
132
133
  protected abstract visitGeneratedAlwaysAs(node: GeneratedAlwaysAsNode): void;
133
134
  protected abstract visitDefaultValue(node: DefaultValueNode): void;
134
135
  protected abstract visitOn(node: OnNode): void;
136
+ protected abstract visitValues(node: ValuesNode): void;
135
137
  }
@@ -69,6 +69,7 @@ export class OperationNodeVisitor {
69
69
  GeneratedAlwaysAsNode: this.visitGeneratedAlwaysAs.bind(this),
70
70
  DefaultValueNode: this.visitDefaultValue.bind(this),
71
71
  OnNode: this.visitOn.bind(this),
72
+ ValuesNode: this.visitValues.bind(this),
72
73
  });
73
74
  visitNode = (node) => {
74
75
  this.nodeStack.push(node);
@@ -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';
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';
2
2
  export interface OperationNode {
3
3
  readonly kind: OperationNodeKind;
4
4
  }
@@ -14,8 +14,6 @@ export declare type FilterableQueryNode = SelectQueryNode | DeleteQueryNode | Up
14
14
  */
15
15
  export declare const QueryNode: Readonly<{
16
16
  is(node: OperationNode): node is QueryNode;
17
- isMutating(node: OperationNode): node is MutatingQueryNode;
18
- isFilterable(node: OperationNode): node is FilterableQueryNode;
19
17
  cloneWithWhere<T extends FilterableQueryNode>(node: T, filter: FilterExpressionNode): T;
20
18
  cloneWithOrWhere<T_1 extends FilterableQueryNode>(node: T_1, filter: FilterExpressionNode): T_1;
21
19
  cloneWithJoin<T_2 extends FilterableQueryNode>(node: T_2, join: JoinNode): T_2;
@@ -15,16 +15,6 @@ export const QueryNode = freeze({
15
15
  UpdateQueryNode.is(node) ||
16
16
  SelectQueryNode.is(node));
17
17
  },
18
- isMutating(node) {
19
- return (DeleteQueryNode.is(node) ||
20
- InsertQueryNode.is(node) ||
21
- UpdateQueryNode.is(node));
22
- },
23
- isFilterable(node) {
24
- return (SelectQueryNode.is(node) ||
25
- DeleteQueryNode.is(node) ||
26
- UpdateQueryNode.is(node));
27
- },
28
18
  cloneWithWhere(node, filter) {
29
19
  return freeze({
30
20
  ...node,
@@ -0,0 +1,15 @@
1
+ import { OperationNode } from './operation-node.js';
2
+ import { PrimitiveValueListNode } from './primitive-value-list-node.js';
3
+ import { ValueListNode } from './value-list-node.js';
4
+ export declare type ValuesItemNode = ValueListNode | PrimitiveValueListNode;
5
+ export interface ValuesNode extends OperationNode {
6
+ readonly kind: 'ValuesNode';
7
+ readonly values: ReadonlyArray<ValuesItemNode>;
8
+ }
9
+ /**
10
+ * @internal
11
+ */
12
+ export declare const ValuesNode: Readonly<{
13
+ is(node: OperationNode): node is ValuesNode;
14
+ create(values: ReadonlyArray<ValuesItemNode>): ValuesNode;
15
+ }>;
@@ -0,0 +1,15 @@
1
+ import { freeze } from '../util/object-utils.js';
2
+ /**
3
+ * @internal
4
+ */
5
+ export const ValuesNode = freeze({
6
+ is(node) {
7
+ return node.kind === 'ValuesNode';
8
+ },
9
+ create(values) {
10
+ return freeze({
11
+ kind: 'ValuesNode',
12
+ values: freeze(values),
13
+ });
14
+ },
15
+ });
@@ -0,0 +1,9 @@
1
+ import { AliasNode } from '../operation-node/alias-node.js';
2
+ import { RawNode } from '../operation-node/raw-node.js';
3
+ import { SelectQueryNode } from '../operation-node/select-query-node.js';
4
+ import { AliasedQueryBuilderFactory, AliasedRawBuilderFactory, AnyAliasedQueryBuilder, AnyAliasedRawBuilder, AnySelectQueryBuilder, AnyRawBuilder, SelectQueryBuilderFactory, RawBuilderFactory } from '../util/type-utils.js';
5
+ import { ParseContext } from './parse-context.js';
6
+ export declare type ComplexExpression<DB, TB extends keyof DB> = AnySelectQueryBuilder | SelectQueryBuilderFactory<DB, TB> | AnyRawBuilder | RawBuilderFactory<DB, TB>;
7
+ export declare type AliasedComplexExpression<DB, TB extends keyof DB> = AnyAliasedQueryBuilder | AliasedQueryBuilderFactory<DB, TB> | AnyAliasedRawBuilder | AliasedRawBuilderFactory<DB, TB>;
8
+ export declare function parseComplexExpression(ctx: ParseContext, exp: ComplexExpression<any, any>): SelectQueryNode | RawNode;
9
+ export declare function parseAliasedComplexExpression(ctx: ParseContext, exp: AliasedComplexExpression<any, any>): AliasNode;