kysely 0.13.0 → 0.15.1

package/dist/esm/index.d.ts

@@ -15,6 +15,7 @@ export * from './query-builder/function-builder.js';
 export * from './query-builder/insert-result.js';
 export * from './query-builder/delete-result.js';
 export * from './query-builder/update-result.js';
+export * from './query-builder/on-conflict-builder.js';
 export * from './raw-builder/raw-builder.js';
 export * from './query-executor/query-executor.js';
 export * from './query-executor/default-query-executor.js';
@@ -56,7 +57,8 @@ export * from './dialect/sqlite/sqlite-introspector.js';
 export * from './dialect/sqlite/sqlite-adapter.js';
 export * from './query-compiler/default-query-compiler.js';
 export * from './query-compiler/query-compiler.js';
-export * from './migration/migration.js';
+export * from './migration/migrator.js';
+export * from './migration/file-migration-provider.js';
 export * from './dialect/dialect.js';
 export * from './dialect/dialect-adapter.js';
 export * from './dialect/dialect-adapter-base.js';
@@ -91,7 +93,7 @@ export * from './operation-node/drop-view-node.js';
 export * from './operation-node/filter-node.js';
 export * from './operation-node/foreign-key-constraint-node.js';
 export * from './operation-node/from-node.js';
-export * from './operation-node/generated-always-as-node.js';
+export * from './operation-node/generated-node.js';
 export * from './operation-node/group-by-item-node.js';
 export * from './operation-node/group-by-node.js';
 export * from './operation-node/having-node.js';
@@ -136,7 +138,8 @@ export * from './operation-node/value-node.js';
 export * from './operation-node/values-node.js';
 export * from './operation-node/where-node.js';
 export * from './operation-node/with-node.js';
-export * from './introspection/database-introspector.js';
+export * from './dialect/database-introspector.js';
+export * from './util/column-type.js';
 export * from './util/compilable.js';
 export * from './util/log.js';
 export { AnyColumn, UnknownRow, AnySelectQueryBuilder, } from './util/type-utils.js';

package/dist/esm/index.js

@@ -15,6 +15,7 @@ export * from './query-builder/function-builder.js';
 export * from './query-builder/insert-result.js';
 export * from './query-builder/delete-result.js';
 export * from './query-builder/update-result.js';
+export * from './query-builder/on-conflict-builder.js';
 export * from './raw-builder/raw-builder.js';
 export * from './query-executor/query-executor.js';
 export * from './query-executor/default-query-executor.js';
@@ -56,7 +57,8 @@ export * from './dialect/sqlite/sqlite-introspector.js';
 export * from './dialect/sqlite/sqlite-adapter.js';
 export * from './query-compiler/default-query-compiler.js';
 export * from './query-compiler/query-compiler.js';
-export * from './migration/migration.js';
+export * from './migration/migrator.js';
+export * from './migration/file-migration-provider.js';
 export * from './dialect/dialect.js';
 export * from './dialect/dialect-adapter.js';
 export * from './dialect/dialect-adapter-base.js';
@@ -91,7 +93,7 @@ export * from './operation-node/drop-view-node.js';
 export * from './operation-node/filter-node.js';
 export * from './operation-node/foreign-key-constraint-node.js';
 export * from './operation-node/from-node.js';
-export * from './operation-node/generated-always-as-node.js';
+export * from './operation-node/generated-node.js';
 export * from './operation-node/group-by-item-node.js';
 export * from './operation-node/group-by-node.js';
 export * from './operation-node/having-node.js';
@@ -136,6 +138,7 @@ export * from './operation-node/value-node.js';
 export * from './operation-node/values-node.js';
 export * from './operation-node/where-node.js';
 export * from './operation-node/with-node.js';
-export * from './introspection/database-introspector.js';
+export * from './dialect/database-introspector.js';
+export * from './util/column-type.js';
 export * from './util/compilable.js';
 export * from './util/log.js';

package/dist/esm/kysely.d.ts

@@ -1,16 +1,16 @@
 import { Dialect } from './dialect/dialect.js';
 import { SchemaModule } from './schema/schema.js';
 import { DynamicModule } from './dynamic/dynamic.js';
-import { MigrationModule } from './migration/migration.js';
 import { QueryExecutor } from './query-executor/query-executor.js';
 import { QueryCreator } from './query-creator.js';
 import { KyselyPlugin } from './plugin/kysely-plugin.js';
-import { GeneratedPlaceholder } from './util/type-utils.js';
-import { DatabaseIntrospector } from './introspection/database-introspector.js';
+import { DatabaseIntrospector } from './dialect/database-introspector.js';
 import { Driver, IsolationLevel } from './driver/driver.js';
 import { ParseContext } from './parser/parse-context.js';
 import { FunctionBuilder } from './query-builder/function-builder.js';
 import { LogConfig } from './util/log.js';
+import { PRIVATE_ADAPTER } from './util/private-symbols.js';
+import { DialectAdapter } from './dialect/dialect-adapter.js';
 /**
  * The main Kysely class.
  *
@@ -60,10 +60,6 @@ export declare class Kysely<DB> extends QueryCreator<DB> {
      * Returns the {@link SchemaModule} module for building database schema.
      */
     get schema(): SchemaModule;
-    /**
-     * Returns the {@link MigrationModule} module for managing and running migrations.
-     */
-    get migration(): MigrationModule;
     /**
      * Returns a the {@link DynamicModule} module.
      *
@@ -75,31 +71,6 @@ export declare class Kysely<DB> extends QueryCreator<DB> {
      * Returns a {@link DatabaseIntrospector | database introspector}.
      */
     get introspection(): DatabaseIntrospector;
-    /**
-     * A value to be used in place of columns that are generated in the database
-     * when inserting rows.
-     *
-     * ### Examples
-     *
-     * In this example the `Person` table has non-null properties `id` and `created_at`
-     * which are both automatically genereted by the database. Since their types are
-     * `number` and `string` respectively instead of `number | null` and `string | null`
-     * the `values` method requires you to give a value for them. the `generated`
-     * placeholder can be used in these cases.
-     *
-     * ```ts
-     * await db.insertInto('person')
-     *   .values({
-     *     id: db.generated,
-     *     created_at: db.generated,
-     *     first_name: 'Jennifer',
-     *     last_name: 'Aniston',
-     *     gender: 'female'
-     *   })
-     *   .execute()
-     * ```
-     */
-    get generated(): GeneratedPlaceholder;
     /**
      * Returns a {@link FunctionBuilder} that can be used to write type safe function
      * calls.
@@ -149,7 +120,6 @@ export declare class Kysely<DB> extends QueryCreator<DB> {
      * const catto = await db.transaction().execute(async (trx) => {
      *   const jennifer = await trx.insertInto('person')
      *     .values({
-     *       id: db.generated,
      *       first_name: 'Jennifer',
      *       last_name: 'Aniston',
      *     })
@@ -160,7 +130,6 @@ export declare class Kysely<DB> extends QueryCreator<DB> {
      *
      *   return await trx.insertInto('pet')
      *     .values({
-     *       id: db.generated,
      *       user_id: jennifer.id,
      *       name: 'Catto',
      *       species: 'cat'
@@ -251,6 +220,11 @@ export declare class Kysely<DB> extends QueryCreator<DB> {
      * You can also use `db instanceof Transaction`.
      */
     get isTransaction(): boolean;
+    /**
+     * @internal
+     * @private
+     */
+    get [PRIVATE_ADAPTER](): DialectAdapter;
 }
 export declare class Transaction<DB> extends Kysely<DB> {
     #private;
@@ -261,10 +235,6 @@ export declare class Transaction<DB> extends Kysely<DB> {
      * You can also use `db instanceof Transaction`.
      */
     get isTransaction(): true;
-    /**
-     * Returns the {@link MigrationModule} module for managing and running migrations.
-     */
-    get migration(): MigrationModule;
     /**
      * Creates a {@link TransactionBuilder} that can be used to run queries inside a transaction.
      *
@@ -285,7 +255,6 @@ export declare class Transaction<DB> extends Kysely<DB> {
      * const catto = await db.transaction().execute(async (trx) => {
      *   const jennifer = await trx.insertInto('person')
      *     .values({
-     *       id: db.generated,
      *       first_name: 'Jennifer',
      *       last_name: 'Aniston',
      *     })
@@ -296,7 +265,6 @@ export declare class Transaction<DB> extends Kysely<DB> {
      *
      *   return await trx.insertInto('pet')
      *     .values({
-     *       id: db.generated,
      *       user_id: jennifer.id,
      *       name: 'Catto',
      *       species: 'cat'

package/dist/esm/kysely.js

@@ -1,9 +1,7 @@
 import { SchemaModule } from './schema/schema.js';
 import { DynamicModule } from './dynamic/dynamic.js';
 import { DefaultConnectionProvider } from './driver/default-connection-provider.js';
-import { MigrationModule } from './migration/migration.js';
 import { QueryCreator } from './query-creator.js';
-import { GENERATED_PLACEHOLDER } from './util/generated-placeholder.js';
 import { DefaultQueryExecutor } from './query-executor/default-query-executor.js';
 import { freeze, isObject } from './util/object-utils.js';
 import { RuntimeDriver } from './driver/runtime-driver.js';
@@ -13,6 +11,7 @@ import { preventAwait } from './util/prevent-await.js';
 import { DefaultParseContext } from './parser/parse-context.js';
 import { FunctionBuilder } from './query-builder/function-builder.js';
 import { Log } from './util/log.js';
+import { PRIVATE_ADAPTER } from './util/private-symbols.js';
 /**
  * The main Kysely class.
  *
@@ -87,12 +86,6 @@ export class Kysely extends QueryCreator {
     get schema() {
         return new SchemaModule(this.#props.executor);
     }
-    /**
-     * Returns the {@link MigrationModule} module for managing and running migrations.
-     */
-    get migration() {
-        return new MigrationModule(this, this.#props.parseContext.adapter);
-    }
     /**
      * Returns a the {@link DynamicModule} module.
      *
@@ -108,33 +101,6 @@ export class Kysely extends QueryCreator {
     get introspection() {
         return this.#props.dialect.createIntrospector(this.withoutPlugins());
     }
-    /**
-     * A value to be used in place of columns that are generated in the database
-     * when inserting rows.
-     *
-     * ### Examples
-     *
-     * In this example the `Person` table has non-null properties `id` and `created_at`
-     * which are both automatically genereted by the database. Since their types are
-     * `number` and `string` respectively instead of `number | null` and `string | null`
-     * the `values` method requires you to give a value for them. the `generated`
-     * placeholder can be used in these cases.
-     *
-     * ```ts
-     * await db.insertInto('person')
-     *   .values({
-     *     id: db.generated,
-     *     created_at: db.generated,
-     *     first_name: 'Jennifer',
-     *     last_name: 'Aniston',
-     *     gender: 'female'
-     *   })
-     *   .execute()
-     * ```
-     */
-    get generated() {
-        return GENERATED_PLACEHOLDER;
-    }
     /**
      * Returns a {@link FunctionBuilder} that can be used to write type safe function
      * calls.
@@ -186,7 +152,6 @@ export class Kysely extends QueryCreator {
      * const catto = await db.transaction().execute(async (trx) => {
      *   const jennifer = await trx.insertInto('person')
      *     .values({
-     *       id: db.generated,
      *       first_name: 'Jennifer',
      *       last_name: 'Aniston',
      *     })
@@ -197,7 +162,6 @@ export class Kysely extends QueryCreator {
      *
      *   return await trx.insertInto('pet')
      *     .values({
-     *       id: db.generated,
      *       user_id: jennifer.id,
      *       name: 'Catto',
      *       species: 'cat'
@@ -308,6 +272,13 @@ export class Kysely extends QueryCreator {
     get isTransaction() {
         return false;
     }
+    /**
+     * @internal
+     * @private
+     */
+    get [PRIVATE_ADAPTER]() {
+        return this.#props.parseContext.adapter;
+    }
 }
 export class Transaction extends Kysely {
     #props;
@@ -321,9 +292,6 @@ export class Transaction extends Kysely {
     get isTransaction() {
         return true;
     }
-    get migration() {
-        throw new Error('the migration module is not available for a transaction. Use the main Kysely instance to run migrations');
-    }
     transaction() {
         throw new Error('calling the transaction method for a Transaction is not supported');
     }

package/dist/esm/migration/file-migration-provider.d.ts

@@ -0,0 +1,52 @@
+import { Migration, MigrationProvider } from './migrator.js';
+/**
+ * A function that takes a folder path and returns names of the
+ * files insider that folder.
+ */
+export declare type ReadDir = (migrationFolderPath: string) => Promise<string[]>;
+/**
+ * A function that combines two file path parts into a single file path.
+ *
+ * ```ts
+ * joinPath('/some/path', 'file.ts')
+ * // ==> '/some/path/file.ts'
+ * ```
+ */
+export declare type JoinPath = (part1: string, part2: string) => string;
+/**
+ * Reads all migrations from a folder.
+ *
+ * You need to provide a function for reading files in a folder and a function for
+ * joining file paths together. The API is like this to make Kysely independent of
+ * node.js or any other environment. See the example usage on node.js below.
+ *
+ * ### Examples
+ *
+ * ```ts
+ * import * as path from 'path'
+ * import * as fs from 'fs/promises'
+ *
+ * new FileMigrationProvider(
+ *   fs.readdir,
+ *   path.join,
+ *   path.join(__dirname, 'migrations')
+ * )
+ * ```
+ */
+export declare class FileMigrationProvider implements MigrationProvider {
+    #private;
+    constructor(readDir: ReadDir, joinPath: JoinPath, migrationFolderPath: string);
+    /**
+     * Returns all migrations, old and new.
+     *
+     * For example if you have your migrations in a folder as separate files,
+     * you can use the {@link FileMigrationProvider} that implements this
+     * method to return all migrations in a folder.
+     *
+     * The keys of the returned object are migration names and values are the
+     * migrations. The order of the migrations is determined by the alphabetical
+     * order of the migration names. The items in the object don't need to be
+     * sorted, they are sorted by Kysely.
+     */
+    getMigrations(): Promise<Record<string, Migration>>;
+}

package/dist/esm/migration/file-migration-provider.js

@@ -0,0 +1,48 @@
+import { isFunction, isObject } from '../util/object-utils.js';
+/**
+ * Reads all migrations from a folder.
+ *
+ * You need to provide a function for reading files in a folder and a function for
+ * joining file paths together. The API is like this to make Kysely independent of
+ * node.js or any other environment. See the example usage on node.js below.
+ *
+ * ### Examples
+ *
+ * ```ts
+ * import * as path from 'path'
+ * import * as fs from 'fs/promises'
+ *
+ * new FileMigrationProvider(
+ *   fs.readdir,
+ *   path.join,
+ *   path.join(__dirname, 'migrations')
+ * )
+ * ```
+ */
+export class FileMigrationProvider {
+    #readDir;
+    #joinPath;
+    #migrationFolderPath;
+    constructor(readDir, joinPath, migrationFolderPath) {
+        this.#readDir = readDir;
+        this.#joinPath = joinPath;
+        this.#migrationFolderPath = migrationFolderPath;
+    }
+    async getMigrations() {
+        const migrations = {};
+        const files = await this.#readDir(this.#migrationFolderPath);
+        for (const fileName of files) {
+            if ((fileName.endsWith('.js') || fileName.endsWith('.ts')) &&
+                !fileName.endsWith('.d.ts')) {
+                const migration = await import(this.#joinPath(this.#migrationFolderPath, fileName));
+                if (isMigration(migration)) {
+                    migrations[fileName.substring(0, fileName.length - 3)] = migration;
+                }
+            }
+        }
+        return migrations;
+    }
+}
+function isMigration(obj) {
+    return isObject(obj) && isFunction(obj.up);
+}