ContextQMD
Back to Yugabyte Db

Use DbSchema with YugabyteDB YSQL

docs/content/stable/integrations/tools/dbschema.md

2026.1.0.0-b252.6 KB
Original Source

DbSchema is a visual database tool that supports over 40 databases from a single interface, and can be used to reverse-engineer schemas, edit entity-relationship (ER) diagrams, browse data, visually build queries, and synchronize schemas. This document describes how to connect DbSchema to YugabyteDB databases.

Before you begin

Your YugabyteDB cluster should be up and running. Refer to YugabyteDB prerequisites.

Install DbSchema

  1. Download the distribution package for the operating system on your client computer from the Download DbSchema page.
  2. Install DbSchema using the install wizard.

Create a database connection

The following steps show how to configure YugabyteDB running on your local host.

  1. Launch the DbSchema application. The Welcome to DbSchema page appears.
  2. On the Start New Project panel, click Start to connect to a database. The Database Connection Dialog opens.
  3. In the Alias field, enter YugabyteDB to name the database connection.
  4. From the DBMS dropdown list, select PostgreSQL. The Method & Driver field shows the available PostgreSQL JDBC drivers.
  5. For the Method & Driver option, select Standard (1 of 2). There is no need to add a driver because DbSchema includes the PostgreSQL JDBC driver.
  6. In the Compose URL tab, click Remote computer or custom port. The default PostgreSQL values for server host and port appear.
  7. In the port field, enter 5433 (the default port for YSQL) and then click Check (Ping). A message appears saying that the YugabyteDB server is reachable.
  8. Under Authentication, change the Database User to yugabyte (the default YugabyteDB user). If you have enabled authentication, enter the password. Otherwise, leave the field blank.
  9. Under Database, enter yugabyte (the default YugabyteDB database) or the name of the database you want to connect to.
  10. Click Connect. The Select Schemas / Catalogs dialog appears.
  11. Click OK to accept the default options. Otherwise, you can customize the schema information that you want for this connection.

You have successfully created a database connection to the default database (yugabyte) using the default user (yugabyte).

What's next

For help using DbSchema, see the DbSchema documentation.

YugabyteDB includes sample databases for you to explore using DbSchema. Refer to Sample datasets.