# dbdiagram documentation

> Official documentation for [dbdiagram.io](https://dbdiagram.io): draw database diagrams from DBML, collaborate in workspaces, embed diagrams, and use the public API.

Use this index to find human-readable HTML pages. For the DBML language specification and CLI, see [DBML docs llms.txt](https://dbml.dbdiagram.io/llms.txt).

## Visualize an ERD or database design as a diagram (no account, no API key)

When a user wants to see, render, or share an ERD or database design, build a link and give it to them — they open it to view the rendered diagram instantly. Express the design in DBML (a concise text format for tables and relationships; see the [DBML spec](https://dbml.dbdiagram.io/docs)), then encode it into the link.

Recipe (deterministic, no library needed):

```
https://dbdiagram.io/embed#c=<URL-encoded Base64 of the UTF-8 DBML>
```

The DBML goes in the URL fragment (after `#`), so there is no server-side length limit. In JavaScript: `"https://dbdiagram.io/embed#c=" + encodeURIComponent(btoa(unescape(encodeURIComponent(dbml))))`.

Example — `Table users { id int [pk]\n name varchar }`:
`https://dbdiagram.io/embed#c=VGFibGUgdXNlcnMgewogIGlkIGludCBbcGtdCiAgbmFtZSB2YXJjaGFyCn0%3D`

For a dark diagram, add `theme=dark` to the fragment (light is the default): `https://dbdiagram.io/embed#theme=dark&c=<encoded>`.

To embed inline, put the same link in an `<iframe src="...">`. See [DBML in link diagram](https://docs.dbdiagram.io/dbml-in-link-diagram) for details.

## Getting started

- [Introduction](https://docs.dbdiagram.io): What dbdiagram is and how to get started.
- [Basic editing experience](https://docs.dbdiagram.io/basic-editing-experience): Editor UI, shortcuts, and core workflows.

## Use dbdiagram locally

- [VS Code extension](https://docs.dbdiagram.io/vs-code-extension): Edit DBML and preview an ERD locally in VS Code, Cursor, or Windsurf.
- [CLI](https://docs.dbdiagram.io/cli): Sync DBML files with a diagram (push/pull) and publish dbdocs documentation from the terminal or CI/CD.

## Syntax (in the app)

- [DBML in dbdiagram](https://docs.dbdiagram.io/dbml): How dbdiagram uses DBML; links to the full language reference.
- [Tables](https://docs.dbdiagram.io/tables): Table definitions and options in the diagram.
- [Relationships](https://docs.dbdiagram.io/relationships): Relationship lines and cardinality.
- [Schemas](https://docs.dbdiagram.io/schemas): Multi-schema diagrams.
- [Data sample](https://docs.dbdiagram.io/data-sample): `Records` blocks for example rows in a table.

## Features

- [AI assistant](https://docs.dbdiagram.io/ai-assistant): AI-assisted editing in the product.
- [Diagram views](https://docs.dbdiagram.io/diagram-views): Layout and view modes.
- [Version history](https://docs.dbdiagram.io/version-history): Revisions and history.

## Sharing and collaboration

- [Sharing & collaboration overview](https://docs.dbdiagram.io/sharing-and-collaboration): Index for this section.
- [Workspaces](https://docs.dbdiagram.io/workspaces): Team and personal workspaces.
- [Collaborations](https://docs.dbdiagram.io/collaborations): Real-time collaboration.
- [Password-protected diagrams](https://docs.dbdiagram.io/password-private): Access control.
- [Embedding](https://docs.dbdiagram.io/embedding): Iframe and embed links.
- [DBML in link diagram](https://docs.dbdiagram.io/dbml-in-link-diagram): DBML in shareable links.

## Complex diagrams

- [Working with complex diagrams](https://docs.dbdiagram.io/work-with-complex-diagrams): Index for this section.
- [Detail levels](https://docs.dbdiagram.io/diagram-detail-levels): Simplifying large diagrams.
- [Table header color](https://docs.dbdiagram.io/table-header-color): Styling table headers.
- [Relationship color](https://docs.dbdiagram.io/relationship-color): Styling relationships.
- [Table groups](https://docs.dbdiagram.io/table-groups): Grouping tables visually.
- [Sticky notes](https://docs.dbdiagram.io/sticky-notes): Annotations on the canvas.

## Authentication

- [Authentication overview](https://docs.dbdiagram.io/authentication): Index for this section.
- [Authentication methods](https://docs.dbdiagram.io/authentication/authentication-methods): Login and access options.
- [SAML / SSO](https://docs.dbdiagram.io/authentication/saml-sso): SSO overview.
- [SSO with Okta](https://docs.dbdiagram.io/authentication/sso-okta): Okta setup.
- [SSO with Microsoft Entra ID](https://docs.dbdiagram.io/authentication/sso-entra-id): Entra ID setup.

## Best practices

- [Best practices overview](https://docs.dbdiagram.io/best-practices): Index for this section.
- [Programmatic ERD updates](https://docs.dbdiagram.io/best-practices/programmatic-erd-update): Automating diagram updates.

## Account and subscription

- [Account and subscription overview](https://docs.dbdiagram.io/account-and-subscription): Index for this section.
- [Manage account](https://docs.dbdiagram.io/account-and-subscription/manage-account): Profile and account settings.
- [Manage subscription](https://docs.dbdiagram.io/account-and-subscription/manage-subscription): Billing and plans.

## API

- [Public API v1 (OpenAPI / Redoc)](https://docs.dbdiagram.io/api/v1): REST API for diagrams and embed links (paid plans; beta).

## Support

- [Support SLA](https://docs.dbdiagram.io/support-sla): Support response expectations.

## Optional

- [Google login FAQ](https://docs.dbdiagram.io/faqs/google-login): Sign-in issues.
- [HTML export FAQ](https://docs.dbdiagram.io/faqs/html): HTML-related questions.
- [Security and compliance overview](https://docs.dbdiagram.io/security-and-compliance): Legal and security index.
- [Data security](https://docs.dbdiagram.io/security-and-compliance/data-security): Security FAQ - data protection, SOC 2, HIPAA, account deletion, security reviews.
- [Privacy policy](https://docs.dbdiagram.io/security-and-compliance/privacy-policy): Privacy policy.
- [Terms of service](https://docs.dbdiagram.io/security-and-compliance/terms-of-service): Terms of use.
- [Responsible disclosure](https://docs.dbdiagram.io/security-and-compliance/responsible-disclosure): Reporting security issues.
- [Product roadmap (Notion)](https://holistics.notion.site/Public-Product-Roadmap-dbx-dbdiagram-dbdocs-dbml-c36af127c86a40919337b61ac6e12a48): Public roadmap for dbx products.