DBeaver is an awesome SQL client and database management tool.
It comes with drivers for the most popular databases, including MySQL, PostgreSQL, SQLite and many others, meaning you can learn one tool and use it across projects built on different technology stacks. How awesome is that?
Bellow are the steps you can use to connect your DBeaver client to a remote database server via SSH.
Note that you only need to do these steps once. The connection configurations will be saved and you can re-use them by right-click + connect.
This guide is created using DBeaver version 6.3.
Method 1: DBeaver via SSH with plain password
1. Create a new connection
Create a new connection by right clicking in your Database Navigator area.
2. Fill SSH details
Fill details under the SSH tab, and click Test tunnel configuration.
You should see a success message if the details were correct.
3. Fill database’s details
Now that DBeaver can connect via SSH, let’s go back to the General tab and fill in the database credentials:
Clicking Test Connection, you should see a success message. Click Finish.
Method 2: DBeaver with encrypted openssh private key file
If your server requires an openssh private key to login, follow the bellow steps:
1. Add SSHJ to DBeaver
You can do it by opening Help/Install New Software… and typing the following link: https://dbeaver.io/update/sshj/latest/
2. Connect
Use the same steps as Method 1, but adjust as follows:
- On the SSH details menu (step 2), provide the password for your encrypted private key file.
-
Select SSHJ, under Implementation.
Providing private key password - Change Authentication Method to Public Key.
-
Select your Private Key
Select Private Key - Click Test tunnel configuration and Finish.
Resources
If you need additional help, this link may be very useful.