Connect to a Database

Database Specific Information

This list include only few of the supported databases!

Compatibility

Using the proper JDBC Driver DbSchema can connect to any Relational Database. If the database you're looking for is missing from the JDBC driver list, you can upload the driver in DbSchema. Learn how!

What are JDBC Drivers?

JDBC comes from Java Database Connectivity. JDBC Drivers are software components provided by the company that wrote the database software. They enable a Java application (DbSchema) to interact with the database you are using.

Connection Dialog

The connection dialog will help you setup the connection to any database.

Establish a connection using Composed URL

  1. Select an Alias for your database connection. This will be the name of this specific connection to the database.
  2. Select the DBMS (Database Management System). This is the database you want to connect to.
  3. The driver for your database will be automatically downloaded when you select the DBMS. Every database can have different methods of connection. You can change them from the dropdown menu. For now, we can stick to the Standard connection. If the standard connection is not working, choose the next one from the menu (this can be different for each database).
  4. If you already know the JDBC URL, you can tick the checkbox and edit the JDBC URL. This is a usual case for cloud databases, like Redshift, Azure or Google where you can find in the web console directly the JDBC URL. For local database you would rather fill in the other parameters, like Server Host, Port and Database and DbSchema will build the URL for you. Choosing a different option from the Method & Driver combo will also result in a different URL.
  5. In the Server Location section, we will establish the connection between DbSchema and the server. If the database you're working with is located on your local machine, choose This computer, default port. If the database is located on a remote computer, choose Remote computer or custom port.
  6. If the database is located on your local machine, the host and port will be automatically completed by DbSchema. If you are trying to reach a remote server, you'll have to complete the server host or IP and port.
  7. The Check (Ping) button helps you to check if the connection to the server is working properly.
  8. In the Authentication section, insert the Database User and Password. The credentials are usually defined during database installation or when the user is created in the database.
  9. In the Database section, you will choose a name for the DbSchema model that will be stored on your local machine. This file gives you the flexibility to work on your schema offline and synchronize it later with the database.
Database Connection Dialog

How to Connect to a Remote Server or Custom Port

In order to connect to a remote server, you have to provide the host and the port for that specific server.
Difference between hostname and IP: The hostname is working if the network has a configured DNS server. DNS is a a central component of the network that translates the IP addresses to computer names. If the network doesn't have a DNS server, you have to provide the IP address.

How to find the Host Name

Windows

  1. 1 Connections
    1. Open Control Panel;
    2. Go to System and Security > System;
    3. See Full Computer Name under the section Computer Name.
  2. 2 Using the command prompt
    1. Type cmd in the Start Menu. Open Command Prompt;
    2. Type hostname command in Command Prompt;
    3. The result on the next line in cmd will be your hostname.

Linux

  1. Open command-line terminal app Application > Accessories > Terminal;
  2. Type hostname or hostname1 or cat /proc/sys/kernel/hostname;
  3. Press [Enter];
  4. The hostname of your machine will appear on the next line.

Mac

  1. Go to Apple Menu > System Preferences > Sharing;
  2. The name of your Mac will appear on the screen.

How to find the IP Address

On Windows

  1. Type cmd in the Start Menu;
  2. Type ipconfig command in Command Prompt;
  3. Look for the IPv4 Address.
IPConfig Windows

Linux

  1. Open command-line terminal app Application > Accessories > Terminal;
  2. Type ifconfig -a or hostname -l;
  3. Press [Enter];
  4. The ip of your machine will appear on the screen.

Mac

  1. Go to Apple Menu > System Preferences > Network
  2. On the left, the option that has a green dot is the network that you are connected to;
  3. In the smaller text underneath the status you should find your IP Address.

How to test the Hostname or IP address

From DbSchema

Test the Hostname or IPaddress from DbSchema by pressing the Check (Ping) button in the Connection Dialog

From Command Prompt

  1. Type cmd in the Start Menu;
  2. Open Command Prompt;
  3. Type ping {yourhost} to check. Replace {yourhost} with the name of the host or IP Address.

Test both, hostname and port

From DbSchema

The ping button from the Connection dialog will check both, host and port.

From Command Prompt

  1. Type cmd in the Start Menu;
  2. Open Command Prompt
  3. Type telnet {host} {port} command. Replace {host} & {port} with the host/ Ip Address and the port of the database server.
Ping Host from Connection Dialog

How to test the Port using Telnet

First, you have to make sure that telnet is enabled.

Windows:
  1. Type Turn Windows features on or off in the start bar. Click on the result;
  2. In the next dialog, search for Telnet Client and make sure that it's enabled;
  3. Click ok and apply the changes.
Use Telnet to Check Database Host

After you enabled Telnet

  1. Open Command Prompt by writing cmd in the start menu;
  2. Type telnet {host} {port}. Replace the {host} & {port} with the host & post of the database. Press Enter;
  3. If the port is open, the telnet window should open, as shown in the right image.
  4. If the telnet can't reach the port, you should receive an error. In this case, verify if the database server is active.
Telnet Window

Establish a connection by editing the JDBC URL

You can insert your own JDBC URL or edit the current one. DbSchema will use this URL to connect to the database. Editing the JDBC URL offers you more freedom than composing the URL in the previous tab Compose URL.

If you need more help with editing the JDBC URL, click on the URL Documentation button. This will take you to the documentation of your database.

Edit Database JDBC URL

Establish a SSH Connection

Establish a SSH Tunnel to encrypt the communication to the database.

  1. Enter the Host where the SSH Server is activated;
  2. Enter the SSH Port where the server is activated. The default port is 22;
  3. Enter the SSH User configured in the SSH Tunnel;
  4. Select the Authentication method. This can be a password or an encrypted private key in Open SSH format.
Setup Database SSH Tunnel

More options

In the Options section you can modify details about your model.

  1. Save your model to a local file. By default, DbSchema saves all the projects to project file. Enabling this feature will allow you to save the connection data to a local file.
  2. Read Only Connection won't allow any modifications in the database. You can add exceptions to this rule.
  3. Set a specific timezone for DbSchema so you can avoid timezone errors when your computer and the database use different timezones.
  4. Highlight Connection Combo allows you to give different colors for different types of connections (eg. Production, Testing, Development).
  5. You can set a different Alias for the schema on your computer.
Database Connection Options

Enable Windows Firewall

Windows Firewall is blocking connectivity from other machines. To allow connectivity you have to create new Inbound rule for the database port. Go to Control Panel > System and Security > Windows Defender Firewall > Advanced Settings > Inbound Rules and follow the “New Rule” setup wizard.

Enable Windows Firewall for Database Connections