[Documentation] Where I can find the specification of data-sources.json #743

New issue

Open

opened 2026-03-04 10:52:41 -05:00 by deekerman · 3 comments

deekerman commented

2026-03-04 10:52:41 -05:00

Owner

Originally created by @ewh0 on GitHub (Jul 16, 2024).

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). 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

deekerman added the

labels

2026-03-04 10:52:41 -05:00

deekerman commented

2026-03-04 10:52:52 -05:00

Author

Owner

@LonwoLonwo commented on GitHub (Jul 16, 2024):

Hello @ewh0

Thanks for the report. We will look at it and try to reconfigure our documentation. We can probably update this article https://dbeaver.com/docs/dbeaver/Admin-Manage-Connections/

@LonwoLonwo commented on GitHub (Jul 16, 2024): Hello @ewh0 Thanks for the report. We will look at it and try to reconfigure our documentation. We can probably update this article https://dbeaver.com/docs/dbeaver/Admin-Manage-Connections/

deekerman commented

2026-03-04 10:52:58 -05:00

Author

Owner

@benbouillet commented on GitHub (Oct 28, 2024):

Hello,
I concur, having the JSON schema for data-sources.json would be a great addition. The organization I work for has automated the generation of db connections to improve developer experience

Thanks in advance!

@benbouillet commented on GitHub (Oct 28, 2024): Hello, I concur, having the JSON schema for `data-sources.json` would be a great addition. The organization I work for has automated the generation of db connections to improve developer experience Thanks in advance!

deekerman commented

2026-03-04 10:53:00 -05:00

Author

Owner

@vanphuoc3012 commented on GitHub (Jan 8, 2025):

Hi, it's would be great there is document for schema of data-sources.json

@vanphuoc3012 commented on GitHub (Jan 8, 2025): Hi, it's would be great there is document for schema of `data-sources.json`