data-sources.json reference

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

The file lives at <workspace>/General/.dbeaver/data-sources.json relative to your workspace root. For details on workspace paths, see Workspace location.

Tip

This file follows the same format as the DBeaver datasources configuration file. You can create this configuration in DBeaver and then copy it to dbvr.

File structure¶

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

Field	Description
`folders`	Folder definitions. Managed by the Dbeaver UI. Leave as `{}` when editing manually
`connections`	Map of connection definitions, keyed by connection ID

Tip

Use dbvr datasource view to inspect an existing connection's full JSON, or dbvr datasource create to generate a new entry without editing the file directly.

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

Connections fields¶

Field	Type	Default	Description
`provider`	string	-	Database provider ID, e.g. `postgresql`, `mysql`, `generic`. Use `dbvr driver list` to find provider IDs
`driver`	string	-	Driver ID, e.g. `postgres-jdbc`, `mysql8`, `sqlite_jdbc`. Use `dbvr driver list` to find driver IDs
`name`	string	-	Display name shown in `dbvr datasource list` output
`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
`custom-properties`	object	-	Transaction and notification settings. See Transaction and notification settings
`configuration`	object	-	Database connection parameters. See Configuration fields

Custom properties settings¶

The custom-properties object stores transaction, notification, and metadata settings for a specific connection.

For property names, allowed values, and descriptions, see DBeaver article Admin manage preferences.

Example

{
  "custom-properties": {
    "database.meta.separate.connection": "NEVER",
    "transaction.auto.close.ttl": "14400",
    "transaction.smart.commit": "true",
    "transaction.smart.commit.recover": "true"
  }
}

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
`config-profile`	string	-	Configuration network profile name. See `network handlers`
`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
`bootstrap`	object	-	Default session settings applied when the connection opens. See Bootstrap settings
`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",
        "auth-model": "native"
      }
    }
  }
}

Auth models¶

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

Info

For details, and examples, see Auth model reference.

Handlers¶

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

Info

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"
  }
}

Bootstrap¶

The bootstrap object inside configuration sets default session settings applied when the connection opens.

Info

For fields and examples, see Bootstrap settings.