kysely 0.28.1 → 0.28.3

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 (110) hide show
  1. package/dist/cjs/dialect/mssql/mssql-driver.d.ts +3 -2
  2. package/dist/cjs/dialect/mssql/mssql-driver.js +68 -57
  3. package/dist/cjs/dialect/postgres/postgres-introspector.js +2 -0
  4. package/dist/cjs/dialect/sqlite/sqlite-introspector.js +2 -1
  5. package/dist/cjs/dynamic/dynamic-table-builder.d.ts +16 -0
  6. package/dist/cjs/dynamic/dynamic-table-builder.js +46 -0
  7. package/dist/cjs/dynamic/dynamic.d.ts +36 -1
  8. package/dist/cjs/dynamic/dynamic.js +37 -0
  9. package/dist/cjs/helpers/mssql.d.ts +4 -4
  10. package/dist/cjs/helpers/mysql.d.ts +4 -4
  11. package/dist/cjs/helpers/postgres.d.ts +4 -4
  12. package/dist/cjs/helpers/sqlite.d.ts +4 -4
  13. package/dist/cjs/index.d.ts +1 -1
  14. package/dist/cjs/kysely.d.ts +5 -1
  15. package/dist/cjs/kysely.js +12 -6
  16. package/dist/cjs/migration/migrator.js +2 -1
  17. package/dist/cjs/parser/delete-from-parser.d.ts +5 -1
  18. package/dist/cjs/parser/merge-into-parser.d.ts +3 -1
  19. package/dist/cjs/parser/select-from-parser.d.ts +3 -1
  20. package/dist/cjs/parser/table-parser.d.ts +4 -3
  21. package/dist/cjs/parser/table-parser.js +4 -0
  22. package/dist/cjs/parser/update-parser.d.ts +5 -1
  23. package/dist/cjs/query-builder/delete-query-builder.js +2 -2
  24. package/dist/cjs/query-builder/function-module.d.ts +5 -5
  25. package/dist/cjs/query-builder/insert-query-builder.js +2 -2
  26. package/dist/cjs/query-builder/merge-query-builder.js +1 -1
  27. package/dist/cjs/query-builder/order-by-interface.d.ts +0 -18
  28. package/dist/cjs/query-builder/select-query-builder.d.ts +0 -18
  29. package/dist/cjs/query-builder/select-query-builder.js +2 -2
  30. package/dist/cjs/query-builder/update-query-builder.js +2 -2
  31. package/dist/cjs/query-compiler/default-query-compiler.js +1 -4
  32. package/dist/cjs/query-executor/query-executor-base.d.ts +2 -2
  33. package/dist/cjs/query-executor/query-executor-base.js +4 -4
  34. package/dist/cjs/query-executor/query-executor.d.ts +2 -2
  35. package/dist/cjs/raw-builder/raw-builder.js +1 -1
  36. package/dist/cjs/schema/alter-table-add-foreign-key-constraint-builder.js +1 -1
  37. package/dist/cjs/schema/alter-table-add-index-builder.js +1 -1
  38. package/dist/cjs/schema/alter-table-builder.js +1 -1
  39. package/dist/cjs/schema/alter-table-drop-constraint-builder.js +1 -1
  40. package/dist/cjs/schema/alter-table-executor.js +1 -1
  41. package/dist/cjs/schema/create-index-builder.js +1 -1
  42. package/dist/cjs/schema/create-schema-builder.js +1 -1
  43. package/dist/cjs/schema/create-table-builder.js +1 -1
  44. package/dist/cjs/schema/create-type-builder.js +1 -1
  45. package/dist/cjs/schema/create-view-builder.js +1 -1
  46. package/dist/cjs/schema/drop-index-builder.js +1 -1
  47. package/dist/cjs/schema/drop-schema-builder.js +1 -1
  48. package/dist/cjs/schema/drop-table-builder.js +1 -1
  49. package/dist/cjs/schema/drop-type-builder.js +1 -1
  50. package/dist/cjs/schema/drop-view-builder.js +1 -1
  51. package/dist/cjs/schema/refresh-materialized-view-builder.js +1 -1
  52. package/dist/cjs/util/type-utils.d.ts +17 -0
  53. package/dist/esm/dialect/mssql/mssql-driver.d.ts +3 -2
  54. package/dist/esm/dialect/mssql/mssql-driver.js +68 -57
  55. package/dist/esm/dialect/postgres/postgres-introspector.js +2 -0
  56. package/dist/esm/dialect/sqlite/sqlite-introspector.js +2 -1
  57. package/dist/esm/dynamic/dynamic-table-builder.d.ts +16 -0
  58. package/dist/esm/dynamic/dynamic-table-builder.js +41 -0
  59. package/dist/esm/dynamic/dynamic.d.ts +36 -1
  60. package/dist/esm/dynamic/dynamic.js +37 -0
  61. package/dist/esm/helpers/mssql.d.ts +4 -4
  62. package/dist/esm/helpers/mysql.d.ts +4 -4
  63. package/dist/esm/helpers/postgres.d.ts +4 -4
  64. package/dist/esm/helpers/sqlite.d.ts +4 -4
  65. package/dist/esm/index.d.ts +1 -1
  66. package/dist/esm/kysely.d.ts +5 -1
  67. package/dist/esm/kysely.js +12 -6
  68. package/dist/esm/migration/migrator.js +3 -2
  69. package/dist/esm/parser/delete-from-parser.d.ts +5 -1
  70. package/dist/esm/parser/merge-into-parser.d.ts +3 -1
  71. package/dist/esm/parser/select-from-parser.d.ts +3 -1
  72. package/dist/esm/parser/table-parser.d.ts +4 -3
  73. package/dist/esm/parser/table-parser.js +4 -0
  74. package/dist/esm/parser/update-parser.d.ts +5 -1
  75. package/dist/esm/query-builder/delete-query-builder.js +2 -2
  76. package/dist/esm/query-builder/function-module.d.ts +5 -5
  77. package/dist/esm/query-builder/insert-query-builder.js +2 -2
  78. package/dist/esm/query-builder/merge-query-builder.js +1 -1
  79. package/dist/esm/query-builder/order-by-interface.d.ts +0 -18
  80. package/dist/esm/query-builder/select-query-builder.d.ts +0 -18
  81. package/dist/esm/query-builder/select-query-builder.js +2 -2
  82. package/dist/esm/query-builder/update-query-builder.js +2 -2
  83. package/dist/esm/query-compiler/default-query-compiler.js +1 -4
  84. package/dist/esm/query-executor/query-executor-base.d.ts +2 -2
  85. package/dist/esm/query-executor/query-executor-base.js +4 -4
  86. package/dist/esm/query-executor/query-executor.d.ts +2 -2
  87. package/dist/esm/raw-builder/raw-builder.js +1 -1
  88. package/dist/esm/schema/alter-table-add-foreign-key-constraint-builder.js +1 -1
  89. package/dist/esm/schema/alter-table-add-index-builder.js +1 -1
  90. package/dist/esm/schema/alter-table-builder.js +1 -1
  91. package/dist/esm/schema/alter-table-drop-constraint-builder.js +1 -1
  92. package/dist/esm/schema/alter-table-executor.js +1 -1
  93. package/dist/esm/schema/create-index-builder.js +1 -1
  94. package/dist/esm/schema/create-schema-builder.js +1 -1
  95. package/dist/esm/schema/create-table-builder.js +1 -1
  96. package/dist/esm/schema/create-type-builder.js +1 -1
  97. package/dist/esm/schema/create-view-builder.js +1 -1
  98. package/dist/esm/schema/drop-index-builder.js +1 -1
  99. package/dist/esm/schema/drop-schema-builder.js +1 -1
  100. package/dist/esm/schema/drop-table-builder.js +1 -1
  101. package/dist/esm/schema/drop-type-builder.js +1 -1
  102. package/dist/esm/schema/drop-view-builder.js +1 -1
  103. package/dist/esm/schema/refresh-materialized-view-builder.js +1 -1
  104. package/dist/esm/util/type-utils.d.ts +17 -0
  105. package/package.json +36 -33
  106. package/.renovaterc.json +0 -3
  107. package/CODE_OF_CONDUCT.md +0 -183
  108. package/FUNDING.md +0 -25
  109. package/deno.check.d.ts +0 -93
  110. package/deno.check.json +0 -21
@@ -6,6 +6,7 @@ import { randomString } from '../../util/random-string.js';
6
6
  import { Deferred } from '../../util/deferred.js';
7
7
  const PRIVATE_RESET_METHOD = Symbol();
8
8
  const PRIVATE_DESTROY_METHOD = Symbol();
9
+ const PRIVATE_VALIDATE_METHOD = Symbol();
9
10
  export class MssqlDriver {
10
11
  #config;
11
12
  #pool;
@@ -27,7 +28,7 @@ export class MssqlDriver {
27
28
  validate: validateConnections === false ||
28
29
  deprecatedValidateConnections === false
29
30
  ? undefined
30
- : (connection) => connection.validate(),
31
+ : (connection) => connection[PRIVATE_VALIDATE_METHOD](),
31
32
  });
32
33
  }
33
34
  async init() {
@@ -64,14 +65,12 @@ export class MssqlDriver {
64
65
  }
65
66
  class MssqlConnection {
66
67
  #connection;
68
+ #hasSocketError;
67
69
  #tedious;
68
70
  constructor(connection, tedious) {
69
71
  this.#connection = connection;
72
+ this.#hasSocketError = false;
70
73
  this.#tedious = tedious;
71
- this.#connection.on('error', console.error);
72
- this.#connection.once('end', () => {
73
- this.#connection.off('error', console.error);
74
- });
75
74
  }
76
75
  async beginTransaction(settings) {
77
76
  const { isolationLevel } = settings;
@@ -93,17 +92,28 @@ class MssqlConnection {
93
92
  }));
94
93
  }
95
94
  async connect() {
96
- await new Promise((resolve, reject) => {
97
- this.#connection.connect((error) => {
98
- if (error) {
99
- console.error(error);
100
- reject(error);
101
- }
102
- else {
103
- resolve(undefined);
104
- }
105
- });
95
+ const { promise: waitForConnected, reject, resolve } = new Deferred();
96
+ this.#connection.connect((error) => {
97
+ if (error) {
98
+ return reject(error);
99
+ }
100
+ resolve();
106
101
  });
102
+ this.#connection.on('error', (error) => {
103
+ if (error instanceof Error &&
104
+ 'code' in error &&
105
+ error.code === 'ESOCKET') {
106
+ this.#hasSocketError = true;
107
+ }
108
+ console.error(error);
109
+ reject(error);
110
+ });
111
+ function endListener() {
112
+ reject(new Error('The connection ended without ever completing the connection'));
113
+ }
114
+ this.#connection.once('end', endListener);
115
+ await waitForConnected;
116
+ this.#connection.off('end', endListener);
107
117
  return this;
108
118
  }
109
119
  async executeQuery(compiledQuery) {
@@ -167,22 +177,6 @@ class MssqlConnection {
167
177
  await this.#cancelRequest(request);
168
178
  }
169
179
  }
170
- async validate() {
171
- try {
172
- const deferred = new Deferred();
173
- const request = new MssqlRequest({
174
- compiledQuery: CompiledQuery.raw('select 1'),
175
- onDone: deferred,
176
- tedious: this.#tedious,
177
- });
178
- this.#connection.execSql(request.request);
179
- await deferred.promise;
180
- return true;
181
- }
182
- catch {
183
- return false;
184
- }
185
- }
186
180
  #getTediousIsolationLevel(isolationLevel) {
187
181
  const { ISOLATION_LEVEL } = this.#tedious;
188
182
  const mapper = {
@@ -204,27 +198,50 @@ class MssqlConnection {
204
198
  const wasCanceled = this.#connection.cancel();
205
199
  if (!wasCanceled) {
206
200
  request.request.off('requestCompleted', resolve);
207
- resolve(undefined);
201
+ resolve();
208
202
  }
209
203
  });
210
204
  }
205
+ [PRIVATE_DESTROY_METHOD]() {
206
+ if ('closed' in this.#connection && this.#connection.closed) {
207
+ return Promise.resolve();
208
+ }
209
+ return new Promise((resolve) => {
210
+ this.#connection.once('end', resolve);
211
+ this.#connection.close();
212
+ });
213
+ }
211
214
  async [PRIVATE_RESET_METHOD]() {
212
215
  await new Promise((resolve, reject) => {
213
216
  this.#connection.reset((error) => {
214
- if (error)
215
- reject(error);
216
- else
217
- resolve(undefined);
217
+ if (error) {
218
+ return reject(error);
219
+ }
220
+ resolve();
218
221
  });
219
222
  });
220
223
  }
221
- [PRIVATE_DESTROY_METHOD]() {
222
- return new Promise((resolve) => {
223
- this.#connection.once('end', () => {
224
- resolve(undefined);
224
+ async [PRIVATE_VALIDATE_METHOD]() {
225
+ if (this.#hasSocketError || this.#isConnectionClosed()) {
226
+ return false;
227
+ }
228
+ try {
229
+ const deferred = new Deferred();
230
+ const request = new MssqlRequest({
231
+ compiledQuery: CompiledQuery.raw('select 1'),
232
+ onDone: deferred,
233
+ tedious: this.#tedious,
225
234
  });
226
- this.#connection.close();
227
- });
235
+ this.#connection.execSql(request.request);
236
+ await deferred.promise;
237
+ return true;
238
+ }
239
+ catch {
240
+ return false;
241
+ }
242
+ }
243
+ #isConnectionClosed() {
244
+ return 'closed' in this.#connection && Boolean(this.#connection.closed);
228
245
  }
229
246
  }
230
247
  class MssqlRequest {
@@ -248,23 +265,19 @@ class MssqlRequest {
248
265
  }
249
266
  delete this.#subscribers[subscriptionKey];
250
267
  if (event === 'error') {
251
- onDone.reject(error);
252
- }
253
- else {
254
- onDone.resolve({
255
- rowCount: this.#rowCount,
256
- rows: this.#rows,
257
- });
268
+ return onDone.reject(error);
258
269
  }
270
+ onDone.resolve({
271
+ rowCount: this.#rowCount,
272
+ rows: this.#rows,
273
+ });
259
274
  };
260
275
  }
261
276
  this.#request = new this.#tedious.Request(compiledQuery.sql, (err, rowCount) => {
262
277
  if (err) {
263
- Object.values(this.#subscribers).forEach((subscriber) => subscriber('error', err instanceof AggregateError ? err.errors : err));
264
- }
265
- else {
266
- this.#rowCount = rowCount;
278
+ return Object.values(this.#subscribers).forEach((subscriber) => subscriber('error', err instanceof AggregateError ? err.errors : err));
267
279
  }
280
+ this.#rowCount = rowCount;
268
281
  });
269
282
  this.#addParametersToRequest(compiledQuery.parameters);
270
283
  this.#attachListeners();
@@ -278,11 +291,9 @@ class MssqlRequest {
278
291
  this.#subscribers[subscriptionKey] = (event, error) => {
279
292
  delete this.#subscribers[subscriptionKey];
280
293
  if (event === 'error') {
281
- reject(error);
282
- }
283
- else {
284
- resolve(this.#rows.splice(0, this.#streamChunkSize));
294
+ return reject(error);
285
295
  }
296
+ resolve(this.#rows.splice(0, this.#streamChunkSize));
286
297
  };
287
298
  this.#request.resume();
288
299
  });
@@ -46,6 +46,8 @@ export class PostgresIntrospector {
46
46
  ])
47
47
  .where('ns.nspname', '!~', '^pg_')
48
48
  .where('ns.nspname', '!=', 'information_schema')
49
+ // Filter out internal cockroachdb schema
50
+ .where('ns.nspname', '!=', 'crdb_internal')
49
51
  // No system columns
50
52
  .where('a.attnum', '>=', 0)
51
53
  .where('a.attisdropped', '!=', true)
@@ -49,7 +49,8 @@ export class SqliteIntrospector {
49
49
  'p.dflt_value',
50
50
  'p.pk',
51
51
  ])
52
- .orderBy(['tl.name', 'p.cid'])
52
+ .orderBy('tl.name')
53
+ .orderBy('p.cid')
53
54
  .execute();
54
55
  const columnsByTable = {};
55
56
  for (const row of tableMetadata) {
@@ -0,0 +1,16 @@
1
+ import { AliasNode } from '../operation-node/alias-node.js';
2
+ import { OperationNodeSource } from '../operation-node/operation-node-source.js';
3
+ export declare class DynamicTableBuilder<T extends string> {
4
+ #private;
5
+ get table(): T;
6
+ constructor(table: T);
7
+ as<A extends string>(alias: A): AliasedDynamicTableBuilder<T, A>;
8
+ }
9
+ export declare class AliasedDynamicTableBuilder<T extends string, A extends string> implements OperationNodeSource {
10
+ #private;
11
+ get table(): T;
12
+ get alias(): A;
13
+ constructor(table: T, alias: A);
14
+ toOperationNode(): AliasNode;
15
+ }
16
+ export declare function isAliasedDynamicTableBuilder(obj: unknown): obj is AliasedDynamicTableBuilder<any, any>;
@@ -0,0 +1,41 @@
1
+ /// <reference types="./dynamic-table-builder.d.ts" />
2
+ import { AliasNode } from '../operation-node/alias-node.js';
3
+ import { IdentifierNode } from '../operation-node/identifier-node.js';
4
+ import { isOperationNodeSource, } from '../operation-node/operation-node-source.js';
5
+ import { parseTable } from '../parser/table-parser.js';
6
+ import { isObject, isString } from '../util/object-utils.js';
7
+ export class DynamicTableBuilder {
8
+ #table;
9
+ get table() {
10
+ return this.#table;
11
+ }
12
+ constructor(table) {
13
+ this.#table = table;
14
+ }
15
+ as(alias) {
16
+ return new AliasedDynamicTableBuilder(this.#table, alias);
17
+ }
18
+ }
19
+ export class AliasedDynamicTableBuilder {
20
+ #table;
21
+ #alias;
22
+ get table() {
23
+ return this.#table;
24
+ }
25
+ get alias() {
26
+ return this.#alias;
27
+ }
28
+ constructor(table, alias) {
29
+ this.#table = table;
30
+ this.#alias = alias;
31
+ }
32
+ toOperationNode() {
33
+ return AliasNode.create(parseTable(this.#table), IdentifierNode.create(this.#alias));
34
+ }
35
+ }
36
+ export function isAliasedDynamicTableBuilder(obj) {
37
+ return (isObject(obj) &&
38
+ isOperationNodeSource(obj) &&
39
+ isString(obj.table) &&
40
+ isString(obj.alias));
41
+ }
@@ -1,5 +1,6 @@
1
1
  import { DynamicReferenceBuilder } from './dynamic-reference-builder.js';
2
- export declare class DynamicModule {
2
+ import { DynamicTableBuilder } from './dynamic-table-builder.js';
3
+ export declare class DynamicModule<DB> {
3
4
  /**
4
5
  * Creates a dynamic reference to a column that is not know at compile time.
5
6
  *
@@ -86,4 +87,38 @@ export declare class DynamicModule {
86
87
  * ```
87
88
  */
88
89
  ref<R extends string = never>(reference: string): DynamicReferenceBuilder<R>;
90
+ /**
91
+ * Creates a table reference to a table that's not fully known at compile time.
92
+ *
93
+ * The type `T` is allowed to be a union of multiple tables.
94
+ *
95
+ * <!-- siteExample("select", "Generic find query", 130) -->
96
+ *
97
+ * A generic type-safe helper function for finding a row by a column value:
98
+ *
99
+ * ```ts
100
+ * import { SelectType } from 'kysely'
101
+ * import { Database } from 'type-editor'
102
+ *
103
+ * async function getRowByColumn<
104
+ * T extends keyof Database,
105
+ * C extends keyof Database[T] & string,
106
+ * V extends SelectType<Database[T][C]>,
107
+ * >(t: T, c: C, v: V) {
108
+ * // We need to use the dynamic module since the table name
109
+ * // is not known at compile time.
110
+ * const { table, ref } = db.dynamic
111
+ *
112
+ * return await db
113
+ * .selectFrom(table(t).as('t'))
114
+ * .selectAll()
115
+ * .where(ref(c), '=', v)
116
+ * .orderBy('t.id')
117
+ * .executeTakeFirstOrThrow()
118
+ * }
119
+ *
120
+ * const person = await getRowByColumn('person', 'first_name', 'Arnold')
121
+ * ```
122
+ */
123
+ table<T extends keyof DB & string>(table: T): DynamicTableBuilder<T>;
89
124
  }
@@ -1,5 +1,6 @@
1
1
  /// <reference types="./dynamic.d.ts" />
2
2
  import { DynamicReferenceBuilder } from './dynamic-reference-builder.js';
3
+ import { DynamicTableBuilder } from './dynamic-table-builder.js';
3
4
  export class DynamicModule {
4
5
  /**
5
6
  * Creates a dynamic reference to a column that is not know at compile time.
@@ -89,4 +90,40 @@ export class DynamicModule {
89
90
  ref(reference) {
90
91
  return new DynamicReferenceBuilder(reference);
91
92
  }
93
+ /**
94
+ * Creates a table reference to a table that's not fully known at compile time.
95
+ *
96
+ * The type `T` is allowed to be a union of multiple tables.
97
+ *
98
+ * <!-- siteExample("select", "Generic find query", 130) -->
99
+ *
100
+ * A generic type-safe helper function for finding a row by a column value:
101
+ *
102
+ * ```ts
103
+ * import { SelectType } from 'kysely'
104
+ * import { Database } from 'type-editor'
105
+ *
106
+ * async function getRowByColumn<
107
+ * T extends keyof Database,
108
+ * C extends keyof Database[T] & string,
109
+ * V extends SelectType<Database[T][C]>,
110
+ * >(t: T, c: C, v: V) {
111
+ * // We need to use the dynamic module since the table name
112
+ * // is not known at compile time.
113
+ * const { table, ref } = db.dynamic
114
+ *
115
+ * return await db
116
+ * .selectFrom(table(t).as('t'))
117
+ * .selectAll()
118
+ * .where(ref(c), '=', v)
119
+ * .orderBy('t.id')
120
+ * .executeTakeFirstOrThrow()
121
+ * }
122
+ *
123
+ * const person = await getRowByColumn('person', 'first_name', 'Arnold')
124
+ * ```
125
+ */
126
+ table(table) {
127
+ return new DynamicTableBuilder(table);
128
+ }
92
129
  }
@@ -1,6 +1,6 @@
1
1
  import { Expression } from '../expression/expression.js';
2
2
  import { RawBuilder } from '../raw-builder/raw-builder.js';
3
- import { Simplify } from '../util/type-utils.js';
3
+ import { ShallowDehydrateObject, ShallowDehydrateValue, Simplify } from '../util/type-utils.js';
4
4
  /**
5
5
  * An MS SQL Server helper for aggregating a subquery into a JSON array.
6
6
  *
@@ -73,7 +73,7 @@ import { Simplify } from '../util/type-utils.js';
73
73
  * from "person"
74
74
  * ```
75
75
  */
76
- export declare function jsonArrayFrom<O>(expr: Expression<O>): RawBuilder<Simplify<O>[]>;
76
+ export declare function jsonArrayFrom<O>(expr: Expression<O>): RawBuilder<Simplify<ShallowDehydrateObject<O>>[]>;
77
77
  /**
78
78
  * An MS SQL Server helper for turning a subquery into a JSON object.
79
79
  *
@@ -146,7 +146,7 @@ export declare function jsonArrayFrom<O>(expr: Expression<O>): RawBuilder<Simpli
146
146
  * from "person"
147
147
  * ```
148
148
  */
149
- export declare function jsonObjectFrom<O>(expr: Expression<O>): RawBuilder<Simplify<O> | null>;
149
+ export declare function jsonObjectFrom<O>(expr: Expression<O>): RawBuilder<Simplify<ShallowDehydrateObject<O>> | null>;
150
150
  /**
151
151
  * The MS SQL Server `json_query` function, single argument variant.
152
152
  *
@@ -208,5 +208,5 @@ export declare function jsonObjectFrom<O>(expr: Expression<O>): RawBuilder<Simpl
208
208
  * ```
209
209
  */
210
210
  export declare function jsonBuildObject<O extends Record<string, Expression<unknown>>>(obj: O): RawBuilder<Simplify<{
211
- [K in keyof O]: O[K] extends Expression<infer V> ? V : never;
211
+ [K in keyof O]: O[K] extends Expression<infer V> ? ShallowDehydrateValue<V> : never;
212
212
  }>>;
@@ -1,7 +1,7 @@
1
1
  import { Expression } from '../expression/expression.js';
2
2
  import { SelectQueryBuilderExpression } from '../query-builder/select-query-builder-expression.js';
3
3
  import { RawBuilder } from '../raw-builder/raw-builder.js';
4
- import { Simplify } from '../util/type-utils.js';
4
+ import { ShallowDehydrateObject, ShallowDehydrateValue, Simplify } from '../util/type-utils.js';
5
5
  /**
6
6
  * A MySQL helper for aggregating a subquery into a JSON array.
7
7
  *
@@ -50,7 +50,7 @@ import { Simplify } from '../util/type-utils.js';
50
50
  * from `person`
51
51
  * ```
52
52
  */
53
- export declare function jsonArrayFrom<O>(expr: SelectQueryBuilderExpression<O>): RawBuilder<Simplify<O>[]>;
53
+ export declare function jsonArrayFrom<O>(expr: SelectQueryBuilderExpression<O>): RawBuilder<Simplify<ShallowDehydrateObject<O>>[]>;
54
54
  /**
55
55
  * A MySQL helper for turning a subquery into a JSON object.
56
56
  *
@@ -101,7 +101,7 @@ export declare function jsonArrayFrom<O>(expr: SelectQueryBuilderExpression<O>):
101
101
  * from `person`
102
102
  * ```
103
103
  */
104
- export declare function jsonObjectFrom<O>(expr: SelectQueryBuilderExpression<O>): RawBuilder<Simplify<O> | null>;
104
+ export declare function jsonObjectFrom<O>(expr: SelectQueryBuilderExpression<O>): RawBuilder<Simplify<ShallowDehydrateObject<O>> | null>;
105
105
  /**
106
106
  * The MySQL `json_object` function.
107
107
  *
@@ -143,5 +143,5 @@ export declare function jsonObjectFrom<O>(expr: SelectQueryBuilderExpression<O>)
143
143
  * ```
144
144
  */
145
145
  export declare function jsonBuildObject<O extends Record<string, Expression<unknown>>>(obj: O): RawBuilder<Simplify<{
146
- [K in keyof O]: O[K] extends Expression<infer V> ? V : never;
146
+ [K in keyof O]: O[K] extends Expression<infer V> ? ShallowDehydrateValue<V> : never;
147
147
  }>>;
@@ -1,6 +1,6 @@
1
1
  import { Expression } from '../expression/expression.js';
2
2
  import { RawBuilder } from '../raw-builder/raw-builder.js';
3
- import { Simplify } from '../util/type-utils.js';
3
+ import { ShallowDehydrateValue, ShallowDehydrateObject, Simplify } from '../util/type-utils.js';
4
4
  /**
5
5
  * A postgres helper for aggregating a subquery (or other expression) into a JSONB array.
6
6
  *
@@ -50,7 +50,7 @@ import { Simplify } from '../util/type-utils.js';
50
50
  * from "person"
51
51
  * ```
52
52
  */
53
- export declare function jsonArrayFrom<O>(expr: Expression<O>): RawBuilder<Simplify<O>[]>;
53
+ export declare function jsonArrayFrom<O>(expr: Expression<O>): RawBuilder<Simplify<ShallowDehydrateObject<O>>[]>;
54
54
  /**
55
55
  * A postgres helper for turning a subquery (or other expression) into a JSON object.
56
56
  *
@@ -102,7 +102,7 @@ export declare function jsonArrayFrom<O>(expr: Expression<O>): RawBuilder<Simpli
102
102
  * from "person"
103
103
  * ```
104
104
  */
105
- export declare function jsonObjectFrom<O>(expr: Expression<O>): RawBuilder<Simplify<O> | null>;
105
+ export declare function jsonObjectFrom<O>(expr: Expression<O>): RawBuilder<Simplify<ShallowDehydrateObject<O>> | null>;
106
106
  /**
107
107
  * The PostgreSQL `json_build_object` function.
108
108
  *
@@ -147,7 +147,7 @@ export declare function jsonObjectFrom<O>(expr: Expression<O>): RawBuilder<Simpl
147
147
  * ```
148
148
  */
149
149
  export declare function jsonBuildObject<O extends Record<string, Expression<unknown>>>(obj: O): RawBuilder<Simplify<{
150
- [K in keyof O]: O[K] extends Expression<infer V> ? V : never;
150
+ [K in keyof O]: O[K] extends Expression<infer V> ? ShallowDehydrateValue<V> : never;
151
151
  }>>;
152
152
  export type MergeAction = 'INSERT' | 'UPDATE' | 'DELETE';
153
153
  /**
@@ -1,7 +1,7 @@
1
1
  import { Expression } from '../expression/expression.js';
2
2
  import { SelectQueryBuilderExpression } from '../query-builder/select-query-builder-expression.js';
3
3
  import { RawBuilder } from '../raw-builder/raw-builder.js';
4
- import { Simplify } from '../util/type-utils.js';
4
+ import { ShallowDehydrateObject, ShallowDehydrateValue, Simplify } from '../util/type-utils.js';
5
5
  /**
6
6
  * A SQLite helper for aggregating a subquery into a JSON array.
7
7
  *
@@ -63,7 +63,7 @@ import { Simplify } from '../util/type-utils.js';
63
63
  * from "person"
64
64
  * ```
65
65
  */
66
- export declare function jsonArrayFrom<O>(expr: SelectQueryBuilderExpression<O>): RawBuilder<Simplify<O>[]>;
66
+ export declare function jsonArrayFrom<O>(expr: SelectQueryBuilderExpression<O>): RawBuilder<Simplify<ShallowDehydrateObject<O>>[]>;
67
67
  /**
68
68
  * A SQLite helper for turning a subquery into a JSON object.
69
69
  *
@@ -127,7 +127,7 @@ export declare function jsonArrayFrom<O>(expr: SelectQueryBuilderExpression<O>):
127
127
  * from "person";
128
128
  * ```
129
129
  */
130
- export declare function jsonObjectFrom<O>(expr: SelectQueryBuilderExpression<O>): RawBuilder<Simplify<O> | null>;
130
+ export declare function jsonObjectFrom<O>(expr: SelectQueryBuilderExpression<O>): RawBuilder<Simplify<ShallowDehydrateObject<O>> | null>;
131
131
  /**
132
132
  * The SQLite `json_object` function.
133
133
  *
@@ -185,5 +185,5 @@ export declare function jsonObjectFrom<O>(expr: SelectQueryBuilderExpression<O>)
185
185
  * ```
186
186
  */
187
187
  export declare function jsonBuildObject<O extends Record<string, Expression<unknown>>>(obj: O): RawBuilder<Simplify<{
188
- [K in keyof O]: O[K] extends Expression<infer V> ? V : never;
188
+ [K in keyof O]: O[K] extends Expression<infer V> ? ShallowDehydrateValue<V> : never;
189
189
  }>>;
@@ -204,7 +204,7 @@ export * from './util/compilable.js';
204
204
  export * from './util/explainable.js';
205
205
  export * from './util/streamable.js';
206
206
  export * from './util/log.js';
207
- export { AnyAliasedColumn, AnyAliasedColumnWithTable, AnyColumn, AnyColumnWithTable, Equals, UnknownRow, Simplify, SqlBool, Nullable, NotNull, } from './util/type-utils.js';
207
+ export { AnyAliasedColumn, AnyAliasedColumnWithTable, AnyColumn, AnyColumnWithTable, Equals, UnknownRow, Simplify, SqlBool, Nullable, NotNull, ShallowDehydrateObject, ShallowDehydrateValue, StringsWhenDataTypeNotAvailable, } from './util/type-utils.js';
208
208
  export * from './util/infer-result.js';
209
209
  export { logOnce } from './util/log-once.js';
210
210
  export { createQueryId, QueryId } from './util/query-id.js';
@@ -18,6 +18,10 @@ import { Expression } from './expression/expression.js';
18
18
  import { DrainOuterGeneric } from './util/type-utils.js';
19
19
  import { ReleaseSavepoint, RollbackToSavepoint } from './parser/savepoint-parser.js';
20
20
  import { ControlledConnection } from './util/provide-controlled-connection.js';
21
+ declare global {
22
+ interface AsyncDisposable {
23
+ }
24
+ }
21
25
  /**
22
26
  * The main Kysely class.
23
27
  *
@@ -65,7 +69,7 @@ export declare class Kysely<DB> extends QueryCreator<DB> implements QueryExecuto
65
69
  * The {@link DynamicModule} module can be used to bypass strict typing and
66
70
  * passing in dynamic values for the queries.
67
71
  */
68
- get dynamic(): DynamicModule;
72
+ get dynamic(): DynamicModule<DB>;
69
73
  /**
70
74
  * Returns a {@link DatabaseIntrospector | database introspector}.
71
75
  */
@@ -17,6 +17,7 @@ import { CaseNode } from './operation-node/case-node.js';
17
17
  import { parseExpression } from './parser/expression-parser.js';
18
18
  import { WithSchemaPlugin } from './plugin/with-schema/with-schema-plugin.js';
19
19
  import { provideControlledConnection, } from './util/provide-controlled-connection.js';
20
+ import { logOnce } from './util/log-once.js';
20
21
  // @ts-ignore
21
22
  Symbol.asyncDispose ??= Symbol('Symbol.asyncDispose');
22
23
  /**
@@ -457,9 +458,14 @@ export class Kysely extends QueryCreator {
457
458
  *
458
459
  * See {@link https://github.com/kysely-org/kysely/blob/master/site/docs/recipes/0004-splitting-query-building-and-execution.md#execute-compiled-queries splitting build, compile and execute code recipe} for more information.
459
460
  */
460
- executeQuery(query, queryId = createQueryId()) {
461
+ executeQuery(query,
462
+ // TODO: remove this in the future. deprecated in 0.28.x
463
+ queryId) {
464
+ if (queryId !== undefined) {
465
+ logOnce('Passing `queryId` in `db.executeQuery` is deprecated and will result in a compile-time error in the future.');
466
+ }
461
467
  const compiledQuery = isCompilable(query) ? query.compile() : query;
462
- return this.getExecutor().executeQuery(compiledQuery, queryId);
468
+ return this.getExecutor().executeQuery(compiledQuery);
463
469
  }
464
470
  async [Symbol.asyncDispose]() {
465
471
  await this.destroy();
@@ -878,13 +884,13 @@ class NotCommittedOrRolledBackAssertingExecutor {
878
884
  provideConnection(consumer) {
879
885
  return this.#executor.provideConnection(consumer);
880
886
  }
881
- executeQuery(compiledQuery, queryId) {
887
+ executeQuery(compiledQuery) {
882
888
  assertNotCommittedOrRolledBack(this.#state);
883
- return this.#executor.executeQuery(compiledQuery, queryId);
889
+ return this.#executor.executeQuery(compiledQuery);
884
890
  }
885
- stream(compiledQuery, chunkSize, queryId) {
891
+ stream(compiledQuery, chunkSize) {
886
892
  assertNotCommittedOrRolledBack(this.#state);
887
- return this.#executor.stream(compiledQuery, chunkSize, queryId);
893
+ return this.#executor.stream(compiledQuery, chunkSize);
888
894
  }
889
895
  withConnectionProvider(connectionProvider) {
890
896
  return new NotCommittedOrRolledBackAssertingExecutor(this.#executor.withConnectionProvider(connectionProvider), this.#state);
@@ -1,7 +1,7 @@
1
1
  /// <reference types="./migrator.d.ts" />
2
2
  import { NoopPlugin } from '../plugin/noop-plugin.js';
3
3
  import { WithSchemaPlugin } from '../plugin/with-schema/with-schema-plugin.js';
4
- import { freeze, getLast } from '../util/object-utils.js';
4
+ import { freeze, getLast, isObject } from '../util/object-utils.js';
5
5
  export const DEFAULT_MIGRATION_TABLE = 'kysely_migration';
6
6
  export const DEFAULT_MIGRATION_LOCK_TABLE = 'kysely_migration_lock';
7
7
  export const DEFAULT_ALLOW_UNORDERED_MIGRATIONS = false;
@@ -176,7 +176,8 @@ export class Migrator {
176
176
  */
177
177
  async migrateTo(targetMigrationName) {
178
178
  return this.#migrate(({ migrations, executedMigrations, pendingMigrations, }) => {
179
- if (targetMigrationName === NO_MIGRATIONS) {
179
+ if (isObject(targetMigrationName) &&
180
+ targetMigrationName.__noMigrations__ === true) {
180
181
  return { direction: 'Down', step: Infinity };
181
182
  }
182
183
  if (!migrations.find((m) => m.name === targetMigrationName)) {
@@ -2,4 +2,8 @@ import type { DeleteQueryBuilder } from '../query-builder/delete-query-builder.j
2
2
  import type { DeleteResult } from '../query-builder/delete-result.js';
3
3
  import type { ShallowRecord } from '../util/type-utils.js';
4
4
  import type { ExtractTableAlias, From, FromTables, TableExpressionOrList } from './table-parser.js';
5
- export type DeleteFrom<DB, TE extends TableExpressionOrList<DB, never>> = TE extends ReadonlyArray<infer T> ? DeleteQueryBuilder<From<DB, T>, FromTables<DB, never, T>, DeleteResult> : TE extends keyof DB & string ? DeleteQueryBuilder<DB, ExtractTableAlias<DB, TE>, DeleteResult> : TE extends `${infer T} as ${infer A}` ? T extends keyof DB ? DeleteQueryBuilder<DB & ShallowRecord<A, DB[T]>, A, DeleteResult> : never : DeleteQueryBuilder<From<DB, TE>, FromTables<DB, never, TE>, DeleteResult>;
5
+ export type DeleteFrom<DB, TE extends TableExpressionOrList<DB, never>> = [
6
+ TE
7
+ ] extends [keyof DB] ? DeleteQueryBuilder<DB, ExtractTableAlias<DB, TE>, DeleteResult> : [
8
+ TE
9
+ ] extends [`${infer T} as ${infer A}`] ? T extends keyof DB ? DeleteQueryBuilder<DB & ShallowRecord<A, DB[T]>, A, DeleteResult> : never : TE extends ReadonlyArray<infer T> ? DeleteQueryBuilder<From<DB, T>, FromTables<DB, never, T>, DeleteResult> : DeleteQueryBuilder<From<DB, TE>, FromTables<DB, never, TE>, DeleteResult>;
@@ -2,4 +2,6 @@ import type { MergeQueryBuilder } from '../query-builder/merge-query-builder.js'
2
2
  import type { MergeResult } from '../query-builder/merge-result.js';
3
3
  import type { ShallowRecord } from '../util/type-utils.js';
4
4
  import type { ExtractTableAlias, SimpleTableReference } from './table-parser.js';
5
- export type MergeInto<DB, TE extends SimpleTableReference<DB>> = TE extends keyof DB & string ? MergeQueryBuilder<DB, ExtractTableAlias<DB, TE>, MergeResult> : TE extends `${infer T} as ${infer A}` ? T extends keyof DB ? MergeQueryBuilder<DB & ShallowRecord<A, DB[T]>, A, MergeResult> : never : never;
5
+ export type MergeInto<DB, TE extends SimpleTableReference<DB>> = [TE] extends [
6
+ keyof DB
7
+ ] ? MergeQueryBuilder<DB, ExtractTableAlias<DB, TE>, MergeResult> : [TE] extends [`${infer T} as ${infer A}`] ? T extends keyof DB ? MergeQueryBuilder<DB & ShallowRecord<A, DB[T]>, A, MergeResult> : never : never;
@@ -1,4 +1,6 @@
1
1
  import type { SelectQueryBuilder } from '../query-builder/select-query-builder.js';
2
2
  import type { ShallowRecord } from '../util/type-utils.js';
3
3
  import type { ExtractTableAlias, From, FromTables, TableExpressionOrList } from './table-parser.js';
4
- export type SelectFrom<DB, TB extends keyof DB, TE extends TableExpressionOrList<DB, TB>> = TE extends keyof DB & string ? SelectQueryBuilder<DB, TB | ExtractTableAlias<DB, TE>, {}> : TE extends `${infer T} as ${infer A}` ? T extends keyof DB ? SelectQueryBuilder<DB & ShallowRecord<A, DB[T]>, TB | A, {}> : never : TE extends ReadonlyArray<infer T> ? SelectQueryBuilder<From<DB, T>, FromTables<DB, TB, T>, {}> : SelectQueryBuilder<From<DB, TE>, FromTables<DB, TB, TE>, {}>;
4
+ export type SelectFrom<DB, TB extends keyof DB, TE extends TableExpressionOrList<DB, TB>> = [TE] extends [keyof DB] ? SelectQueryBuilder<DB, TB | ExtractTableAlias<DB, TE>, {}> : [
5
+ TE
6
+ ] extends [`${infer T} as ${infer A}`] ? T extends keyof DB ? SelectQueryBuilder<DB & ShallowRecord<A, DB[T]>, TB | A, {}> : never : TE extends ReadonlyArray<infer T> ? SelectQueryBuilder<From<DB, T>, FromTables<DB, TB, T>, {}> : SelectQueryBuilder<From<DB, TE>, FromTables<DB, TB, TE>, {}>;