Skip to main content

A Quick Tour Around dbdocs.io

Welcome to dbdocs.io! If you're reading this document, you probably have been able to set up dbdocs.io and are looking to get familiar with the platform. This doc will help you with that!

For demo purpose, we'll use our example in the Quickstart guide.

Overview​

Go to https://dbdocs.io/khanh-tran-quoc/Ecommerce. The first screen shows you an overview of your schema.

Project Overview

Table Structure​

Let's start exploring by clicking merchants table

Table Structure

Table structure of merchants is shown in the Fields section.

Table Fields

In the References column, you can see that merchants has relationships with products, contries and users. Clicking product.merchant_id will lead you to the target table.

Table References

dbdocs lets you jump between related tables. Not only that, but it also visualizes the relationships between those tables. You can find a visual representation of those related tables under the Table references section.

Table References Diagram

Quick tip: Do you know that you can prototype table schema diagrams by using our FREE tool dbdiagram.io?

Search Capability​

You can search for tables, fields, table notes, field notes, etc., via the search box on top of the database structure sidebar.

Search entities within project

Relationships​

dbdocs also visualizes the entire schema. See it under the Relationships tab:

Relationship diagrams

Quick tip: You can rearrange the diagrams using drag & drop.

Share​

There are different options to share projects with others:

  • Public: Anyone with the link can access it.
  • Password-protected: Anyone with the link and password can access it.
  • Private: Only invited people can access it.

Project access control

Protected Project​

If you've already generated a password for your document, remember to share it, too. By default, anyone can access the document if they have the link. But if you've set a password for it, they will need to enter password before being able to view.

Protected project

Private Project​

You may control who can view your dbdocs project by using private mode and inviting other users to your project.

Private project

Project list​

You can view all your database projects via your organization page by select "My Projects" in the account dropdown menu

Manage all project

If you have any questions or requests, send us an email at [email protected], we will get back to you shortly!