@mikro-orm/knex 6.0.0-dev.5 → 6.0.0-dev.51

package/schema/{SchemaGenerator.d.ts → SqlSchemaGenerator.d.ts}

@@ -1,18 +1,13 @@
-import type { MikroORM } from '@mikro-orm/core';
+import type { MikroORM, ISchemaGenerator } from '@mikro-orm/core';
 import { AbstractSchemaGenerator } from '@mikro-orm/core';
 import type { SchemaDifference } from '../typings';
 import { DatabaseSchema } from './DatabaseSchema';
 import type { AbstractSqlDriver } from '../AbstractSqlDriver';
-/**
- * Should be renamed to `SqlSchemaGenerator` in v6
- */
-export declare class SchemaGenerator extends AbstractSchemaGenerator<AbstractSqlDriver> {
+export declare class SqlSchemaGenerator extends AbstractSchemaGenerator<AbstractSqlDriver> implements ISchemaGenerator {
     private readonly helper;
     private readonly options;
     protected lastEnsuredDatabase?: string;
     static register(orm: MikroORM): void;
-    /** @deprecated use `dropSchema` and `createSchema` commands respectively */
-    generate(): Promise<string>;
     createSchema(options?: {
         wrap?: boolean;
         schema?: string;
@@ -88,7 +83,7 @@ export declare class SchemaGenerator extends AbstractSchemaGenerator<AbstractSql
     dropDatabase(name: string): Promise<void>;
     execute(sql: string, options?: {
         wrap?: boolean;
-    }): Promise<undefined>;
+    }): Promise<void>;
     private wrapSchema;
     private createSchemaBuilder;
     private createTable;
@@ -101,3 +96,4 @@ export declare class SchemaGenerator extends AbstractSchemaGenerator<AbstractSql
     private dump;
     private get knex();
 }
+export { SqlSchemaGenerator as SchemaGenerator };

package/schema/{SchemaGenerator.js → SqlSchemaGenerator.js}

@@ -1,28 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SchemaGenerator = void 0;
+exports.SchemaGenerator = exports.SqlSchemaGenerator = void 0;
 const core_1 = require("@mikro-orm/core");
 const DatabaseSchema_1 = require("./DatabaseSchema");
 const SchemaComparator_1 = require("./SchemaComparator");
-/**
- * Should be renamed to `SqlSchemaGenerator` in v6
- */
-class SchemaGenerator extends core_1.AbstractSchemaGenerator {
+class SqlSchemaGenerator extends core_1.AbstractSchemaGenerator {
     constructor() {
         super(...arguments);
         this.helper = this.platform.getSchemaHelper();
         this.options = this.config.get('schemaGenerator');
     }
     static register(orm) {
-        orm.config.registerExtension('@mikro-orm/schema-generator', new SchemaGenerator(orm.em));
-    }
-    /** @deprecated use `dropSchema` and `createSchema` commands respectively */
-    async generate() {
-        const [dropSchema, createSchema] = await Promise.all([
-            this.getDropSchemaSQL({ wrap: false }),
-            this.getCreateSchemaSQL({ wrap: false }),
-        ]);
-        return this.wrapSchema(dropSchema + createSchema);
+        orm.config.registerExtension('@mikro-orm/schema-generator', () => new SqlSchemaGenerator(orm.em));
     }
     async createSchema(options) {
         await this.ensureDatabase();
@@ -143,7 +132,9 @@ class SchemaGenerator extends core_1.AbstractSchemaGenerator {
         return this.diffToSQL(diffUp, options);
     }
     async getUpdateSchemaMigrationSQL(options = {}) {
-        await this.ensureDatabase();
+        if (!options.fromSchema) {
+            await this.ensureDatabase();
+        }
         const { fromSchema, toSchema } = await this.prepareSchemaForComparison(options);
         const comparator = new SchemaComparator_1.SchemaComparator(this.platform);
         const diffUp = comparator.compare(fromSchema, toSchema);
@@ -154,9 +145,9 @@ class SchemaGenerator extends core_1.AbstractSchemaGenerator {
         };
     }
     async prepareSchemaForComparison(options) {
-        options.wrap ?? (options.wrap = this.options.disableForeignKeys);
-        options.safe ?? (options.safe = false);
-        options.dropTables ?? (options.dropTables = true);
+        options.wrap ??= this.options.disableForeignKeys;
+        options.safe ??= false;
+        options.dropTables ??= true;
         const toSchema = this.getTargetSchema(options.schema);
         const fromSchema = options.fromSchema ?? await DatabaseSchema_1.DatabaseSchema.create(this.connection, this.platform, this.config, options.schema);
         const wildcardSchemaTables = Object.values(this.metadata.getAll()).filter(meta => meta.schema === '*').map(meta => meta.tableName);
@@ -305,13 +296,13 @@ class SchemaGenerator extends core_1.AbstractSchemaGenerator {
                 this.helper.configureColumn(column, col, this.knex, changedProperties);
             }
             for (const { column } of Object.values(diff.changedColumns).filter(diff => diff.changedProperties.has('autoincrement'))) {
-                this.helper.pushTableQuery(table, this.helper.getAlterColumnAutoincrement(tableName, column));
+                this.helper.pushTableQuery(table, this.helper.getAlterColumnAutoincrement(tableName, column, schemaName));
             }
             for (const { column, changedProperties } of Object.values(diff.changedColumns).filter(diff => diff.changedProperties.has('comment'))) {
                 if (['type', 'nullable', 'autoincrement', 'unsigned', 'default', 'enumItems'].some(t => changedProperties.has(t))) {
                     continue; // will be handled via knex
                 }
-                this.helper.pushTableQuery(table, this.helper.getChangeColumnCommentSQL(tableName, column));
+                this.helper.pushTableQuery(table, this.helper.getChangeColumnCommentSQL(tableName, column, schemaName));
             }
             for (const [oldColumnName, column] of Object.entries(diff.renamedColumns)) {
                 this.helper.pushTableQuery(table, this.helper.getRenameColumnSQL(tableName, oldColumnName, column, schemaName));
@@ -364,19 +355,20 @@ class SchemaGenerator extends core_1.AbstractSchemaGenerator {
         await this.driver.execute(this.helper.getDropDatabaseSQL('' + this.knex.ref(name)));
     }
     async execute(sql, options = {}) {
-        options.wrap ?? (options.wrap = false);
+        options.wrap ??= false;
         const lines = this.wrapSchema(sql, options).split('\n').filter(i => i.trim());
         if (lines.length === 0) {
             return;
         }
         if (this.platform.supportsMultipleStatements()) {
             const query = lines.join('\n');
-            return void await this.driver.execute(query);
+            await this.driver.execute(query);
+            return;
         }
         await core_1.Utils.runSerial(lines, line => this.driver.execute(line));
     }
     wrapSchema(sql, options = {}) {
-        options.wrap ?? (options.wrap = this.options.disableForeignKeys);
+        options.wrap ??= this.options.disableForeignKeys;
         if (!options.wrap || sql.trim() === '') {
             return sql;
         }
@@ -487,4 +479,5 @@ class SchemaGenerator extends core_1.AbstractSchemaGenerator {
         return this.connection.getKnex();
     }
 }
-exports.SchemaGenerator = SchemaGenerator;
+exports.SqlSchemaGenerator = SqlSchemaGenerator;
+exports.SchemaGenerator = SqlSchemaGenerator;

package/schema/index.d.ts

@@ -1,5 +1,5 @@
 export * from './DatabaseSchema';
 export * from './DatabaseTable';
-export * from './SchemaGenerator';
+export * from './SqlSchemaGenerator';
 export * from './SchemaHelper';
 export * from './SchemaComparator';

package/schema/index.js

@@ -16,6 +16,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./DatabaseSchema"), exports);
 __exportStar(require("./DatabaseTable"), exports);
-__exportStar(require("./SchemaGenerator"), exports);
+__exportStar(require("./SqlSchemaGenerator"), exports);
 __exportStar(require("./SchemaHelper"), exports);
 __exportStar(require("./SchemaComparator"), exports);

package/typings.d.ts

@@ -25,6 +25,7 @@ export interface JoinOptions {
     path?: string;
     prop: EntityProperty;
     cond: Dictionary;
+    cond_?: Dictionary;
 }
 export interface Column {
     name: string;
@@ -54,7 +55,7 @@ export interface ForeignKey {
     updateRule?: string;
     deleteRule?: string;
 }
-export interface Index {
+export interface IndexDef {
     columnNames: string[];
     keyName: string;
     unique: boolean;
@@ -67,7 +68,7 @@ export interface Index {
         predicate?: Knex.QueryBuilder;
     }>;
 }
-export interface Check<T = unknown> {
+export interface CheckDef<T = unknown> {
     name: string;
     expression: string | CheckCallback<T>;
     definition?: string;
@@ -88,13 +89,13 @@ export interface TableDifference {
     changedColumns: Dictionary<ColumnDifference>;
     removedColumns: Dictionary<Column>;
     renamedColumns: Dictionary<Column>;
-    addedIndexes: Dictionary<Index>;
-    changedIndexes: Dictionary<Index>;
-    removedIndexes: Dictionary<Index>;
-    renamedIndexes: Dictionary<Index>;
-    addedChecks: Dictionary<Check>;
-    changedChecks: Dictionary<Check>;
-    removedChecks: Dictionary<Check>;
+    addedIndexes: Dictionary<IndexDef>;
+    changedIndexes: Dictionary<IndexDef>;
+    removedIndexes: Dictionary<IndexDef>;
+    renamedIndexes: Dictionary<IndexDef>;
+    addedChecks: Dictionary<CheckDef>;
+    changedChecks: Dictionary<CheckDef>;
+    removedChecks: Dictionary<CheckDef>;
     addedForeignKeys: Dictionary<ForeignKey>;
     changedForeignKeys: Dictionary<ForeignKey>;
     removedForeignKeys: Dictionary<ForeignKey>;
@@ -136,16 +137,16 @@ export interface IQueryBuilder<T> {
     getAliasForJoinPath(path: string): string | undefined;
     getNextAlias(entityName?: string): string;
 }
-export interface ICriteriaNode {
+export interface ICriteriaNode<T extends object> {
     readonly entityName: string;
-    readonly parent?: ICriteriaNode | undefined;
+    readonly parent?: ICriteriaNode<T> | undefined;
     readonly key?: string | undefined;
     payload: any;
     prop?: EntityProperty;
     index?: number;
-    process<T>(qb: IQueryBuilder<T>, alias?: string): any;
+    process(qb: IQueryBuilder<T>, alias?: string): any;
     shouldInline(payload: any): boolean;
-    willAutoJoin<T>(qb: IQueryBuilder<T>, alias?: string): boolean;
+    willAutoJoin(qb: IQueryBuilder<T>, alias?: string): boolean;
     shouldRename(payload: any): boolean;
     renameFieldToPK<T>(qb: IQueryBuilder<T>): string;
     getPath(addIndex?: boolean): string;