Skip to content

Quote and escape identifiers with spaces, umlauts, or non-ASCII characters in DBML export #582

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 17, 2025
Merged

Quote and escape identifiers with spaces, umlauts, or non-ASCII characters in DBML export #582

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 21 additions & 7 deletions src/utils/exportAs/dbml.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,18 @@ import i18n from "../../i18n/i18n";
import { escapeQuotes } from "../exportSQL/shared";
import { isFunction, isKeyword } from "../utils";

const IDENT_SAFE_RE = /^[A-Za-z_][A-Za-z0-9_]*$/;

function escapeIdentifier(s) {
return String(s).replace(/\\/g, "\\\\").replace(/"/g, '\\"');
}

function quoteIdentifier(name) {
if (name == null) return name;
const s = String(name);
return IDENT_SAFE_RE.test(s) ? s : `"${escapeIdentifier(s)}"`;
}

function parseDefaultDbml(field, database) {
if (isFunction(field.default)) {
return `\`${field.default}\``;
Expand Down Expand Up @@ -96,7 +108,7 @@ export function toDBML(diagram) {
(f) => f.id === rel.endFieldId,
);

return `Ref ${rel.name} {\n\t${startTableName}.${startFieldName} ${cardinality(rel)} ${endTableName}.${endFieldName} [ delete: ${rel.deleteConstraint.toLowerCase()}, update: ${rel.updateConstraint.toLowerCase()} ]\n}`;
return `Ref ${rel.name} {\n\t${quoteIdentifier(startTableName)}.${quoteIdentifier(startFieldName)} ${cardinality(rel)} ${quoteIdentifier(endTableName)}.${quoteIdentifier(endFieldName)} [ delete: ${rel.deleteConstraint.toLowerCase()}, update: ${rel.updateConstraint.toLowerCase()} ]\n}`;
};

let enumDefinitions = "";
Expand All @@ -107,25 +119,25 @@ export function toDBML(diagram) {
(field.type === "ENUM" || field.type === "SET") &&
Array.isArray(field.values)
) {
enumDefinitions += `enum ${field.name}_${field.values.join("_")}_t {\n\t${field.values.join("\n\t")}\n}\n\n`;
enumDefinitions += `enum ${quoteIdentifier(`${field.name}_${field.values.join("_")}_t`)} {\n\t${field.values.map((v) => quoteIdentifier(v)).join("\n\t")}\n}\n\n`;
}
}
}

return `${diagram.enums
.map(
(en) =>
`enum ${en.name} {\n${en.values.map((v) => `\t${v}`).join("\n")}\n}\n\n`,
`enum ${quoteIdentifier(en.name)} {\n${en.values.map((v) => `\t${quoteIdentifier(v)}`).join("\n")}\n}\n\n`,
)
.join("\n\n")}${enumDefinitions}${diagram.tables
.map(
(table) =>
`Table ${table.name} [headercolor: ${table.color}] {\n${table.fields
`Table ${quoteIdentifier(table.name)} [headercolor: ${table.color}] {\n${table.fields
.map(
(field) =>
`\t${field.name} ${
`\t${quoteIdentifier(field.name)} ${
field.type === "ENUM" || field.type === "SET"
? `${field.name}_${field.values.join("_")}_t`
? quoteIdentifier(`${field.name}_${field.values.join("_")}_t`)
: field.type.toLowerCase()
}${fieldSize(
field,
Expand All @@ -138,7 +150,9 @@ export function toDBML(diagram) {
table.indices
.map(
(index) =>
`\t\t(${index.fields.join(", ")}) [ name: '${
`\t\t(${index.fields
.map((f) => quoteIdentifier(f))
.join(", ")}) [ name: '${
index.name
}'${index.unique ? ", unique" : ""} ]`,
)
Expand Down