Add extended properties for MSSQL table and column comments (#464)

src/utils/exportSQL/mssql.js

@@ -1,65 +1,117 @@
-import { exportFieldComment, parseDefault } from "./shared";
+import { parseDefault, escapeQuotes } from "./shared";
 
 import { dbToTypes } from "../../data/datatypes";
 
+function generateAddExtendedPropertySQL(value, level1name, level2name = null) {
+  if (!value || value.trim() === "") {
+    return "";
+  }
+  const escapedValue = escapeQuotes(value.replace(/\n/g, " "));
+  const escapedTableName = escapeQuotes(level1name);
+
+  if (level2name) {
+    const escapedColumnName = escapeQuotes(level2name);
+    return `
+EXEC sys.sp_addextendedproperty
+    @name=N'MS_Description', @value=N'${escapedValue}',
+    @level0type=N'SCHEMA',@level0name=N'dbo',
+    @level1type=N'TABLE',@level1name=N'${escapedTableName}',
+    @level2type=N'COLUMN',@level2name=N'${escapedColumnName}';
+GO
+`;
+  } else {
+    return `
+EXEC sys.sp_addextendedproperty
+    @name=N'MS_Description', @value=N'${escapedValue}',
+    @level0type=N'SCHEMA',@level0name=N'dbo',
+    @level1type=N'TABLE',@level1name=N'${escapedTableName}';
+GO
+`;
+  }
+}
+
 export function toMSSQL(diagram) {
-  return `${diagram.tables
-    .map(
-      (table) =>
-        `${
-          table.comment === "" ? "" : `/**\n${table.comment}\n*/\n`
-        }CREATE TABLE [${table.name}] (\n${table.fields
-          .map(
-            (field) =>
-              `${exportFieldComment(field.comment)}\t[${
-                field.name
-              }] ${field.type}${
-                field.notNull ? " NOT NULL" : ""
-              }${field.increment ? " IDENTITY" : ""}${
-                field.unique ? " UNIQUE" : ""
-              }${
-                field.default !== ""
-                  ? ` DEFAULT ${parseDefault(field, diagram.database)}`
-                  : ""
-              }${
-                field.check === "" ||
-                !dbToTypes[diagram.database][field.type].hasCheck
-                  ? ""
-                  : ` CHECK(${field.check})`
-              }`,
-          )
-          .join(",\n")}${
-          table.fields.filter((f) => f.primary).length > 0
-            ? `,\n\tPRIMARY KEY(${table.fields
-                .filter((f) => f.primary)
-                .map((f) => `[${f.name}]`)
-                .join(", ")})`
-            : ""
-        }\n);\nGO\n${`${table.indices
-          .map(
-            (i) =>
-              `\nCREATE ${i.unique ? "UNIQUE " : ""}INDEX [${
-                i.name
-              }]\nON [${table.name}] (${i.fields
-                .map((f) => `[${f}]`)
-                .join(", ")});\nGO\n`,
-          )
-          .join("")}`}`,
-    )
-    .join("\n")}\n${diagram.references
-    .map((r) => {
-      const { name: startName, fields: startFields } = diagram.tables.find(
-        (t) => t.id === r.startTableId,
+  const tablesSql = diagram.tables
+    .map((table) => {
+      const fieldsSql = table.fields
+        .map(
+          (field) =>
+            `\t[${field.name}] ${field.type}${
+              field.notNull ? " NOT NULL" : ""
+            }${field.increment ? " IDENTITY" : ""}${
+              field.unique ? " UNIQUE" : ""
+            }${
+              field.default !== ""
+                ? ` DEFAULT ${parseDefault(field, diagram.database)}`
+                : ""
+            }${
+              field.check === "" ||
+              !dbToTypes[diagram.database][field.type].hasCheck
+                ? ""
+                : ` CHECK(${field.check})`
+            }`,
+        )
+        .join(",\n");
+
+      const primaryKeys = table.fields.filter((f) => f.primary);
+      const primaryKeySql =
+        primaryKeys.length > 0
+          ? `,\n\tPRIMARY KEY(${primaryKeys
+              .map((f) => `[${f.name}]`)
+              .join(", ")})`
+          : "";
+
+      const createTableSql = `CREATE TABLE [${
+        table.name
+      }] (\n${fieldsSql}${primaryKeySql}\n);\nGO\n`;
+
+      const tableCommentSql = generateAddExtendedPropertySQL(
+        table.comment,
+        table.name,
       );
 
-      const { name: endName, fields: endFields } = diagram.tables.find(
-        (t) => t.id === r.endTableId,
-      );
-      return `ALTER TABLE [${startName}]\nADD FOREIGN KEY([${
-        startFields.find((f) => f.id === r.startFieldId).name
-      }]) REFERENCES [${endName}]([${
-        endFields.find((f) => f.id === r.endFieldId).name
-      }])\nON UPDATE ${r.updateConstraint.toUpperCase()} ON DELETE ${r.deleteConstraint.toUpperCase()};\nGO`;
+      const columnCommentsSql = table.fields
+        .map((field) =>
+          generateAddExtendedPropertySQL(field.comment, table.name, field.name),
+        )
+        .join("");
+
+      const indicesSql = table.indices
+        .map(
+          (i) =>
+            `\nCREATE ${i.unique ? "UNIQUE " : ""}INDEX [${
+              i.name
+            }]\nON [${table.name}] (${i.fields
+              .map((f) => `[${f}]`)
+              .join(", ")});\nGO\n`,
+        )
+        .join("");
+
+      return `${createTableSql}${tableCommentSql}${columnCommentsSql}${indicesSql}`;
     })
-    .join("\n")}`;
+    .join("\n");
+
+  const referencesSql = diagram.references
+    .map((r) => {
+      const startTable = diagram.tables.find((t) => t.id === r.startTableId);
+      const endTable = diagram.tables.find((t) => t.id === r.endTableId);
+
+      if (!startTable || !endTable) return "";
+
+      const startField = startTable.fields.find(
+        (f) => f.id === r.startFieldId,
+      );
+      const endField = endTable.fields.find((f) => f.id === r.endFieldId);
+
+      if (!startField || !endField) return "";
+
+      return `\nALTER TABLE [${startTable.name}]
+ADD FOREIGN KEY([${startField.name}])
+REFERENCES [${endTable.name}]([${endField.name}])
+ON UPDATE ${r.updateConstraint.toUpperCase()} ON DELETE ${r.deleteConstraint.toUpperCase()};
+GO`;
+    })
+    .join("");
+
+  return `${tablesSql}\n${referencesSql}`;
 }