Dbdiagram pull does not pull the Text comments?

dbdiagram pull --diagram-id -o jira.dbml downloads the DBML, but all the text comments are missing. However, if I download the DBML using the UI, everything is fine.

Jay

Hi @JayOnSoftware,

This is expected (and confusing) and currently, we’re working to improve this.

The reason is that dbdiagram and dbdocs store separate copies of the DBML. Notes you add directly in dbdocs (via the markdown editor) live only in the dbdocs copy, so dbdiagram pull won’t include them since it pulls from dbdiagram’s copy.

Two workarounds for now:

  1. Copy-paste the DBML from dbdocs back into dbdiagram so both copies stay in sync, then pull will include everything.
  2. Avoid editing notes in dbdocs. Instead, add your notes in dbdiagram instead (using DBML Note blocks, then you’ll able to edit in markdown editor that similar to dbdocs when hovering on the table/field) and treat dbdiagram as the single editing source. Then you can publish from dbdiagram to dbdocs and dbdocs will stay up to date.

We do plan to improve this sync flow in the future. For now, keeping dbdiagram as the source of truth is the most reliable approach.