Getting Started

First Step

Welcome to DbSchema.

The easiest way to start your first project is by connecting to database, which allows you to immediately explore and visualize your schema. Alternatively, you can design from scratch without a database connection and deploy it later, or import from file such as SQLite or CSV.

As soon as you choose your database, you will be taken to the Database Connection Dialog.

There, you can select your connection mode, for example Standard mode, specify the server where your database is hosted, and then authenticate using your Database User name and Password.

Create Tables and Diagrams:

Nice, now you can start working on your first project.

On the right side in Diagram View, you can create and edit tables to build your full diagram, while on the left side in Project Structure you can see your database schema, including your tables, which you can also drag into the diagram. At the top in the Toolbar, you will find important tools such as the Data Editor, Query Builder, and SQL Editor. Don’t forget to save your file.

With a right-click in Diagram View, you can create your first table (Create Table).

Give it a Table Name and add columns, for example an ID, first name, and last name. You can also define the data types, add comments and set options such as primary keys or whether null values are allowed.

Drag and drop a column from one table to another to create a foreign key and establish a relationship between your tables, which is visualized by an arrow between them.

Under Data Type, you can choose whether the relationship should be displayed between the two columns that form the foreign key or between the two tables. You can also choose whether the column data types should be displayed.

You can create as many diagrams as you like, each containing the same or different tables. This allows you to focus on a specific part of your schema or work on a completely new area.

Document the schema

You can export your diagram as an HTML file to share with your team by clicking on Diagram in the Menu Bar and then selecting Export HTML5/MD/PDF Documentation. The exported HTML documentation preserves the structure of your tables and relationships, and allows you to see column types and comments with a simple mouse-over tooltip.

Share the design in the team

If you work disconnected, you can add and edit tables in your model without affecting your database. Later, when you reconnect, you can synchronize your database with your model.

You can save all your schemas in a single file, called the design model. This file preserves all your schemas, even if you are working disconnected from your database.

This allows you to work on your schema anywhere, and easily share your work with your team.

Data Tools

The application provides various data tools to help you work with your data.

One of these tools is the Relational Data Editor, which you can open by right-clicking on a table header or by using the menu above. The Relational Data Editor allows you to explore and edit data from multiple tables that are connected via foreign keys or virtual foreign keys.

Another tool lets you generate sample data, where you can choose data types and configure additional options.

Query Tools

The Query Builder helps you create SQL queries automatically — you simply click on the columns in your tables and their relationships. You can add more tables to your Query Builder diagram by clicking the foreign key symbol.

The SQL Editor lets you write and execute SQL code.