kysely 0.9.8 → 0.11.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 (220) hide show
  1. package/README.md +22 -16
  2. package/dist/cjs/dialect/dialect-adapter.d.ts +3 -2
  3. package/dist/cjs/dialect/mysql/mysql-adapter.js +1 -1
  4. package/dist/cjs/dialect/mysql/mysql-dialect.d.ts +3 -3
  5. package/dist/cjs/dialect/mysql/mysql-driver.js +25 -32
  6. package/dist/cjs/dialect/postgres/postgres-dialect.d.ts +2 -2
  7. package/dist/cjs/dialect/postgres/postgres-driver.js +8 -19
  8. package/dist/cjs/dialect/sqlite/sqlite-adapter.d.ts +7 -0
  9. package/dist/cjs/dialect/sqlite/sqlite-adapter.js +18 -0
  10. package/dist/cjs/dialect/sqlite/sqlite-dialect.d.ts +64 -0
  11. package/dist/cjs/dialect/sqlite/sqlite-dialect.js +33 -0
  12. package/dist/cjs/dialect/sqlite/sqlite-driver.d.ts +14 -0
  13. package/dist/cjs/dialect/sqlite/sqlite-driver.js +116 -0
  14. package/dist/cjs/dialect/sqlite/sqlite-introspector.d.ts +7 -0
  15. package/dist/cjs/dialect/sqlite/sqlite-introspector.js +31 -0
  16. package/dist/cjs/dialect/sqlite/sqlite-query-compiler.d.ts +7 -0
  17. package/dist/cjs/dialect/sqlite/sqlite-query-compiler.js +19 -0
  18. package/dist/cjs/driver/database-connection.d.ts +2 -2
  19. package/dist/cjs/driver/runtime-driver.js +3 -4
  20. package/dist/cjs/index.d.ts +10 -0
  21. package/dist/cjs/index.js +10 -0
  22. package/dist/cjs/kysely.d.ts +6 -4
  23. package/dist/cjs/kysely.js +6 -4
  24. package/dist/cjs/migration/migration.d.ts +1 -1
  25. package/dist/cjs/migration/migration.js +3 -3
  26. package/dist/cjs/operation-node/column-definition-node.d.ts +8 -6
  27. package/dist/cjs/operation-node/column-definition-node.js +4 -4
  28. package/dist/cjs/operation-node/create-schema-node.d.ts +1 -2
  29. package/dist/cjs/operation-node/create-table-node.d.ts +2 -3
  30. package/dist/cjs/operation-node/create-table-node.js +2 -2
  31. package/dist/cjs/operation-node/create-view-node.d.ts +23 -0
  32. package/dist/cjs/operation-node/create-view-node.js +25 -0
  33. package/dist/cjs/operation-node/default-value-node.d.ts +14 -0
  34. package/dist/cjs/operation-node/default-value-node.js +18 -0
  35. package/dist/cjs/operation-node/drop-index-node.d.ts +1 -2
  36. package/dist/cjs/operation-node/drop-schema-node.d.ts +2 -3
  37. package/dist/cjs/operation-node/drop-schema-node.js +3 -3
  38. package/dist/cjs/operation-node/drop-table-node.d.ts +2 -3
  39. package/dist/cjs/operation-node/drop-table-node.js +2 -2
  40. package/dist/cjs/operation-node/drop-view-node.d.ts +17 -0
  41. package/dist/cjs/operation-node/drop-view-node.js +25 -0
  42. package/dist/cjs/operation-node/generated-always-as-node.d.ts +16 -0
  43. package/dist/cjs/operation-node/generated-always-as-node.js +25 -0
  44. package/dist/cjs/operation-node/having-node.d.ts +4 -8
  45. package/dist/cjs/operation-node/having-node.js +3 -3
  46. package/dist/cjs/operation-node/join-node.d.ts +6 -9
  47. package/dist/cjs/operation-node/join-node.js +10 -7
  48. package/dist/cjs/operation-node/on-node.d.ts +14 -0
  49. package/dist/cjs/operation-node/on-node.js +28 -0
  50. package/dist/cjs/operation-node/operation-node-transformer.d.ts +10 -0
  51. package/dist/cjs/operation-node/operation-node-transformer.js +55 -11
  52. package/dist/cjs/operation-node/operation-node-visitor.d.ts +11 -0
  53. package/dist/cjs/operation-node/operation-node-visitor.js +11 -2
  54. package/dist/cjs/operation-node/operation-node.d.ts +1 -1
  55. package/dist/cjs/operation-node/query-node.d.ts +3 -3
  56. package/dist/cjs/operation-node/raw-node.d.ts +1 -1
  57. package/dist/cjs/operation-node/select-query-node.d.ts +5 -5
  58. package/dist/cjs/operation-node/select-query-node.js +1 -1
  59. package/dist/cjs/operation-node/where-node.d.ts +4 -8
  60. package/dist/cjs/operation-node/where-node.js +3 -3
  61. package/dist/cjs/parser/filter-parser.js +1 -1
  62. package/dist/cjs/parser/returning-parser.d.ts +4 -2
  63. package/dist/cjs/parser/select-parser.d.ts +2 -2
  64. package/dist/cjs/plugin/immediate-value.ts/immediate-value-plugin.d.ts +17 -0
  65. package/dist/cjs/plugin/immediate-value.ts/immediate-value-plugin.js +22 -0
  66. package/dist/cjs/plugin/immediate-value.ts/immediate-value-transformer.d.ts +13 -0
  67. package/dist/cjs/plugin/immediate-value.ts/immediate-value-transformer.js +21 -0
  68. package/dist/cjs/plugin/with-schema/with-schema-transformer.d.ts +4 -0
  69. package/dist/cjs/plugin/with-schema/with-schema-transformer.js +6 -0
  70. package/dist/cjs/query-builder/delete-result.d.ts +5 -0
  71. package/dist/cjs/query-builder/delete-result.js +13 -0
  72. package/dist/cjs/query-builder/expression-builder.d.ts +2 -2
  73. package/dist/cjs/query-builder/expression-builder.js +1 -1
  74. package/dist/cjs/query-builder/function-builder.d.ts +5 -5
  75. package/dist/cjs/query-builder/function-builder.js +3 -3
  76. package/dist/cjs/query-builder/insert-result.d.ts +27 -0
  77. package/dist/cjs/query-builder/insert-result.js +35 -0
  78. package/dist/cjs/query-builder/query-builder.d.ts +91 -81
  79. package/dist/cjs/query-builder/query-builder.js +38 -41
  80. package/dist/cjs/query-builder/update-result.d.ts +5 -0
  81. package/dist/cjs/query-builder/update-result.js +13 -0
  82. package/dist/cjs/query-compiler/compiled-query.d.ts +5 -0
  83. package/dist/cjs/query-compiler/compiled-query.js +12 -0
  84. package/dist/cjs/query-compiler/default-query-compiler.d.ts +10 -0
  85. package/dist/cjs/query-compiler/default-query-compiler.js +82 -23
  86. package/dist/cjs/query-compiler/query-compiler.d.ts +3 -1
  87. package/dist/cjs/query-creator.d.ts +36 -26
  88. package/dist/cjs/query-creator.js +25 -17
  89. package/dist/cjs/raw-builder/raw-builder.d.ts +1 -1
  90. package/dist/cjs/schema/alter-table-builder.d.ts +6 -2
  91. package/dist/cjs/schema/alter-table-builder.js +28 -4
  92. package/dist/cjs/schema/column-definition-builder.d.ts +43 -2
  93. package/dist/cjs/schema/column-definition-builder.js +23 -6
  94. package/dist/cjs/schema/create-schema-builder.js +1 -1
  95. package/dist/cjs/schema/create-table-builder.d.ts +7 -8
  96. package/dist/cjs/schema/create-table-builder.js +8 -9
  97. package/dist/cjs/schema/create-view-builder.d.ts +28 -0
  98. package/dist/cjs/schema/create-view-builder.js +84 -0
  99. package/dist/cjs/schema/drop-index-builder.js +1 -1
  100. package/dist/cjs/schema/drop-schema-builder.js +3 -1
  101. package/dist/cjs/schema/drop-table-builder.js +3 -1
  102. package/dist/cjs/schema/drop-view-builder.d.ts +20 -0
  103. package/dist/cjs/schema/drop-view-builder.js +39 -0
  104. package/dist/cjs/schema/schema.d.ts +30 -3
  105. package/dist/cjs/schema/schema.js +44 -3
  106. package/dist/cjs/util/dynamic-import.d.ts +2 -0
  107. package/dist/cjs/util/dynamic-import.js +32 -0
  108. package/dist/cjs/util/performance-now.d.ts +1 -0
  109. package/dist/cjs/util/performance-now.js +13 -0
  110. package/dist/cjs/util/type-utils.d.ts +4 -15
  111. package/dist/esm/dialect/dialect-adapter.d.ts +3 -2
  112. package/dist/esm/dialect/mysql/mysql-adapter.js +1 -1
  113. package/dist/esm/dialect/mysql/mysql-dialect.d.ts +3 -3
  114. package/dist/esm/dialect/mysql/mysql-driver.js +26 -33
  115. package/dist/esm/dialect/postgres/postgres-dialect.d.ts +2 -2
  116. package/dist/esm/dialect/postgres/postgres-driver.js +8 -19
  117. package/dist/esm/dialect/sqlite/sqlite-adapter.d.ts +7 -0
  118. package/dist/esm/dialect/sqlite/sqlite-adapter.js +14 -0
  119. package/dist/esm/dialect/sqlite/sqlite-dialect.d.ts +64 -0
  120. package/dist/esm/dialect/sqlite/sqlite-dialect.js +29 -0
  121. package/dist/esm/dialect/sqlite/sqlite-driver.d.ts +14 -0
  122. package/dist/esm/dialect/sqlite/sqlite-driver.js +112 -0
  123. package/dist/esm/dialect/sqlite/sqlite-introspector.d.ts +7 -0
  124. package/dist/esm/dialect/sqlite/sqlite-introspector.js +27 -0
  125. package/dist/esm/dialect/sqlite/sqlite-query-compiler.d.ts +7 -0
  126. package/dist/esm/dialect/sqlite/sqlite-query-compiler.js +15 -0
  127. package/dist/esm/driver/database-connection.d.ts +2 -2
  128. package/dist/esm/driver/runtime-driver.js +3 -4
  129. package/dist/esm/index.d.ts +10 -0
  130. package/dist/esm/index.js +10 -0
  131. package/dist/esm/kysely.d.ts +6 -4
  132. package/dist/esm/kysely.js +6 -4
  133. package/dist/esm/migration/migration.d.ts +1 -1
  134. package/dist/esm/migration/migration.js +3 -3
  135. package/dist/esm/operation-node/column-definition-node.d.ts +8 -6
  136. package/dist/esm/operation-node/column-definition-node.js +4 -4
  137. package/dist/esm/operation-node/create-schema-node.d.ts +1 -2
  138. package/dist/esm/operation-node/create-table-node.d.ts +2 -3
  139. package/dist/esm/operation-node/create-table-node.js +2 -2
  140. package/dist/esm/operation-node/create-view-node.d.ts +23 -0
  141. package/dist/esm/operation-node/create-view-node.js +22 -0
  142. package/dist/esm/operation-node/default-value-node.d.ts +14 -0
  143. package/dist/esm/operation-node/default-value-node.js +15 -0
  144. package/dist/esm/operation-node/drop-index-node.d.ts +1 -2
  145. package/dist/esm/operation-node/drop-schema-node.d.ts +2 -3
  146. package/dist/esm/operation-node/drop-schema-node.js +3 -3
  147. package/dist/esm/operation-node/drop-table-node.d.ts +2 -3
  148. package/dist/esm/operation-node/drop-table-node.js +2 -2
  149. package/dist/esm/operation-node/drop-view-node.d.ts +17 -0
  150. package/dist/esm/operation-node/drop-view-node.js +22 -0
  151. package/dist/esm/operation-node/generated-always-as-node.d.ts +16 -0
  152. package/dist/esm/operation-node/generated-always-as-node.js +22 -0
  153. package/dist/esm/operation-node/having-node.d.ts +4 -8
  154. package/dist/esm/operation-node/having-node.js +3 -3
  155. package/dist/esm/operation-node/join-node.d.ts +6 -9
  156. package/dist/esm/operation-node/join-node.js +10 -7
  157. package/dist/esm/operation-node/on-node.d.ts +14 -0
  158. package/dist/esm/operation-node/on-node.js +25 -0
  159. package/dist/esm/operation-node/operation-node-transformer.d.ts +10 -0
  160. package/dist/esm/operation-node/operation-node-transformer.js +55 -11
  161. package/dist/esm/operation-node/operation-node-visitor.d.ts +11 -0
  162. package/dist/esm/operation-node/operation-node-visitor.js +11 -2
  163. package/dist/esm/operation-node/operation-node.d.ts +1 -1
  164. package/dist/esm/operation-node/query-node.d.ts +3 -3
  165. package/dist/esm/operation-node/raw-node.d.ts +1 -1
  166. package/dist/esm/operation-node/select-query-node.d.ts +5 -5
  167. package/dist/esm/operation-node/select-query-node.js +1 -1
  168. package/dist/esm/operation-node/where-node.d.ts +4 -8
  169. package/dist/esm/operation-node/where-node.js +3 -3
  170. package/dist/esm/parser/filter-parser.js +1 -1
  171. package/dist/esm/parser/returning-parser.d.ts +4 -2
  172. package/dist/esm/parser/select-parser.d.ts +2 -2
  173. package/dist/esm/plugin/immediate-value.ts/immediate-value-plugin.d.ts +17 -0
  174. package/dist/esm/plugin/immediate-value.ts/immediate-value-plugin.js +18 -0
  175. package/dist/esm/plugin/immediate-value.ts/immediate-value-transformer.d.ts +13 -0
  176. package/dist/esm/plugin/immediate-value.ts/immediate-value-transformer.js +17 -0
  177. package/dist/esm/plugin/with-schema/with-schema-transformer.d.ts +4 -0
  178. package/dist/esm/plugin/with-schema/with-schema-transformer.js +6 -0
  179. package/dist/esm/query-builder/delete-result.d.ts +5 -0
  180. package/dist/esm/query-builder/delete-result.js +9 -0
  181. package/dist/esm/query-builder/expression-builder.d.ts +2 -2
  182. package/dist/esm/query-builder/expression-builder.js +1 -1
  183. package/dist/esm/query-builder/function-builder.d.ts +5 -5
  184. package/dist/esm/query-builder/function-builder.js +3 -3
  185. package/dist/esm/query-builder/insert-result.d.ts +27 -0
  186. package/dist/esm/query-builder/insert-result.js +31 -0
  187. package/dist/esm/query-builder/query-builder.d.ts +91 -81
  188. package/dist/esm/query-builder/query-builder.js +38 -41
  189. package/dist/esm/query-builder/update-result.d.ts +5 -0
  190. package/dist/esm/query-builder/update-result.js +9 -0
  191. package/dist/esm/query-compiler/compiled-query.d.ts +5 -0
  192. package/dist/esm/query-compiler/compiled-query.js +11 -1
  193. package/dist/esm/query-compiler/default-query-compiler.d.ts +10 -0
  194. package/dist/esm/query-compiler/default-query-compiler.js +82 -23
  195. package/dist/esm/query-compiler/query-compiler.d.ts +3 -1
  196. package/dist/esm/query-creator.d.ts +36 -26
  197. package/dist/esm/query-creator.js +25 -17
  198. package/dist/esm/raw-builder/raw-builder.d.ts +1 -1
  199. package/dist/esm/schema/alter-table-builder.d.ts +6 -2
  200. package/dist/esm/schema/alter-table-builder.js +28 -4
  201. package/dist/esm/schema/column-definition-builder.d.ts +43 -2
  202. package/dist/esm/schema/column-definition-builder.js +23 -6
  203. package/dist/esm/schema/create-schema-builder.js +1 -1
  204. package/dist/esm/schema/create-table-builder.d.ts +7 -8
  205. package/dist/esm/schema/create-table-builder.js +8 -9
  206. package/dist/esm/schema/create-view-builder.d.ts +28 -0
  207. package/dist/esm/schema/create-view-builder.js +80 -0
  208. package/dist/esm/schema/drop-index-builder.js +1 -1
  209. package/dist/esm/schema/drop-schema-builder.js +3 -1
  210. package/dist/esm/schema/drop-table-builder.js +3 -1
  211. package/dist/esm/schema/drop-view-builder.d.ts +20 -0
  212. package/dist/esm/schema/drop-view-builder.js +35 -0
  213. package/dist/esm/schema/schema.d.ts +30 -3
  214. package/dist/esm/schema/schema.js +44 -3
  215. package/dist/esm/util/dynamic-import.d.ts +2 -0
  216. package/dist/esm/util/dynamic-import.js +27 -0
  217. package/dist/esm/util/performance-now.d.ts +1 -0
  218. package/dist/esm/util/performance-now.js +9 -0
  219. package/dist/esm/util/type-utils.d.ts +4 -15
  220. package/package.json +5 -3
@@ -1,11 +1,13 @@
1
1
  import { QueryBuilder } from './query-builder/query-builder.js';
2
2
  import { QueryBuilderWithTable, TableExpression, TableReference } from './parser/table-parser.js';
3
- import { InsertResultTypeTag, DeleteResultTypeTag, UpdateResultTypeTag } from './util/type-utils.js';
4
3
  import { QueryExecutor } from './query-executor/query-executor.js';
5
4
  import { RawBuilder } from './raw-builder/raw-builder.js';
6
5
  import { CommonTableExpression, QueryCreatorWithCommonTableExpression } from './parser/with-parser.js';
7
6
  import { WithNode } from './operation-node/with-node.js';
8
7
  import { ParseContext } from './parser/parse-context.js';
8
+ import { InsertResult } from './query-builder/insert-result.js';
9
+ import { DeleteResult } from './query-builder/delete-result.js';
10
+ import { UpdateResult } from './query-builder/update-result.js';
9
11
  export declare class QueryCreator<DB> {
10
12
  #private;
11
13
  constructor(props: QueryCreatorProps);
@@ -21,7 +23,7 @@ export declare class QueryCreator<DB> {
21
23
  * db.selectFrom('person').selectAll()
22
24
  * ```
23
25
  *
24
- * The generated SQL (postgresql):
26
+ * The generated SQL (PostgreSQL):
25
27
  *
26
28
  * ```sql
27
29
  * select * from "person"
@@ -38,7 +40,7 @@ export declare class QueryCreator<DB> {
38
40
  * console.log(persons[0].id)
39
41
  * ```
40
42
  *
41
- * The generated SQL (postgresql):
43
+ * The generated SQL (PostgreSQL):
42
44
  *
43
45
  * ```sql
44
46
  * select "p"."id", "p"."first_name" from "person" as "p"
@@ -57,7 +59,7 @@ export declare class QueryCreator<DB> {
57
59
  * console.log(persons[0].identifier)
58
60
  * ```
59
61
  *
60
- * The generated SQL (postgresql):
62
+ * The generated SQL (PostgreSQL):
61
63
  *
62
64
  * ```sql
63
65
  * select "p"."identifier",
@@ -79,7 +81,7 @@ export declare class QueryCreator<DB> {
79
81
  * console.log(items[0].one)
80
82
  * ```
81
83
  *
82
- * The generated SQL (postgresql):
84
+ * The generated SQL (PostgreSQL):
83
85
  *
84
86
  * ```sql
85
87
  * select "q"."one",
@@ -106,7 +108,7 @@ export declare class QueryCreator<DB> {
106
108
  * .execute()
107
109
  * ```
108
110
  *
109
- * The generated SQL (postgresql):
111
+ * The generated SQL (PostgreSQL):
110
112
  *
111
113
  * ```sql
112
114
  * select "p".id, "a"."species", "q"."one"
@@ -121,20 +123,17 @@ export declare class QueryCreator<DB> {
121
123
  /**
122
124
  * Creates an insert query.
123
125
  *
124
- * The return value of this query is `number | undefined` because of the differences
125
- * between database engines. Most engines (like Mysql) return the auto incrementing
126
- * primary key (if it exists), but some (like postgres) return nothing by default.
127
- * If you are running a database engine like `Mysql` that always returns the primary
128
- * key, you can safely use `!` or the {@link QueryBuilder.castTo | castTo} method
129
- * to cast away the `undefined` from the type.
126
+ * The return value of this query is an instance of {@link InsertResult}. {@link InsertResult}
127
+ * has the {@link InsertResult.insertId | insertId} field that holds the auto incremented id of
128
+ * the inserted row if the db returned one.
130
129
  *
131
130
  * See the {@link QueryBuilder.values | values} method for more info and examples. Also see
132
131
  * the {@link QueryBuilder.returning | returning} method for a way to return columns
133
- * on supported databases like postgres.
132
+ * on supported databases like PostgreSQL.
134
133
  *
135
134
  * @example
136
135
  * ```ts
137
- * const maybePrimaryKey: number | undefined = await db
136
+ * const result = await db
138
137
  * .insertInto('person')
139
138
  * .values({
140
139
  * id: db.generated,
@@ -142,10 +141,12 @@ export declare class QueryCreator<DB> {
142
141
  * last_name: 'Aniston'
143
142
  * })
144
143
  * .executeTakeFirst()
144
+ *
145
+ * console.log(result.insertId)
145
146
  * ```
146
147
  *
147
148
  * @example
148
- * Some databases like postgres support the `returning` method:
149
+ * Some databases like PostgreSQL support the `returning` method:
149
150
  *
150
151
  * ```ts
151
152
  * const { id } = await db
@@ -159,22 +160,26 @@ export declare class QueryCreator<DB> {
159
160
  * .executeTakeFirst()
160
161
  * ```
161
162
  */
162
- insertInto<T extends keyof DB & string>(table: T): QueryBuilder<DB, T, InsertResultTypeTag>;
163
+ insertInto<T extends keyof DB & string>(table: T): QueryBuilder<DB, T, InsertResult>;
163
164
  /**
164
165
  * Creates a delete query.
165
166
  *
166
167
  * See the {@link QueryBuilder.where} method for examples on how to specify
167
- * a where clause for the delete operation .
168
+ * a where clause for the delete operation.
169
+ *
170
+ * The return value of the query is an instance of {@link DeleteResult}.
168
171
  *
169
172
  * @example
170
173
  * ```ts
171
- * const numAffectedRows = await db
174
+ * const result = await db
172
175
  * .deleteFrom('person')
173
176
  * .where('person.id', '=', 1)
174
177
  * .executeTakeFirst()
178
+ *
179
+ * console.log(result.numDeletedRows)
175
180
  * ```
176
181
  */
177
- deleteFrom<TR extends TableReference<DB>>(table: TR): QueryBuilderWithTable<DB, never, DeleteResultTypeTag, TR>;
182
+ deleteFrom<TR extends TableReference<DB>>(table: TR): QueryBuilderWithTable<DB, never, DeleteResult, TR>;
178
183
  /**
179
184
  * Creates an update query.
180
185
  *
@@ -184,16 +189,20 @@ export declare class QueryCreator<DB> {
184
189
  * See the {@link QueryBuilder.set} method for examples on how to
185
190
  * specify the updates.
186
191
  *
192
+ * The return value of the query is an {@link UpdateResult}.
193
+ *
187
194
  * @example
188
195
  * ```ts
189
- * const numAffectedRows = await db
196
+ * const result = await db
190
197
  * .updateTable('person')
191
198
  * .set({ first_name: 'Jennifer' })
192
199
  * .where('person.id', '=', 1)
193
200
  * .executeTakeFirst()
201
+ *
202
+ * console.log(result.numUpdatedRows)
194
203
  * ```
195
204
  */
196
- updateTable<TR extends TableReference<DB>>(table: TR): QueryBuilderWithTable<DB, never, UpdateResultTypeTag, TR>;
205
+ updateTable<TR extends TableReference<DB>>(table: TR): QueryBuilderWithTable<DB, never, UpdateResult, TR>;
197
206
  /**
198
207
  * Creates a `with` query (common table expressions).
199
208
  *
@@ -233,7 +242,7 @@ export declare class QueryCreator<DB> {
233
242
  * .execute()
234
243
  * ```
235
244
  *
236
- * The generated SQL (postgresql):
245
+ * The generated SQL (PostgreSQL):
237
246
  *
238
247
  * ```sql
239
248
  * select * from "mammals"."pet"
@@ -253,7 +262,7 @@ export declare class QueryCreator<DB> {
253
262
  * .execute()
254
263
  * ```
255
264
  *
256
- * The generated SQL (postgresql):
265
+ * The generated SQL (PostgreSQL):
257
266
  *
258
267
  * ```sql
259
268
  * select "p"."name" from "mammals"."pet" as "p"
@@ -298,7 +307,7 @@ export declare class QueryCreator<DB> {
298
307
  * console.log(person.name)
299
308
  * ```
300
309
  *
301
- * The generated SQL (postgresql):
310
+ * The generated SQL (PostgreSQL):
302
311
  *
303
312
  * ```sql
304
313
  * select concat(first_name, ' ', last_name) as "name"
@@ -356,7 +365,7 @@ export declare class QueryCreator<DB> {
356
365
  * }
357
366
  * ```
358
367
  *
359
- * The generated SQL (postgresql):
368
+ * The generated SQL (PostgreSQL):
360
369
  *
361
370
  * ```sql
362
371
  * select * from "person" where now() - birth_date > interval $1 year
@@ -370,7 +379,8 @@ export declare class QueryCreator<DB> {
370
379
  * Example of creating a completely raw query from scratch:
371
380
  *
372
381
  * ```ts
373
- * const persons = await db.raw<Person>('select p.* from person p').execute()
382
+ * const result = await db.raw<Person>('select p.* from person p').execute()
383
+ * const persons = result.rows
374
384
  * ```
375
385
  *
376
386
  * For a raw query, you need to specify the type of the returned __row__. In
@@ -26,20 +26,17 @@ export class QueryCreator {
26
26
  /**
27
27
  * Creates an insert query.
28
28
  *
29
- * The return value of this query is `number | undefined` because of the differences
30
- * between database engines. Most engines (like Mysql) return the auto incrementing
31
- * primary key (if it exists), but some (like postgres) return nothing by default.
32
- * If you are running a database engine like `Mysql` that always returns the primary
33
- * key, you can safely use `!` or the {@link QueryBuilder.castTo | castTo} method
34
- * to cast away the `undefined` from the type.
29
+ * The return value of this query is an instance of {@link InsertResult}. {@link InsertResult}
30
+ * has the {@link InsertResult.insertId | insertId} field that holds the auto incremented id of
31
+ * the inserted row if the db returned one.
35
32
  *
36
33
  * See the {@link QueryBuilder.values | values} method for more info and examples. Also see
37
34
  * the {@link QueryBuilder.returning | returning} method for a way to return columns
38
- * on supported databases like postgres.
35
+ * on supported databases like PostgreSQL.
39
36
  *
40
37
  * @example
41
38
  * ```ts
42
- * const maybePrimaryKey: number | undefined = await db
39
+ * const result = await db
43
40
  * .insertInto('person')
44
41
  * .values({
45
42
  * id: db.generated,
@@ -47,10 +44,12 @@ export class QueryCreator {
47
44
  * last_name: 'Aniston'
48
45
  * })
49
46
  * .executeTakeFirst()
47
+ *
48
+ * console.log(result.insertId)
50
49
  * ```
51
50
  *
52
51
  * @example
53
- * Some databases like postgres support the `returning` method:
52
+ * Some databases like PostgreSQL support the `returning` method:
54
53
  *
55
54
  * ```ts
56
55
  * const { id } = await db
@@ -76,14 +75,18 @@ export class QueryCreator {
76
75
  * Creates a delete query.
77
76
  *
78
77
  * See the {@link QueryBuilder.where} method for examples on how to specify
79
- * a where clause for the delete operation .
78
+ * a where clause for the delete operation.
79
+ *
80
+ * The return value of the query is an instance of {@link DeleteResult}.
80
81
  *
81
82
  * @example
82
83
  * ```ts
83
- * const numAffectedRows = await db
84
+ * const result = await db
84
85
  * .deleteFrom('person')
85
86
  * .where('person.id', '=', 1)
86
87
  * .executeTakeFirst()
88
+ *
89
+ * console.log(result.numDeletedRows)
87
90
  * ```
88
91
  */
89
92
  deleteFrom(table) {
@@ -103,13 +106,17 @@ export class QueryCreator {
103
106
  * See the {@link QueryBuilder.set} method for examples on how to
104
107
  * specify the updates.
105
108
  *
109
+ * The return value of the query is an {@link UpdateResult}.
110
+ *
106
111
  * @example
107
112
  * ```ts
108
- * const numAffectedRows = await db
113
+ * const result = await db
109
114
  * .updateTable('person')
110
115
  * .set({ first_name: 'Jennifer' })
111
116
  * .where('person.id', '=', 1)
112
117
  * .executeTakeFirst()
118
+ *
119
+ * console.log(result.numUpdatedRows)
113
120
  * ```
114
121
  */
115
122
  updateTable(table) {
@@ -167,7 +174,7 @@ export class QueryCreator {
167
174
  * .execute()
168
175
  * ```
169
176
  *
170
- * The generated SQL (postgresql):
177
+ * The generated SQL (PostgreSQL):
171
178
  *
172
179
  * ```sql
173
180
  * select * from "mammals"."pet"
@@ -187,7 +194,7 @@ export class QueryCreator {
187
194
  * .execute()
188
195
  * ```
189
196
  *
190
- * The generated SQL (postgresql):
197
+ * The generated SQL (PostgreSQL):
191
198
  *
192
199
  * ```sql
193
200
  * select "p"."name" from "mammals"."pet" as "p"
@@ -237,7 +244,7 @@ export class QueryCreator {
237
244
  * console.log(person.name)
238
245
  * ```
239
246
  *
240
- * The generated SQL (postgresql):
247
+ * The generated SQL (PostgreSQL):
241
248
  *
242
249
  * ```sql
243
250
  * select concat(first_name, ' ', last_name) as "name"
@@ -295,7 +302,7 @@ export class QueryCreator {
295
302
  * }
296
303
  * ```
297
304
  *
298
- * The generated SQL (postgresql):
305
+ * The generated SQL (PostgreSQL):
299
306
  *
300
307
  * ```sql
301
308
  * select * from "person" where now() - birth_date > interval $1 year
@@ -309,7 +316,8 @@ export class QueryCreator {
309
316
  * Example of creating a completely raw query from scratch:
310
317
  *
311
318
  * ```ts
312
- * const persons = await db.raw<Person>('select p.* from person p').execute()
319
+ * const result = await db.raw<Person>('select p.* from person p').execute()
320
+ * const persons = result.rows
313
321
  * ```
314
322
  *
315
323
  * For a raw query, you need to specify the type of the returned __row__. In
@@ -41,5 +41,5 @@ export interface RawBuilderProps {
41
41
  readonly queryId: QueryId;
42
42
  readonly executor: QueryExecutor;
43
43
  readonly sql: string;
44
- readonly parameters?: any;
44
+ readonly parameters?: ReadonlyArray<unknown>;
45
45
  }
@@ -63,7 +63,7 @@ export interface AlterTableExecutorProps extends AlterTableBuilderProps {
63
63
  export declare class AlterTableAddColumnBuilder implements ColumnDefinitionBuilderInterface<AlterTableAddColumnBuilder>, OperationNodeSource, Compilable {
64
64
  #private;
65
65
  constructor(props: AlterTableAddColumnBuilderProps);
66
- increments(): AlterTableAddColumnBuilder;
66
+ autoIncrement(): AlterTableAddColumnBuilder;
67
67
  primaryKey(): AlterTableAddColumnBuilder;
68
68
  references(ref: string): AlterTableAddColumnBuilder;
69
69
  onDelete(onDelete: OnModifyForeignAction): AlterTableAddColumnBuilder;
@@ -72,6 +72,8 @@ export declare class AlterTableAddColumnBuilder implements ColumnDefinitionBuild
72
72
  notNull(): AlterTableAddColumnBuilder;
73
73
  defaultTo(value: PrimitiveValue | AnyRawBuilder): AlterTableAddColumnBuilder;
74
74
  check(sql: string): AlterTableAddColumnBuilder;
75
+ generatedAlwaysAs(sql: string): AlterTableAddColumnBuilder;
76
+ stored(): AlterTableAddColumnBuilder;
75
77
  toOperationNode(): AlterTableNode;
76
78
  compile(): CompiledQuery;
77
79
  execute(): Promise<void>;
@@ -82,7 +84,7 @@ export interface AlterTableAddColumnBuilderProps extends AlterTableBuilderProps
82
84
  export declare class AlterTableModifyColumnBuilder implements ColumnDefinitionBuilderInterface<AlterTableModifyColumnBuilder>, OperationNodeSource, Compilable {
83
85
  #private;
84
86
  constructor(props: AlterTableModifyColumnBuilderProps);
85
- increments(): AlterTableModifyColumnBuilder;
87
+ autoIncrement(): AlterTableModifyColumnBuilder;
86
88
  primaryKey(): AlterTableModifyColumnBuilder;
87
89
  references(ref: string): AlterTableModifyColumnBuilder;
88
90
  onDelete(onDelete: OnModifyForeignAction): AlterTableModifyColumnBuilder;
@@ -91,6 +93,8 @@ export declare class AlterTableModifyColumnBuilder implements ColumnDefinitionBu
91
93
  notNull(): AlterTableModifyColumnBuilder;
92
94
  defaultTo(value: PrimitiveValue | AnyRawBuilder): AlterTableModifyColumnBuilder;
93
95
  check(sql: string): AlterTableModifyColumnBuilder;
96
+ generatedAlwaysAs(sql: string): AlterTableModifyColumnBuilder;
97
+ stored(): AlterTableModifyColumnBuilder;
94
98
  toOperationNode(): AlterTableNode;
95
99
  compile(): CompiledQuery;
96
100
  execute(): Promise<void>;
@@ -184,10 +184,10 @@ export class AlterTableAddColumnBuilder {
184
184
  constructor(props) {
185
185
  this.#props = freeze(props);
186
186
  }
187
- increments() {
187
+ autoIncrement() {
188
188
  return new AlterTableAddColumnBuilder({
189
189
  ...this.#props,
190
- columnBuilder: this.#props.columnBuilder.increments(),
190
+ columnBuilder: this.#props.columnBuilder.autoIncrement(),
191
191
  });
192
192
  }
193
193
  primaryKey() {
@@ -238,6 +238,18 @@ export class AlterTableAddColumnBuilder {
238
238
  columnBuilder: this.#props.columnBuilder.check(sql),
239
239
  });
240
240
  }
241
+ generatedAlwaysAs(sql) {
242
+ return new AlterTableAddColumnBuilder({
243
+ ...this.#props,
244
+ columnBuilder: this.#props.columnBuilder.generatedAlwaysAs(sql),
245
+ });
246
+ }
247
+ stored() {
248
+ return new AlterTableAddColumnBuilder({
249
+ ...this.#props,
250
+ columnBuilder: this.#props.columnBuilder.stored(),
251
+ });
252
+ }
241
253
  toOperationNode() {
242
254
  return this.#props.executor.transformQuery(AlterTableNode.cloneWith(this.#props.alterTableNode, {
243
255
  addColumn: AddColumnNode.create(this.#props.columnBuilder.toOperationNode()),
@@ -255,10 +267,10 @@ export class AlterTableModifyColumnBuilder {
255
267
  constructor(props) {
256
268
  this.#props = freeze(props);
257
269
  }
258
- increments() {
270
+ autoIncrement() {
259
271
  return new AlterTableModifyColumnBuilder({
260
272
  ...this.#props,
261
- columnBuilder: this.#props.columnBuilder.increments(),
273
+ columnBuilder: this.#props.columnBuilder.autoIncrement(),
262
274
  });
263
275
  }
264
276
  primaryKey() {
@@ -309,6 +321,18 @@ export class AlterTableModifyColumnBuilder {
309
321
  columnBuilder: this.#props.columnBuilder.check(sql),
310
322
  });
311
323
  }
324
+ generatedAlwaysAs(sql) {
325
+ return new AlterTableModifyColumnBuilder({
326
+ ...this.#props,
327
+ columnBuilder: this.#props.columnBuilder.generatedAlwaysAs(sql),
328
+ });
329
+ }
330
+ stored() {
331
+ return new AlterTableModifyColumnBuilder({
332
+ ...this.#props,
333
+ columnBuilder: this.#props.columnBuilder.stored(),
334
+ });
335
+ }
312
336
  toOperationNode() {
313
337
  return this.#props.executor.transformQuery(AlterTableNode.cloneWith(this.#props.alterTableNode, {
314
338
  modifyColumn: ModifyColumnNode.create(this.#props.columnBuilder.toOperationNode()),
@@ -12,7 +12,7 @@ export interface ColumnDefinitionBuilderInterface<R> {
12
12
  * Some dialects like PostgreSQL don't support this. On PostgreSQL
13
13
  * you can use the `serial` or `bigserial` data type instead.
14
14
  */
15
- increments(): R;
15
+ autoIncrement(): R;
16
16
  /**
17
17
  * Makes the column the primary key.
18
18
  *
@@ -40,10 +40,19 @@ export interface ColumnDefinitionBuilderInterface<R> {
40
40
  * column definition (like MySQL 5) you need to call the table level
41
41
  * {@link TableBuilder.addForeignKeyConstraint} method instead.
42
42
  *
43
+ * @example
44
+ * ```ts
45
+ * col.references('person.id').onDelete('cascade')
46
+ * ```
43
47
  */
44
48
  onDelete(onDelete: OnModifyForeignAction): R;
45
49
  /**
46
50
  * Adds an `on update` constraint for the foreign key column.
51
+ *
52
+ * @example
53
+ * ```ts
54
+ * col.references('person.id').onUpdate('cascade')
55
+ * ```
47
56
  */
48
57
  onUpdate(onUpdate: OnModifyForeignAction): R;
49
58
  /**
@@ -78,11 +87,41 @@ export interface ColumnDefinitionBuilderInterface<R> {
78
87
  * ```
79
88
  */
80
89
  check(sql: string): R;
90
+ /**
91
+ * Makes the column a generated column using a `generated always as` statement.
92
+ *
93
+ * @example
94
+ * ```ts
95
+ * db.schema
96
+ * .createTable('person')
97
+ * .addColumn('full_name', 'varchar(255)',
98
+ * (col) => col.generatedAlwaysAs("concat(first_name, ' ', last_name)")
99
+ * )
100
+ * .execute()
101
+ * ```
102
+ */
103
+ generatedAlwaysAs(sql: string): R;
104
+ /**
105
+ * Makes a generated column stored instead of virtual. This method can only
106
+ * be used with {@link generatedAlwaysAs}
107
+ *
108
+ * @example
109
+ * ```ts
110
+ * db.schema
111
+ * .createTable('person')
112
+ * .addColumn('full_name', 'varchar(255)', (col) => col
113
+ * .generatedAlwaysAs("concat(first_name, ' ', last_name)")
114
+ * .stored()
115
+ * )
116
+ * .execute()
117
+ * ```
118
+ */
119
+ stored(): R;
81
120
  }
82
121
  export declare class ColumnDefinitionBuilder implements ColumnDefinitionBuilderInterface<ColumnDefinitionBuilder>, OperationNodeSource {
83
122
  #private;
84
123
  constructor(node: ColumnDefinitionNode);
85
- increments(): ColumnDefinitionBuilder;
124
+ autoIncrement(): ColumnDefinitionBuilder;
86
125
  primaryKey(): ColumnDefinitionBuilder;
87
126
  references(ref: string): ColumnDefinitionBuilder;
88
127
  onDelete(onDelete: OnModifyForeignAction): ColumnDefinitionBuilder;
@@ -91,5 +130,7 @@ export declare class ColumnDefinitionBuilder implements ColumnDefinitionBuilderI
91
130
  notNull(): ColumnDefinitionBuilder;
92
131
  defaultTo(value: DefaultValueExpression): ColumnDefinitionBuilder;
93
132
  check(sql: string): ColumnDefinitionBuilder;
133
+ generatedAlwaysAs(sql: string): ColumnDefinitionBuilder;
134
+ stored(): ColumnDefinitionBuilder;
94
135
  toOperationNode(): ColumnDefinitionNode;
95
136
  }
@@ -6,16 +6,18 @@ import { parseStringReference } from '../parser/reference-parser.js';
6
6
  import { preventAwait } from '../util/prevent-await.js';
7
7
  import { ColumnDefinitionNode } from '../operation-node/column-definition-node.js';
8
8
  import { parseDefaultValueExpression, } from '../parser/default-value-parser.js';
9
+ import { GeneratedAlwaysAsNode } from '../operation-node/generated-always-as-node.js';
10
+ import { DefaultValueNode } from '../operation-node/default-value-node.js';
9
11
  export class ColumnDefinitionBuilder {
10
12
  #node;
11
13
  constructor(node) {
12
14
  this.#node = node;
13
15
  }
14
- increments() {
15
- return new ColumnDefinitionBuilder(ColumnDefinitionNode.cloneWith(this.#node, { isAutoIncrementing: true }));
16
+ autoIncrement() {
17
+ return new ColumnDefinitionBuilder(ColumnDefinitionNode.cloneWith(this.#node, { autoIncrement: true }));
16
18
  }
17
19
  primaryKey() {
18
- return new ColumnDefinitionBuilder(ColumnDefinitionNode.cloneWith(this.#node, { isPrimaryKey: true }));
20
+ return new ColumnDefinitionBuilder(ColumnDefinitionNode.cloneWith(this.#node, { primaryKey: true }));
19
21
  }
20
22
  references(ref) {
21
23
  const references = parseStringReference(ref);
@@ -45,14 +47,14 @@ export class ColumnDefinitionBuilder {
45
47
  }));
46
48
  }
47
49
  unique() {
48
- return new ColumnDefinitionBuilder(ColumnDefinitionNode.cloneWith(this.#node, { isUnique: true }));
50
+ return new ColumnDefinitionBuilder(ColumnDefinitionNode.cloneWith(this.#node, { unique: true }));
49
51
  }
50
52
  notNull() {
51
- return new ColumnDefinitionBuilder(ColumnDefinitionNode.cloneWith(this.#node, { isNullable: false }));
53
+ return new ColumnDefinitionBuilder(ColumnDefinitionNode.cloneWith(this.#node, { nullable: false }));
52
54
  }
53
55
  defaultTo(value) {
54
56
  return new ColumnDefinitionBuilder(ColumnDefinitionNode.cloneWith(this.#node, {
55
- defaultTo: parseDefaultValueExpression(value),
57
+ defaultTo: DefaultValueNode.create(parseDefaultValueExpression(value)),
56
58
  }));
57
59
  }
58
60
  check(sql) {
@@ -60,6 +62,21 @@ export class ColumnDefinitionBuilder {
60
62
  check: CheckConstraintNode.create(sql),
61
63
  }));
62
64
  }
65
+ generatedAlwaysAs(sql) {
66
+ return new ColumnDefinitionBuilder(ColumnDefinitionNode.cloneWith(this.#node, {
67
+ generatedAlwaysAs: GeneratedAlwaysAsNode.create(sql),
68
+ }));
69
+ }
70
+ stored() {
71
+ if (!this.#node.generatedAlwaysAs) {
72
+ throw new Error('stored() can only be called after generatedAlwaysAs');
73
+ }
74
+ return new ColumnDefinitionBuilder(ColumnDefinitionNode.cloneWith(this.#node, {
75
+ generatedAlwaysAs: GeneratedAlwaysAsNode.cloneWith(this.#node.generatedAlwaysAs, {
76
+ stored: true,
77
+ }),
78
+ }));
79
+ }
63
80
  toOperationNode() {
64
81
  return this.#node;
65
82
  }
@@ -9,7 +9,7 @@ export class CreateSchemaBuilder {
9
9
  ifNotExists() {
10
10
  return new CreateSchemaBuilder({
11
11
  ...this.#props,
12
- createSchemaNode: CreateSchemaNode.cloneWith(this.#props.createSchemaNode, { modifier: 'IfNotExists' }),
12
+ createSchemaNode: CreateSchemaNode.cloneWith(this.#props.createSchemaNode, { ifNotExists: true }),
13
13
  });
14
14
  }
15
15
  toOperationNode() {
@@ -26,9 +26,9 @@ export declare class CreateTableBuilder<TB extends string, C extends string = ne
26
26
  * ```ts
27
27
  * await db.schema
28
28
  * .createTable('person')
29
- * .addColumn('id', 'integer', (col) => col.increments().primaryKey()),
30
- * .addColumn('first_name', 'varchar(50), (col) => col.notNull())
31
- * .addColumn('last_name', 'varchar')
29
+ * .addColumn('id', 'integer', (col) => col.autoIncrement().primaryKey()),
30
+ * .addColumn('first_name', 'varchar(50)', (col) => col.notNull())
31
+ * .addColumn('last_name', 'varchar(255)')
32
32
  * .addColumn('bank_balance', 'numeric(8, 2)')
33
33
  * .addColumn('data', db.raw('customtype'))
34
34
  * .addColumn('parent_id', 'integer', (col) =>
@@ -37,11 +37,10 @@ export declare class CreateTableBuilder<TB extends string, C extends string = ne
37
37
  * ```
38
38
  *
39
39
  * With this method, it's once again good to remember that Kysely just builds the query
40
- * that's as close to the structure of your builder method calls as possible, and doesn't
41
- * provide the same API for all databses. For example, some databases like older MySQL
42
- * don't support `references` statement in the column definition. Instead foreign key
43
- * constraints need to be defined in at the level of the `create table` query. See
44
- * the next example:
40
+ * and doesn't provide the same API for all databses. For example, some databases like
41
+ * older MySQL don't support `references` statement in the column definition. Instead
42
+ * foreign key constraints need to be defined in at the level of the `create table`
43
+ * query. See the next example:
45
44
  *
46
45
  * @example
47
46
  * ```ts
@@ -27,7 +27,7 @@ export class CreateTableBuilder {
27
27
  ifNotExists() {
28
28
  return new CreateTableBuilder({
29
29
  ...this.#props,
30
- createTableNode: CreateTableNode.cloneWithModifier(this.#props.createTableNode, 'IfNotExists'),
30
+ createTableNode: CreateTableNode.cloneWithIfNotExists(this.#props.createTableNode, true),
31
31
  });
32
32
  }
33
33
  /**
@@ -37,9 +37,9 @@ export class CreateTableBuilder {
37
37
  * ```ts
38
38
  * await db.schema
39
39
  * .createTable('person')
40
- * .addColumn('id', 'integer', (col) => col.increments().primaryKey()),
41
- * .addColumn('first_name', 'varchar(50), (col) => col.notNull())
42
- * .addColumn('last_name', 'varchar')
40
+ * .addColumn('id', 'integer', (col) => col.autoIncrement().primaryKey()),
41
+ * .addColumn('first_name', 'varchar(50)', (col) => col.notNull())
42
+ * .addColumn('last_name', 'varchar(255)')
43
43
  * .addColumn('bank_balance', 'numeric(8, 2)')
44
44
  * .addColumn('data', db.raw('customtype'))
45
45
  * .addColumn('parent_id', 'integer', (col) =>
@@ -48,11 +48,10 @@ export class CreateTableBuilder {
48
48
  * ```
49
49
  *
50
50
  * With this method, it's once again good to remember that Kysely just builds the query
51
- * that's as close to the structure of your builder method calls as possible, and doesn't
52
- * provide the same API for all databses. For example, some databases like older MySQL
53
- * don't support `references` statement in the column definition. Instead foreign key
54
- * constraints need to be defined in at the level of the `create table` query. See
55
- * the next example:
51
+ * and doesn't provide the same API for all databses. For example, some databases like
52
+ * older MySQL don't support `references` statement in the column definition. Instead
53
+ * foreign key constraints need to be defined in at the level of the `create table`
54
+ * query. See the next example:
56
55
  *
57
56
  * @example
58
57
  * ```ts