kysely 0.11.3 → 0.12.2

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 (250) hide show
  1. package/README.md +1 -1
  2. package/dist/cjs/dialect/dialect-adapter-base.d.ts +36 -0
  3. package/dist/cjs/dialect/mysql/mysql-adapter.d.ts +36 -0
  4. package/dist/cjs/dialect/mysql/mysql-dialect.d.ts +16 -0
  5. package/dist/cjs/dialect/mysql/mysql-driver.d.ts +29 -0
  6. package/dist/cjs/dialect/mysql/mysql-introspector.d.ts +3 -0
  7. package/dist/cjs/dialect/postgres/postgres-adapter.d.ts +36 -0
  8. package/dist/cjs/dialect/postgres/postgres-dialect.d.ts +16 -0
  9. package/dist/cjs/dialect/postgres/postgres-driver.d.ts +29 -0
  10. package/dist/cjs/dialect/postgres/postgres-introspector.d.ts +3 -0
  11. package/dist/cjs/dialect/sqlite/sqlite-adapter.d.ts +36 -0
  12. package/dist/cjs/dialect/sqlite/sqlite-adapter.js +6 -2
  13. package/dist/cjs/dialect/sqlite/sqlite-dialect.d.ts +16 -0
  14. package/dist/cjs/dialect/sqlite/sqlite-driver.d.ts +29 -0
  15. package/dist/cjs/dialect/sqlite/sqlite-introspector.d.ts +3 -0
  16. package/dist/cjs/driver/default-connection-provider.d.ts +4 -0
  17. package/dist/cjs/driver/runtime-driver.d.ts +29 -0
  18. package/dist/cjs/driver/single-connection-provider.d.ts +4 -0
  19. package/dist/cjs/dynamic/dynamic-reference-builder.d.ts +1 -0
  20. package/dist/cjs/dynamic/dynamic-reference-builder.js +9 -1
  21. package/dist/cjs/dynamic/dynamic.d.ts +6 -7
  22. package/dist/cjs/dynamic/dynamic.js +6 -7
  23. package/dist/cjs/index.d.ts +14 -3
  24. package/dist/cjs/index.js +12 -1
  25. package/dist/cjs/kysely.d.ts +170 -11
  26. package/dist/cjs/kysely.js +69 -9
  27. package/dist/cjs/migration/migration.d.ts +2 -2
  28. package/dist/cjs/operation-node/common-table-expression-name-node.d.ts +15 -0
  29. package/dist/cjs/operation-node/common-table-expression-name-node.js +23 -0
  30. package/dist/cjs/operation-node/common-table-expression-node.d.ts +3 -3
  31. package/dist/cjs/operation-node/create-table-node.d.ts +6 -2
  32. package/dist/cjs/operation-node/create-table-node.js +6 -6
  33. package/dist/cjs/operation-node/create-view-node.d.ts +1 -0
  34. package/dist/cjs/operation-node/insert-query-node.d.ts +4 -4
  35. package/dist/cjs/operation-node/operation-node-transformer.d.ts +4 -0
  36. package/dist/cjs/operation-node/operation-node-transformer.js +20 -1
  37. package/dist/cjs/operation-node/operation-node-visitor.d.ts +4 -0
  38. package/dist/cjs/operation-node/operation-node-visitor.js +2 -0
  39. package/dist/cjs/operation-node/operation-node.d.ts +1 -1
  40. package/dist/cjs/operation-node/query-node.d.ts +0 -2
  41. package/dist/cjs/operation-node/query-node.js +0 -10
  42. package/dist/cjs/operation-node/values-node.d.ts +15 -0
  43. package/dist/cjs/operation-node/values-node.js +18 -0
  44. package/dist/cjs/operation-node/with-node.d.ts +3 -1
  45. package/dist/cjs/operation-node/with-node.js +2 -1
  46. package/dist/cjs/package.json +1 -3
  47. package/dist/cjs/parser/complex-expression-parser.d.ts +9 -0
  48. package/dist/cjs/parser/complex-expression-parser.js +25 -0
  49. package/dist/cjs/parser/filter-parser.d.ts +13 -4
  50. package/dist/cjs/parser/filter-parser.js +21 -24
  51. package/dist/cjs/parser/insert-values-parser.d.ts +7 -10
  52. package/dist/cjs/parser/insert-values-parser.js +31 -39
  53. package/dist/cjs/parser/order-by-parser.d.ts +1 -1
  54. package/dist/cjs/parser/parse-context.d.ts +22 -8
  55. package/dist/cjs/parser/parse-context.js +10 -10
  56. package/dist/cjs/parser/reference-parser.d.ts +8 -7
  57. package/dist/cjs/parser/reference-parser.js +8 -17
  58. package/dist/cjs/parser/returning-parser.d.ts +1 -5
  59. package/dist/cjs/parser/select-parser.d.ts +12 -14
  60. package/dist/cjs/parser/select-parser.js +5 -9
  61. package/dist/cjs/parser/table-parser.d.ts +9 -11
  62. package/dist/cjs/parser/table-parser.js +2 -8
  63. package/dist/cjs/parser/union-parser.d.ts +2 -2
  64. package/dist/cjs/parser/union-parser.js +1 -6
  65. package/dist/cjs/parser/update-set-parser.d.ts +2 -8
  66. package/dist/cjs/parser/update-set-parser.js +6 -26
  67. package/dist/cjs/parser/value-parser.d.ts +9 -6
  68. package/dist/cjs/parser/value-parser.js +7 -30
  69. package/dist/cjs/parser/with-parser.d.ts +36 -6
  70. package/dist/cjs/parser/with-parser.js +13 -2
  71. package/dist/cjs/plugin/camel-case/camel-case-plugin.d.ts +34 -0
  72. package/dist/cjs/plugin/immediate-value.ts/immediate-value-plugin.d.ts +34 -0
  73. package/dist/cjs/plugin/immediate-value.ts/immediate-value-plugin.js +2 -2
  74. package/dist/cjs/plugin/with-schema/with-schema-plugin.d.ts +34 -0
  75. package/dist/cjs/plugin/with-schema/with-schema-transformer.js +8 -0
  76. package/dist/cjs/query-builder/delete-query-builder.d.ts +647 -0
  77. package/dist/cjs/query-builder/delete-query-builder.js +185 -0
  78. package/dist/cjs/query-builder/expression-builder.d.ts +8 -6
  79. package/dist/cjs/query-builder/expression-builder.js +3 -3
  80. package/dist/cjs/query-builder/function-builder.d.ts +2 -1
  81. package/dist/cjs/query-builder/function-builder.js +2 -1
  82. package/dist/cjs/query-builder/having-interface.d.ts +49 -0
  83. package/dist/cjs/query-builder/having-interface.js +2 -0
  84. package/dist/cjs/query-builder/insert-query-builder.d.ts +504 -0
  85. package/dist/cjs/query-builder/insert-query-builder.js +256 -0
  86. package/dist/cjs/query-builder/insert-result.d.ts +3 -2
  87. package/dist/cjs/query-builder/insert-result.js +3 -2
  88. package/dist/cjs/query-builder/join-builder.d.ts +19 -20
  89. package/dist/cjs/query-builder/join-builder.js +12 -12
  90. package/dist/cjs/query-builder/join-interface.d.ts +130 -0
  91. package/dist/cjs/query-builder/join-interface.js +2 -0
  92. package/dist/cjs/query-builder/no-result-error.d.ts +9 -0
  93. package/dist/cjs/query-builder/no-result-error.js +14 -0
  94. package/dist/cjs/query-builder/returning-interface.d.ts +73 -0
  95. package/dist/cjs/query-builder/returning-interface.js +2 -0
  96. package/dist/cjs/query-builder/{query-builder.d.ts → select-query-builder.d.ts} +145 -634
  97. package/dist/cjs/query-builder/select-query-builder.js +571 -0
  98. package/dist/cjs/query-builder/update-query-builder.d.ts +735 -0
  99. package/dist/cjs/query-builder/update-query-builder.js +279 -0
  100. package/dist/cjs/query-builder/where-interface.d.ts +378 -0
  101. package/dist/cjs/query-builder/where-interface.js +2 -0
  102. package/dist/cjs/query-compiler/default-query-compiler.d.ts +4 -0
  103. package/dist/cjs/query-compiler/default-query-compiler.js +33 -5
  104. package/dist/cjs/query-creator.d.ts +69 -43
  105. package/dist/cjs/query-creator.js +66 -29
  106. package/dist/cjs/query-executor/default-query-executor.d.ts +19 -0
  107. package/dist/cjs/query-executor/noop-query-executor.d.ts +19 -0
  108. package/dist/cjs/query-executor/query-executor.d.ts +1 -1
  109. package/dist/cjs/query-executor/query-executor.js +1 -1
  110. package/dist/cjs/raw-builder/raw-builder.d.ts +2 -0
  111. package/dist/cjs/raw-builder/raw-builder.js +7 -1
  112. package/dist/cjs/schema/alter-table-builder.d.ts +218 -2
  113. package/dist/cjs/schema/column-definition-builder.d.ts +135 -20
  114. package/dist/cjs/schema/create-index-builder.d.ts +2 -1
  115. package/dist/cjs/schema/create-index-builder.js +2 -1
  116. package/dist/cjs/schema/create-table-builder.d.ts +26 -9
  117. package/dist/cjs/schema/create-table-builder.js +42 -9
  118. package/dist/cjs/schema/create-view-builder.d.ts +17 -3
  119. package/dist/cjs/schema/create-view-builder.js +25 -16
  120. package/dist/cjs/schema/schema.d.ts +18 -11
  121. package/dist/cjs/schema/schema.js +18 -11
  122. package/dist/cjs/util/log.d.ts +3 -2
  123. package/dist/cjs/util/log.js +8 -15
  124. package/dist/cjs/util/type-utils.d.ts +7 -7
  125. package/dist/esm/dialect/dialect-adapter-base.d.ts +36 -0
  126. package/dist/esm/dialect/mysql/mysql-adapter.d.ts +36 -0
  127. package/dist/esm/dialect/mysql/mysql-dialect.d.ts +16 -0
  128. package/dist/esm/dialect/mysql/mysql-driver.d.ts +29 -0
  129. package/dist/esm/dialect/mysql/mysql-introspector.d.ts +3 -0
  130. package/dist/esm/dialect/postgres/postgres-adapter.d.ts +36 -0
  131. package/dist/esm/dialect/postgres/postgres-dialect.d.ts +16 -0
  132. package/dist/esm/dialect/postgres/postgres-driver.d.ts +29 -0
  133. package/dist/esm/dialect/postgres/postgres-introspector.d.ts +3 -0
  134. package/dist/esm/dialect/sqlite/sqlite-adapter.d.ts +36 -0
  135. package/dist/esm/dialect/sqlite/sqlite-adapter.js +6 -2
  136. package/dist/esm/dialect/sqlite/sqlite-dialect.d.ts +16 -0
  137. package/dist/esm/dialect/sqlite/sqlite-driver.d.ts +29 -0
  138. package/dist/esm/dialect/sqlite/sqlite-introspector.d.ts +3 -0
  139. package/dist/esm/driver/default-connection-provider.d.ts +4 -0
  140. package/dist/esm/driver/runtime-driver.d.ts +29 -0
  141. package/dist/esm/driver/single-connection-provider.d.ts +4 -0
  142. package/dist/esm/dynamic/dynamic-reference-builder.d.ts +1 -0
  143. package/dist/esm/dynamic/dynamic-reference-builder.js +7 -0
  144. package/dist/esm/dynamic/dynamic.d.ts +6 -7
  145. package/dist/esm/dynamic/dynamic.js +6 -7
  146. package/dist/esm/index.d.ts +14 -3
  147. package/dist/esm/index.js +12 -1
  148. package/dist/esm/kysely.d.ts +170 -11
  149. package/dist/esm/kysely.js +69 -9
  150. package/dist/esm/migration/migration.d.ts +2 -2
  151. package/dist/esm/operation-node/common-table-expression-name-node.d.ts +15 -0
  152. package/dist/esm/operation-node/common-table-expression-name-node.js +20 -0
  153. package/dist/esm/operation-node/common-table-expression-node.d.ts +3 -3
  154. package/dist/esm/operation-node/create-table-node.d.ts +6 -2
  155. package/dist/esm/operation-node/create-table-node.js +6 -6
  156. package/dist/esm/operation-node/create-view-node.d.ts +1 -0
  157. package/dist/esm/operation-node/insert-query-node.d.ts +4 -4
  158. package/dist/esm/operation-node/operation-node-transformer.d.ts +4 -0
  159. package/dist/esm/operation-node/operation-node-transformer.js +20 -1
  160. package/dist/esm/operation-node/operation-node-visitor.d.ts +4 -0
  161. package/dist/esm/operation-node/operation-node-visitor.js +2 -0
  162. package/dist/esm/operation-node/operation-node.d.ts +1 -1
  163. package/dist/esm/operation-node/query-node.d.ts +0 -2
  164. package/dist/esm/operation-node/query-node.js +0 -10
  165. package/dist/esm/operation-node/values-node.d.ts +15 -0
  166. package/dist/esm/operation-node/values-node.js +15 -0
  167. package/dist/esm/operation-node/with-node.d.ts +3 -1
  168. package/dist/esm/operation-node/with-node.js +2 -1
  169. package/dist/esm/package.json +1 -3
  170. package/dist/esm/parser/complex-expression-parser.d.ts +9 -0
  171. package/dist/esm/parser/complex-expression-parser.js +20 -0
  172. package/dist/esm/parser/filter-parser.d.ts +13 -4
  173. package/dist/esm/parser/filter-parser.js +21 -24
  174. package/dist/esm/parser/insert-values-parser.d.ts +7 -10
  175. package/dist/esm/parser/insert-values-parser.js +31 -38
  176. package/dist/esm/parser/order-by-parser.d.ts +1 -1
  177. package/dist/esm/parser/parse-context.d.ts +22 -8
  178. package/dist/esm/parser/parse-context.js +10 -10
  179. package/dist/esm/parser/reference-parser.d.ts +8 -7
  180. package/dist/esm/parser/reference-parser.js +9 -18
  181. package/dist/esm/parser/returning-parser.d.ts +1 -5
  182. package/dist/esm/parser/select-parser.d.ts +12 -14
  183. package/dist/esm/parser/select-parser.js +6 -10
  184. package/dist/esm/parser/table-parser.d.ts +9 -11
  185. package/dist/esm/parser/table-parser.js +3 -9
  186. package/dist/esm/parser/union-parser.d.ts +2 -2
  187. package/dist/esm/parser/union-parser.js +1 -6
  188. package/dist/esm/parser/update-set-parser.d.ts +2 -8
  189. package/dist/esm/parser/update-set-parser.js +5 -24
  190. package/dist/esm/parser/value-parser.d.ts +9 -6
  191. package/dist/esm/parser/value-parser.js +8 -31
  192. package/dist/esm/parser/with-parser.d.ts +36 -6
  193. package/dist/esm/parser/with-parser.js +13 -2
  194. package/dist/esm/plugin/camel-case/camel-case-plugin.d.ts +34 -0
  195. package/dist/esm/plugin/immediate-value.ts/immediate-value-plugin.d.ts +34 -0
  196. package/dist/esm/plugin/immediate-value.ts/immediate-value-plugin.js +2 -2
  197. package/dist/esm/plugin/with-schema/with-schema-plugin.d.ts +34 -0
  198. package/dist/esm/plugin/with-schema/with-schema-transformer.js +8 -0
  199. package/dist/esm/query-builder/delete-query-builder.d.ts +647 -0
  200. package/dist/esm/query-builder/delete-query-builder.js +181 -0
  201. package/dist/esm/query-builder/expression-builder.d.ts +8 -6
  202. package/dist/esm/query-builder/expression-builder.js +3 -3
  203. package/dist/esm/query-builder/function-builder.d.ts +2 -1
  204. package/dist/esm/query-builder/function-builder.js +2 -1
  205. package/dist/esm/query-builder/having-interface.d.ts +49 -0
  206. package/dist/esm/query-builder/having-interface.js +1 -0
  207. package/dist/esm/query-builder/insert-query-builder.d.ts +504 -0
  208. package/dist/esm/query-builder/insert-query-builder.js +252 -0
  209. package/dist/esm/query-builder/insert-result.d.ts +3 -2
  210. package/dist/esm/query-builder/insert-result.js +3 -2
  211. package/dist/esm/query-builder/join-builder.d.ts +19 -20
  212. package/dist/esm/query-builder/join-builder.js +12 -12
  213. package/dist/esm/query-builder/join-interface.d.ts +130 -0
  214. package/dist/esm/query-builder/join-interface.js +1 -0
  215. package/dist/esm/query-builder/no-result-error.d.ts +9 -0
  216. package/dist/esm/query-builder/no-result-error.js +10 -0
  217. package/dist/esm/query-builder/returning-interface.d.ts +73 -0
  218. package/dist/esm/query-builder/returning-interface.js +1 -0
  219. package/dist/esm/query-builder/{query-builder.d.ts → select-query-builder.d.ts} +145 -634
  220. package/dist/esm/query-builder/select-query-builder.js +566 -0
  221. package/dist/esm/query-builder/update-query-builder.d.ts +735 -0
  222. package/dist/esm/query-builder/update-query-builder.js +275 -0
  223. package/dist/esm/query-builder/where-interface.d.ts +378 -0
  224. package/dist/esm/query-builder/where-interface.js +1 -0
  225. package/dist/esm/query-compiler/default-query-compiler.d.ts +4 -0
  226. package/dist/esm/query-compiler/default-query-compiler.js +33 -5
  227. package/dist/esm/query-creator.d.ts +69 -43
  228. package/dist/esm/query-creator.js +66 -29
  229. package/dist/esm/query-executor/default-query-executor.d.ts +19 -0
  230. package/dist/esm/query-executor/noop-query-executor.d.ts +19 -0
  231. package/dist/esm/query-executor/query-executor.d.ts +1 -1
  232. package/dist/esm/query-executor/query-executor.js +1 -1
  233. package/dist/esm/raw-builder/raw-builder.d.ts +2 -0
  234. package/dist/esm/raw-builder/raw-builder.js +7 -1
  235. package/dist/esm/schema/alter-table-builder.d.ts +218 -2
  236. package/dist/esm/schema/column-definition-builder.d.ts +135 -20
  237. package/dist/esm/schema/create-index-builder.d.ts +2 -1
  238. package/dist/esm/schema/create-index-builder.js +2 -1
  239. package/dist/esm/schema/create-table-builder.d.ts +26 -9
  240. package/dist/esm/schema/create-table-builder.js +43 -10
  241. package/dist/esm/schema/create-view-builder.d.ts +17 -3
  242. package/dist/esm/schema/create-view-builder.js +25 -16
  243. package/dist/esm/schema/schema.d.ts +18 -11
  244. package/dist/esm/schema/schema.js +18 -11
  245. package/dist/esm/util/log.d.ts +3 -2
  246. package/dist/esm/util/log.js +7 -14
  247. package/dist/esm/util/type-utils.d.ts +7 -7
  248. package/package.json +10 -8
  249. package/dist/cjs/query-builder/query-builder.js +0 -1067
  250. package/dist/esm/query-builder/query-builder.js +0 -1061
@@ -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()
@@ -204,6 +207,38 @@ export declare class Kysely<DB> extends QueryCreator<DB> {
204
207
  * Returns a copy of this Kysely instance without any plugins.
205
208
  */
206
209
  withoutPlugins(): Kysely<DB>;
210
+ /**
211
+ * Returns a copy of this Kysely instance with tables added to its
212
+ * database type.
213
+ *
214
+ * This method only modifies the types and doesn't affect any of the
215
+ * executed queries in any way.
216
+ *
217
+ * ### Examples
218
+ *
219
+ * The following example adds and uses a temporary table:
220
+ *
221
+ * @example
222
+ * ```ts
223
+ * await db.schema
224
+ * .createTable('temp_table')
225
+ * .temporary()
226
+ * .addColumn('some_column', 'integer')
227
+ * .execute()
228
+ *
229
+ * const tempDb = db.withTables<{
230
+ * temp_table: {
231
+ * some_column: number
232
+ * }
233
+ * }>()
234
+ *
235
+ * await tempDb
236
+ * .insertInto('temp_table')
237
+ * .values({ some_column: 100 })
238
+ * .execute()
239
+ * ```
240
+ */
241
+ withTables<T extends Record<string, Record<string, any>>>(): Kysely<DB & T>;
207
242
  /**
208
243
  * Releases all resources and disconnects from the database.
209
244
  *
@@ -218,10 +253,134 @@ export declare class Kysely<DB> extends QueryCreator<DB> {
218
253
  get isTransaction(): boolean;
219
254
  }
220
255
  export declare class Transaction<DB> extends Kysely<DB> {
256
+ #private;
257
+ constructor(props: KyselyProps);
258
+ /**
259
+ * Returns true if this `Kysely` instance is a transaction.
260
+ *
261
+ * You can also use `db instanceof Transaction`.
262
+ */
221
263
  get isTransaction(): true;
264
+ /**
265
+ * Returns the {@link MigrationModule} module for managing and running migrations.
266
+ */
222
267
  get migration(): MigrationModule;
268
+ /**
269
+ * Creates a {@link TransactionBuilder} that can be used to run queries inside a transaction.
270
+ *
271
+ * The returned {@link TransactionBuilder} can be used to configure the transaction. The
272
+ * {@link TransactionBuilder.execute} method can then be called to run the transaction.
273
+ * {@link TransactionBuilder.execute} takes a function that is run inside the
274
+ * transaction. If the function throws, the transaction is rolled back. Otherwise
275
+ * the transaction is committed.
276
+ *
277
+ * The callback function passed to the {@link TransactionBuilder.execute | execute}
278
+ * method gets the transaction object as its only argument. The transaction is
279
+ * of type {@link Transaction} which inherits {@link Kysely}. Any query
280
+ * started through the transaction object is executed inside the transaction.
281
+ *
282
+ * ### Examples
283
+ *
284
+ * ```ts
285
+ * const catto = await db.transaction().execute(async (trx) => {
286
+ * const jennifer = await trx.insertInto('person')
287
+ * .values({
288
+ * id: db.generated,
289
+ * first_name: 'Jennifer',
290
+ * last_name: 'Aniston',
291
+ * })
292
+ * .returning('id')
293
+ * .executeTakeFirstOrThrow()
294
+ *
295
+ * await someFunction(trx, jennifer)
296
+ *
297
+ * return await trx.insertInto('pet')
298
+ * .values({
299
+ * id: db.generated,
300
+ * user_id: jennifer.id,
301
+ * name: 'Catto',
302
+ * species: 'cat'
303
+ * })
304
+ * .returning('*')
305
+ * .executeTakeFirst()
306
+ * })
307
+ * ```
308
+ *
309
+ * Setting the isolation level:
310
+ *
311
+ * ```ts
312
+ * await db
313
+ * .transaction()
314
+ * .setIsolationLevel('serializable')
315
+ * .execute(async (trx) => {
316
+ * await doStuff(trx)
317
+ * })
318
+ * ```
319
+ */
223
320
  transaction(): TransactionBuilder<DB>;
321
+ /**
322
+ * Provides a kysely instance bound to a single database connection.
323
+ *
324
+ * ### Examples
325
+ *
326
+ * ```ts
327
+ * await db
328
+ * .connection()
329
+ * .execute(async (db) => {
330
+ * // `db` is an instance of `Kysely` that's bound to a single
331
+ * // database connection. All queries executed through `db` use
332
+ * // the same connection.
333
+ * await doStuff(db)
334
+ * })
335
+ * ```
336
+ */
337
+ connection(): ConnectionBuilder<DB>;
338
+ /**
339
+ * Releases all resources and disconnects from the database.
340
+ *
341
+ * You need to call this when you are done using the `Kysely` instance.
342
+ */
224
343
  destroy(): Promise<void>;
344
+ /**
345
+ * Returns a copy of this Kysely instance with the given plugin installed.
346
+ */
347
+ withPlugin(plugin: KyselyPlugin): Transaction<DB>;
348
+ /**
349
+ * Returns a copy of this Kysely instance without any plugins.
350
+ */
351
+ withoutPlugins(): Transaction<DB>;
352
+ /**
353
+ * Returns a copy of this Kysely instance with tables added to its
354
+ * database type.
355
+ *
356
+ * This method only modifies the types and doesn't affect any of the
357
+ * executed queries in any way.
358
+ *
359
+ * ### Examples
360
+ *
361
+ * The following example adds and uses a temporary table:
362
+ *
363
+ * @example
364
+ * ```ts
365
+ * await db.schema
366
+ * .createTable('temp_table')
367
+ * .temporary()
368
+ * .addColumn('some_column', 'integer')
369
+ * .execute()
370
+ *
371
+ * const tempDb = db.withTables<{
372
+ * temp_table: {
373
+ * some_column: number
374
+ * }
375
+ * }>()
376
+ *
377
+ * await tempDb
378
+ * .insertInto('temp_table')
379
+ * .values({ some_column: 100 })
380
+ * .execute()
381
+ * ```
382
+ */
383
+ withTables<T extends Record<string, Record<string, any>>>(): Transaction<DB & T>;
225
384
  }
226
385
  export interface KyselyProps {
227
386
  readonly config: KyselyConfig;
@@ -240,7 +399,8 @@ export interface KyselyConfig {
240
399
  * Currently there's only two levels: `query` and `error`.
241
400
  * This will be expanded based on user feedback later.
242
401
  *
243
- * @example
402
+ * ### Examples
403
+ *
244
404
  * ```ts
245
405
  * const db = new Kysely<Database>({
246
406
  * dialect: new PostgresDialect(postgresConfig),
@@ -248,7 +408,6 @@ export interface KyselyConfig {
248
408
  * })
249
409
  * ```
250
410
  *
251
- * @example
252
411
  * ```ts
253
412
  * const db = new Kysely<Database>({
254
413
  * 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()
@@ -255,6 +258,40 @@ export class Kysely extends QueryCreator {
255
258
  executor: this.#props.executor.withoutPlugins(),
256
259
  });
257
260
  }
261
+ /**
262
+ * Returns a copy of this Kysely instance with tables added to its
263
+ * database type.
264
+ *
265
+ * This method only modifies the types and doesn't affect any of the
266
+ * executed queries in any way.
267
+ *
268
+ * ### Examples
269
+ *
270
+ * The following example adds and uses a temporary table:
271
+ *
272
+ * @example
273
+ * ```ts
274
+ * await db.schema
275
+ * .createTable('temp_table')
276
+ * .temporary()
277
+ * .addColumn('some_column', 'integer')
278
+ * .execute()
279
+ *
280
+ * const tempDb = db.withTables<{
281
+ * temp_table: {
282
+ * some_column: number
283
+ * }
284
+ * }>()
285
+ *
286
+ * await tempDb
287
+ * .insertInto('temp_table')
288
+ * .values({ some_column: 100 })
289
+ * .execute()
290
+ * ```
291
+ */
292
+ withTables() {
293
+ return new Kysely({ ...this.#props });
294
+ }
258
295
  /**
259
296
  * Releases all resources and disconnects from the database.
260
297
  *
@@ -273,6 +310,11 @@ export class Kysely extends QueryCreator {
273
310
  }
274
311
  }
275
312
  export class Transaction extends Kysely {
313
+ #props;
314
+ constructor(props) {
315
+ super(props);
316
+ this.#props = props;
317
+ }
276
318
  // The return type is `true` instead of `boolean` to make Kysely<DB>
277
319
  // unassignable to Transaction<DB> while allowing assignment the
278
320
  // other way around.
@@ -285,9 +327,27 @@ export class Transaction extends Kysely {
285
327
  transaction() {
286
328
  throw new Error('calling the transaction method for a Transaction is not supported');
287
329
  }
330
+ connection() {
331
+ throw new Error('calling the connection method for a Transaction is not supported');
332
+ }
288
333
  async destroy() {
289
334
  throw new Error('calling the destroy method for a Transaction is not supported');
290
335
  }
336
+ withPlugin(plugin) {
337
+ return new Transaction({
338
+ ...this.#props,
339
+ executor: this.#props.executor.withPlugin(plugin),
340
+ });
341
+ }
342
+ withoutPlugins() {
343
+ return new Transaction({
344
+ ...this.#props,
345
+ executor: this.#props.executor.withoutPlugins(),
346
+ });
347
+ }
348
+ withTables() {
349
+ return new Transaction({ ...this.#props });
350
+ }
291
351
  }
292
352
  export function isKyselyProps(obj) {
293
353
  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: {
@@ -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
  }>;
@@ -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;
@@ -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';
@@ -63,6 +64,7 @@ import { DropViewNode } from './drop-view-node.js';
63
64
  import { GeneratedAlwaysAsNode } from './generated-always-as-node.js';
64
65
  import { DefaultValueNode } from './default-value-node.js';
65
66
  import { OnNode } from './on-node.js';
67
+ import { ValuesNode } from './values-node.js';
66
68
  /**
67
69
  * Transforms an operation node tree into another one.
68
70
  *
@@ -113,6 +115,7 @@ export declare class OperationNodeTransformer {
113
115
  protected transformRaw(node: RawNode): RawNode;
114
116
  protected transformWhere(node: WhereNode): WhereNode;
115
117
  protected transformInsertQuery(node: InsertQueryNode): InsertQueryNode;
118
+ protected transformValues(node: ValuesNode): ValuesNode;
116
119
  protected transformDeleteQuery(node: DeleteQueryNode): DeleteQueryNode;
117
120
  protected transformReturning(node: ReturningNode): ReturningNode;
118
121
  protected transformCreateTable(node: CreateTableNode): CreateTableNode;
@@ -140,6 +143,7 @@ export declare class OperationNodeTransformer {
140
143
  protected transformCheckConstraint(node: CheckConstraintNode): CheckConstraintNode;
141
144
  protected transformWith(node: WithNode): WithNode;
142
145
  protected transformCommonTableExpression(node: CommonTableExpressionNode): CommonTableExpressionNode;
146
+ protected transformCommonTableExpressionName(node: CommonTableExpressionNameNode): CommonTableExpressionNameNode;
143
147
  protected transformHaving(node: HavingNode): HavingNode;
144
148
  protected transformCreateSchema(node: CreateSchemaNode): CreateSchemaNode;
145
149
  protected transformDropSchema(node: DropSchemaNode): DropSchemaNode;
@@ -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),
@@ -95,6 +96,7 @@ export class OperationNodeTransformer {
95
96
  GeneratedAlwaysAsNode: this.transformGeneratedAlwaysAs.bind(this),
96
97
  DefaultValueNode: this.transformDefaultValue.bind(this),
97
98
  OnNode: this.transformOn.bind(this),
99
+ ValuesNode: this.transformValues.bind(this),
98
100
  });
99
101
  transformNode = (node) => {
100
102
  if (!node) {
@@ -229,7 +231,7 @@ export class OperationNodeTransformer {
229
231
  kind: 'InsertQueryNode',
230
232
  into: this.transformNode(node.into),
231
233
  columns: this.transformNodeList(node.columns),
232
- values: this.transformNodeList(node.values),
234
+ values: this.transformNode(node.values),
233
235
  returning: this.transformNode(node.returning),
234
236
  onConflict: this.transformNode(node.onConflict),
235
237
  onDuplicateKey: this.transformNode(node.onDuplicateKey),
@@ -237,6 +239,12 @@ export class OperationNodeTransformer {
237
239
  ignore: node.ignore,
238
240
  };
239
241
  }
242
+ transformValues(node) {
243
+ return {
244
+ kind: 'ValuesNode',
245
+ values: this.transformNodeList(node.values),
246
+ };
247
+ }
240
248
  transformDeleteQuery(node) {
241
249
  return {
242
250
  kind: 'DeleteQueryNode',
@@ -259,7 +267,9 @@ export class OperationNodeTransformer {
259
267
  table: this.transformNode(node.table),
260
268
  columns: this.transformNodeList(node.columns),
261
269
  constraints: this.transformNodeList(node.constraints),
270
+ temporary: node.temporary,
262
271
  ifNotExists: node.ifNotExists,
272
+ onCommit: node.onCommit,
263
273
  };
264
274
  }
265
275
  transformColumnDefinition(node) {
@@ -435,6 +445,7 @@ export class OperationNodeTransformer {
435
445
  return {
436
446
  kind: 'WithNode',
437
447
  expressions: this.transformNodeList(node.expressions),
448
+ recursive: node.recursive,
438
449
  };
439
450
  }
440
451
  transformCommonTableExpression(node) {
@@ -444,6 +455,13 @@ export class OperationNodeTransformer {
444
455
  expression: this.transformNode(node.expression),
445
456
  };
446
457
  }
458
+ transformCommonTableExpressionName(node) {
459
+ return {
460
+ kind: 'CommonTableExpressionNameNode',
461
+ table: this.transformNode(node.table),
462
+ columns: this.transformNodeList(node.columns),
463
+ };
464
+ }
447
465
  transformHaving(node) {
448
466
  return {
449
467
  kind: 'HavingNode',
@@ -525,6 +543,7 @@ export class OperationNodeTransformer {
525
543
  return {
526
544
  kind: 'CreateViewNode',
527
545
  name: this.transformNode(node.name),
546
+ temporary: node.temporary,
528
547
  orReplace: node.orReplace,
529
548
  ifNotExists: node.ifNotExists,
530
549
  materialized: node.materialized,