@mikro-orm/knex 6.0.0-dev.32 → 6.0.0-dev.320

package/schema/SqlSchemaGenerator.js

@@ -5,11 +5,9 @@ const core_1 = require("@mikro-orm/core");
 const DatabaseSchema_1 = require("./DatabaseSchema");
 const SchemaComparator_1 = require("./SchemaComparator");
 class SqlSchemaGenerator extends core_1.AbstractSchemaGenerator {
-    constructor() {
-        super(...arguments);
-        this.helper = this.platform.getSchemaHelper();
-        this.options = this.config.get('schemaGenerator');
-    }
+    helper = this.platform.getSchemaHelper();
+    options = this.config.get('schemaGenerator');
+    lastEnsuredDatabase;
     static register(orm) {
         orm.config.registerExtension('@mikro-orm/schema-generator', () => new SqlSchemaGenerator(orm.em));
     }
@@ -21,21 +19,30 @@ class SqlSchemaGenerator extends core_1.AbstractSchemaGenerator {
     /**
      * Returns true if the database was created.
      */
-    async ensureDatabase() {
+    async ensureDatabase(options) {
         const dbName = this.config.get('dbName');
-        if (this.lastEnsuredDatabase === dbName) {
+        if (this.lastEnsuredDatabase === dbName && !options?.forceCheck) {
             return true;
         }
         const exists = await this.helper.databaseExists(this.connection, dbName);
         this.lastEnsuredDatabase = dbName;
         if (!exists) {
-            this.config.set('dbName', this.helper.getManagementDbName());
-            await this.driver.reconnect();
-            await this.createDatabase(dbName);
-            this.config.set('dbName', dbName);
-            await this.driver.reconnect();
+            const managementDbName = this.helper.getManagementDbName();
+            if (managementDbName) {
+                this.config.set('dbName', managementDbName);
+                await this.driver.reconnect();
+                await this.createDatabase(dbName);
+                this.config.set('dbName', dbName);
+                await this.driver.reconnect();
+            }
+            if (options?.create) {
+                await this.createSchema(options);
+            }
             return true;
         }
+        if (options?.clear) {
+            await this.clearDatabase(options);
+        }
         return false;
     }
     getTargetSchema(schema) {
@@ -93,7 +100,8 @@ class SqlSchemaGenerator extends core_1.AbstractSchemaGenerator {
         await this.ensureDatabase();
         const wrap = options.wrap ?? this.options.disableForeignKeys;
         const metadata = this.getOrderedMetadata(options.schema).reverse();
-        const schema = await DatabaseSchema_1.DatabaseSchema.create(this.connection, this.platform, this.config, options.schema);
+        const schemas = this.getTargetSchema(options.schema).getNamespaces();
+        const schema = await DatabaseSchema_1.DatabaseSchema.create(this.connection, this.platform, this.config, options.schema, schemas);
         let ret = '';
         // remove FKs explicitly if we can't use cascading statement and we don't disable FK checks (we need this for circular relations)
         for (const meta of metadata) {
@@ -110,6 +118,12 @@ class SqlSchemaGenerator extends core_1.AbstractSchemaGenerator {
         for (const meta of metadata) {
             ret += await this.dump(this.dropTable(meta.collection, this.getSchemaName(meta, options)), '\n');
         }
+        if (this.platform.supportsNativeEnums()) {
+            for (const columnName of Object.keys(schema.getNativeEnums())) {
+                const sql = this.helper.getDropNativeEnumSQL(columnName, options.schema ?? this.config.get('schema'));
+                ret += await this.dump(this.knex.schema.raw(sql), '\n');
+            }
+        }
         if (options.dropMigrationsTable) {
             ret += await this.dump(this.dropTable(this.config.get('migrations').tableName, this.config.get('schema')), '\n');
         }
@@ -132,11 +146,13 @@ class SqlSchemaGenerator 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);
-        const diffDown = comparator.compare(toSchema, fromSchema);
+        const diffDown = comparator.compare(toSchema, fromSchema, diffUp);
         return {
             up: await this.diffToSQL(diffUp, options),
             down: this.platform.supportsDownMigrations() ? await this.diffToSQL(diffDown, options) : '',
@@ -147,10 +163,12 @@ class SqlSchemaGenerator extends core_1.AbstractSchemaGenerator {
         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 schemas = toSchema.getNamespaces();
+        const fromSchema = options.fromSchema ?? await DatabaseSchema_1.DatabaseSchema.create(this.connection, this.platform, this.config, options.schema, schemas);
         const wildcardSchemaTables = Object.values(this.metadata.getAll()).filter(meta => meta.schema === '*').map(meta => meta.tableName);
         fromSchema.prune(options.schema, wildcardSchemaTables);
         toSchema.prune(options.schema, wildcardSchemaTables);
+        toSchema.setNativeEnums(fromSchema.getNativeEnums());
         return { fromSchema, toSchema };
     }
     async diffToSQL(schemaDiff, options) {
@@ -206,7 +224,7 @@ class SqlSchemaGenerator extends core_1.AbstractSchemaGenerator {
         if (schema && schemaName === '*') {
             return `${schema}.${referencedTableName.replace(/^\*\./, '')}`;
         }
-        if (schemaName === this.platform.getDefaultSchemaName()) {
+        if (!schemaName || schemaName === this.platform.getDefaultSchemaName()) {
             return tableName;
         }
         return `${schemaName}.${tableName}`;
@@ -254,6 +272,12 @@ class SqlSchemaGenerator extends core_1.AbstractSchemaGenerator {
     alterTable(diff, safe) {
         const ret = [];
         const [schemaName, tableName] = this.splitTableName(diff.name);
+        const changedNativeEnums = [];
+        for (const { column, changedProperties } of Object.values(diff.changedColumns)) {
+            if (column.nativeEnumName && changedProperties.has('enumItems') && column.nativeEnumName in diff.fromTable.nativeEnums) {
+                changedNativeEnums.push([column.nativeEnumName, column.enumItems, diff.fromTable.getColumn(column.name).enumItems]);
+            }
+        }
         ret.push(this.createSchemaBuilder(schemaName).alterTable(tableName, table => {
             for (const index of Object.values(diff.removedIndexes)) {
                 this.dropIndex(table, index);
@@ -267,6 +291,14 @@ class SqlSchemaGenerator extends core_1.AbstractSchemaGenerator {
             for (const check of Object.values(diff.changedChecks)) {
                 this.dropCheck(table, check);
             }
+            /* istanbul ignore else */
+            if (!safe) {
+                for (const column of Object.values(diff.removedColumns)) {
+                    this.helper.pushTableQuery(table, `alter table ${this.platform.quoteIdentifier(tableName)} drop column ${this.platform.quoteIdentifier(column.name)}`);
+                }
+            }
+        }));
+        ret.push(this.createSchemaBuilder(schemaName).alterTable(tableName, table => {
             for (const column of Object.values(diff.addedColumns)) {
                 const col = this.helper.createTableColumn(table, column, diff.fromTable);
                 this.helper.configureColumn(column, col, this.knex);
@@ -280,27 +312,24 @@ class SqlSchemaGenerator extends core_1.AbstractSchemaGenerator {
                         .onDelete(foreignKey.deleteRule);
                 }
             }
-            /* istanbul ignore else */
-            if (!safe) {
-                for (const column of Object.values(diff.removedColumns)) {
-                    table.dropColumn(column.name);
-                }
-            }
             for (const { column, changedProperties } of Object.values(diff.changedColumns)) {
                 if (changedProperties.size === 1 && changedProperties.has('comment')) {
                     continue;
                 }
+                if (changedProperties.size === 1 && changedProperties.has('enumItems') && column.nativeEnumName) {
+                    continue;
+                }
                 const col = this.helper.createTableColumn(table, column, diff.fromTable, changedProperties).alter();
                 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));
@@ -337,17 +366,28 @@ class SqlSchemaGenerator extends core_1.AbstractSchemaGenerator {
                 table.comment(comment);
             }
         }));
+        if (this.platform.supportsNativeEnums()) {
+            changedNativeEnums.forEach(([enumName, itemsNew, itemsOld]) => {
+                // postgres allows only adding new items
+                const newItems = itemsNew.filter(val => !itemsOld.includes(val));
+                ret.push(...newItems.map(val => this.knex.schema.raw(this.helper.getAlterNativeEnumSQL(enumName, schemaName, val))));
+            });
+        }
         return ret;
     }
     /**
      * creates new database and connects to it
      */
     async createDatabase(name) {
-        await this.driver.execute(this.helper.getCreateDatabaseSQL('' + this.knex.ref(name)));
+        const sql = this.helper.getCreateDatabaseSQL('' + this.knex.ref(name));
+        if (sql) {
+            await this.driver.execute(sql);
+        }
         this.config.set('dbName', name);
         await this.driver.reconnect();
     }
     async dropDatabase(name) {
+        name ??= this.config.get('dbName');
         this.config.set('dbName', this.helper.getManagementDbName());
         await this.driver.reconnect();
         await this.driver.execute(this.helper.getDropDatabaseSQL('' + this.knex.ref(name)));
@@ -365,7 +405,7 @@ class SqlSchemaGenerator extends core_1.AbstractSchemaGenerator {
         }
         await core_1.Utils.runSerial(lines, line => this.driver.execute(line));
     }
-    wrapSchema(sql, options = {}) {
+    wrapSchema(sql, options) {
         options.wrap ??= this.options.disableForeignKeys;
         if (!options.wrap || sql.trim() === '') {
             return sql;
@@ -416,7 +456,14 @@ class SqlSchemaGenerator extends core_1.AbstractSchemaGenerator {
             table.primary(index.columnNames, keyName);
         }
         else if (index.unique) {
-            table.unique(index.columnNames, { indexName: index.keyName });
+            // JSON columns can have unique index but not unique constraint, and we need to distinguish those, so we can properly drop them
+            if (index.columnNames.some(column => column.includes('.'))) {
+                const columns = this.platform.getJsonIndexDefinition(index);
+                table.index(columns.map(column => this.knex.raw(`(${column})`)), index.keyName, { indexType: 'unique' });
+            }
+            else {
+                table.unique(index.columnNames, { indexName: index.keyName });
+            }
         }
         else if (index.expression) {
             this.helper.pushTableQuery(table, index.expression);
@@ -428,14 +475,21 @@ class SqlSchemaGenerator extends core_1.AbstractSchemaGenerator {
             }
         }
         else {
-            table.index(index.columnNames, index.keyName, index.type);
+            // JSON columns can have unique index but not unique constraint, and we need to distinguish those, so we can properly drop them
+            if (index.columnNames.some(column => column.includes('.'))) {
+                const columns = this.platform.getJsonIndexDefinition(index);
+                table.index(columns.map(column => this.knex.raw(`(${column})`)), index.keyName, index.type);
+            }
+            else {
+                table.index(index.columnNames, index.keyName, index.type);
+            }
         }
     }
     dropIndex(table, index, oldIndexName = index.keyName) {
         if (index.primary) {
             table.dropPrimary(oldIndexName);
         }
-        else if (index.unique) {
+        else if (index.unique && index.constraint) {
             table.dropUnique(index.columnNames, oldIndexName);
         }
         else {

package/typings.d.ts

@@ -1,6 +1,6 @@
 import type { Knex } from 'knex';
-import type { CheckCallback, Dictionary, EntityProperty, GroupOperator, QBFilterQuery, QueryOrderMap, Type } from '@mikro-orm/core';
-import type { QueryType } from './query/enums';
+import type { CheckCallback, Dictionary, EntityProperty, GroupOperator, RawQueryFragment, QBFilterQuery, QueryOrderMap, Type, QueryFlag } from '@mikro-orm/core';
+import type { JoinType, QueryType } from './query/enums';
 import type { DatabaseSchema, DatabaseTable } from './schema';
 export interface Table {
     table_name: string;
@@ -11,11 +11,11 @@ export type KnexStringRef = Knex.Ref<string, {
     [alias: string]: string;
 }>;
 type AnyString = string & {};
-export type Field<T> = AnyString | keyof T | KnexStringRef | Knex.QueryBuilder;
+export type Field<T> = AnyString | keyof T | RawQueryFragment | KnexStringRef | Knex.QueryBuilder;
 export interface JoinOptions {
     table: string;
     schema?: string;
-    type: 'leftJoin' | 'innerJoin' | 'pivotJoin';
+    type: JoinType;
     alias: string;
     ownerAlias: string;
     inverseAlias?: string;
@@ -25,6 +25,8 @@ export interface JoinOptions {
     path?: string;
     prop: EntityProperty;
     cond: Dictionary;
+    cond_?: Dictionary;
+    subquery?: string;
 }
 export interface Column {
     name: string;
@@ -38,6 +40,8 @@ export interface Column {
     scale?: number;
     default?: string | null;
     comment?: string;
+    generated?: string;
+    nativeEnumName?: string;
     enumItems?: string[];
     primary?: boolean;
     unique?: boolean;
@@ -58,9 +62,11 @@ export interface IndexDef {
     columnNames: string[];
     keyName: string;
     unique: boolean;
+    constraint: boolean;
     primary: boolean;
     composite?: boolean;
     expression?: string;
+    options?: Dictionary;
     type?: string | Readonly<{
         indexType?: string;
         storageEngineIndexType?: 'hash' | 'btree';
@@ -119,10 +125,12 @@ export interface IQueryBuilder<T> {
     delete(cond?: QBFilterQuery): this;
     truncate(): this;
     count(field?: string | string[], distinct?: boolean): this;
-    join(field: string, alias: string, cond?: QBFilterQuery, type?: 'leftJoin' | 'innerJoin' | 'pivotJoin', path?: string): this;
+    join(field: string, alias: string, cond?: QBFilterQuery, type?: JoinType, path?: string): this;
+    innerJoin(field: string, alias: string, cond?: QBFilterQuery): this;
     leftJoin(field: string, alias: string, cond?: QBFilterQuery): this;
     joinAndSelect(field: string, alias: string, cond?: QBFilterQuery): this;
-    leftJoinAndSelect(field: string, alias: string, cond?: QBFilterQuery): this;
+    leftJoinAndSelect(field: string, alias: string, cond?: QBFilterQuery, fields?: string[]): this;
+    innerJoinAndSelect(field: string, alias: string, cond?: QBFilterQuery, fields?: string[]): this;
     withSubQuery(subQuery: Knex.QueryBuilder, alias: string): this;
     where(cond: QBFilterQuery<T>, operator?: keyof typeof GroupOperator): this;
     where(cond: string, params?: any[], operator?: keyof typeof GroupOperator): this;
@@ -133,8 +141,19 @@ export interface IQueryBuilder<T> {
     orderBy(orderBy: QueryOrderMap<T>): this;
     groupBy(fields: (string | keyof T) | (string | keyof T)[]): this;
     having(cond?: QBFilterQuery | string, params?: any[]): this;
-    getAliasForJoinPath(path: string): string | undefined;
+    getAliasForJoinPath(path: string, options?: ICriteriaNodeProcessOptions): string | undefined;
+    getJoinForPath(path?: string, options?: ICriteriaNodeProcessOptions): JoinOptions | undefined;
     getNextAlias(entityName?: string): string;
+    clone(reset?: boolean): IQueryBuilder<T>;
+    setFlag(flag: QueryFlag): this;
+    unsetFlag(flag: QueryFlag): this;
+    hasFlag(flag: QueryFlag): boolean;
+}
+export interface ICriteriaNodeProcessOptions {
+    alias?: string;
+    matchPopulateJoins?: boolean;
+    ignoreBranching?: boolean;
+    preferNoBranch?: boolean;
 }
 export interface ICriteriaNode<T extends object> {
     readonly entityName: string;
@@ -143,7 +162,7 @@ export interface ICriteriaNode<T extends object> {
     payload: any;
     prop?: EntityProperty;
     index?: number;
-    process(qb: IQueryBuilder<T>, alias?: string): any;
+    process(qb: IQueryBuilder<T>, options?: ICriteriaNodeProcessOptions): any;
     shouldInline(payload: any): boolean;
     willAutoJoin(qb: IQueryBuilder<T>, alias?: string): boolean;
     shouldRename(payload: any): boolean;