Admin Manage Connections
- Provide predefined connections
- Importing connections from CSV or XML
- Secure connections from editing
- Using environment variables
This guide describes how to manage/secure the DBeaver database connections. It is designed for System administrators. Regular users should check this guide.
DBeaver keeps connections information in the project folder. By default, all projects reside in the workspace.
The default project folder is workspace\workspace6\General.
DBeaver up to 6.1.3
DBeaver keeps information about project connections in the .dbeaver/data-sources.json
. file.
All secured information (user name, password, secret keys, etc) is stored in the encrypted file, .dbeaver/credentials-config.json
.
DBeaver can load multiple connection files. Any files in the project folder matching the .dbeaver/data-sources*.json
pattern will be loaded on the startup. So you can create a file, for example, .dbeaver/data-sources-2.json
in the project folder and DBeaver will see it.
DBeaver < 6.1.3 (Legacy)
DBeaver keeps information about project connections in the .dbeaver-data-sources.xml
. file.
DBeaver can load multiple connection files. Any files in the project folder matching the .dbeaver-data-sources*.xml
pattern will be loaded on the startup. So you can create a file, for example, .dbeaver-data-sources-2.xml
in the project folder and DBeaver will see it.
You can import a connection from CSV or XML files.
The CSV file must have a header row (first line of file) with column names (see list of supported columns below). The XML file should contain a top-level element and a set of nested elements. The connections config must be specified in the attributes of the nested elements. Attribute names are the same as the CSV column names.
Name | Meaning |
---|---|
name | Connection name |
url | JDBC URL |
host | Database server host name |
port | Database server port |
database | Database/schema name |
user | User name |
password | User password |
You can only specify the URL or the host/port/etc setting. | |
User name/password are optional. |
name,host,port,server,database,url,user,password,type
Postgre Import XML 1,localhost,5432,,postgres,jdbc:postgresql://localhost:5432/postgres,postgres,postgres,dev
Postgre Import XML 2,localhost,5432,,postgres2,jdbc:postgresql://localhost:5432/postgres2,postgres2,postgres2,prod
<connections>
<connection name="Postgre Import XML 1" host="localhost" port="5432" server="" database="postgres" url="jdbc:postgresql://localhost:5432/postgres" user="postgres" password="postgres" type="dev"/>
<connection name="Postgre Import XML 2" host="localhost" port="5432" server="" database="postgres" url="jdbc:postgresql://localhost:5432/postgres2" user="postgres2" password="postgres2" type="prod"/>
</connections>
It is possible to set the connection settings as read-only (protected by password)
- Generate MD5 hash of your password. You can do it from the command line using Linux utility md5sum (
md5sum <<<"your password"
) or you can do it online - just google "MD5 hash online". - Add field
lockPassword
in the connection descriptor (in.dbeaver/data-sources.json
inconnections
element. So it will look like this:
"postgres-jdbc-161537836e8-3e0957d039995715": {
"provider": "postgresql",
"driver": "postgres-jdbc",
"name": "PostgreSQL - postgres",
"save-password": true,
"show-system-objects": true,
"read-only": false,
"folder": "PG",
"lockPassword": "2ba81a47c5512d9e23c435c1f29373cb"
...
}
- If the user will try to change connection settings now, he/she will be asked for a password.
You can use references on environment variables in most of connection configuration properties.
For example:
"postgres-jdbc-161537836e8-3e0957d039995715": {
"provider": "postgresql",
"driver": "postgres-jdbc",
"name": "PostgreSQL - postgres",
"user": "${dbeaver.default-user}",
...
}
- Installation
- Application Window Overview
- Views
- Database Object Editor
- SQL Editor
- Search
- Schema compare
- Using Liquibase in DBeaver
- Data compare
- MockData generation
- Spelling
- Dashboards, DB monitoring
- Projects
- Managing Master password
- Security in PRO products
- Certificate Management
- Bookmarks
- Shortcuts
- Accessibility
- Sample Database
-
Database Connections
- Edit Connection
- Invalidate/Reconnect to Database
- Disconnect from Database
- Change current user password
- Advanced settings
- Cloud configuration settings
- Local Client Configuration
- Connection Types
- Configure Connection Initialization Settings
- Tableau integration
- Transactions
- Drivers
- Tasks
- Cloud Explorer
- Cloud Storage
- Classic
- Cloud
- Changing interface language
- DBeaver extensions - Office, Debugger, SVG
- Installing extensions - Themes, version control, etc
- User Interface Themes
- Command Line
- Reset UI settings
- Reset workspace
- Troubleshooting system issues
- Posting issues
- Log files
- JDBC trace
- Thread dump
- Managing connections
- Managing variables
- Managing drivers
- Managing preferences
- Managing restrictions
- Windows Silent Install
- Snap installation