How to Manage ServBay Databases with DBeaver

ServBay is a comprehensive local web development environment that provides developers with a range of commonly used database services. While ServBay comes pre-integrated with web-based management tools like phpMyAdmin (for MySQL/MariaDB), pgAdmin (for PostgreSQL), and Redis Commander (for Redis), many developers prefer the more powerful and unified experience of a desktop client for database management. DBeaver is a popular cross-platform database tool that meets these needs.

This guide will show you how to use DBeaver to connect to and manage the built-in databases in ServBay, including MariaDB/MySQL, PostgreSQL, SQLite, and Redis.

What Is DBeaver?

DBeaver is a free and open-source universal database tool designed for developers, SQL programmers, DBAs, and analysts. It supports nearly all major database systems, including relational databases (such as MySQL, PostgreSQL, Oracle, SQL Server, SQLite, etc.) and NoSQL databases (like MongoDB, Redis, Cassandra, and more).

Key features of DBeaver include:

• Broad Database Support: Manage a variety of different database types through a single unified interface.
• User-Friendly Interface: Offers an intuitive graphical UI to simplify complex database operations.
• Powerful Capabilities: Includes SQL editors, data editors, metadata browsers, ER diagram generation, data import/export, and many advanced features.
• Cross-Platform: Supports Windows, macOS, and Linux operating systems.
• Active Community & Ongoing Updates: Ensures tool stability and continuous feature improvements.

For ServBay users, DBeaver provides a more professional and consistent database management experience, especially when working with multiple database types or performing complex queries and operations.

Managing ServBay's Built-In MariaDB/MySQL with DBeaver

ServBay includes MariaDB by default, which is highly compatible with MySQL. Follow these steps to connect to and manage ServBay's MariaDB/MySQL database using DBeaver.

Prerequisites

• ServBay is installed and running.
• The MariaDB/MySQL package is started within ServBay.
• DBeaver client is downloaded and installed. You can get the latest version from the official DBeaver website.

Connecting to MariaDB/MySQL

1. Open DBeaver.
2. Click the "New Database Connection" button at the top left (usually shown as a plug icon).
3. In the list of database types, search for and select "MariaDB" or "MySQL". Click "Next".
4. Enter the connection details:
   • Host: 127.0.0.1 (or localhost)
   • Port: 3306
   • Username: Defaults to root.
   • Password: You can find the MariaDB/MySQL root password in the Database tab of the ServBay application interface.
   • Database: You may leave this empty for now and select or create a database after connecting.
   • Connection Mode (Optional): In addition to the standard TCP/IP (host + port) connection, you can also use a Socket connection, which is often more efficient for local connections. In Driver properties, locate connectUsing and set it to socket, then find the socket property and set its value to the ServBay MariaDB/MySQL socket file path, defaulting to /Applications/ServBay/tmp/mysql.sock. Note: When using a socket connection, you normally do not need to fill in host and port.
5. Click the "Test Connection" button to verify your connection details. If the test fails, check if MariaDB is running in ServBay and that the username and password are correct. If you forgot the password, you can reset the MariaDB/MySQL root password in the Database tab of ServBay.
6. Once the connection test is successful, click "Finish" to save the connection.

Basic Database Operations

Once connected, you’ll see the MariaDB/MySQL instance from ServBay in DBeaver's database navigator. You can perform the following operations:

• Create a Database: Right-click the connection name, select "SQL Editor" -> "New SQL Script". Enter CREATE DATABASE mydatabase_servbay; (replace mydatabase_servbay with your preferred name) and click the execute button (green triangle).
• Query Data with SQL Editor: Right-click the connection or a specific database/table, choose "SQL Editor" -> "New SQL Script", and enter your SQL query, such as SELECT * FROM your_table_name;, and execute it.
• Browse & Edit Data: Expand databases and tables in the navigator, double-click a table to view/edit data in a new tab. DBeaver provides a straightforward data editing UI.
• Create, Modify, or Drop Tables: Right-click the "Tables" node under a database and select "Create New Table". You can also right-click existing tables to modify or delete them.
• Import/Export Data: DBeaver supports data import and export in various formats for easy migration.

These actions can be performed through DBeaver’s graphical interface or built-in SQL editor, and are similar to managing other databases.

Managing ServBay's Built-In PostgreSQL with DBeaver

ServBay also integrates PostgreSQL. The steps to connect and manage ServBay’s PostgreSQL using DBeaver are as follows.

Prerequisites

• ServBay is installed and running.
• The PostgreSQL package is started within ServBay.
• DBeaver client is installed.

Connecting to PostgreSQL

1. Open DBeaver.
2. Click the "New Database Connection" button at the top left.
3. In the list, search for and select "PostgreSQL". Click "Next".
4. Enter the connection details:
   • Host: 127.0.0.1 (or localhost)
   • Port: 5432 (the default PostgreSQL port)
   • Database: Defaults to postgres. You can also connect to other PostgreSQL databases created in ServBay.
   • Username: Defaults to servbay.
   • Password: Find the password for the PostgreSQL user in the Database tab of the ServBay application interface.
   • Connection Mode (Optional): Like MariaDB/MySQL, a Socket connection can be used. In Driver properties, look for a property called socketFactory or similar and configure the socket file path, defaulting to /Applications/ServBay/tmp/.s.PGSQL.5432 (if connection fails, try /Applications/ServBay/tmp). The configuration may vary slightly by DBeaver version; usually, it is found in the advanced settings of connection properties. When using socket connection, host and port are typically not required.
5. Click the "Test Connection" button. If the test fails, ensure the PostgreSQL service is running in ServBay, and that your username and password are correct. If you forgot your password, you can reset the PostgreSQL password in the Database tab of ServBay.
6. Once the connection test succeeds, click "Finish" to save the connection.

Basic Database Operations

Once connected, you’ll see the PostgreSQL instance from ServBay in DBeaver's navigator. Most fundamental relational database operations—such as creating databases, creating tables, running queries, editing data, and importing/exporting—work in DBeaver the same way as with MariaDB/MySQL. You can accomplish them using either the SQL editor or the graphical interface.

Managing ServBay's Built-In SQLite 3 with DBeaver

ServBay also provides support for SQLite 3, a lightweight, file-based database engine that does not require a separate database server process.

Prerequisites

• ServBay is installed and running.
• DBeaver client is installed.
• You need a SQLite database file (.db, .sqlite, .sqlite3, etc.). If you don't have one yet, DBeaver can create it for you when setting up a new connection.

Connecting to SQLite

1. Open DBeaver.
2. Click the "New Database Connection" button at the top left.
3. In the type list, search for and select "SQLite". Click "Next".
4. Enter the connection details:
   • Database File Path: Click the folder icon on the right and select or enter the full path to your SQLite database file. ServBay recommends storing such files in /Applications/ServBay/db/sqlite/ for easy management and possible backups.
   • If the target database file does not exist, enter your intended file path and name; DBeaver will create it automatically when you connect.
5. Click the "Test Connection" button. If the file path is correct and accessible, you should connect successfully.
6. Once connected, click "Finish" to save the connection.

Basic Database Operations (SQLite)

After connecting to the SQLite file, you can manage it in DBeaver as you would any other database, though SQLite's feature set is more limited.

• Create Table: Right-click the database connection name and select "Create New Table".
• Use SQL Editor: Right-click the connection name, select "SQL Editor" -> "New SQL Script", enter and execute SQL statements.
• Browse & Edit Data: Double-click a table name to view or edit data.
• Delete Table: Right-click the table name and select "Delete".
• Delete Database: A SQLite database is a file; simply delete the corresponding .db file in your file system to remove the database.

Managing ServBay's Built-In Redis with DBeaver

Redis is an open-source in-memory data structure store, often used as a database, cache, and message broker. ServBay includes Redis integration as well.

Prerequisites

• ServBay is installed and running.
• The Redis package is started within ServBay.
• DBeaver client is installed.

Connecting to Redis

1. Open DBeaver.
2. Click the "New Database Connection" button at the top left.
3. In the type list, search for and select "Redis". Click "Next".
4. Enter the connection details:
   • Host: 127.0.0.1 (or localhost)
   • Port: 6379 (the default Redis port)
   • Password: By default, Redis installed via ServBay does not require a password; leave blank. If you have set a Redis password in ServBay, enter it here.
5. Click the "Test Connection" button. If this fails, check that Redis is running in ServBay and that your port and password (if any) are correct.
6. Once the connection test is successful, click "Finish" to save the connection.

Basic Data Management (Redis)

Once connected to Redis, DBeaver provides a graphical interface for browsing and managing keys and values.

• View Keys: Expand the connection in the database navigator and select the database (usually DB 0); you'll see the list of keys.
• Add a Key: Right-click the database node or empty space in the key list, select "New Key", enter the key name, choose the key type (String, List, Set, Hash, ZSet, etc.), and input the value.
• Edit Key: Double-click or right-click an existing key and select "Edit Key" to modify its value or TTL (Time To Live).
• Delete Key: Right-click a key name and select "Delete Key".
• Use Redis Console: Right-click the connection or database, choose "SQL Editor" -> "New Redis Console", and directly enter and execute Redis commands.

FAQ & Troubleshooting

• Connection Refused Error:
  • Make sure ServBay is running.
  • Confirm that the database services (MariaDB/MySQL, PostgreSQL, Redis) you wish to connect to are started in ServBay and displayed as running (usually green).
  • Check that the host and port in your connection settings are correct. For local connections, it's usually 127.0.0.1 and their default ports (MariaDB/MySQL: 3306, PostgreSQL: 5432, Redis: 6379).
  • If using a Socket connection, ensure the socket file path is correct and your database service is configured to use that socket.
  • Examine your firewall settings to make sure DBeaver is not blocked from accessing local ports.
• Authentication Failed:
  • Double-check your username and password. You can find or reset the root/default user password in the Database tab of ServBay.
• Incorrect File Path when Connecting to SQLite:
  • Confirm the file path you entered is complete and correct.
  • Ensure DBeaver has read/write permissions to that file path.
• DBeaver Interface Display Issues:
  • Try restarting DBeaver.
  • Make sure your Java environment (required by DBeaver) is properly installed and functioning.

Conclusion

DBeaver is a powerful, universal database management tool that, when paired with the ServBay local development environment, can significantly enhance the efficiency of managing various databases. With this guide, you can easily connect DBeaver to ServBay’s bundled MariaDB/MySQL, PostgreSQL, SQLite, and Redis databases, and carry out everyday development and management tasks. Whether you're browsing and editing data, executing SQL queries, or handling advanced database maintenance operations, DBeaver offers a unified and efficient experience. Combined with ServBay’s convenient environment management, your local development workflow will be smoother and more productive.