kysely 0.27.3 → 0.27.4

package/dist/cjs/query-creator.d.ts

@@ -125,10 +125,10 @@ export declare class QueryCreator<DB> {
      * ```
      */
     selectFrom<TE extends keyof DB & string>(from: TE[]): SelectQueryBuilder<DB, ExtractTableAlias<DB, TE>, {}>;
-    selectFrom<TE extends TableExpression<DB, keyof DB>>(from: TE[]): SelectQueryBuilder<From<DB, TE>, FromTables<DB, never, TE>, {}>;
+    selectFrom<TE extends TableExpression<DB, never>>(from: TE[]): SelectQueryBuilder<From<DB, TE>, FromTables<DB, never, TE>, {}>;
     selectFrom<TE extends keyof DB & string>(from: TE): SelectQueryBuilder<DB, ExtractTableAlias<DB, TE>, {}>;
     selectFrom<TE extends AnyAliasedTable<DB>>(from: TE): SelectQueryBuilder<DB & PickTableWithAlias<DB, TE>, ExtractTableAlias<DB & PickTableWithAlias<DB, TE>, TE>, {}>;
-    selectFrom<TE extends TableExpression<DB, keyof DB>>(from: TE): SelectQueryBuilder<From<DB, TE>, FromTables<DB, never, TE>, {}>;
+    selectFrom<TE extends TableExpression<DB, never>>(from: TE): SelectQueryBuilder<From<DB, TE>, FromTables<DB, never, TE>, {}>;
     /**
      * Creates a `select` query builder without a `from` clause.
      *
@@ -365,24 +365,77 @@ export declare class QueryCreator<DB> {
      *
      * ### Examples
      *
+     * <!-- siteExample("cte", "Simple selects", 10) -->
+     *
+     * Common table expressions (CTE) are a great way to modularize complex queries.
+     * Essentially they allow you to run multiple separate queries within a
+     * single roundtrip to the DB.
+     *
+     * Since CTEs are a part of the main query, query optimizers inside DB
+     * engines are able to optimize the overall query. For example, postgres
+     * is able to inline the CTEs inside the using queries if it decides it's
+     * faster.
+     *
      * ```ts
-     * await db
+     * const result = await db
+     *   // Create a CTE called `jennifers` that selects all
+     *   // persons named 'Jennifer'.
      *   .with('jennifers', (db) => db
      *     .selectFrom('person')
      *     .where('first_name', '=', 'Jennifer')
      *     .select(['id', 'age'])
      *   )
+     *   // Select all rows from the `jennifers` CTE and
+     *   // further filter it.
      *   .with('adult_jennifers', (db) => db
      *     .selectFrom('jennifers')
      *     .where('age', '>', 18)
      *     .select(['id', 'age'])
      *   )
+     *   // Finally select all adult jennifers that are
+     *   // also younger than 60.
      *   .selectFrom('adult_jennifers')
      *   .where('age', '<', 60)
      *   .selectAll()
      *   .execute()
      * ```
      *
+     * <!-- siteExample("cte", "Inserts, updates and deletions", 20) -->
+     *
+     * Some databases like postgres also allow you to run other queries than selects
+     * in CTEs. On these databases CTEs are extremely powerful:
+     *
+     * ```ts
+     * const result = await db
+     *   .with('new_person', (db) => db
+     *     .insertInto('person')
+     *     .values({
+     *       first_name: 'Jennifer',
+     *       age: 35,
+     *     })
+     *     .returning('id')
+     *   )
+     *   .with('new_pet', (db) => db
+     *     .insertInto('pet')
+     *     .values({
+     *       name: 'Doggo',
+     *       species: 'dog',
+     *       is_favorite: true,
+     *       // Use the id of the person we just inserted.
+     *       owner_id: db
+     *         .selectFrom('new_person')
+     *         .select('id')
+     *     })
+     *     .returning('id')
+     *   )
+     *   .selectFrom(['new_person', 'new_pet'])
+     *   .select([
+     *     'new_person.id as person_id',
+     *     'new_pet.id as pet_id'
+     *   ])
+     *   .execute()
+     * ```
+     *
      * The CTE name can optionally specify column names in addition to
      * a name. In that case Kysely requires the expression to retun
      * rows with the same columns.

package/dist/cjs/query-creator.js

@@ -141,24 +141,77 @@ class QueryCreator {
      *
      * ### Examples
      *
+     * <!-- siteExample("cte", "Simple selects", 10) -->
+     *
+     * Common table expressions (CTE) are a great way to modularize complex queries.
+     * Essentially they allow you to run multiple separate queries within a
+     * single roundtrip to the DB.
+     *
+     * Since CTEs are a part of the main query, query optimizers inside DB
+     * engines are able to optimize the overall query. For example, postgres
+     * is able to inline the CTEs inside the using queries if it decides it's
+     * faster.
+     *
      * ```ts
-     * await db
+     * const result = await db
+     *   // Create a CTE called `jennifers` that selects all
+     *   // persons named 'Jennifer'.
      *   .with('jennifers', (db) => db
      *     .selectFrom('person')
      *     .where('first_name', '=', 'Jennifer')
      *     .select(['id', 'age'])
      *   )
+     *   // Select all rows from the `jennifers` CTE and
+     *   // further filter it.
      *   .with('adult_jennifers', (db) => db
      *     .selectFrom('jennifers')
      *     .where('age', '>', 18)
      *     .select(['id', 'age'])
      *   )
+     *   // Finally select all adult jennifers that are
+     *   // also younger than 60.
      *   .selectFrom('adult_jennifers')
      *   .where('age', '<', 60)
      *   .selectAll()
      *   .execute()
      * ```
      *
+     * <!-- siteExample("cte", "Inserts, updates and deletions", 20) -->
+     *
+     * Some databases like postgres also allow you to run other queries than selects
+     * in CTEs. On these databases CTEs are extremely powerful:
+     *
+     * ```ts
+     * const result = await db
+     *   .with('new_person', (db) => db
+     *     .insertInto('person')
+     *     .values({
+     *       first_name: 'Jennifer',
+     *       age: 35,
+     *     })
+     *     .returning('id')
+     *   )
+     *   .with('new_pet', (db) => db
+     *     .insertInto('pet')
+     *     .values({
+     *       name: 'Doggo',
+     *       species: 'dog',
+     *       is_favorite: true,
+     *       // Use the id of the person we just inserted.
+     *       owner_id: db
+     *         .selectFrom('new_person')
+     *         .select('id')
+     *     })
+     *     .returning('id')
+     *   )
+     *   .selectFrom(['new_person', 'new_pet'])
+     *   .select([
+     *     'new_person.id as person_id',
+     *     'new_pet.id as pet_id'
+     *   ])
+     *   .execute()
+     * ```
+     *
      * The CTE name can optionally specify column names in addition to
      * a name. In that case Kysely requires the expression to retun
      * rows with the same columns.

package/dist/cjs/raw-builder/raw-builder.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createRawBuilder = void 0;
+exports.createRawBuilder = createRawBuilder;
 const alias_node_js_1 = require("../operation-node/alias-node.js");
 const prevent_await_js_1 = require("../util/prevent-await.js");
 const object_utils_js_1 = require("../util/object-utils.js");
@@ -63,7 +63,6 @@ class RawBuilderImpl {
 function createRawBuilder(props) {
     return new RawBuilderImpl(props);
 }
-exports.createRawBuilder = createRawBuilder;
 (0, prevent_await_js_1.preventAwait)(RawBuilderImpl, "don't await RawBuilder instances directly. To execute the query you need to call `execute`");
 class AliasedRawBuilderImpl {
     #rawBuilder;

package/dist/cjs/raw-builder/sql.d.ts

@@ -33,12 +33,12 @@ export interface Sql {
      *     // method to give it an alias.
      *     sql<string>`concat(first_name, ' ', last_name)`.as('full_name')
      *   )
-     *   .where(sql`birthdate between ${date1} and ${date2}`)
+     *   .where(sql<boolean>`birthdate between ${date1} and ${date2}`)
      *   // Here we assume we have list of nicknames for the person
      *   // (a list of strings) and we use the PostgreSQL `@>` operator
      *   // to test if all of them are valid nicknames for the user.
-     *   .where('nicknames', '@>', sql`ARRAY[${sql.join(nicknames)}]`)
-     *   .orderBy(sql`concat(first_name, ' ', last_name)`)
+     *   .where('nicknames', '@>', sql<string[]>`ARRAY[${sql.join(nicknames)}]`)
+     *   .orderBy(sql<string>`concat(first_name, ' ', last_name)`)
      *   .execute()
      * ```
      *
@@ -63,7 +63,7 @@ export interface Sql {
      *
      * ```ts
      * const petName = db.selectFrom('pet').select('name').limit(1)
-     * const fullName = sql`concat(first_name, ' ', last_name)`
+     * const fullName = sql<string>`concat(first_name, ' ', last_name)`
      *
      * sql`
      *   select ${fullName} as full_name, ${petName} as pet_name
@@ -301,7 +301,7 @@ export interface Sql {
      *   return db
      *     .selectFrom('person')
      *     .selectAll()
-     *     .where('nicknames', '@>', sql`ARRAY[${sql.join(nicknames)}]`)
+     *     .where('nicknames', '@>', sql<string[]>`ARRAY[${sql.join(nicknames)}]`)
      *     .execute()
      * }
      * ```

package/dist/cjs/schema/alter-column-builder.js

@@ -4,6 +4,7 @@ exports.AlteredColumnBuilder = exports.AlterColumnBuilder = void 0;
 const alter_column_node_js_1 = require("../operation-node/alter-column-node.js");
 const data_type_parser_js_1 = require("../parser/data-type-parser.js");
 const default_value_parser_js_1 = require("../parser/default-value-parser.js");
+const prevent_await_js_1 = require("../util/prevent-await.js");
 class AlterColumnBuilder {
     #column;
     constructor(column) {
@@ -33,6 +34,7 @@ class AlterColumnBuilder {
     }
 }
 exports.AlterColumnBuilder = AlterColumnBuilder;
+(0, prevent_await_js_1.preventAwait)(AlterColumnBuilder, "don't await AlterColumnBuilder instances");
 /**
  * Allows us to force consumers to do exactly one alteration to a column.
  *
@@ -58,3 +60,4 @@ class AlteredColumnBuilder {
     }
 }
 exports.AlteredColumnBuilder = AlteredColumnBuilder;
+(0, prevent_await_js_1.preventAwait)(AlteredColumnBuilder, "don't await AlteredColumnBuilder instances");

package/dist/cjs/schema/alter-table-add-index-builder.d.ts

@@ -72,7 +72,7 @@ export declare class AlterTableAddIndexBuilder implements OperationNodeSource, C
      * await db.schema
      *   .alterTable('person')
      *   .addIndex('person_first_name_index')
-     *   .expression(sql`(first_name < 'Sami')`)
+     *   .expression(sql<boolean>`(first_name < 'Sami')`)
      *   .execute()
      * ```
      *

package/dist/cjs/schema/alter-table-add-index-builder.js

@@ -99,7 +99,7 @@ class AlterTableAddIndexBuilder {
      * await db.schema
      *   .alterTable('person')
      *   .addIndex('person_first_name_index')
-     *   .expression(sql`(first_name < 'Sami')`)
+     *   .expression(sql<boolean>`(first_name < 'Sami')`)
      *   .execute()
      * ```
      *

package/dist/cjs/schema/alter-table-builder.js

@@ -203,6 +203,7 @@ class AlterTableBuilder {
     }
 }
 exports.AlterTableBuilder = AlterTableBuilder;
+(0, prevent_await_js_1.preventAwait)(AlterTableBuilder, "don't await AlterTableBuilder instances");
 class AlterTableColumnAlteringBuilder {
     #props;
     constructor(props) {
@@ -252,6 +253,4 @@ class AlterTableColumnAlteringBuilder {
     }
 }
 exports.AlterTableColumnAlteringBuilder = AlterTableColumnAlteringBuilder;
-(0, prevent_await_js_1.preventAwait)(AlterTableBuilder, "don't await AlterTableBuilder instances");
-(0, prevent_await_js_1.preventAwait)(alter_column_builder_js_1.AlterColumnBuilder, "don't await AlterColumnBuilder instances");
 (0, prevent_await_js_1.preventAwait)(AlterTableColumnAlteringBuilder, "don't await AlterTableColumnAlteringBuilder instances directly. To execute the query you need to call `execute`");

package/dist/cjs/schema/column-definition-builder.d.ts

@@ -220,6 +220,11 @@ export declare class ColumnDefinitionBuilder implements OperationNodeSource {
      * ```
      */
     nullsNotDistinct(): ColumnDefinitionBuilder;
+    /**
+     * Adds `if not exists` specifier.
+     * This only works for PostgreSQL.
+     */
+    ifNotExists(): ColumnDefinitionBuilder;
     /**
      * This can be used to add any additional SQL to the end of the column definition.
      *

package/dist/cjs/schema/column-definition-builder.js

@@ -299,6 +299,13 @@ class ColumnDefinitionBuilder {
     nullsNotDistinct() {
         return new ColumnDefinitionBuilder(column_definition_node_js_1.ColumnDefinitionNode.cloneWith(this.#node, { nullsNotDistinct: true }));
     }
+    /**
+     * Adds `if not exists` specifier.
+     * This only works for PostgreSQL.
+     */
+    ifNotExists() {
+        return new ColumnDefinitionBuilder(column_definition_node_js_1.ColumnDefinitionNode.cloneWith(this.#node, { ifNotExists: true }));
+    }
     /**
      * This can be used to add any additional SQL to the end of the column definition.
      *

package/dist/cjs/util/assert.js

@@ -1,15 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.assertIsString = exports.assertNotNullOrUndefined = void 0;
+exports.assertNotNullOrUndefined = assertNotNullOrUndefined;
+exports.assertIsString = assertIsString;
 function assertNotNullOrUndefined(value) {
     if (value === null || value === undefined) {
         throw new Error(`${value} must not be null or undefined`);
     }
 }
-exports.assertNotNullOrUndefined = assertNotNullOrUndefined;
 function assertIsString(value) {
     if (typeof value !== 'string') {
         throw new Error(`${value} must be a string`);
     }
 }
-exports.assertIsString = assertIsString;

package/dist/cjs/util/compilable.js

@@ -1,8 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isCompilable = void 0;
+exports.isCompilable = isCompilable;
 const object_utils_js_1 = require("./object-utils.js");
 function isCompilable(value) {
     return (0, object_utils_js_1.isObject)(value) && (0, object_utils_js_1.isFunction)(value.compile);
 }
-exports.isCompilable = isCompilable;

package/dist/cjs/util/json-object-args.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getJsonObjectArgs = void 0;
+exports.getJsonObjectArgs = getJsonObjectArgs;
 const expression_wrapper_js_1 = require("../expression/expression-wrapper.js");
 const alias_node_js_1 = require("../operation-node/alias-node.js");
 const column_node_js_1 = require("../operation-node/column-node.js");
@@ -26,7 +26,6 @@ function getJsonObjectArgs(node, table) {
     }
     return args;
 }
-exports.getJsonObjectArgs = getJsonObjectArgs;
 function colName(col) {
     return new expression_wrapper_js_1.ExpressionWrapper(value_node_js_1.ValueNode.createImmediate(col));
 }

package/dist/cjs/util/log-once.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.logOnce = void 0;
+exports.logOnce = logOnce;
 const LOGGED_MESSAGES = new Set();
 /**
  * Use for system-level logging, such as deprecation messages.
@@ -13,4 +13,3 @@ function logOnce(message) {
     LOGGED_MESSAGES.add(message);
     console.log(message);
 }
-exports.logOnce = logOnce;

package/dist/cjs/util/object-utils.js

@@ -1,6 +1,25 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.compare = exports.noop = exports.isReadonlyArray = exports.asReadonlyArray = exports.asArray = exports.freeze = exports.getLast = exports.isPlainObject = exports.isArrayBufferOrView = exports.isObject = exports.isFunction = exports.isBuffer = exports.isBigInt = exports.isDate = exports.isNull = exports.isBoolean = exports.isNumber = exports.isString = exports.isUndefined = exports.isEmpty = void 0;
+exports.isEmpty = isEmpty;
+exports.isUndefined = isUndefined;
+exports.isString = isString;
+exports.isNumber = isNumber;
+exports.isBoolean = isBoolean;
+exports.isNull = isNull;
+exports.isDate = isDate;
+exports.isBigInt = isBigInt;
+exports.isBuffer = isBuffer;
+exports.isFunction = isFunction;
+exports.isObject = isObject;
+exports.isArrayBufferOrView = isArrayBufferOrView;
+exports.isPlainObject = isPlainObject;
+exports.getLast = getLast;
+exports.freeze = freeze;
+exports.asArray = asArray;
+exports.asReadonlyArray = asReadonlyArray;
+exports.isReadonlyArray = isReadonlyArray;
+exports.noop = noop;
+exports.compare = compare;
 function isEmpty(obj) {
     if (Array.isArray(obj) || isString(obj) || isBuffer(obj)) {
         return obj.length === 0;
@@ -10,69 +29,60 @@ function isEmpty(obj) {
     }
     return false;
 }
-exports.isEmpty = isEmpty;
 function isUndefined(obj) {
     return typeof obj === 'undefined' || obj === undefined;
 }
-exports.isUndefined = isUndefined;
 function isString(obj) {
     return typeof obj === 'string';
 }
-exports.isString = isString;
 function isNumber(obj) {
     return typeof obj === 'number';
 }
-exports.isNumber = isNumber;
 function isBoolean(obj) {
     return typeof obj === 'boolean';
 }
-exports.isBoolean = isBoolean;
 function isNull(obj) {
     return obj === null;
 }
-exports.isNull = isNull;
 function isDate(obj) {
     return obj instanceof Date;
 }
-exports.isDate = isDate;
 function isBigInt(obj) {
     return typeof obj === 'bigint';
 }
-exports.isBigInt = isBigInt;
 // Don't change the returnd type to `obj is Buffer` to not create a
 // hard dependency to node.
 function isBuffer(obj) {
     return typeof Buffer !== 'undefined' && Buffer.isBuffer(obj);
 }
-exports.isBuffer = isBuffer;
 function isFunction(obj) {
     return typeof obj === 'function';
 }
-exports.isFunction = isFunction;
 function isObject(obj) {
     return typeof obj === 'object' && obj !== null;
 }
-exports.isObject = isObject;
 function isArrayBufferOrView(obj) {
     return obj instanceof ArrayBuffer || ArrayBuffer.isView(obj);
 }
-exports.isArrayBufferOrView = isArrayBufferOrView;
 function isPlainObject(obj) {
-    return (isObject(obj) &&
-        !Array.isArray(obj) &&
-        !isDate(obj) &&
-        !isBuffer(obj) &&
-        !isArrayBufferOrView(obj));
+    if (!isObject(obj) || getTag(obj) !== '[object Object]') {
+        return false;
+    }
+    if (Object.getPrototypeOf(obj) === null) {
+        return true;
+    }
+    let proto = obj;
+    while (Object.getPrototypeOf(proto) !== null) {
+        proto = Object.getPrototypeOf(proto);
+    }
+    return Object.getPrototypeOf(obj) === proto;
 }
-exports.isPlainObject = isPlainObject;
 function getLast(arr) {
     return arr[arr.length - 1];
 }
-exports.getLast = getLast;
 function freeze(obj) {
     return Object.freeze(obj);
 }
-exports.freeze = freeze;
 function asArray(arg) {
     if (isReadonlyArray(arg)) {
         return arg;
@@ -81,7 +91,6 @@ function asArray(arg) {
         return [arg];
     }
 }
-exports.asArray = asArray;
 function asReadonlyArray(arg) {
     if (isReadonlyArray(arg)) {
         return arg;
@@ -90,15 +99,12 @@ function asReadonlyArray(arg) {
         return freeze([arg]);
     }
 }
-exports.asReadonlyArray = asReadonlyArray;
 function isReadonlyArray(arg) {
     return Array.isArray(arg);
 }
-exports.isReadonlyArray = isReadonlyArray;
 function noop(obj) {
     return obj;
 }
-exports.noop = noop;
 function compare(obj1, obj2) {
     if (isReadonlyArray(obj1) && isReadonlyArray(obj2)) {
         return compareArrays(obj1, obj2);
@@ -108,7 +114,6 @@ function compare(obj1, obj2) {
     }
     return obj1 === obj2;
 }
-exports.compare = compare;
 function compareArrays(arr1, arr2) {
     if (arr1.length !== arr2.length) {
         return false;
@@ -148,3 +153,10 @@ function compareGenericObjects(obj1, obj2) {
     }
     return true;
 }
+const toString = Object.prototype.toString;
+function getTag(value) {
+    if (value == null) {
+        return value === undefined ? '[object Undefined]' : '[object Null]';
+    }
+    return toString.call(value);
+}

package/dist/cjs/util/performance-now.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.performanceNow = void 0;
+exports.performanceNow = performanceNow;
 const object_utils_js_1 = require("./object-utils.js");
 function performanceNow() {
     if (typeof performance !== 'undefined' && (0, object_utils_js_1.isFunction)(performance.now)) {
@@ -10,4 +10,3 @@ function performanceNow() {
         return Date.now();
     }
 }
-exports.performanceNow = performanceNow;

package/dist/cjs/util/prevent-await.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.preventAwait = void 0;
+exports.preventAwait = preventAwait;
 function preventAwait(clazz, message) {
     Object.defineProperties(clazz.prototype, {
         then: {
@@ -11,4 +11,3 @@ function preventAwait(clazz, message) {
         },
     });
 }
-exports.preventAwait = preventAwait;

package/dist/cjs/util/query-id.js

@@ -1,11 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createQueryId = void 0;
+exports.createQueryId = createQueryId;
 const random_string_js_1 = require("./random-string.js");
 function createQueryId() {
     return new LazyQueryId();
 }
-exports.createQueryId = createQueryId;
 class LazyQueryId {
     #queryId;
     get queryId() {

package/dist/cjs/util/random-string.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.randomString = void 0;
+exports.randomString = randomString;
 const CHARS = [
     'A',
     'B',
@@ -72,7 +72,6 @@ function randomString(length) {
     }
     return chars;
 }
-exports.randomString = randomString;
 function randomChar() {
     return CHARS[~~(Math.random() * CHARS.length)];
 }

package/dist/cjs/util/require-all-props.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.requireAllProps = void 0;
+exports.requireAllProps = requireAllProps;
 /**
  * Helper function to check listed properties according to given type. Check if all properties has been used when object is initialised.
  *
@@ -37,4 +37,3 @@ exports.requireAllProps = void 0;
 function requireAllProps(obj) {
     return obj;
 }
-exports.requireAllProps = requireAllProps;

package/dist/cjs/util/stack-trace-utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.extendStackTrace = void 0;
+exports.extendStackTrace = extendStackTrace;
 const object_utils_js_1 = require("./object-utils.js");
 function extendStackTrace(err, stackError) {
     if (isStackHolder(err) && stackError.stack) {
@@ -11,7 +11,6 @@ function extendStackTrace(err, stackError) {
     }
     return err;
 }
-exports.extendStackTrace = extendStackTrace;
 function isStackHolder(obj) {
     return (0, object_utils_js_1.isObject)(obj) && (0, object_utils_js_1.isString)(obj.stack);
 }

package/dist/esm/dialect/dialect-adapter-base.d.ts

@@ -2,7 +2,7 @@ import { Kysely } from '../kysely.js';
 import { DialectAdapter, MigrationLockOptions } from './dialect-adapter.js';
 /**
  * A basic implementation of `DialectAdapter` with sensible default values.
- * 3rd party dialects can extend this instead of implementing the `DialectAdapter`
+ * Third-party dialects can extend this instead of implementing the `DialectAdapter`
  * interface from scratch. That way all new settings will get default values when
  * they are added and there will be less breaking changes.
  */
@@ -26,6 +26,7 @@ export declare abstract class DialectAdapterBase implements DialectAdapter {
      * updates and deletes.
      */
     get supportsReturning(): boolean;
+    get supportsOutput(): boolean;
     /**
      * This method is used to acquire a lock for the migrations so that
      * it's not possible for two migration operations to run in parallel.

package/dist/esm/dialect/dialect-adapter-base.js

@@ -1,7 +1,7 @@
 /// <reference types="./dialect-adapter-base.d.ts" />
 /**
  * A basic implementation of `DialectAdapter` with sensible default values.
- * 3rd party dialects can extend this instead of implementing the `DialectAdapter`
+ * Third-party dialects can extend this instead of implementing the `DialectAdapter`
  * interface from scratch. That way all new settings will get default values when
  * they are added and there will be less breaking changes.
  */
@@ -15,4 +15,7 @@ export class DialectAdapterBase {
     get supportsReturning() {
         return false;
     }
+    get supportsOutput() {
+        return false;
+    }
 }

package/dist/esm/dialect/dialect-adapter.d.ts

@@ -27,6 +27,11 @@ export interface DialectAdapter {
      * updates and deletes.
      */
     readonly supportsReturning: boolean;
+    /**
+     * Whether or not this dialect supports the `output` clause in inserts
+     * updates and deletes.
+     */
+    readonly supportsOutput?: boolean;
     /**
      * This method is used to acquire a lock for the migrations so that
      * it's not possible for two migration operations to run in parallel.

package/dist/esm/dialect/mssql/mssql-adapter.d.ts

@@ -15,11 +15,7 @@ export declare class MssqlAdapter extends DialectAdapterBase {
      * If this is true, migrations are executed inside a transaction.
      */
     get supportsTransactionalDdl(): boolean;
-    /**
-     * Whether or not this dialect supports the `returning` in inserts
-     * updates and deletes.
-     */
-    get supportsReturning(): boolean;
+    get supportsOutput(): boolean;
     /**
      * This method is used to acquire a lock for the migrations so that
      * it's not possible for two migration operations to run in parallel.