Data Sources Json Reference

Table of contents

• File structure
• Connections fields
  • Configuration fields
    • Auth models
    • Handlers
    • Properties

data-sources.json stores all database connection definitions in the CloudBeaver workspace.

The file lives at ${WORKSPACE}/workspace/GlobalConfiguration/.dbeaver relative to your workspace root.

For details on workspace paths, see Workspace location.

File structure

{
  "folders": {},
  "connections": {
    "<connection-id>": {
      "configuration": {
        ...
        }
      }
    }
  },
}

Field	Description
folders	Folder definitions. Leave as {} when editing manually. For more details about folders, see Database Navigator folders
connections	Map of connection definitions, keyed by connection ID

Each entry in connections is a connection object. Two groups of fields: connection fields that control how CloudBeaver manages the connection, and the configuration object that holds the database connection parameters.

Connections fields

Field	Type	Default	Description
provider	string	-	Database provider ID, for example postgresql, mysql, or generic. To find a provider ID, open Driver Manager, select a database provider, and check the Provider ID field in the driver description.
driver	string	-	Driver ID, for example postgres-jdbc, mysql8, or sqlite_jdbc. To find a driver ID, open Driver Manager, select a driver, click Edit, and check the ID field in the driver description.
name	string	-	Display name shown in the Database Navigator
description	string	-	Description of the connection
save-password	boolean	false	Store credentials in the workspace config. When true, the encrypted credentials file is used. When false, credentials must be entered on each connect
read-only	boolean	false	Open the connection in read-only mode
folder	string	-	Place the connection in a folder within the project, e.g. "prod" or "prod/finance"
configuration	object	-	Database connection parameters. See Configuration fields

Configuration fields

Field	Type	Default	Description
host	string	-	Database server hostname or IP address. Ignored if url is set
port	string	-	Database port. Ignored if url is set
database	string	-	Database name. Ignored if url is set
server	string	-	Logical server name. Ignored if url is set
url	string	-	Full JDBC connection URL. When set, overrides host, port, database, and server
configurationType	string	MANUAL	MANUAL to use host/port/database fields, URL to use the url field
closeIdleConnection	boolean	false	Disconnect after the connection has been idle
auth-model	string	native	Authentication model ID. See Auth model reference
auth-properties	object	-	Credentials for the selected auth model. See Auth model reference
properties	object	-	JDBC driver properties passed directly to the driver. See Driver properties
handlers	object	-	Network handler configurations: SSH tunnels, SSL, proxies, AWS SSM, Kubernetes. See Handlers reference

Example:

{
  "connections": {
    "postgres-jdbc-19a9ccb2c0e-201a227bc74f6a48": {
      "provider": "postgresql",
      "driver": "postgres-jdbc",
      "name": "PostgreSQL - prod",
      "save-password": true,
      "read-only": false,
      "folder": "prod",
      "configuration": {
        "host": "db.example.com",
        "port": "5432",
        "database": "appdb",
        "url": "jdbc:postgresql://db.example.com:5432/appdb",
        "configurationType": "MANUAL",
        "type": "dev",
        "auth-model": "native"
      }
    }
  }
}

Auth models

The auth-model and auth-properties fields control how CloudBeaver authenticates to the database. The available models and their parameters depend on the driver.

For details, and examples, see Auth model reference.

Handlers

The handlers object routes connections through SSH tunnels, SSL, or a SOCKS proxy.

For handler IDs, properties, and examples, see Network handlers reference.

Properties

The properties object passes key-value pairs directly to the JDBC driver. The available keys depend entirely on the driver - check your driver's documentation for the full list.

Example:

{
  "properties": {
    "connectTimeout": "20",
    "loginTimeout": "20",
    "escapeSyntaxCallMode": "callIfNoReturn"
  }
}