starred/cloudbeaver
1
0
Fork 0
mirror of https://github.com/dbeaver/cloudbeaver.git synced 2026-04-25 05:36:14 +03:00
Code Issues 212 Projects Releases Packages Wiki Activity

[GH-ISSUE #3421] Adding a driver to CloudBeaver CE. #1256

New issue
Closed
opened 2026-03-07 21:01:42 +03:00 by kerem · 10 comments
kerem commented 2026-03-07 21:01:42 +03:00
Owner
Copy link

Originally created by @avhz on GitHub (May 6, 2025).
Original GitHub issue: https://github.com/dbeaver/cloudbeaver/issues/3421

Hi :) I am trying to get SAP HANA working in CB (CE), running in Docker.

I have read the docs here, but the files described do not exist.

root@1340e8206d6a:/opt/cloudbeaver# find . -name pom.xml
./server/plugins/org.jkiss.bundle.gis_2.0.7/META-INF/maven/org.jkiss.bundle/org.jkiss.bundle.gis/pom.xml
./server/plugins/org.jkiss.bundle.antlr4_1.0.1/META-INF/maven/org.jkiss.bundle/org.jkiss.bundle.antlr4/pom.xml
./server/plugins/org.jkiss.bundle.apache.poi_5.3.0/META-INF/maven/org.jkiss.bundle/org.jkiss.bundle.apache.poi/pom.xml
./server/plugins/org.jkiss.bundle.graphql.java_22.2.0/META-INF/maven/org.jkiss.bundle/org.jkiss.bundle.graphql.java/pom.xml
./server/plugins/org.jkiss.bundle.sshj_0.34.1/META-INF/maven/org.jkiss.bundle/org.jkiss.bundle.sshj/pom.xml
./server/plugins/org.jkiss.bundle.logback_1.0.2/META-INF/maven/org.jkiss.bundle/org.jkiss.bundle.logback/pom.xml
./server/plugins/org.jkiss.bundle.jakarta.jetty.server_1.0.0/META-INF/maven/org.jkiss.bundle/org.jkiss.bundle.jakarta.jetty.server/pom.xml
./server/plugins/org.jkiss.bundle.apache.dbcp_2.12.5/META-INF/maven/org.jkiss.bundle/org.jkiss.bundle.apache.dbcp/pom.xml

root@1340e8206d6a:/opt/cloudbeaver# find . -name plugin.xml
root@1340e8206d6a:/opt/cloudbeaver#

Am I missing something ?

Cheers !

Originally created by @avhz on GitHub (May 6, 2025). Original GitHub issue: https://github.com/dbeaver/cloudbeaver/issues/3421 Hi :) I am trying to get SAP HANA working in CB (CE), running in Docker. I have read the docs [here](https://github.com/dbeaver/cloudbeaver/wiki/Adding-new-database-drivers#adding-drivers-in-cloudbeaver-community-edition), but the files described do not exist. ```bash root@1340e8206d6a:/opt/cloudbeaver# find . -name pom.xml ./server/plugins/org.jkiss.bundle.gis_2.0.7/META-INF/maven/org.jkiss.bundle/org.jkiss.bundle.gis/pom.xml ./server/plugins/org.jkiss.bundle.antlr4_1.0.1/META-INF/maven/org.jkiss.bundle/org.jkiss.bundle.antlr4/pom.xml ./server/plugins/org.jkiss.bundle.apache.poi_5.3.0/META-INF/maven/org.jkiss.bundle/org.jkiss.bundle.apache.poi/pom.xml ./server/plugins/org.jkiss.bundle.graphql.java_22.2.0/META-INF/maven/org.jkiss.bundle/org.jkiss.bundle.graphql.java/pom.xml ./server/plugins/org.jkiss.bundle.sshj_0.34.1/META-INF/maven/org.jkiss.bundle/org.jkiss.bundle.sshj/pom.xml ./server/plugins/org.jkiss.bundle.logback_1.0.2/META-INF/maven/org.jkiss.bundle/org.jkiss.bundle.logback/pom.xml ./server/plugins/org.jkiss.bundle.jakarta.jetty.server_1.0.0/META-INF/maven/org.jkiss.bundle/org.jkiss.bundle.jakarta.jetty.server/pom.xml ./server/plugins/org.jkiss.bundle.apache.dbcp_2.12.5/META-INF/maven/org.jkiss.bundle/org.jkiss.bundle.apache.dbcp/pom.xml ``` ```bash root@1340e8206d6a:/opt/cloudbeaver# find . -name plugin.xml root@1340e8206d6a:/opt/cloudbeaver# ``` Am I missing something ? Cheers !
kerem commented 2026-03-07 21:01:43 +03:00
Author
Owner
Copy link

@dariamarutkina commented on GitHub (May 7, 2025):

Hello, @avhz !
The pom.xml needs to be downloaded from the maven - https://mvnrepository.com/artifact/com.sap.hana :

Explore directory [server/drivers](https://github.com/dbeaver/cloudbeaver/tree/devel/server/drivers).
Create a new sub-folder new-driver-id. You can copy-paste some existing driver directory for simplification.
Add the pom.xml file to the new directory.

And then open file server/bundles/io.cloudbeaver.resources.drivers.base/plugin.xml
and edit it according to the instructions

Please let us know if you were able to do it. If not, feel free to tell us what didn’t work — we’ll try to figure it out together 🦫

<!-- gh-comment-id:2857657348 --> @dariamarutkina commented on GitHub (May 7, 2025): Hello, @avhz ! The pom.xml needs to be downloaded from the maven - https://mvnrepository.com/artifact/com.sap.hana : ``` Explore directory [server/drivers](https://github.com/dbeaver/cloudbeaver/tree/devel/server/drivers). Create a new sub-folder new-driver-id. You can copy-paste some existing driver directory for simplification. Add the pom.xml file to the new directory. ``` And then open file [server/bundles/io.cloudbeaver.resources.drivers.base/plugin.xml](https://github.com/dbeaver/cloudbeaver/blob/devel/server/bundles/io.cloudbeaver.resources.drivers.base/plugin.xml) and edit it according to the [instructions](https://github.com/dbeaver/cloudbeaver/wiki/Adding-new-database-drivers#include-driver-in-server-configuration) Please let us know if you were able to do it. If not, feel free to tell us what didn’t work — we’ll try to figure it out together 🦫
kerem commented 2026-03-07 21:01:43 +03:00
Author
Owner
Copy link

@avhz commented on GitHub (May 7, 2025):

Thanks for the response @dariamarutkina :)

server/bundles/io.cloudbeaver.resources.drivers.base/plugin.xml

This file does not exist in the container.

Edit: for completeness, my compose.yaml:

services:
  dbeaver:
    image: dbeaver/cloudbeaver:latest
    container_name: dbeaver
    restart: unless-stopped
    ports:
      - 10004:8978
    volumes:
      - ./dbeaver/logs:/opt/cloudbeaver/logs
      - ./dbeaver/workspace:/opt/cloudbeaver/workspace

Then simply run with docker compose up --build --detach.

You can then shell into it and run find . -name plugin.xml which returns no results.

<!-- gh-comment-id:2857841512 --> @avhz commented on GitHub (May 7, 2025): Thanks for the response @dariamarutkina :) [server/bundles/io.cloudbeaver.resources.drivers.base/plugin.xml](https://github.com/dbeaver/cloudbeaver/blob/devel/server/bundles/io.cloudbeaver.resources.drivers.base/plugin.xml) This file does not exist in the container. Edit: for completeness, my `compose.yaml`: ```yaml services: dbeaver: image: dbeaver/cloudbeaver:latest container_name: dbeaver restart: unless-stopped ports: - 10004:8978 volumes: - ./dbeaver/logs:/opt/cloudbeaver/logs - ./dbeaver/workspace:/opt/cloudbeaver/workspace ``` Then simply run with `docker compose up --build --detach`. You can then shell into it and run `find . -name plugin.xml` which returns no results.
kerem commented 2026-03-07 21:01:43 +03:00
Author
Owner
Copy link

@dariamarutkina commented on GitHub (May 7, 2025):

Please try the following:

  1. Clone the CloudBeaver source code from GitHub:
    git clone https://github.com/dbeaver/cloudbeaver.git
  2. Add your SAP HANA driver:
  • Navigate to the server/drivers directory.
  • Create a new subfolder for your driver
  • Add your pom.xml there.
  • Edit server/bundles/io.cloudbeaver.resources.drivers.base/plugin.xml to register the driver.
  1. Build your own Docker image using the provided script:
    Inside the cloned repo, run:
    ./deploy/docker/make-docker-container.sh
  2. Then run your new custom image via Docker Compose (replace the image in your compose.yaml with the one you've just built).
<!-- gh-comment-id:2858884082 --> @dariamarutkina commented on GitHub (May 7, 2025): Please try the following: 1. Clone the CloudBeaver source code from GitHub: ` git clone https://github.com/dbeaver/cloudbeaver.git` 2. Add your SAP HANA driver: - Navigate to the `server/drivers` directory. - Create a new subfolder for your driver - Add your `pom.xml` there. - Edit `server/bundles/io.cloudbeaver.resources.drivers.base/plugin.xml` to register the driver. 3. Build your own Docker image using the provided script: Inside the cloned repo, run: ` ./deploy/docker/make-docker-container.sh` 4. Then run your new custom image via Docker Compose (replace the image in your compose.yaml with the one you've just built).
kerem commented 2026-03-07 21:01:43 +03:00
Author
Owner
Copy link

@avhz commented on GitHub (May 8, 2025):

Okay I'll give it a go and let you know, thank you @dariamarutkina :)

A side note: is it intentionally missing from the published image ? Seems like a useful thing to include.

<!-- gh-comment-id:2862301273 --> @avhz commented on GitHub (May 8, 2025): Okay I'll give it a go and let you know, thank you @dariamarutkina :) A side note: is it intentionally missing from the published image ? Seems like a useful thing to include.
kerem commented 2026-03-07 21:01:43 +03:00
Author
Owner
Copy link

@dariamarutkina commented on GitHub (May 8, 2025):

Actually, the file is included in the Docker image — it's just packaged inside a JAR file, not available as a plain file in the filesystem. That's why find doesn't return any results.
We will be waiting for your messages. 🦫

<!-- gh-comment-id:2862460938 --> @dariamarutkina commented on GitHub (May 8, 2025): Actually, the file is included in the Docker image — it's just packaged inside a JAR file, not available as a plain file in the filesystem. That's why find doesn't return any results. We will be waiting for your messages. 🦫
kerem commented 2026-03-07 21:01:43 +03:00
Author
Owner
Copy link

@dariamarutkina commented on GitHub (May 27, 2025):

Hello, @avhz !
Just checking — did the instructions work for you? Let us know if you need anything else!🦫

<!-- gh-comment-id:2912282784 --> @dariamarutkina commented on GitHub (May 27, 2025): Hello, @avhz ! Just checking — did the instructions work for you? Let us know if you need anything else!🦫
kerem commented 2026-03-07 21:01:44 +03:00
Author
Owner
Copy link

@avhz commented on GitHub (May 27, 2025):

I'm sorry, I haven't attempted it yet as I am stuck on #3437

<!-- gh-comment-id:2912307880 --> @avhz commented on GitHub (May 27, 2025): I'm sorry, I haven't attempted it yet as I am stuck on #3437
kerem commented 2026-03-07 21:01:44 +03:00
Author
Owner
Copy link

@avhz commented on GitHub (May 30, 2025):

My proxy issue is resolved with help from @yagudin10 :)

@dariamarutkina is it possible to add the new driver to the dbeaver/cloudbeaver image, or do I need to do it via the repo first ?

<!-- gh-comment-id:2921732689 --> @avhz commented on GitHub (May 30, 2025): My proxy issue is resolved with help from @yagudin10 :) @dariamarutkina is it possible to add the new driver to the `dbeaver/cloudbeaver` image, or do I need to do it via the repo first ?
kerem commented 2026-03-07 21:01:44 +03:00
Author
Owner
Copy link

@dariamarutkina commented on GitHub (May 30, 2025):

Hello, @avhz!
Please follow the instructions in this comment:
https://github.com/dbeaver/cloudbeaver/issues/3421#issuecomment-2858884082

<!-- gh-comment-id:2921886105 --> @dariamarutkina commented on GitHub (May 30, 2025): Hello, @avhz! Please follow the instructions in this comment: https://github.com/dbeaver/cloudbeaver/issues/3421#issuecomment-2858884082
kerem commented 2026-03-07 21:01:44 +03:00
Author
Owner
Copy link

@LonwoLonwo commented on GitHub (Jul 21, 2025):

It has been a while since the last update on this issue.
If the issue persists, please inform us and provide additional details.

<!-- gh-comment-id:3095618691 --> @LonwoLonwo commented on GitHub (Jul 21, 2025): It has been a while since the last update on this issue. If the issue persists, please inform us and provide additional details.
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
devel
dbeaver/cloudbeaver#4120-support-token-header
dbeaver/pro#8978-advanced-paste
dbeaver/pro#5680-add-generation-rest-api-for-te
8961-cb-checkboxes-are-not-clickable-in-main-toolbar-dropdown-menu
dbeaver/pro#9047-cb-explain-execution-plan-ai
8328-cb-sql-query-generation-add-settings-for-the-generated-sql-window
8473-ai-confirmation
8107-cb-increase-the-contrast-of-some-elements
dbeaver/cloudbeaver#4249-session-id-rotation
dbeaver/pro#8234-udbt-only-for-admins
dbeaver/pro#9061-NPE-on-starting-RM-and-QM-applications
dbeaver/pro#8707-remove-folder-feature
dbeaver/pro#8766-migrate-to-junit5
dbeaver/pro#8711-sql-executation-plan-improvments
9048-cb-deadlock
release_26_0_3
dbeaver/pro#8044-add-api-for-database-user-preference
8839-entraid-not-working-from-within-myappsmicrosoftcom
8559-te-launch-redesign
8670-cb-multi-paste-support-in-data-editor-3
8943-cb-bump-npm-dependencies
dbeaver/pro#8655-cb-ai-functions-support
dbeaver/pro#8746-oauth
dbeaver/pro#8824-Unify-file-lock-handling-for-local-and-shared-fs
7912-db-oauth-in-te
dbeaver/pro#4158-tree-advanced-filter
dbeaver/dbeaver-devops#1604-non-root-user-25-2
dbeaver/pro#5124-fix-case-insensetive-username-in-import
3815-ctrl-z-is-unstable-lib-523-version
8894-ai-assistant-cache
dbeaver/pro#8896-Remove-added-h2_server_v3
release_26_0_2
dbeaver/pro#8392-Add-H2-driver-with-the-newest-version
8065-lsp-front-end
release_26_0_1
dbeaver/pro#7844-cb-lsp-server
dbeaver/pro#7530-csp-protection
release_26_0_0
release_25_3_5
release_25_3_4
release_25_3_3
7953-cb-ability-to-pin-rows-in-the-data-editor
devops-2221-base-java-repo
7923-cb-ws-events-are-misconfigured
release_25_3_2
release_25_3_1
release_25_3_0
release_25_2_5
dbeaver/pro#5267/auth-providers-refactoring
dbeaver/pro#6364-add-option-to-set-default-view-for-project
release_25_2_4
dbeaver/pro#5476-task-scheduler-refactor
release_25_2_3
7128-remove-deprecated-api
release_25_2_0
release_25_2_1
release_25_2_2
4569-cb-3681-use-something-better-than-md5-hash-to-pass-local-user-passwords
dbeaver/dbeaver-devops#1604-non-root-user-without-user-in-image
dbeaver/pro#6976-logging-poc
dbeaver/pro#6324-cursor-sync
dbeaver/pro#5630-add-cache-for-queries
dbeaver/pro#5574/fix/multi-query-vqb
dbeaver/pro#5802/feat/table-api
5664-cb-vscode-value-panel-support-text-format
CB-6291-build-local-script-do-not-clone-all-required-repos-for-successful-build
4288-core-fix-critical-cve-2022-0839-and-cve-2022-0839-in-liquibase-bundle
3944-model-data
4207-core-duplicate-cb-session-id-in-dc-side
chore/update-vite-assets-plugin
25.1.5
25.1.4
25.1.3
25.1.2
25.1.1
25.1.0
25.0.5
25.0.4
25.0.3
25.0.2
25.0.1
25.0.0
24.3.5
24.3.4
24.3.3
24.3.2
24.3.0
24.3.1
24.2.5
24.2.4
24.2.3
24.2.2
24.2.1
24.2.0
24.1.5
24.1.4
24.1.3
24.1.2
24.1.0
24.1.1
24.0.5
24.0.4
24.0.3
24.0.2
24.0.1
24.0.0
23.3.5
23.3.4
23.3.3
23.3.2
23.3.1
23.3.0
23.2.5
23.2.4
23.2.3
23.2.2
23.2.1
23.2.0
23.1.5
23.1.4
23.1.3
23.1.2
23.1.1
v23.1.0
v23_0_5
21.3.3
21.2.4
1.2.0
1.1.0
1.0.4
1.0.3
1.0.1b
1.0.2
1.0.1
1.0.0
Labels
Clear labels   
AS

   
can't reproduce

   
can't reproduce

   
deployment

   
development

   
documentation

   
duplicate

   
duplicate

   
ee

   
enhancement

   
external

   
new driver

   
performance

   
pull-request

Mirrored from GitHub Pull Request

  
third party issue

   
wait for response

   
wait for review

   
wontfix

   
x:Oracle

   
x:cassandra

   
x:clickhouse

   
x:db2

   
x:duckdb

   
x:greenplum

   
x:h2

   
x:h2gis

   
x:hana

   
x:hive

   
x:intersystems

   
x:kyuubi

   
x:maria

   
x:mongo

   
x:mysql

   
x:postgresql

   
x:presto

   
x:sql server

   
x:sqlite

   
x:teradata

   
x:trino

   
xf:accessibility

   
xf:administration

   
xf:ai

   
xf:authentication

   
xf:aws

   
xf:commit-mode

   
xf:connection

   
xf:dark theme

   
xf:data editor

   
xf:datatransfer

   
xf:dba

   
xf:driver management

   
xf:erd

   
xf:filters

   
xf:i18n

   
xf:i18n

   
xf:installer

   
xf:json

   
xf:kerberos

   
xf:ldap

   
xf:local config

   
xf:log viewer

   
xf:metadata

   
xf:metadata editor

   
xf:navigator

   
xf:okta

   
xf:query manager

   
xf:resource manager

   
xf:scripts

   
xf:sql editor

   
xf:tasks

   
xf:ui/uix

   
xo: Firefox

   
xo:eclipse

   
xo:internet explorer

   
xo:macos

   
xp:major

   
xrn:internal
No labels
AS
can't reproduce
can't reproduce
deployment
development
documentation
duplicate
duplicate
ee
enhancement
external
new driver
performance
pull-request
third party issue
wait for response
wait for review
wontfix
x:Oracle
x:cassandra
x:clickhouse
x:db2
x:duckdb
x:greenplum
x:h2
x:h2gis
x:hana
x:hive
x:intersystems
x:kyuubi
x:maria
x:mongo
x:mysql
x:postgresql
x:presto
x:sql server
x:sqlite
x:teradata
x:trino
xf:accessibility
xf:administration
xf:ai
xf:authentication
xf:aws
xf:commit-mode
xf:connection
xf:dark theme
xf:data editor
xf:datatransfer
xf:dba
xf:driver management
xf:erd
xf:filters
xf:i18n
xf:i18n
xf:installer
xf:json
xf:kerberos
xf:ldap
xf:local config
xf:log viewer
xf:metadata
xf:metadata editor
xf:navigator
xf:okta
xf:query manager
xf:resource manager
xf:scripts
xf:sql editor
xf:tasks
xf:ui/uix
xo: Firefox
xo:eclipse
xo:internet explorer
xo:macos
xp:major
xrn:internal
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
starred/cloudbeaver#1256
No description provided.