cloudbeaver Documentation

Technical Documentation: dbeaver/cloudbeaver

ℹ️ Provenance: Multi-Tier Ingestion · CodeWiki Reference

Overview (`README.md`) Copy Section

CloudBeaver Community

Cloud Database Manager - Community Edition.
CloudBeaver is a web server that provides a rich web interface. The server itself is a Java application, and the web part is written in TypeScript and React.
It is free to use and open-source (licensed under Apache 2 license).

Documentation Copy Chapter

• GitHub WIKI
• Official documentation

Run in Docker Copy Chapter

• Official Docker repository
• Deployment instructions

Demo server Copy Chapter

You can see a live demo of CloudBeaver server here: https://demo.cloudbeaver.io

Database access instructions

Changelog Copy Chapter

26.2.3 2026-10-19 Copy Section

• AI Assistant:
  • Added support for authenticating user-created OpenAI profiles with a ChatGPT subscription via a browser or device code.
• Data Editor
  • Fixed an issue where setting a cell to NULL from the context menu caused the table to scroll to the top when the Value panel was open.
• SQL Editor:
  • Fixed an issue where using a Chinese IME in string literals inserted raw Pinyin characters, potentially replacing or removing existing text.
• Navigator:
  • Fixed an issue where folders moved using drag-and-drop were not synchronized between browser tabs.
  • Added the ability to create new folders from the context menu for the Scripts tabs.
• Accessibility:
  • Added the ability to copy content from the administration tables using the standard copying shortcut.
• Security:
  • Fixed authorization checks to prevent users from accessing or modifying resources in shared projects without permission.
  • Fixed one critical and three high vulnerabilities in the shell-quote, source-map-js, @graphql-tools/utils, and @graphql-tools/executor-legacy-ws libraries (CVE-2026-102422, CVE-2026-93749, CVE-2026-104852, and CVE-2026-103921). The libraries were updated to versions 1.12.0, 1.2.2, 12.0.3, and 1.1.37, respectively.
  • Fixed three high vulnerabilities in the @fastify/busboy and probe-image-size libraries (GHSA-x8mw-p69m-v3mx, GHSA-xjh9-v7x6-24jw, and GHSA-gjj5-9665-rwrc). The libraries were updated to versions 3.2.2 and 7.4.0, respectively.
• Databases and drivers:
  • Clickhouse: Added the ability to rename tables from the Navigator tree.
  • PostgreSQL:
    • Fixed bulk imports that mishandled literal backslashes or custom CSV escape characters
    • Fixed SQL formatting for the @? operator

26.2.2 2026-10-05 Copy Section

• AI Assistant:
  • AI profiles are now sorted alphabetically in AI Chat and administration settings.
• Administration:
  • Added an Administration label and a Connections button to the administration header for easier navigation back to the application.
• Authorization:
  • Added the ability to change the database user password from the connection context menu if the “Enable database password change” setting is enabled in the Server configuration.
• Data Transfer:
  • Added format settings for data import in CloudBeaver, allowing users to configure how imported data is parsed and processed.
• General:
  • Improved performance and keyboard navigation in the Driver Properties tab.
  • Improved spacing and alignment in the connection form.
  • User profile tabs were moved to a vertical layout to improve usability and prevent horizontal scrolling on smaller screens.
  • Added keyboard navigation for the Connection and Scripts trees, including expanding, collapsing, and opening items.
• Security:
  • Updated the MariaDB driver to version 3.5.10 to address CVE-2026-55856, CVE-2026-55857, and CVE-2026-55858.
  • Fixed an LDAP authorization issue related to access filter handling in certain configurations.

26.2.1 2026-09-21 Copy Section

• AI Assistant:
  • Added the ability for users to configure their own API tokens for administrator-created AI profiles. Users can set, update, and reset API tokens from AI Chat and User Settings.
  • Fixed Gson parsing errors when using OpenAI-compatible streaming providers, such as LiteLLM.
• Connectivity:
  • Fixed long-polling fallback when WebSocket connections close cleanly, preventing queries from staying in the Loading state. (thanks to @ThomasSwinicki)
• General:
  • The connection page was redesigned to improve users' experience with this form. Connection, authentication, database-specific, and other settings moved to the vertical tabs on the left side of the page.
  • Fixed an issue where new icons were not shown after updating the application until the browser cache was cleared.
  • Fixed an issue where subfolders disappeared when another folder with the same name was created in CloudBeaver.
  • Fixed notifications for opened connections when they are moved to a folder or deleted from another CloudBeaver session.
• Security:
  • Restricted web-service actions in CloudBeaver configuration mode to prevent unauthorized access before server setup is complete.
  • Restricted CloudBeaver file system API access and added file name validation to prevent unauthorized file operations.
• Databases and drivers:
  • DuckDB: Added SQL LIMIT clauses to Data Editor queries to prevent excessive memory use with large tables.
  • Firebird: Fixed function DDL generation to preserve parameter and return types, nullability, and SQL security mode.
  • MariaDB:
    • Fixed an issue where the Constraints tab could show a CHECK expression from another table
    • Named CHECK constraints are now shown in the Constraints tab for users with SELECT-only access

26.2.0 2026-08-31 Copy Section

Changes since 26.1.0 Copy Section

• AI Assistant:
  • Added AI Chat to help users generate and fix queries and explore data more easily. It’s integrated with the SQL Editor to run generated queries instantly. All AI features can be turned off in the Server configuration.
  • Added the ability to use multiple AI configurations for working with the AI chat. Administrators can define tokens, engines and models for OpenAI and Copilot in the Administration panel for each AI profile separately. After that, users can switch between these profiles while using AI features.
  • Added the ability to cancel a response in the AI Chat to stop response generation when needed.
  • The "Endpoint" setting was renamed to "API Base URL" for the OpenAI provider.
  • Added AI engine icons to AI configuration profiles, making it easier to identify AI providers in the Administration panel and AI Chat configuration.
• Administration:
  • Added the database version and the driver version to diagnostic logs.
  • Fixed the issue of fetching groups during LDAP authorization. CloudBeaver now provides all matched groups regardless of fetching errors.
  • Added the Last Login time to the user form and the user table in the administration part.
• Authorization:
  • Added the option to upload files for certificates and keys in the SSL authorization configuration.
  • Fixed an issue causing the application to lose connection to the database after extended uptime. Access is kept automatically during long-running sessions.
• Data Editor:
  • Added the References panel to the Data Editor. The panel displays related records from connected tables. Users can explore table relationships directly.
  • Added the ability to export generated SQL to a .sql file from the Generate SQL dialog.
  • Fixed copying of large JSON values in the Data Editor - now the full value can be copied.
  • Resolved an issue where the Data Editor ignored the text preview's maximum length quota. Increasing this quota now enables the ability to edit large values.
• Data Transfer:
  • Added advanced data import settings, including database-specific replace methods, transaction support, bulk loading, and the option to use a separate connection for data import.
  • Improved memory usage when importing large CSV files to improve the application performance.
• Accessibility:
  • Improved accessibility for the search on the Users section in the Administration panel. The application allows focusing on the search field with the Tab key.
  • Added a loader to the Save button in the Administration panel to improve indication of the long-performing operations.
  • Improved drag-and-drop in the Navigator Tree for objects by enlarging the auto-scroll trigger areas.
  • Added the ability to expand and collapse code block elements, including JSON, using the keyboard in the Data Editor.
  • Fixed shortcuts behavior for AZERTY keyboards. Now shortcuts like Ctrl/Cmd + Z work correctly.
  • Added the ability to use the Enter or space keys to turn checkboxes on/off in the connection properties tab.
• General:
  • Added connection types to visually distinguish database connections using background colors across the Database Navigator and application UI.
  • Improved SQL autocomplete suggestion ordering for object names. Now suggestions are sorted alphabetically.
  • Added a Project Info tab containing the project description to the project context menu.
  • Fixed synchronization between devices. Users see updated connections and folders in other devices without manual refreshes.
• Databases:
  • ClickHouse
    • The driver was updated to version 0.10.0
    • Improved JSON display in the Value panel
    • Added support for the Map data type visualization for the Data Editor
  • The Databend driver was updated to version 0.4.8.
  • LibSQL: Added support for database views.
  • MySQL: Fixed support for comments starting with '#' symbol in the SQL Editor.
  • PostgreSQL
    • Updated the driver to version 42.7.13.
    • Added a Show full DDL option for schemas and tables to generate complete DDL, including objects within a schema and object comments and privileges.
    • Fixed an error that occurred when applying filters to database nodes
    • Fixed generated calls for procedures with OUT parameters
• Security:
  • Removed the ability to rename SQL scripts that start with dots to prevent them from being moved outside the Scripts directory into the root Tree.
  • Added a new "Auto-create users" setting for the reverse proxy provider, allowing new user creation on login. It is enabled by default.
  • Fixed a security flaw allowing unauthorized users to test database connections. The application now requires proper permissions for this action, preventing malicious requests and protecting server files.
  • Fixed a security flaw in the LDAP authentication process. The application validates the username input to prevent unauthorized access and protect directory data.
  • Fixed a cross-site scripting vulnerability caused by unsanitized user input in the web interface.
  • Resolved a security flaw related to user-controlled file paths by adding strict validation to prevent unauthorized resource access.
  • Updated session handling to prevent session fixation vulnerabilities. The application generates new session identifiers upon login.
  • Updated the PostgreSQL JDBC driver to version 42.7.13, including a fix for a high-severity security vulnerability (CVE-2026-54291).
  • Fixed the critical vulnerability (CVE-2026-59873) in the tar library. The library was updated to version 7.5.19.
  • Fixed the critical vulnerability (CVE-2026-9277) in the shell-quote library (updated to version 1.8.4)
  • Fixed the high vulnerability (CVE-2026-10050) in the jetty-security library. The library was updated to version 12.1.11.
  • Fixed the high vulnerability (CVE-2026-14257) in the brace-expansion library. The library was updated to version 5.0.8.
  • Fixed the high vulnerability (GHSA-r28c-9q8g-f849) in the postcss library. The library was updated to version 8.5.18.
  • Fixed the high vulnerability (GHSA-pm4m-ph32-ghv5) in the js-yaml library. The library was updated to version 5.2.2.
  • Fixed the high vulnerability (CVE-2026-59880) in the immutable library. The library was updated to version 5.1.8.
  • Fixed the high vulnerability (CVE-2026-59879) in the fast-uri library. The library was updated to version 3.1.3.
  • Fixed the high vulnerability (CVE-2026-13311) in the shell-quote library. The library was updated to version 1.9.0.
  • Fixed the high vulnerability (GHSA-gcfj-64vw-6mp9) in the axios library. The library was updated to version 1.18.0.
  • Fixed the high vulnerability (CVE-2026-67213) in the nanoid library. The library was updated to version 3.3.17.
  • Fixed the high vulnerability (CVE-2025-71329) in the less library. The library was updated to version 4.7.0.
  • Fixed the high vulnerability (CVE-2026-13697) in the undici library. The library was updated to version 8.9.0.
  • Fixed the high vulnerability (CVE-2026-18446) in the fast-uri library. The library was updated to version 4.1.2.
  • Fixed the high vulnerability (CVE-2026-69152) in the brace-expansion library. The library was updated to version 5.0.9.
  • Fixed the high vulnerability (GHSA-gv7w-rqvm-qjhr) in the esbuild library. The library was updated to version 0.28.1.
  • Fixed the high vulnerability (CVE-2026-12143) in the form-data library. The library was updated to version 4.0.6.

Overview (`webapp/readme.md`) Copy Section

Steps to Run

Welcome! Follow these steps to install and run the frontend dev server.

Prerequisites:

• Ensure you have the correct Node.js version

  We recommend using the latest LTS (Long-Term Support) version. Check the official Node.js website: https://nodejs.org/
  The minimum supported version is v22.15.0

• Ensure you have Yarn installed

  If not, see the instructions on the official website: https://yarnpkg.com/getting-started/install

• Enable Corepack

  To ensure that Corepack is enabled, run the following command:

  bash Copy

  corepack enable

  More about corepack you can find here: https://yarnpkg.com/corepack

Installation Steps:

1. Build the Backend Server

   Navigate to the deploy directory and execute the build script. This script will handle cloning necessary repositories and building the backend. It also installs all frontend dependencies and builds it as well.

   For macOS/Linux:

   bash Copy

   cd deploy
   ./build.sh

   For Windows:

   bash Copy

   cd deploy
   ./build.bat

2. Navigate to the Directory with Build Artifacts

   Change your current directory to the cloudbeaver folder within the deploy directory.

   bash Copy

   cd cloudbeaver

3. Run the Backend Server

   Start the backend server by running the execution script.

   For macOS/Linux:

   bash Copy

   ./run-cloudbeaver-server.sh

   For Windows:

   bash Copy

   ./run-cloudbeaver-server.bat

4. Navigate to the Webapp Directory

   Open a new terminal window or tab, and change your directory to the web application's product folder.

   bash. Copy

   cd webapp/packages/product-default

5. Run the Web Application

   Start the web application development server, specifying the backend server's URL. The default URL is http://localhost:8978/.

   For macOS/Linux:

   bash Copy

   server=http://localhost:8978/ yarn dev

   For Windows Command Prompt:

   cmd Copy

   set server=http://localhost:8978/ && yarn dev

   For Windows PowerShell:

   powershell Copy

   $env:server="http://localhost:8978/"; yarn dev

You should see a message with URL of your running dev server like below

➜ Local: http://localhost:8080/

Developing in VSCode

VSCode offers dedicated tasks to streamline development with our project, making it the recommended environment for working on the CloudBeaver Frontend.

To access these tasks, press F1 (or Cmd/Ctrl + Shift + P) in VSCode, select "Tasks: Run Task" from the command palette, and then choose the desired task from the list.

To start the local development server, follow these steps:

1. Execute the Build CE task. This task builds both the backend and frontend.
2. Run the Run Backend CE task to start the backend server.
3. Run the Run DevServer CE task.

These steps will launch the frontend in development mode and proxy API requests to your locally running backend, accessible at http://localhost:8080/.

Overview (`.vscode/vscode-java-configs/README.md`) Copy Section

vscode-java-configs

FAQ Copy Chapter

Typescript Server crashed 5 times Copy Section

• Open .pnp.cjs and replace bestCandidate.apiPaths.length === 1 with bestCandidate.apiPaths.length > 0

Overview (`apps/h2-query-executor/README.md`) Copy Section

H2 Query Executor

Applications for executing h2 database queries through the console and running queries to fix the CloudBeaver database

How to build Copy Chapter

Use mvn clean install to build executable jar.

Arguments: Copy Chapter

--db-path - path to cloudbeaver database

--db-user - cloudbeaver database username

--db-password-path - path to .database.credentials.dat

--db-password - database password(use only password or db-password-path, not both)

--db-custom-query - execute custom sql query

--db-execute-11-migration-fix - mark that scripts to fix broken migration must be executed

Example: Copy Chapter

java -jar h2-query-executor-1.0.0.jar --db-path=/var/cloudbeaver/workspace/.data/cb.h2.dat.mv.db --db-user=cb-data
--db-password-path=/var/cloudbeaver/workspace/.data/.database-credentials.dat --db-custom-query="show tables"

Overview (`webapp/common-react/@dbeaver/ui-kit/README.md`) Copy Section

DBeaver UI Kit

The DBeaver UI Kit is a collection of reusable React components designed to help developers build consistent and visually appealing user interfaces.

Using Ladle for Component Development Copy Chapter

Ladle is a tool that allows you to develop, test, and document your React components in isolation. We use it to create a sandbox environment where you can interact with your components and ensure they work as expected.

To get started with Ladle in the DBeaver UI Kit, write in terminal:

yarn docs

Then open the provided URL to see components.

How to Customize Copy Chapter

DBeaver UI Kit components have basic styles and use some defaults from Tailwind CSS. To change styling, you can use different approaches.

Global CSS Tokens Copy Section

The UI kit uses several global CSS tokens described on the Global Tokens page. These tokens help maintain consistency across the UI components. All DBeaver UI tokens are prefixed with --dbv-kit-. You can use these tokens to customize the UI kit to fit your application's design. For example, changing the --dbv-kit-font-size-base token will change the base font size for text in the UI kit. Changing the --dbv-kit-control-height-base token will change all control heights. If you don't want to change all controls, you can change --dbv-kit-control-height-small, --dbv-kit-control-height-medium, or other tokens separately. They will affect only specific components.

Component CSS Tokens Copy Section

Some components have their own tokens. For example, the Button component has tokens for button sizes, padding, and colors. You can change these tokens to customize the Button component. To see the list of tokens, go to sources or start Ladle.

Component CSS Classes Copy Section

Each component in the UI kit has a default CSS class name following the dbv-kit-[component name(in lowercase)] naming convention that you can use to customize the component. You can find the default class name in the component's documentation.

For button:

.dbv-kit-button {
  /* Your custom styles */
}

For input:

.dbv-kit-input {
  /* Your custom styles */
}

Some components have additional classes for different states or sizes. For example, the Button component has classes for different sizes: .dbv-kit-button--small, .dbv-kit-button--large. We use the BEM convention for class names. If a component has a modifier, it will be separated by two dashes. If a component has a child element, it will be separated by two underscores, for example:

• .dbv-kit-button__icon - icon is a child element of the button
• .dbv-kit-button--large - large is a size modifier
• .dbv-kit-button__icon--start - icon is a child element of the button and has a start placement

Each component accepts the standard className and style props which enable using vanilla CSS, utility classes (e.g., Tailwind), CSS-in-JS (e.g., Styled Components), etc. A custom className can be specified and will be appended to a class list of a component:

<Button className="my-custom-button">Button</Button>

<Button style={{ background: 'red' }}>Button</Button>

--- METRICS ---

• Files Extracted: 5
• Estimated Token Budget: ~5301 tokens
• Canonical Reference: https://codewiki.google/github.com/dbeaver/cloudbeaver