Database diagrams editor that allows you to visualize and design your DB with a single query.
TypeScript databasedbdb-migrationeditorerdmariadbmssqlmysqlpostgresqlreactreact-flowschema-migrationssqlsqlitetypescriptvisualizationxyflow
fix(sql-export): escape newlines and quotes in multi-line comments (#765)
Jonathan Fishnerf7f92903def8
diff --git a/src/lib/data/export-metadata/export-per-type/common.ts b/src/lib/data/export-metadata/export-per-type/common.tsindex f935e406..ff0c7847 100644--- a/src/lib/data/export-metadata/export-per-type/common.ts+++ b/src/lib/data/export-metadata/export-per-type/common.ts@@ -48,6 +48,50 @@ export function exportFieldComment(comment: string): string {.join('');}+export function escapeSQLComment(comment: string): string {+ if (!comment) {+ return '';+ }++ // Escape single quotes by doubling them+ let escaped = comment.replace(/'/g, "''");++ // Replace newlines with spaces to prevent breaking SQL syntax+ // Some databases support multi-line comments with specific syntax,+ // but for maximum compatibility, we'll replace newlines with spaces+ escaped = escaped.replace(/[\r\n]+/g, ' ');++ // Trim any excessive whitespace+ escaped = escaped.replace(/\s+/g, ' ').trim();++ return escaped;+}++export function formatTableComment(comment: string): string {+ if (!comment) {+ return '';+ }++ // Split by newlines and add -- to each line+ return (+ comment+ .split('\n')+ .map((line) => `-- ${line}`)+ .join('\n') + '\n'+ );+}++export function formatMSSQLTableComment(comment: string): string {+ if (!comment) {+ return '';+ }++ // For MSSQL, we use multi-line comment syntax+ // Escape */ to prevent breaking the comment block+ const escaped = comment.replace(/\*\//g, '* /');+ return `/**\n${escaped}\n*/\n`;+}+export function getInlineFK(table: DBTable, diagram: Diagram): string {if (!diagram.relationships) {return '';diff --git a/src/lib/data/export-metadata/export-per-type/mssql.ts b/src/lib/data/export-metadata/export-per-type/mssql.tsindex 7f9b5566..7148180d 100644--- a/src/lib/data/export-metadata/export-per-type/mssql.ts+++ b/src/lib/data/export-metadata/export-per-type/mssql.ts@@ -1,5 +1,6 @@import {exportFieldComment,+ formatMSSQLTableComment,isFunction,isKeyword,strHasQuotes,@@ -108,7 +109,7 @@ export function exportMSSQL(diagram: Diagram): string {: `[${table.name}]`;return `${- table.comments ? `/**\n${table.comments}\n*/\n` : ''+ table.comments ? formatMSSQLTableComment(table.comments) : ''}CREATE TABLE ${tableName} (\n${table.fields.map((field: DBField) => {const fieldName = `[${field.name}]`;diff --git a/src/lib/data/export-metadata/export-per-type/mysql.ts b/src/lib/data/export-metadata/export-per-type/mysql.tsindex 122d915a..a9c51ab3 100644--- a/src/lib/data/export-metadata/export-per-type/mysql.ts+++ b/src/lib/data/export-metadata/export-per-type/mysql.ts@@ -1,5 +1,7 @@import {exportFieldComment,+ escapeSQLComment,+ formatTableComment,isFunction,isKeyword,strHasQuotes,@@ -215,7 +217,7 @@ export function exportMySQL(diagram: Diagram): string {const primaryKeyFields = table.fields.filter((f) => f.primaryKey);return `${- table.comments ? `-- ${table.comments}\n` : ''+ table.comments ? formatTableComment(table.comments) : ''}CREATE TABLE IF NOT EXISTS ${tableName} (\n${table.fields.map((field: DBField) => {const fieldName = `\`${field.name}\``;@@ -289,7 +291,7 @@ export function exportMySQL(diagram: Diagram): string {// MySQL supports inline commentsconst comment = field.comments- ? ` COMMENT '${field.comments.replace(/'/g, "''")}'`+ ? ` COMMENT '${escapeSQLComment(field.comments)}'`: '';return `${exportFieldComment(field.comments ?? '')} ${fieldName} ${typeWithSize}${notNull}${autoIncrement}${unique}${defaultValue}${comment}`;@@ -304,7 +306,7 @@ export function exportMySQL(diagram: Diagram): string {}\n)${// MySQL supports table commentstable.comments- ? ` COMMENT='${table.comments.replace(/'/g, "''")}'`+ ? ` COMMENT='${escapeSQLComment(table.comments)}'`: ''};\n\n${// Add indexes - MySQL creates them separately from the table definitiondiff --git a/src/lib/data/export-metadata/export-per-type/postgresql.ts b/src/lib/data/export-metadata/export-per-type/postgresql.tsindex 8ed9b5ab..c98c5f02 100644--- a/src/lib/data/export-metadata/export-per-type/postgresql.ts+++ b/src/lib/data/export-metadata/export-per-type/postgresql.ts@@ -1,5 +1,7 @@import {exportFieldComment,+ escapeSQLComment,+ formatTableComment,isFunction,isKeyword,strHasQuotes,@@ -216,7 +218,7 @@ export function exportPostgreSQL(diagram: Diagram): string {const primaryKeyFields = table.fields.filter((f) => f.primaryKey);return `${- table.comments ? `-- ${table.comments}\n` : ''+ table.comments ? formatTableComment(table.comments) : ''}CREATE TABLE ${tableName} (\n${table.fields.map((field: DBField) => {const fieldName = `"${field.name}"`;@@ -311,7 +313,7 @@ export function exportPostgreSQL(diagram: Diagram): string {}\n);\n\n${// Add table commentstable.comments- ? `COMMENT ON TABLE ${tableName} IS '${table.comments.replace(/'/g, "''")}';\n\n`+ ? `COMMENT ON TABLE ${tableName} IS '${escapeSQLComment(table.comments)}';\n\n`: ''}${// Add column comments@@ -319,7 +321,7 @@ export function exportPostgreSQL(diagram: Diagram): string {.filter((f) => f.comments).map((f) =>- `COMMENT ON COLUMN ${tableName}."${f.name}" IS '${f.comments?.replace(/'/g, "''")}';\n`+ `COMMENT ON COLUMN ${tableName}."${f.name}" IS '${escapeSQLComment(f.comments || '')}';\n`).join('')}\n${diff --git a/src/lib/data/export-metadata/export-per-type/sqlite.ts b/src/lib/data/export-metadata/export-per-type/sqlite.tsindex d980c002..e897cac6 100644--- a/src/lib/data/export-metadata/export-per-type/sqlite.ts+++ b/src/lib/data/export-metadata/export-per-type/sqlite.ts@@ -1,5 +1,6 @@import {exportFieldComment,+ formatTableComment,isFunction,isKeyword,strHasQuotes,@@ -195,7 +196,7 @@ export function exportSQLite(diagram: Diagram): string {primaryKeyFields[0].type.name.toLowerCase() === 'int');return `${schemaComment}${- table.comments ? `-- ${table.comments}\n` : ''+ table.comments ? formatTableComment(table.comments) : ''}CREATE TABLE IF NOT EXISTS ${tableName} (\n${table.fields.map((field: DBField) => {const fieldName = `"${field.name}"`;diff --git a/src/lib/data/export-metadata/export-sql-script.ts b/src/lib/data/export-metadata/export-sql-script.tsindex dfc5fb08..9c4c5d74 100644--- a/src/lib/data/export-metadata/export-sql-script.ts+++ b/src/lib/data/export-metadata/export-sql-script.ts@@ -285,13 +285,13 @@ export const exportBaseSQL = ({// Add table commentif (table.comments) {- sqlScript += `COMMENT ON TABLE ${tableName} IS '${table.comments}';\n`;+ sqlScript += `COMMENT ON TABLE ${tableName} IS '${table.comments.replace(/'/g, "''")}';\n`;}table.fields.forEach((field) => {// Add column commentif (field.comments) {- sqlScript += `COMMENT ON COLUMN ${tableName}.${field.name} IS '${field.comments}';\n`;+ sqlScript += `COMMENT ON COLUMN ${tableName}.${field.name} IS '${field.comments.replace(/'/g, "''")}';\n`;}});