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.
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.
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.
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.
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.
Next steps: Design Model Overview | Import SQL / DDL
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.
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.
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.
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.
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.
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.
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.
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.
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.
Next steps: Automation Scripts | AI Assistant | DbSchemaCLI
Licensing and Registration
DbSchema offers a free Community Edition and a Pro Edition with a 15-day trial. Licenses are tied to your account and can be transferred between machines.
Next steps: Licensing & Registration