Skip to content

Fix dbml comment export #699

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
Nov 15, 2025
Merged

Fix dbml comment export #699

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
27 changes: 18 additions & 9 deletions src/utils/exportAs/dbml.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,14 +40,6 @@ function columnDefault(field, database) {
return `default: ${parseDefaultDbml(field, database)}`;
}

function columnComment(field) {
if (!field.comment || field.comment.trim() === "") {
return "";
}

return `note: '${escapeQuotes(field.comment)}'`;
}

function columnSettings(field, database) {
let constraints = [];

Expand Down Expand Up @@ -98,6 +90,23 @@ function processComment(comment) {
return `'${escapeQuotes(comment)}'`;
}

function columnComment(field) {
if (!field.comment || field.comment.trim() === "") {
return "";
}

return `note: ${processComment(field.comment)}`;
}

function processType(type) {
// TODO: remove after a while
if (type.toUpperCase() === "TIMESTAMP WITH TIME ZONE") {
return "timestamptz";
}

return type.toLowerCase();
}

export function toDBML(diagram) {
const generateRelString = (rel) => {
const { fields: startTableFields, name: startTableName } =
Expand Down Expand Up @@ -142,7 +151,7 @@ export function toDBML(diagram) {
`\t${quoteIdentifier(field.name)} ${
field.type === "ENUM" || field.type === "SET"
? quoteIdentifier(`${field.name}_${field.values.join("_")}_t`)
: field.type.toLowerCase()
: processType(field.type)
}${fieldSize(
field,
diagram.database,
Expand Down