S
DesignSQL

DesignSQL Documentation

Learn how to generate and document database schemas quickly, collaboratively, and in a structured way.

Write Code, See Diagrams Instantly

DesignSQL features a Monaco-powered DBML (Database Markup Language) editor — the same editor used by VS Code — with visual diagrams that update instantly as you type. No need to click "generate" or reload. Code and diagrams are always in sync.

Read More →

Diagrams You Can Touch and Edit Directly

More than just images. Diagrams in DesignSQL are fully interactive — drag tables anywhere, create relationships by drawing lines between columns, and edit properties directly from the canvas.

Read More →

Not a Fan of Coding? Edit via the Table Panel

For those who prefer a visual interface, the Table Panel provides a structured view of all tables and columns. Add, edit, and delete columns directly from the panel — changes are automatically reflected in the code and diagram.

Read More →

Don't Fear Mistakes Everything is Saved, Everything Can Be Restored

Every change is automatically saved. DesignSQL keeps a complete history of your schema, so you can see what changed at any time, compare two versions, and restore to a previous state.

Read More →

Design Schemas with Your Team

Invite team members to work on database schemas together. Control who can edit and who can only view. Changes sync instantly for everyone.

Read More →

Share Diagrams with Anyone No Account Required

Need to show your database schema to clients, reviewers, or stakeholders? Generate a one-click preview link. They can view the latest diagram without needing to log in, and without the ability to make changes.

Read More →

Documentation Directly Inside Your Schema

Create notes and documentation that connect directly to specific tables. No need to open Notion or Confluence separately — everything is inside DesignSQL. The editor is powered by BlockSuite for a modern rich text writing experience.

Read More →

Export Schemas to the Formats You Need

Once your schema is complete, export it to ready-to-use SQL, DBML to save in your repo, or JSON for further processing. Export diagram images for presentations or documentation.

Read More →

Start from an Existing Database

Already have a running database? Import its schema into DesignSQL in minutes using our provided CLI tool. Supports all popular databases.

Read More →

Integrate DesignSQL into Your Developer Workflow

Use the @designsql/sync CLI to push and pull schemas directly between your database and DesignSQL. Perfect for teams who want to keep their schema synchronized between the development database and visual documentation.

Read More →

An Editor That Feels Like Yours

The Settings Panel provides full control over the appearance of the code editor and visual diagrams. All changes are automatically saved to your account and apply across all devices when logged in.

Read More →

Three Status Indicators, So You Never Lose Your Work

DesignSQL provides automatic auto-saves every 5 minutes that run in the background. Every real-time change detected is immediately flagged with a status indicator in the corner.

Read More →

Reopen and Continue From Where You Left Off

When you reopen DesignSQL — after a refresh, closing the tab, or opening from another device — your project, version, and the last table positions are automatically restored exactly to their last state.

Read More →