DbSchema Documentation

DbSchema is a visual database design and management tool for 70+ SQL and NoSQL databases. This guide walks you through every feature, from your first connection to team collaboration with Git.

Start a New Project

Open DbSchema and choose how to begin: connect to a database to reverse-engineer an existing schema, design from scratch to start with a blank canvas, or import from file to load SQL, CSV, or SQLite data. DbSchema downloads the required JDBC driver automatically.

DbSchema start project - connect, design from scratch, or import

Next steps: Welcome Screen | Connection Dialog | Quick Tutorial

Design Tables on Interactive Diagrams

Double-click any table to open the inline editor. Add columns, set data types, define primary keys, and write column comments without leaving the diagram. Changes are reflected instantly.

Edit a table directly on the ER diagram

Next steps: Tables, Columns & Indexes | Foreign Keys & Relationships | Logical Design

Create Multiple Diagrams

Split a large schema into focused diagrams, one per module, microservice, or feature area. Each diagram is saved inside the same project file, so nothing gets lost.

Create multiple diagrams for different schema areas

Next steps: Diagrams | Interface Overview

Customize the Diagram View

Choose how much detail to show: display column data types, hide or show foreign-key columns, switch between compact and expanded table headers, or toggle relationship labels.

Show or hide column data types on the diagram

Next steps: Diagrams | Settings

Save Everything in the Design Model

The design model is a single .dbs file that stores your schemas, diagrams, queries, and saved editors. You can work offline, share the file via Git, and reopen it without a live database connection.

The DbSchema design model file

Next steps: Design Model Overview | Import SQL / DDL and Migration Scripts

Design Without a Database Connection

Create and modify tables in the model without affecting any live database. When you are ready, connect to a target database and deploy your changes with schema synchronization.

Design a schema offline without a database connection

Next steps: Synchronize with Database | Model Validation

Synchronize Schema Changes

Compare your design model against a live database, review every difference side by side, and generate the migration SQL. Apply it to dev, test, or production with one click.

Compare and synchronize schema between model and database

Next steps: Synchronize with Database

Generate Interactive Documentation

Export your entire schema as an interactive HTML5 page complete with diagrams, table descriptions, and column-level tooltips. Share it with stakeholders who do not have DbSchema installed.

Export schema documentation as interactive HTML5

Next steps: Generate Documentation

Collaborate with Git

Save your .dbs project in a Git repository. Every schema change is tracked as a commit, branches let team members work in parallel, and merges bring everything together.

Version-control your database schema with Git

Next steps: Working as a Team with Git | Git Basics Overview

Explore and Edit Data

The Relational Data Explorer lets you browse rows across related tables in a single view. Follow foreign-key links, filter and sort inline, and edit cell values directly.

Browse and edit data across related tables

Next steps: Relational Data Editor

Generate Test Data

Populate your tables with realistic sample data. Choose from built-in generators for names, emails, dates, numbers, and more, or write custom expressions. Referential integrity is maintained automatically.

Generate realistic test data for your tables

Next steps: Data Generator | Data Importer | Data Loader

Build Queries Visually

Click columns and relationships on a visual canvas to build SQL queries without writing code. The generated SQL updates in real time. Run it, export it, or copy it into your application.

Build SQL queries visually with the Query Builder

Next steps: Query Builder

Write and Execute SQL

A full-featured SQL editor with syntax highlighting, auto-complete, and a tabular result viewer. Execute single statements or entire scripts, and review results side by side.

Write and execute SQL in the DbSchema SQL Editor

Next steps: SQL Editor

Automate with Scripts

Record repetitive tasks like data imports, schema patches, and report generation as Groovy scripts and replay them on demand or schedule them with your CI pipeline.

Automate database tasks with Groovy scripts

Next steps: Automation Scripts | AI Assistant | DbSchemaCLI

Licensing and Registration

DbSchema offers a free Community Edition plus the Pro and Architect editions, with a 15-day trial. Licenses are tied to your account and can be transferred between machines.

DbSchema licensing and registration

Next steps: Licensing & Registration