You need to follow the next steps to setup the dev environment for developing in VS Code.

1. Setup Eclipse – follow this guide to setup Eclipse in the same folder with
   cloudbeaver
2. You need to place eclipse workspace in the eclipse folder:
   eclipse/workspace (windows) or
   eclipse/Eclipse.app/Contents/Eclipse/workspace` (MacOS)
3. Create folder
   opt/cbce
   in the same folder as
   cloudbeaver
4. Build CloudBeaver
5. Copy the content of
   cloudbeaver/deploy/cloudbeaver
   to
   opt/cbce
6. Specify the workspace folder in Eclipse debug profile to
   opt/cbce
7. Run debugging in Eclipse. After debug was successfully run, you can stop it and close eclipse
8. Now you can open
   cloudbeaver
   in VS Code and use debugging

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

Overview

Domain Manager enables you to configure a domain name and associated SSL certificate for your CloudBeaver instance. You can choose to automatically generate a domain at no cost or use your existing domain during product installation or later through the administration interface.

Domain configuration during initial setup

When setting up your server, you have two options for configuring the domain: automatic generation and manual setup. Follow the instructions below based on your preferred method.

Important: The Domain Manager won’t work without a configured Nginx server provided by CloudBeaver.

• You can use the full Docker Compose setup from our deployment repository.
• Alternatively, download our pre-configured Nginx Docker image from Docker Hub. Make sure to set the Nginx URL using the environment variable
  CLOUDBEAVER_DMSVC_URL
  by passing it directly to the container when running it. For detailed instructions on setting environment variables in Docker, refer to the official Docker documentation.

Automatic domain generation

When using automatic generation, the domain you create will have the format

. The is initially generated from your company’s name as specified in the license, but it can be customized if needed. Also, you can choose any name for the .

For example, if your organization name is

example-corp

and you choose

production

as your deployment subdomain, your domain would be

production.example-corp.databases.team

. Learn more about domain configuration fields.

In addition to the domain, you receive an SSL certificate, automatically renewed every three months.

To automatically generate a domain for your web server within the local network using a Let’s Encrypt certificate, follow these steps:

1) Navigate to the Domain Manager tab during the initial server configuration.

2) Click the Generate Automatically button.

3) Fill in the necessary fields as detailed in the table below.

4) Submit your settings and wait for the domain registration to complete. There may be a waiting period for domain registration.

5) Once the domain is active, you will be redirected to your server at the newly constructed domain,

.

Tip: For more information on deployment, see CloudBeaver Enterprise deployment repository.

Configuration fields

Field/Button	Description
Organization Subdomain	Specify the Organization subdomain. Automatically assigned during initial setup based on your licence.
Deployment Subdomain (Optional)	Specify the subdomain for your specific CloudBeaver server instance. Instances can be named uniquely, for example production or test .
Server Address	Provide the IP address where your server is hosted.
Delete	Delete the domain.

Manual domain configuration

If you prefer to set up the domain manually, using a custom SSL certificate, follow these steps:

1) Navigate to the Domain Manager tab during the initial server configuration.

2) Click the Set Up Manually button.

3) Fill in the necessary fields:

	Field	Description
	Domain Name	Enter your custom domain name.
	Certificate	Upload the SSL certificate file.
	Private Key	Upload the private key file associated with your SSL certificate.
	Certificate Chain (optional)	Upload the SSL certificate chain if applicable.

4) Ensure that the necessary DNS records are set to redirect traffic to your server.

5) Click the Add Certificate button to finalize the configuration.

Tip: Provided certificates will be stored in the appropriate directory (e.g.,

/etc/nginx/ssl/live/

on your server).

Adjusting domain settings in admin panel

Once the application is operational, you can modify the domain settings.

To modify your domain settings, follow these steps: 1) Log in as an administrator.

2) Navigate to Settings -> Administration -> Domain Manager.

3) Select either the automatic or manual configuration method.

Detailed steps for each method can be found in the sections:

• Automatic domain generation
• Manual domain configuration

Deleting the domain

To delete a domain, follow these steps:

1) Log in as an administrator.

2) Navigate to Settings -> Administration -> Domain Manager.

3) Select the Delete option.

Notes:

• If you’re using a Let’s Encrypt certificate, you don’t need to delete the Organization subdomain to assign a new one. Simply update the subdomain name and click Save to apply the changes.
• Ensure that local access is configured, as changes might disrupt SSO functionalities.
• After deleting the domain, this server will be accessible with the Server Address (IP).

Modifying the domain

To make changes to a domain:

1) Log in as an administrator.

2) Navigate to Settings -> Administration -> Domain Manager.

3) Update the necessary fields. If your domain uses a custom certificate, click the Update Certificate button to make changes to your SSL certificate.

For existing domains, whether set up automatically or manually, you can switch between the automatic and manual setup types by clicking the Change Type button.

Modifications for automatically generated domain

If your domain was configured using the automatic domain generation, consider the following additional steps and restrictions:

1) Modify the fields under the Deployment or Organization subdomains, respecting the limits on changes.

> Note: You can change the Deployment Subdomain up to three times per calendar month.

2) Submit your settings and wait for the domain registration to complete. There may be a waiting period.

3) Once the domain is active, you will be redirected to your server at the newly constructed domain, e.g.,

. If the organizational domain has been deleted, you will be redirected to your Server’s Address.

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.

You can order data in columns in one of the following ways:

1. Click the ordering icon in the header of the column.

   

   The icon has three states:

   • Clicking once establishes an ascending order
   • Clicking a second time changes the order to descending
   • Clicking a third time removes the ordering from the column

To order data by multiple columns, go column by column, holding the ctrl (windows) or cmd (mac) button, setting the order with the Ordering icon, starting from the column by which you want to order the data first.

2. Open the context menu, click Sorting. Choose from the ordering states we have mentioned before. When we choose an ordering state from the context menu, there is no need to hold the ctrl or cmd button to order data by multiple columns.

To reset the column data ordering to its initial state, open the Cell context menu and click Sorting -> Disable. If you want to reset all data ordering, open the Cell context menu, then click Sorting -> Disable all. You can also click the Ordering icon in the header of the any column to reset all data ordering.

Features

• Shortcuts
• Data Filters
• Data Ordering
• Value Panel
• Grouping panel
• JSON and Document View

• Working with spatial/GIS data

Shortcuts

Shortcut	Description
Enter Backspace a-Z and 0-9 keys	Start inline editing
Alt+Insert	Add a new row
Ctrl+Alt+Insert	Duplicate row
Delete	Delete row
Escape	Revert changes
Ctrl+V	Past value to cell from clipboard
Ctrl+C	Copy data to clipboard

Overview

CloudBeaver supports exporting data from database tables in various formats. Users can initiate data exports from the Database Navigator, Metadata Editor, Data Editor, or directly from the SQL Editor’s ResultSet.

Supported formats

CloudBeaver supports multiple output formats for data export:

• CSV.
• DBUnit.
• JSON.
• Markdown.
• Source Code.
• SQL.
• TXT.
• XML.
• Parquet.
• XLSX.

• HTML.

Steps to export data

To export data from CloudBeaver, follow these steps:

1. Choose the table you wish to export.

   

   You can initiate an export also from the Database Navigator, Data Editor after querying data, or directly from the ResultSet in the SQL Editor.

2. Select your desired format from the available options.

   

3. Set the necessary configuration options based on the format you have selected. Each format may have specific configuration settings that can be adjusted to meet your needs.

   

4. Once you have set the necessary configuration options for your selected format, move to the “Output” tab to configure the additional settings.

   

   Setting name	Description
   Encoding	Set the character encoding for the exported file.
   Insert BOM	Choose whether to include a Byte Order Mark in the file.
   Compression	Specifies if the export file should be compressed into a .zip archive.

   After configuring the settings, click on Export to initiate the export process.

5. Once you click the Export button, a pop-up dialog titled “File is Ready to Download” will appear. You can cancel the process by clicking Cancel or proceed with the download by clicking Download. Selecting Download will initiate the file download to your local system.

   Tip: It is advisable not to make changes to the data while the export is in progress to prevent any potential data integrity issues.

Specific configuration settings

In this section, you will find specific configuration settings for each supported export format. These settings allow you to customize the export process according to the requirements of the data format you choose.

CSV

Setting name	Description	Available options
Characters escape	Bad characters escaping model (surrounded with quotes or escaped with ‘\’ character).	quotes / escape
Delimiter	Column delimiter.	You can use special characters like `\t , \n , and \r `.
File extension	The default file extension for the exported file.	csv
Format numbers	Format numeric values using locale settings.	true / false
Header	CSV header settings.	none / top / bottom
Header case	You can choose lower or upper case for column names or descriptions in the header.	as is / upper / lower
Header format	Defines the formatting of the header.	label / description / both
NULL string	String which will be used instead of NULL values.
Quote always	Quote all cell values. Cannot be used with “Quote Never”.	disabled / all / strings / all but numbers / all but nulls
Quote character	Character which will be used to quote strings (space means no quote).
Quote never	Do not quote cell values. Cannot be used with “Quote Always”.	true / false
Row delimiter	Row delimiter. Default is system-specific line feed delimiter.	default / \n / \r / \r\n / \n\r

DBUnit

Setting name	Description	Available options
File extension	The default file extension for the exported file.	xml
Force upper case column names	Convert all column names to upper case.	true / false
Force upper case table name	Convert the table name to upper case.	true / false
Include NULL values in export	Include NULL values in the exported data.	true / false
Replace NULL values with	Specify a string to replace NULL values in the export.

JSON

Setting name	Description	Available options
File extension	The default file extension for the exported file.	json
Format dates in ISO 8601	Convert all date values to ISO 8601 format.	true / false
Print table name	Include the table name in the exported file.	true / false
Export JSON values as	Export values as text or as JSON objects.	string / JSON

Markdown

Setting name	Description	Available Options
Confluence format	Enable Confluence-specific Markdown formatting.	true / false
File extension	The default file extension for the exported file.	md
Format numbers	Format numeric values using locale settings.	true / false
NULL string	String to represent NULL values in the export.
Show header separator	Include a separator line below the header.	true / false

Source code

Setting name	Description	Available options
File extension	The default file extension for the exported file.	php
Format dates in ISO 8601	Convert all date values to ISO 8601 format.	true / false
Language	Specifies the PHP version compatibility for the generated code.	PHP < 5.4 , PHP 5.4+
Quote character	Character which will be used to quote strings.	" , '
Row delimiter	Row delimiter. Default is system-specific line feed delimiter.	default , \n , \r , \r\n , \n\r

SQL

Setting name	Description	Available options
Data rows per statement	Specifies the number of data rows in a single insert statement.	integer
File extension	The default file extension for the exported file.	sql
Identifier case	Allows selection of lower or upper keyword case for table and column names.	as is / upper / lower
Include generated columns	Specifies whether to include auto-generated columns (e.g., auto-increment) in SQL INSERT statements.	true / false
Insert line before rows	Specifies inserting a line feed before values in multi-row inserts.	true / false
Keyword case	Allows selection of lower or upper keyword case.	upper / lower
Native date/time format	Specifies using native date/time format in INSERT statements.	true / false
Omit schema name	Specifies omitting schema/catalog name in INSERT statements.	true / false
On conflict expression	Provides an expression for the end of the statement. This setting is specific to the database.
Target table name	Allows specification of the target table name to generate an INSERT statement.
Upsert keyword	Allows selection of different upsert keywords.	INSERT / INSERT ALL / UPDATE OR / UPSERT INTO / REPLACE INTO / ON DUPLICATE KEY UPDATE / ON CONFLICT

TXT

Setting name	Description	Available options
Batch size	Specifies the number of records per batch.	integer
File extension	Specifies the file type for output.	txt
In-between delimiter	Adds a custom character between data values.
Max column length	Specifies the maximum length of data in a column; longer values will be cropped.	integer
Min column length	Specifies the minimum length of data in a column; shorter values will be padded with spaces.	integer
Print header	Specifies whether to print column names at the top of the file.	true / false
Show header delimiter	Adds hyphen characters either in the first row without a header or between the header and data.	true / false
Show leading delimiter	Adds a pipe character at the start of the row.	true / false
Show NULLs	Controls the display of NULL values in the output.	true / false
Show trailing delimiter	Adds a pipe character at the end of the row.	true / false

XML

Setting name	Description	Available options
File extension	Specifies the file type for output.	xml
Include DOCTYPE declaration	Specifies whether to include the DOCTYPE declaration in the XML file export.	true / false

XLSX

Setting name	Description	Available options
Append strategy	Strategy used when appending data to an existing file.	create new sheets / use existing sheets
Boolean string FALSE	String that replaces FALSE boolean values in the exported file.	true / false
Boolean string TRUE	String that replaces TRUE boolean values in the exported file.	true / false
Border style	Style of cell borders in the exported file.	NONE / THIN / THICK
Excel date format	Date and time format used in the Excel file (modifiable in Excel application).	m/d/yy / d-mmm-yy / d-mmm / mmm-yy / h:mm AM/PM / h:mm:ss AM/PM / h:mm / h:mm:ss / m/d/yy h:mm
Column group	Column number used for grouping rows on a sheet by column value.	integer
Export SQL	Specifies whether to export SQL to a second sheet in the Excel file.	true / false
File extension	File extension for the exported document.	xlsx
Header format	Format of the header in the exported file.	label / description / both / none
Header row font	Font styling for the first row in the exported file.	NONE / BOLD / ITALIC / STRIKEOUT / UNDERLINE
Max row on sheet	Maximum number of rows allowed on a single sheet, after which data will split into another sheet.	integer
NULL string	String used instead of displaying NULL values in the exported file.
Row number(s)	Includes the row index as the first column in the exported file.	true / false
Split SQL Text	Splits exported SQL into rows by CR (Carriage Return) in the exported file.	true / false
Trim strings	Removes extra leading and trailing spaces from all string values in the exported file.	true / false

HTML

Setting name	Description	Available options
File extension	File extension for the exported document.	html
Images	Extracts images to graphic files.	true / false
Output column headers	Outputs column names as an additional row in the generated table.	true / false
Output table header	Outputs the query or table name as the first row in the generated table.	true / false

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

In CloudBeaver, data import is accessible through the Data Editor when a table is open.

Import process steps

1. Click the Import button to open a pop-up window for the import process.

   

2. Choose the file type for import.

   

3. Choose the file from local storage and press Import.

   

4. Upon successful import, a confirmation message will appear.

   

Import configuration details

The import process in CloudBeaver includes several key features and limitations:

• The Community Edition (CE) only allows for
  CSV
  files. Pro versions include
  CSV
  ,
  XLSX
  , and
  XML
  files.

• In CloudBeaver, data import is available to users with the roles of Editor, Manager, Developer, and Administrator.

• CSV
  files should be comma-delimited.

• The structure (DDL) of the uploaded table must match the existing table, specifically in terms of columns.

• Only unique primary key values are accepted to ensure data integrity and avoid duplicates.

• The import operation does not block the interface, allowing for continued work while the import is processed.

• The system currently supports uploading one file at a time.

Overview

The Database Navigator is a primary interface component for managing database structures and contents. It is positioned on the left-hand side of the application window. Key elements of the Database Navigator include the Toolbar, the Settings menu, and a hierarchical Object tree.

For details about the options available in the Toolbar and the Settings menu, see the Toolbar and the Settings menu guides.

Object tree

The Database Navigator displays a hierarchical tree that includes the following types of objects:

• Folders
• Database connections
  • Database objects (varying by database type, such as Tables, Views, Indexes, etc.)

Tip: You can store Database connections in folders. For more information, see Database Navigator folders.

Context menu

To access the context menu for an object, hover your cursor over the object in the Database Navigator and click the sandwich button to the right of the object. You can also access the context menu by right-clicking on the object in the Database Navigator.

The table below summarizes the available context menu items for each object type within the tree. The availability of these items depends on the specific database and object types.

Menu item	Description
Open	Opens an object in a separate Document viewer.
Filter	Allows inclusion or exclusion of database objects based on specified criteria. You can apply masks ( % , _ and * ) to define these criteria.
SQL Editor	Opens a new SQL Editor for the connection. For more information, see SQL Editor.
Connection view	Changes the view of the Database Navigator. For more information, see Simple and advanced view.
Edit Connection	Opens the Connection Configuration window that allows the configuration of connection settings. For more information, see Connection Configuration.
Disconnect	Disconnects from the database.
Disconnect all	Disconnects all database connections.
Delete	Deletes an object. The Delete action is irreversible and will remove the object from both the navigator tree and the database or file system permanently.
Refresh	Refreshes the object’s subnodes – mostly used for refreshing schemas.
Rename	Opens the Rename dialog box for an object.
Generate SQL	Opens a submenu on which you can select the type of SQL query to generate: SELECT , INSERT , UPDATE , DELETE , MERGE , DDL. Clicking one of the items (e.g., INSERT ) generates a relevant query in a separate window.
Export	Opens the Export window for table data export. For more information, see Data Export.

Shortcuts

Shortcut	Description
Ctrl + F	Enable filtering
Ctrl + Shift + ,	Link with editor
Ctrl + Shift + /	Collapse all

Configuring Database Navigator in the configuration file

Administrators can customize the Database Navigator settings in the

section of the configuration file. These settings control the visibility and organization of database objects within the navigator.

For more information on how to adjust Database Navigator settings through the configuration file, see the Server configuration.

Note: This feature is available in Team edition only.

A Dataset is a query result set presented in the form of a data grid that analytical team members can effectively and safely use with Editor or Viewer roles in Team Edition.

Administrators, Developers, and Managers create Datasets using existing tables for their non-technical colleagues so that they can conduct data analysis and create reports without going deep into database mechanisms.

Note: Dataset changes are immediately available to colleagues. If you delete or edit a Dataset in the web version of Team Edition, it will immediately disappear in the desktop version of Team Edition, and vice versa.

Datasets are stored in the Resource Manager server -> Team workspace -> Project -> Datasets folder.

Datasets in the web version

By checking the Show Datasets button, Administrators, Developers, and Managers can open the Datasets folder to make their work convenient.

There are several ways to create a new Dataset in the web version.

Create using the Data Editor

You can unfold your database connection in the Database Navigator, access the existing table, open it in the main view, and use the Add Dataset button at the bottom.

It will appear on the right panel after clicking the Add Dataset button and entering the new Dataset name.

Create using the SQL Editor

Another way to create a Dataset is to run the query you need in the SQL Editor and use the Result tab as a base. It will appear on the right after clicking the Add Dataset button and entering the new Dataset name.

Create using the Grouping Panel

You can also create a Dataset from the Grouping panel. Open the Grouping window by clicking the corresponding button , move the column/s from the Data Editor (enter filters if necessary), and click the Add Dataset button.

Editing Datasets

Right-click your Dataset on the right panel and get the context menu with the following options: Open, Edit, Rename, Delete, and Refresh. When you choose Edit, the

statement used for the Dataset creation appears in the main view. You can edit it by specifying additional clauses. Remember to click the Save Dataset button at the bottom. The Refresh option is useful when you want to get the latest changes from your colleagues who work in another Team Edition client.

Datasets in the desktop version

There are also several ways to create a Dataset in the desktop version of Team Edition.

Create using the Data Editor

You can access your existing table in the Database Navigator, open it in the main view, right-click inside Data Editor window, and choose the Create Dataset option in the context menu.

Tip: After entering the name and saving, you can access your Dataset in the Datasets folder in the Database Navigator.

Create using the SQL Editor

You can also create a new Dataset from the Result tab of the SQL Editor. Run the query you need, right-click inside Result tab window, and choose the Create Dataset option.

Create using the Grouping Panel

You can also create a Dataset from the Grouping panel. Open the Grouping window by clicking the corresponding button , move the column from the Data Editor (enter filters if necessary), and click the Add Dataset button.

Editing Datasets

In the desktop edition, Datasets are stored in the Datasets folder in the Database Navigator. You can navigate to this folder, select the desired Dataset, and right-click to access the context menu with options to Open Dataset, Delete, Rename, and Refresh.