Documentation

Schemity documentation

Everything you need to get productive with Schemity, the offline ERD tool for software engineers. These 28 guides cover creating a workspace, connecting PostgreSQL, MySQL, MariaDB, SQL Server, and SQLite, reverse engineering a live database, Context Views, migration SQL diffs, and the plain JSON storage format you can version control with Git.

Getting Started

What is Schemity
Install & First Launch
Create a Workspace
Quick Start (5-minute tour)
Tabs & Navigation

Connections

Connections Overview
Connect to PostgreSQL
Connect to MySQL
Connect to SQL Server
Connect to SQLite
Reverse-Engineer an Existing Database
Keep Your ERD in Sync with the Database

Designing Your ERD

The ERD Canvas
Entities & Fields
Templates
Relationships
Check Constraints & Composite Unique
Custom Waypoints
Junction Tables (Many-to-Many)

Organizing Schemas

Context Views
Legends & Annotations
Single Source of Truth workflow

Storage & Version Control

JSON Storage Format
Version Control in Git

AI Features

BYOK Setup (bring your own key)
AI-Assisted Design (offline / private)

Export & Migrations

Export SQL / Generate DDL
Migration SQL Diff