@mikro-orm/sql 7.1.2-dev.10 → 7.1.2-dev.11

package/dialects/sqlite/SqlitePlatform.d.ts

@@ -11,6 +11,7 @@ export declare class SqlitePlatform extends AbstractSqlPlatform {
     usesDefaultKeyword(): boolean;
     usesReturningStatement(): boolean;
     usesEnumCheckConstraints(): boolean;
+    supportsComments(): boolean;
     getCurrentTimestampSQL(length: number): string;
     getDateTimeTypeDeclarationSQL(column: {
         length: number;

package/dialects/sqlite/SqlitePlatform.js

@@ -18,6 +18,10 @@ export class SqlitePlatform extends AbstractSqlPlatform {
     usesEnumCheckConstraints() {
         return true;
     }
+    // sqlite has no table/column comments, so they cannot round-trip through introspection
+    supportsComments() {
+        return false;
+    }
     getCurrentTimestampSQL(length) {
         return `(strftime('%s', 'now') * 1000)`;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mikro-orm/sql",
-  "version": "7.1.2-dev.10",
+  "version": "7.1.2-dev.11",
   "description": "TypeScript ORM for Node.js based on Data Mapper, Unit of Work and Identity Map patterns. Supports MongoDB, MySQL, PostgreSQL and SQLite databases as well as usage with vanilla JavaScript.",
   "keywords": [
     "data-mapper",
@@ -53,7 +53,7 @@
     "@mikro-orm/core": "^7.1.1"
   },
   "peerDependencies": {
-    "@mikro-orm/core": "7.1.2-dev.10"
+    "@mikro-orm/core": "7.1.2-dev.11"
   },
   "engines": {
     "node": ">= 22.17.0"

package/schema/DatabaseTable.js

@@ -975,6 +975,7 @@ export class DatabaseTable {
             mappedType instanceof t.float ||
             mappedType instanceof t.double;
         const supportsUnsigned = this.#platform.supportsUnsigned();
+        const supportsComments = this.#platform.supportsComments();
         const columnsMapped = sortedColumnKeys.reduce((o, col) => {
             const c = columns[col];
             // omit `autoincrement` from options so `serial` (metadata) and `int4` (introspection) collapse the same
@@ -1003,7 +1004,7 @@ export class DatabaseTable {
                 precision: fixedPrecision ? null : (c.precision ?? null),
                 scale: fixedPrecision ? null : (c.scale ?? null),
                 default: defaultValue,
-                comment: c.comment || null,
+                comment: supportsComments ? c.comment || null : null,
                 collation: c.collation ?? null,
                 enumItems: c.enumItems ?? [],
                 mappedType: Utils.keys(t).find(k => t[k] === c.mappedType.constructor),
@@ -1092,8 +1093,9 @@ export class DatabaseTable {
             triggers: sortedTriggers,
             foreignKeys: sortedForeignKeys,
             // emit `comment` even when unset so introspection (which always reads it) matches metadata;
-            // collapse mysql's `""` for unset comments to `null` so both sources agree
-            comment: this.comment || null,
+            // collapse mysql's `""` for unset comments to `null` so both sources agree. drop entirely on
+            // platforms that can't read comments back (sqlite), where keeping it would flip the snapshot
+            comment: supportsComments ? this.comment || null : null,
         };
     }
 }

package/schema/SchemaComparator.js

@@ -339,7 +339,7 @@ export class SchemaComparator {
             fromTable,
             toTable,
         };
-        if (this.diffComment(fromTable.comment, toTable.comment)) {
+        if (this.#platform.supportsComments() && this.diffComment(fromTable.comment, toTable.comment)) {
             tableDifferences.changedComment = toTable.comment;
             this.log(`table comment changed for ${tableDifferences.name}`, {
                 fromTableComment: fromTable.comment,
@@ -713,7 +713,7 @@ export class SchemaComparator {
             log(`'default' changed for column ${fromTable.name}.${fromColumn.name}`, { fromColumn, toColumn });
             changedProperties.add('default');
         }
-        if (this.diffComment(fromColumn.comment, toColumn.comment)) {
+        if (this.#platform.supportsComments() && this.diffComment(fromColumn.comment, toColumn.comment)) {
             log(`'comment' changed for column ${fromTable.name}.${fromColumn.name}`, { fromColumn, toColumn });
             changedProperties.add('comment');
         }