[GH-ISSUE #2780] [Documentation] Where I can find the specification of data-sources.json #930

New issue

Open

opened 2026-03-07 20:56:52 +03:00 by kerem · 0 comments

kerem commented

2026-03-07 20:56:52 +03:00

Owner

Originally created by @ewh0 on GitHub (Jul 16, 2024).
Original GitHub issue: https://github.com/dbeaver/cloudbeaver/issues/2780

Originally assigned to: @daelynum on GitHub.

As a new user to cloudbeaver (and dbeaver in general), I need to pre-configure the database connection and personally I find it's difficult to look up the specification of data-sources.json

I've navigated back and force between a lot of links, such as

but none of these links fully cover the exact semantics of data-sources.json. For example, what will happen exactly if I turn save-password to true or false?

I'm looking for a specification where it lists every parameter we can put on this json file, and overall schema and the semantic of each parameter.

Using docker as example, the specification of docker compose (https://docs.docker.com/compose/compose-file/build/) basically list and explains each and every possible parameter.

IMHO, having such a document as a reference will help people quickly onboard cloudbeaver (prehaps also dbeaver) in general.

Thanks

Originally created by @ewh0 on GitHub (Jul 16, 2024). Original GitHub issue: https://github.com/dbeaver/cloudbeaver/issues/2780 Originally assigned to: @daelynum on GitHub. As a new user to cloudbeaver (and dbeaver in general), I need to pre-configure the database connection and personally I find it's difficult to look up the specification of `data-sources.json` I've navigated back and force between a lot of links, such as - https://dbeaver.com/docs/cloudbeaver/Server-configuration/ - https://dbeaver.com/docs/cloudbeaver/Configuring-server-datasources/ - https://dbeaver.com/docs/dbeaver/Configuration-files-in-DBeaver/ - https://github.com/dbeaver/cloudbeaver/blob/devel/config/sample-databases/DefaultConfiguration/GlobalConfiguration/.dbeaver/data-sources.json - https://dbeaver.com/docs/dbeaver/Admin-Manage-Connections/ - etc. but none of these links fully cover the exact semantics of `data-sources.json`. For example, what will happen exactly if I turn `save-password` to true or false? I'm looking for a specification where it lists every parameter we can put on this json file, and overall schema and the semantic of each parameter. Using docker as example, the specification of docker compose (https://docs.docker.com/compose/compose-file/build/) basically list and explains each and every possible parameter. IMHO, having such a document as a reference will help people quickly onboard cloudbeaver (prehaps also dbeaver) in general. Thanks