1. Log in to your account in Microsoft Azure and go to
   Virtual networks
   .

2. Select the network that you created during the VM startup process.

3. Select
   Overview
   ->
   Capabilities
   ->
   Peerings
   and click
   Add peering
   .

4. The
   Add peering
   window will be opened.

• In the

  Peering link name
  field add the name for the new peering.

• In the

  Virtual network
  field select the network where your database is located (
  SQL-vpc
  in this case).

5. Click
   Create
   . The peering is configured.

1. Connect to your Linux VM via SSH:

2. Check that your Linux VM has access to your SQL DB private IP.

• Copy the private IP address of your database in
  Virtual machines
  ->
  Your SQL DB
  ->
  Properties
  ->
  Networking
  .

• Ping this IP in the terminal:

If everything was done correctly in the previous steps, you will get the result as in the screenshot above. All that remains is to connect our CloudBeaver server to your database.

3. Install Docker if it is not installed. Check this documentation for details.

4. Run CloudBeaver with this command:

You can learn more about CloudBeaver deployment in our documentation.

You need to make small changes to the network configuration so that you can access CloudBeaver UI.

1. Go to
   Virtual machines
   ->
   Networking
   ->
   Inbound port rules
   ->
   Add inbound port rule

2. Add access to port
   8080
   . For security reasons, we recommend specifying your IP or the IP of your proxy in the resource to avoid third-party access.

3. Open in browser
   http://<your_vm_ip>:8080

That’s all done! You are in the CloudBeaver interface.

1. Enter your license key and configure your server.

2. Go to

   Connection Templates
   , click
   Add
   , and type your database name (PostgreSQL for example).

3. In the

   Host
   field enter the IP address of your database you received earlier and indicate the authorization data for your database.

4. Click
   TEST
   to check that your configuration works.

5. Perfect! Now click
   CREATE
   in the top right. Connection to your database is added to CloudBeaver.

1. Connect to your Windows VM by using RDP.

2. Check that your Linux VM has access to your SQL DB private IP.

• Copy the private IP address of your database in
  Virtual machines
  ->
  Your SQL DB
  ->
  Properties
  ->
  Networking
  .

• Ping this IP in the terminal:

If everything was done correctly in the previous steps, you will get the result as in the screenshot above. All that remains is to connect our DBeaver to your database.

3. Add your license when starting the application.

4. Create a new connection and choose your database (for example, PostgreSQL).

5. In the
   Host
   field, specify the Private IP address of your database and fill in other fields.

Perfect! Your connection is ready.

This document provides guidelines for configuring details about administrator credentials and predefined teams in the CloudBeaver, including their IDs, names, descriptions, and assigned permissions.

Tip: For more information on server configuration, see Server Configuration.

The path to the initial data configuration file is specified in the

Tip: By default, the file is located at

/opt/cloudbeaver/conf/initial-data.conf

.

{

    adminName: "cbadmin",

    adminPassword: "cbadmin20",

    teams: [

        {

            subjectId: "admin",

            teamName: "Admin",

            description: "Administrative access. Has total and full authority.",

            permission: ["admin"]

        },

        {

            subjectId: "user",

            teamName: "User",

            description: "Standard user",

            permission: []

        }

    ]

}

Note: By default, admin configurations are not created automatically, but you can create them manually if needed.

Note: This feature is available in Enterprise, AWS, Team editions only.

JSON data representation is available in several databases such as DocumentDB, DynamoDB and other NoSQL databases. Data is represented as formatted JSON. The headline of the latter is unique identification of the document.

The document can be selected in order to display all available actions.

To start editing, click on the pencil icon in the left panel. You will have your document switched to the editing mode. In the editing mode, you can see a toolbar with apply and revert buttons. If the document has some unsaved changes in it, it will be highlighted with an orange border.

This article provides a guide on how to migrate the CloudBeaver Enterprise Edition workspace. The process involves stopping the server, copying the workspace folder, and then restarting the server.

Tip: For detailed deployment instructions, refer to the Docker image deployment.

First, stop the CloudBeaver server to ensure that no data is being written to the workspace during the migration. This can typically be done by terminating the running server instance.

Create a copy of the workspace folder. This folder is typically located in the directory specified when the Docker container is launched. For example, to start the container with a specific workspace directory, you might use the command:

docker run --name cloudbeaver-ee --rm -ti -p 8080:8978 -v /var/cloudbeaver/workspace:/opt/cloudbeaver/workspace dbeaver/cloudbeaver-ee:latest

You will need to copy all files from the workspace. Make sure to transfer all files to the new location where you wish to migrate your CloudBeaver workspace.

Tip: For more details, see Workspace location.

After relocating the workspace, restart the CloudBeaver Docker container at the new location. When launching the Docker container, it is essential to specify the correct path to the moved workspace to ensure proper configuration. Use the Docker run command with the updated volume path, like so:

docker run --name cloudbeaver-ee --rm -ti -p 8080:8978 -v [new-workspace-path]:/opt/cloudbeaver/workspace dbeaver/cloudbeaver-ee:latest

This command ensures that the CloudBeaver server operates with the workspace in its new environment, maintaining all your configurations.

Note: This feature is available in Enterprise, AWS, Team editions only.

The CloudBeaver allows you to generate API tokens for automating tasks and interacting with the GraphQL API.

Note: Tokens are available only for administrators. Each administrator must create their own tokens.

1. Navigate to your Profile page in the CloudBeaver.

2. Open the API Token tab.

3. Click + Add.

Note: Users can create up to 5 tokens.

4. Choose Name and Expiration period. You can choose from options like 1 day, 1 week, 1 moth, 1 year, or no expiration (not recommended for security reasons).

5. Copy the token after it’s generated.

Important: Tokens are displayed only once during creation.

1. On the API Token tab.

2. Find the token you want to delete and click the Delete icon.

3. Confirm the deletion in the confirmation dialog.

Note: Deleting a token doesn’t immediately end an active session. Users must log in again for the deletion to take effect.

Authenticate with the GraphQL API console using your token by including it in the query.

• Example query:

query authLogin($credentials: Object) {

  authLogin(

    provider: "token"

    credentials: $credentials

  ) {

    authId

    userTokens {

      userId

    }

    authStatus

  }

}

• Variables:

{

  "credentials": {

    "token": "your_api_token_here"

  }

}

• Example response:

Note: This feature is available in Enterprise, AWS, Team editions only.

Go to the Administration menu and enable Google in the Server configuration tab.

1. Go to the Identity Providers tab and create a new configuration using the OpenID details.

Client ID – Client ID from your Google OAuth 2.0 application

Client Secret – Client Secret from your Google OAuth 2.0 application

Open identity provider in CloudBeaver, copy

The new Federated tab becomes available after creating the configuration in the CloudBeaver authentication dialog. The user can select the configuration and thereafter login into the application using Google SSO.

In the CloudBeaver, it’s possible to view and work with databases hosted in GCP, without the need to manually configure each connection to the database. To do this, you need to configure the integration of Google Identity provider with GCP.

Go to the Administration menu and enable GCP services in the Server configuration tab.

• Go to the Identity Providers tab and open your existing Google provider.
• Enable
  Add custom scopes
  checkbox – this will allow you to specify additional scopes for your identity provider, and expand its capabilities
• Specify the following scopes:

https://www.googleapis.com/auth/spanner.admin;https://www.googleapis.com/auth/bigquery;https://www.googleapis.com/auth/cloud-platform;https://www.googleapis.com/auth/devstorage.full_control

After setting up the provider, you need to re-login. Now you can open

The Grouping panel provides tools to calculate statistics based on a table or a custom SQL query. It uses

To obtain the grouping results for one or more columns of a data table, open the Grouping Panel. Then, in the result table, place the cursor on the table header and drag-and-drop the column into the panel:

If you add several columns to the panel, CloudBeaver groups the data in the order the columns are added and calculates statistics based on the grouping.

By default, the

To add a function, follow these steps:

1. Click the Configure button on the Grouping panel’s toolbar.

2. In the Grouping Configuration window, locate the Functions area and enter the function into the row.

Note:

COUNT

is the only function that allows the use of

*

instead of specifying a column name.

3. To complete the process, click Apply.

To remove a function, navigate to the Grouping Configuration window, click the Remove button, and then click Apply.

You can also manage columns in the same Grouping Configuration window.

To add a column:

1. Click the Configure button on the Grouping panel’s toolbar.

2. In the Grouping Configuration window, go to the Columns area and enter the column name into the row.

3. To complete the process, click Apply.

Tip: You can add a column with an expression for MySQL/MariaDB databases. The expression will be calculated in the resulting column:

• To remove a column, in the same Grouping Configuration window, click the cross (

  X
  ) icon and then click Apply.

• Alternatively, you can remove a column by clicking the column name and then clicking the Remove button in the Grouping panel’s toolbar.

• You can also remove a column by dragging and dropping it outside the Grouping panel.

To clear all results from the Grouping Panel, click the Clear button .

You can filter data in the Grouping Panel. For more information, refer to the Data Filters article.

Click the Sort by Column button to switch sorting options for the grouped data:

Option	Icon	Description
Unsorted		Leaves the data in its original order.
Ascending		Sorts the grouped data in ascending order.
Descending		Sorts the grouped data in descending order.

Click the Show Duplicates button to filter the results and display only those rows where the

Note: This feature is available in Enterprise, AWS, Team editions only.

You can create and manage various charts directly within the Grouping Panel. For more information, refer to the Managing Charts article.

You can export grouped data using the Export button in the Grouping Panel. For more details on exporting data, refer to the Data Export article.

CloudBeaver is a lightweight web application designed for comprehensive data management. It allows you to work with various data sources, including SQL, NoSQL, and cloud databases, all through a single secure cloud solution accessible via a browser.

Tip: For a practical demonstration of CloudBeaver’s capabilities, please refer to our demo server. For more information, see Demo Server.

• Database Support Interact with different databases through a unified interface. Learn more

• Drivers’ Management Create custom drivers and edit existing ones. Learn more

• Centralized Access Facilitate a centralized access management system. Learn more

• Connection Access Management Harness administrator privileges to manage user access for shared connections. Learn more

• Data Management Use flexible data filters and switch between views for interactive data handling. Learn more
• SQL Development Tools Enhance your SQL development with autocomplete and syntax highlighting. Learn more
• Script Execution Execute and manage scripts efficiently. Learn more
• Data Export Easily export your data to various formats. Learn more
• Data Import Import files into your database with ease. Learn more

• Data Types Manage and display diverse data types.

• ER Diagrams Visualize database schemas and relationships. Learn more

• Visual Query Builder Construct complex SQL queries effortlessly. Learn more

• AI Smart Assistance Enhance your SQL development with AI-powered smart completion. Learn more

• Cloud Explorer Access and manage resources from major cloud providers. Learn more

• Cloud File Explorer Integrate smoothly with cloud-based file systems. Learn more

• Server Configuration Modify CloudBeaver’s server settings. Learn more

• Product Configuration Customize various aspects of CloudBeaver. Learn more

• Getting started

  • Application overview
  • Demo Server
  • Supported databases

• Administration

  • Server configuration
  • Create Connection

  • Network configuration settings

    • SSH configuration
    • SSL configuration
  • Connection Templates Management

  • Access Management

    • Users
    • Teams
    • Users Provisioning
  • CloudBeaver authentication methods
    • Local Access Authentication
    • Anonymous Access Configuration
    • Reverse proxy header authentication
    • LDAP
    • Single Sign On
    • SAML
    • OpenID
    • AWS OpenID
    • AWS SAML
    • AWS IAM
    • AWS OpenId via Okta
    • Snowflake SSO
    • Okta OpenId
    • Cognito OpenId
    • JWT authentication
    • Kerberos authentication
    • NTLM
    • Microsoft Entra ID authentication
    • Google authentication

  • Database authentication methods

    • Database Native
    • Kerberos
    • MongoDB
    • Microsoft Entra ID
    • Oracle wallet
    • PostgreSQL Pgpass
    • Salesforce
  • User credentials storage
  • Cloud Explorer
  • Cloud storage
  • Query Manager
  • Drivers Management
  • Accessibility
  • Keyboard shortcuts

• Features

  • Database navigator
    • DB Navigator toolbar
    • DB Navigator Settings menu
    • DB Navigator folders
    • Simple and Advanced View
  • Data editor
    • Data Filters
    • Data Ordering
    • Value Panel
    • Grouping Panel
    • Result details Panel
    • Managing Charts
    • JSON and Document View
    • Working with Spatial Geographic Information System (GIS) data
  • Data export
  • Data import
  • Entity Diagrams
  • SQL Editor
    • SQL Formatting
    • Query Execution Plan
    • Visual Query Builder
    • AI Smart Assistance
    • Auto and Manual commit modes
  • Log Viewer
  • Query History
  • Resource Manager
  • Session Manager

• Installation

  • Installation
  • Version upgrade
  • Workspace location
  • Workspace backup

• Configuration

  • Server configuration
    • Configuring server datasources
    • Initial data configuration
    • Admin password recovery
    • Password policy
    • Query manager database configuration
    • Server database
  • CloudBeaver and Nginx
  • Domain manager
  • Configuring HTTPS for Jetty server
  • Product configuration parameters
    • Authentication
    • Theming
    • Localization
    • Database Navigator
    • Data Editor
    • SQL Editor
    • Log Viewer
    • Data Export
    • ERD
    • Connections
  • Command line parameters
  • Local Preferences

  • API

    • Server architecture
    • Server API explorer
    • API token generation

• CloudBeaver AWS

  • Overview
  • AWS Settings
  • Cloud Explorer

• CloudBeaver Enterprise Edition

  • Overview
  • License Management

• Deployment

  • CloudBeaver AWS
    • AWS Marketplace
    • Docker image
  • CloudBeaver Enterprise
    • Docker image
    • AWS AMI
    • Google Cloud
    • Microsoft Azure
  • Deployment options
    • SSL certificate configuration
    • How to connect CloudBeaver to a database on a separate machine in Azure
    • Managing CloudBeaver server on AWS

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