How to share an ER diagram: links, embeds, images, and docs

Sooner or later someone outside the team needs to see the schema: a product manager scoping a feature, an analyst writing a query, a contractor, a customer’s integration engineer, or the readers of your open-source README. The usual answer is a screenshot, which is wrong within a week and cannot be searched, zoomed, or clicked.

There are five better ways to share an ER diagram. They differ in two things: who can see it, and whether it stays current. Pick by audience.

1. A read-only link, for specific people

For: a stakeholder, a contractor, another team. A share link opens the diagram in the browser with no account and no way to edit. The recipient can pan, zoom, and read every table, which a screenshot of sixty tables never allowed.

In DB Planner a share link is a private grant: only people who have the link can open it, and it is never listed anywhere. On the Free plan the link shows a snapshot of the board; on Pro it is live, so the person you sent it to watches the schema change as you change it. That turns a link into a way to walk someone through a design on a call without sharing your screen.

2. A seat on the team, for people who should take part

For: anyone whose opinion you want in writing. A link lets someone look. If they should also comment on a table or propose a change, invite them to the project as a viewer: they still cannot edit the schema directly, but their questions land on the diagram instead of in your inbox. How that works day to day is in building an ER diagram with your team.

3. A public board, for everyone

For: open-source projects, tutorials, a schema you are teaching from. Making a project public gives it one address anyone can open. It is the interactive diagram, not a picture of it.

Before you make anything public, read the column notes. Schemas pick up comments like “legacy, see incident 412” that were written for colleagues.

4. An embed, for your own docs and README

For: an engineering handbook, a docs site, a blog post. A public board can be embedded as an iframe: the Share dialog gives you the snippet, and the diagram renders inside your page, current every time the page loads. That is the difference from pasting an image into a wiki, where the picture starts ageing the day it is pasted.

Private share links are deliberately not embeddable, because an embed puts the address in a page’s source for anyone to read. For a repository README, where an iframe will not render, published schema docs come with a badge that links to them.

5. An image or a file, for everything else

For: a slide, a design document, a ticket, an audit. Sometimes a picture really is the right format, and sometimes the reader wants the schema itself. DB Planner exports the board as PNG or SVG, and the schema as DBML, SQL for PostgreSQL, MySQL, or SQL Server, or code such as Prisma and TypeScript. DBML, Mermaid, and SQL exports are included on Free, with ads; board images and the code formats are part of Pro.

Treat an exported image as a dated artifact. Put the date on the slide, and link to the live diagram underneath it.

Published schema docs, for people searching

One more audience is people who do not know your schema exists. A project’s creator can publish it as documentation: a page for the schema and one for each table, with every column, type, and note, indexed by search engines. This is a separate switch from the public board, on purpose. A board link is something you hand to someone; a docs page is something anyone can find. Browse the published schemas to see what they look like, and see how to document a database schema for what to write in the notes first.

Which one to use

  • One person needs to look, today: a read-only link.
  • They should be able to ask questions on it: a viewer seat.
  • It should sit inside your documentation: a public board, embedded.
  • It goes in a slide or a PDF: an exported image, dated.
  • Strangers should be able to find and read it: published schema docs.

Three mistakes to avoid

  • Sharing a copy. If the thing you sent can drift from the schema, it will, and someone will build on the old one. Prefer anything that renders from the source.
  • Sharing the database to share the schema. Giving an analyst a read-only database login so they can see the table shapes also gives them the rows. A diagram built from a schema dump shows structure and nothing else.
  • Sharing everything. A reader who needs the billing tables does not need two hundred others. Tell them which tables to look at, or keep that area in a project of its own.