The Database Navigator contains various tools on the top toolbar.

The table below contains a detailed description of each tool.

Tool	Icon	Description
Settings		Opens the settings menu with additional tools. For more information, see Settings menu.
Link with editor		Synchronises the active SQL Editor, Data Editor or Metadata Editor with the element in the Database Navigator. It becomes visible when an Editor for a connection is opened.
Collapse all		Collapses all expanded objects in the Database Navigator. It becomes visible when at least one object is expanded.
New folder		Creates a folder in the Navigator tree to group connections. For more information, see Folders in Database Navigator.
Refresh		Refreshes all objects in the Database Navigator.

DBeaver Team Edition is a feature-rich solution, combining the capabilities of CloudBeaver Enterprise and DBeaver Ultimate products. With both web and desktop clients, it’s built for medium-to-large teams needing collaborative database management with centralized control and advanced security.

Note: DBeaver Team Edition requires a server deployment.

Team Edition includes:

• Cross-platform accessibility: Team Edition includes both web and desktop clients.
• Collaboration: Multiple users can share database connections, queries, credentials, SQL scripts, and diagrams.
• Centralized management: A Team Edition server enables administrators to manage permissions, monitor activity, and audit interactions by controlling shared resources and user roles.
• User management: Integration with external user directories, such as Active Directory and Okta, allows seamless user provisioning and role-based access control.

• Flexible deployment: DBeaver Team Edition can be deployed on the client’s server within a private network for secure, on-premises use, or hosted in the cloud. For deployment details, see Team Edition deployment.

Many features in Team Edition are shared between the web and desktop clients, such as:

• Data visualization:

  • Data filtering and sorting: Provides tools to filter and sort data directly within the database interface.
  • Functional panels: Enhances data manipulation by offering additional space in the Data Editor for managing complex data types, accessible via tabs in a dedicated panel.

• Query development:

  • SQL Editor: Provides code completion for easier writing, auto-formatting, spelling checks, and support for variables. Available for both web client and desktop client.
  • AI assistant: Integrates an AI assistant to offer guidance and automation within the SQL Editor. Available for both web client and desktop client

• Administrative tasks:

  • Entity Relationship Diagrams: Supports reverse engineering of databases into entity-relationship diagrams. Offered in the web and desktop clients.
  • Permission and user management: Manages database permissions and user accounts.
  • Export and Import from files: Facilitates data export and import operations, supported in both the web (Data Export) and web (Data Import), as well as the desktop clients.
  • Database authentication: Implements database authentication mechanisms to secure access.
  • Git integration: Provides version control and change tracking, available across both the web and desktop clients.

• Cloud management:

  • Cloud Explorer: Manages and connects to cloud-hosted databases. Available in both web and desktop clients.
  • Cloud Storage: Manages files within cloud environments, supported across web and desktop clients.

In addition to shared features, each web and desktop client offers its own unique capabilities:

The Team Edition web client includes specific capabilities:

• Setup and configuration:

  • Initial setup: Complete setup of Team Edition available exclusively in the web client. Learn more
  • Server configuration: Includes identity provider settings for SSO and centralized access management
  • Domain management: Allows setting up custom domains or using a provided default. Learn more
  • Multiple projects: Supports viewing and organizing multiple projects within the Database Navigator. Learn more

• User and role management:

  • SSO setup: Enhances security with identity provider configuration for single sign-on. Learn more
  • Role-based access: Controls user access with Editor and Viewer roles. Learn more
  • User import: Supports importing users from third-party systems. Learn more
  • Supervisor role: Enables elevated query privileges within the Query Manager. Learn more
  • Session management: Allows logging users out from active sessions if login limits are exceeded

• Database and query management:

  • Direct server connections: Simplifies database access with direct server connections
  • Query history: Stores a history of past SQL queries, with upcoming support for server-side deletion. Learn more
  • Database search: Provides search functionality to locate databases by server address

• Data and file handling:

  • Collaborative dataset editing: Enables team-based data modifications directly within the web client. Learn more
  • Cloud file editing: Allows users to edit files stored in Cloud Storage. Learn more

The Team Edition desktop client offers several unique capabilities:

• Data visualization:

  • Color coding and highlighting: Simplifies data analysis by color-coding and highlighting table rows and fields based on conditions. Learn more
  • Tableau integration: Facilitates integration with Tableau for advanced data visualization and analysis. Learn more

• Query development:

  • Execution plan visualization: Provides detailed visualizations of SQL execution plans. Learn more
  • Visual Query Builder (VQB): Provides a graphical interface to construct SQL queries without writing code. Learn more
  • SQL debugger: Offers an SQL debugger specifically designed for PostgreSQL, aiding in query development and troubleshooting. Learn more
  • AI Chat: Integrates an AI-driven chat assistant to provide real-time query support within the SQL editor. Learn more

• Administrative tasks:

  • Metadata editor: Enables the management and editing of database metadata
  • Edit mode for ER-Diagrams: Offers functionalities for editing entity-relationship diagrams to aid in database design. Learn more
  • Administrative tools:
    • Backup and Restore: Ensures data safety by offering functionalities for backing up and restoring databases. Learn more
    • Analyze and vacuum: Optimizes database performance by analyzing and vacuuming database objects
  • Permission and user management: Manages database permissions and user accounts
  • Schema comparison: Provides tools for comparing database schemas within the same or across different databases. Learn more
  • Data comparison: Offers tools for comparing data within or across different databases. Learn more
  • Mock data generator: Provides tools for generating mock data, useful for testing and development. Learn more

• Data migration:

  • Direct transfer between databases: Allows efficient data migration between different databases or systems. Learn more

• Automation:

  • Task manager: A tool for managing and monitoring database tasks, enhancing productivity and organization. Learn more
  • Task scheduler: Allows scheduling of database tasks, automating routine operations. Learn more

• Kafka support: Provides integration with Apache Kafka

The Team Edition is offered as an annual subscription, which must be renewed to continue receiving updates and support.

Discover more about the DBeaver Team Edition and subscribe

The Team Edition web client supports a wide range of databases. For a full list, refer to Supported databases

The Team Edition desktop client has a comprehensive set of JDBC drivers, offering connectivity to various databases without needing separate downloads and configurations. Additionally, a versatile ODBC driver is supported for broader database compatibility.

For additional details on utilizing the ODBC driver, please consult the ODBC-JDBC driver article.

You can apply custom filters to table contents or query results. There are several ways in which you can filter data in a table.

One of the ways is to use the filter field above the table next to the top toolbar. To filter data, enter an SQL expression into the field and click the Apply filter criteria button next to the field or press Enter.

You can apply ready-to-use SQL expressions or SQL expression templates via the context menu. To select a ready SQL expression, select or focus cell and press the Cell context button , then click Filters -> Cell value in the context menu and choose one of the expressions.

The data updates dynamically. To remove a filter, click Filters -> Delete filter for ... If you want to delete all filters, click Filters -> Reset all filters. You can also delete filters by clicking the Reset filter criteria button in the top toolbar.

Users can conveniently group and store connections using folders in the Database Navigator. Folders can be created by any logged-in user in the Private project, and by administrators in the Shared project.

To create a folder in the Database Navigator, follow these steps:

1. Press the New folder button on the top Navigator toolbar.

   

2. Enter a folder name in the popup dialog box and press the Create button.

   

   Note: Folder names may not contain the following symbols

   ?

   ,

   U

   ,

   [

   ,

   ^

   ,

   /

   ,

   :

   ,

   '

   ,

   "

   ,

   \

   ,

   <

   ,

   >

   ,

   |

   ,

   ?

   ,

   ]

   ,

   +

   ,

   *

   and cannot start with a

   .

   . Each folder name must be unique within the project. If a user attempts to use unsupported characters or a non-unique name, an error message will prompt a name change.

   Tip: If the option to enable private connections is activated in the settings, you can select whether folders are shared or private during creation.

To add a connection to a folder, drag and drop the connection into the folder. The connection will then appear in the Database Navigator within the folder.

To move a connection out of a folder, drag and drop it above the list of Navigator objects.

To create a subfolder, drag and drop one folder into another, or click on a folder and create a new one. To move a subfolder, drag and drop it above the list of Navigator objects or into another folder.

To rename a folder, select Rename from the folder’s context menu and change the name in the popup dialog box.

To delete a folder, select Delete from the folder context menu and confirm the action in the popup dialog box.

Note: Deleting a folder will only remove the folder and any subfolders. All connections will remain in the Database Navigator.

To update a folder’s content, select Refresh from the folder context menu.

Please note: This article has been updated and its content is now available in a revised form at a new location. Please refer to the updated article Create Connection for the most current information.

Important: This feature will be removed in version

25.0

.

The templates enable administrators to define various reusable connection parameters, subsequently allowing users to create multiple connections based on these templates. This process ensures consistency across the connections created from these templates, as they adhere to the defined parameters within the templates.

You can add, edit, or remove database templates on the

To create a new template, follow the steps below:

1. Click the
   Add
   button located on the top toolbar. This will open the template creation form.
2. Fill out the fields in the form with the appropriate information.
3. Once all fields are completed, click
   Create
   .

Your new template should be successfully created and it will appear at the top of the templates table.

Below are the detailed steps to set the template parameters:

1. Open the template form. This can be done by clicking the
   Add
   button in the toolbar.
2. Fill in the appropriate information in the base template parameters, driver settings, SSH tunnel, and access fields.
3. To verify the template connection, click the
   Test
   button. If SSH is configured, the test will use it to establish the connection.
4. When users attempt to establish a connection using the template, they will be prompted to enter credentials.

You can manage access to the database at the

Once a template is prepared, connections can be created using the template from the public section of the CloudBeaver.

1. In the toolbar, select Connection.
2. From the dropdown menu, select From a template.
3. Choose the desired template.

Please note: This article has been updated and its content is now available in a revised form at a new location. Please refer to the updated article Create Connection for the most current information.

This document provides guidelines for contributing to the CloudBeaver repository. It outlines the procedures for creating pull requests, fixing bugs, and maintaining consistency in code style within our codebase.

Generally, you can suggest any feature you think is useful for the database management tool. However, we usually do not implement features that are too specific to your development process or specific to your internal company processes.

Good options include:

• Adding new database or driver support.
• Extending database metadata read/modify capabilities (e.g., adding trigger reading for a specific database).
• Adding a new data export format.
• Localizing the CloudBeaver interface (extend existing localization or add a new language).
• Adding a new database-specific tool (e.g., table analysis for a specific database).

You can find code examples of all these features in our codebase.

Important: When suggesting new features, be aware that if a feature already exists in the Enterprise, AWS, or Team Editions, we may not merge it into the Community Edition.

If you identify a bug on our board that needs fixing and it is not scheduled for the nearest milestone, you are welcome to attempt fixing it yourself. It is a good idea to ask in the ticket because some issues may not be resolved for specific reasons.

If you decide to fix the bug and submit a pull request (refer to the guidelines), the team will review it and provide feedback if necessary. If the PR is merged, the fix will be included in the next release of the CloudBeaver Community Edition.

Before creating a pull request, you should first create a ticket in our issue tracker. Leave a comment indicating that you intend to implement the feature or fix the bug yourself. Once the CloudBeaver development or QA team has responded to your comment, you may begin your work.

You can follow the standard GitHub instructions for this process. Generally, you will need to:

• Create a fork of the
  dbeaver/cloudbeaver
  repository.
• Create a new branch in your fork.
• Commit your changes to this branch.
• Create a pull request to the upstream repository.

Important: When committing changes in your branch, include the ticket number in the commit message like this:

dbeaver/cloudbeaver#issue-number Initial commit for my super-duper feature

. You may make any number of commits. We typically perform a squash merge before integrating changes into the main repository.

• Please avoid creating multiple pull requests for a single issue.
• Provide a detailed description of the affected functionality.
• Avoid force-pushing commits in the PR branch, as this makes reading the commit history more difficult.

• If the UI is affected, it is recommended to provide screenshots or a video demonstrating the changes made.

The main rule is to use the same code style already applied in a particular source file.

• Do not reformat code or optimize imports in a file you are changing, as it makes it very difficult to review your commits due to the volume of changes.
• Use our automatic code style checks for pull requests. Every PR you submit to the
  dbeaver/cloudbeaver
  repository will be checked, and you will be able to see the report of the checklist.

IntelliJ IDEA code style can be found at: https://github.com/dbeaver/idea-rcp-launch-config-generator.

Every file you add or modify must include the following copyright header at the top:

/*

 * DBeaver - Universal Database Manager

 * Copyright (C) 2010-2024 DBeaver Corp and others

 *

 * Licensed under the Apache License, Version 2.0 (the "License");

 * you may not use this file except in compliance with the License.

 * You may obtain a copy of the License at

 *

 *     http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 */

Tip: Ensure the copyright header is present and up to date for each file in your pull request.

We appreciate your contributions and offer rewards for accepted pull requests. Keep contributing to improve the project and receive a reward from the team! For more details, visit Help the Beaver.

CloudBeaver provides multiple methods to set up a connection. To create a connection, do one of the following:

To establish a new connection, follow these steps:

1. Initiate new connection:

   • Click the
     +
     button in the top menu.
   • Select New Connection from the dropdown options.

   

2. Select the appropriate driver from the available options.

   Tip: If you cannot find a driver for your database, then probably there is no suitable driver, and you need to create one. Please see the Database Drivers article.

3. Enter all necessary details in the form fields provided. For detailed steps on filling out these fields, refer to the section below.

   

4. Test the connection (optional):

   • Click the Test button to ensure the connection parameters are correct.

5. After confirming all details, click the Create button.

6. Access and modify connection:

   • The new connection will appear in the connection navigator menu.
   • To edit the connection details, click the context button next to the connection name and choose Edit Connection.

   

Access these connections through

To use and adjust template connections, refer to the guide available in Connection templates management article.

In the New connection wizard, on the Main tab, you need to set all primary connection settings.

Here’s what you typically need to configure:

This table describes how credential options vary based on the project type:

Note: The number and type of connection properties are very dependent on the driver.

When setting up a new connection, you may need to configure additional options:

Tip: For secure database connections, store your SSH credentials in

data-sources.json

as follows:

• SSH Key: Assign your SSH key to
  connections.configuration.handlers.ssh_tunnel.properties.keyValue
  .

In the Community, Enterprise and AWS Editions, you can manage access permissions for a database:

1. Initiate the creation of a new database connection as an administrator.
2. Find the Project dropdown menu and select Shared project.
3. Complete the necessary fields based on the selected type of credentials.

4. Go to Access tab, click Edit, check the box next to their names and click the Add button.

   

To manage access permissions for a database, ensure the Enable private connections setting is configured correctly in the Server configuration settings:

• If Enable private connections is turned on, switch the project mode to Shared from the dropdown menu of the Project settings to access the Access tab.
• If Enable private connections is turned off, the Access tab is available by default.

Note: For Private projects, credentials saved during connection creating or database login are stored permanently for the current user. For Shared projects, credentials saved while creating a connection are available to all users with access, but if saved during login, they are retained only for the current session.