@mikro-orm/sql 7.0.3-dev.8 → 7.0.3

package/schema/SchemaComparator.d.ts

@@ -7,70 +7,74 @@ import type { AbstractSqlPlatform } from '../AbstractSqlPlatform.js';
  * Compares two Schemas and return an instance of SchemaDifference.
  */
 export declare class SchemaComparator {
-    #private;
-    constructor(platform: AbstractSqlPlatform);
-    /**
-     * Returns a SchemaDifference object containing the differences between the schemas fromSchema and toSchema.
-     *
-     * The returned differences are returned in such a way that they contain the
-     * operations to change the schema stored in fromSchema to the schema that is
-     * stored in toSchema.
-     */
-    compare(fromSchema: DatabaseSchema, toSchema: DatabaseSchema, inverseDiff?: SchemaDifference): SchemaDifference;
-    /**
-     * Returns the difference between the tables fromTable and toTable.
-     * If there are no differences this method returns the boolean false.
-     */
-    diffTable(fromTable: DatabaseTable, toTable: DatabaseTable, inverseTableDiff?: TableDifference): TableDifference | false;
-    /**
-     * Try to find columns that only changed their name, rename operations maybe cheaper than add/drop
-     * however ambiguities between different possibilities should not lead to renaming at all.
-     */
-    private detectColumnRenamings;
-    /**
-     * Try to find indexes that only changed their name, rename operations maybe cheaper than add/drop
-     * however ambiguities between different possibilities should not lead to renaming at all.
-     */
-    private detectIndexRenamings;
-    diffForeignKey(key1: ForeignKey, key2: ForeignKey, tableDifferences: TableDifference): boolean;
-    /**
-     * Returns the difference between the columns
-     */
-    diffColumn(fromColumn: Column, toColumn: Column, fromTable: DatabaseTable, logging?: boolean): Set<string>;
-    diffEnumItems(items1?: string[], items2?: string[]): boolean;
-    diffComment(comment1?: string, comment2?: string): boolean;
-    /**
-     * Finds the difference between the indexes index1 and index2.
-     * Compares index1 with index2 and returns index2 if there are any differences or false in case there are no differences.
-     */
-    diffIndex(index1: IndexDef, index2: IndexDef): boolean;
-    /**
-     * Checks if the other index already fulfills all the indexing and constraint needs of the current one.
-     */
-    isIndexFulfilledBy(index1: IndexDef, index2: IndexDef): boolean;
-    /**
-     * Compare advanced column options between two indexes.
-     */
-    private compareIndexColumns;
-    /**
-     * Compare two arrays for equality (order matters).
-     */
-    private compareArrays;
-    diffExpression(expr1: string, expr2: string): boolean;
-    /**
-     * Compares two view expressions, with special handling for SELECT *.
-     * Databases like PostgreSQL and MySQL expand `SELECT *` to explicit column names
-     * in their stored view definitions, which makes diffExpression always detect changes.
-     * When SELECT * is present, we strip the first SELECT...FROM column list from both
-     * sides and compare only the structural parts (FROM clause onwards).
-     * Note: this means changes *within* subqueries in the SELECT list of a SELECT * view
-     * may not be detected — an acceptable tradeoff since SELECT * views are inherently
-     * column-list-agnostic.
-     * @see https://github.com/mikro-orm/mikro-orm/issues/7308
-     */
-    private diffViewExpression;
-    parseJsonDefault(defaultValue?: string | null): Dictionary | string | null;
-    hasSameDefaultValue(from: Column, to: Column): boolean;
-    private mapColumnToProperty;
-    private log;
+  #private;
+  constructor(platform: AbstractSqlPlatform);
+  /**
+   * Returns a SchemaDifference object containing the differences between the schemas fromSchema and toSchema.
+   *
+   * The returned differences are returned in such a way that they contain the
+   * operations to change the schema stored in fromSchema to the schema that is
+   * stored in toSchema.
+   */
+  compare(fromSchema: DatabaseSchema, toSchema: DatabaseSchema, inverseDiff?: SchemaDifference): SchemaDifference;
+  /**
+   * Returns the difference between the tables fromTable and toTable.
+   * If there are no differences this method returns the boolean false.
+   */
+  diffTable(
+    fromTable: DatabaseTable,
+    toTable: DatabaseTable,
+    inverseTableDiff?: TableDifference,
+  ): TableDifference | false;
+  /**
+   * Try to find columns that only changed their name, rename operations maybe cheaper than add/drop
+   * however ambiguities between different possibilities should not lead to renaming at all.
+   */
+  private detectColumnRenamings;
+  /**
+   * Try to find indexes that only changed their name, rename operations maybe cheaper than add/drop
+   * however ambiguities between different possibilities should not lead to renaming at all.
+   */
+  private detectIndexRenamings;
+  diffForeignKey(key1: ForeignKey, key2: ForeignKey, tableDifferences: TableDifference): boolean;
+  /**
+   * Returns the difference between the columns
+   */
+  diffColumn(fromColumn: Column, toColumn: Column, fromTable: DatabaseTable, logging?: boolean): Set<string>;
+  diffEnumItems(items1?: string[], items2?: string[]): boolean;
+  diffComment(comment1?: string, comment2?: string): boolean;
+  /**
+   * Finds the difference between the indexes index1 and index2.
+   * Compares index1 with index2 and returns index2 if there are any differences or false in case there are no differences.
+   */
+  diffIndex(index1: IndexDef, index2: IndexDef): boolean;
+  /**
+   * Checks if the other index already fulfills all the indexing and constraint needs of the current one.
+   */
+  isIndexFulfilledBy(index1: IndexDef, index2: IndexDef): boolean;
+  /**
+   * Compare advanced column options between two indexes.
+   */
+  private compareIndexColumns;
+  /**
+   * Compare two arrays for equality (order matters).
+   */
+  private compareArrays;
+  diffExpression(expr1: string, expr2: string): boolean;
+  /**
+   * Compares two view expressions, with special handling for SELECT *.
+   * Databases like PostgreSQL and MySQL expand `SELECT *` to explicit column names
+   * in their stored view definitions, which makes diffExpression always detect changes.
+   * When SELECT * is present, we strip the first SELECT...FROM column list from both
+   * sides and compare only the structural parts (FROM clause onwards).
+   * Note: this means changes *within* subqueries in the SELECT list of a SELECT * view
+   * may not be detected — an acceptable tradeoff since SELECT * views are inherently
+   * column-list-agnostic.
+   * @see https://github.com/mikro-orm/mikro-orm/issues/7308
+   */
+  private diffViewExpression;
+  parseJsonDefault(defaultValue?: string | null): Dictionary | string | null;
+  hasSameDefaultValue(from: Column, to: Column): boolean;
+  private mapColumnToProperty;
+  private log;
 }