DBeaver Documentation

DOWNLOAD pdf

Command Line

Command line parameters can be passed directly to the DBeaver executable. The way to do this depends on your operating system:

Windows

You can use the dbeaver-cli.exe [parameters] executable. This executable does not spawn a new window, so you can see the output messages.

Mac

Parameters can be passed to DBeaver in one of two ways:

  • Use the open command followed by the -a flag and the name of the application, along with any necessary arguments. Depending on the version of DBeaver, you might need to specify DBeaver.app, DBeaverLite.app, DBeaverEE.app, DBeaverUltimate.app, or DBeaverTeam.app. For example: open -a "DBeaver.app" --args [parameters].
    Note: This method does not redirect logging messages, stdout, and stderr to the terminal.
  • Pass parameters directly to the DBeaver executable in the terminal using the path where the .app file is located. For example: /Applications/DBeaver.app/Content/MacOS/dbeaver [parameters]. This method redirects logging messages, stdout, and stderr to the terminal.



For both Windows and Mac, parameters can also be added in the dbeaver.ini configuration file. These should be written at the beginning of the file, with each parameter on its own line.

Tip: Detailed instructions on finding dbeaver.ini are available in our article.

Command line parameters

DBeaver control

NameValueExample
-helpPrints help message
-stopQuits DBeaver
-dumpPrints DBeaver thread dump
-fOpens the file in DBeaver UI, if the command has -con argument, connects it to datasource-f c:\some-path\some-file.sql
-conOpens database connection in DBeaver UISee connection parameters table
-closeTabsCloses all open editor tabs
-disconnectAllCloses all open connections
-reuseWorkspaceForces reuse of single workspace by multiple DBeaver instances
-newInstanceForces new DBeaver instance creation (do not try to reuse already running one)
-bringToFrontBrings the DBeaver window on top of other applications
-var Customs variables for runTask. You can change existing variables in the task. You cannot add new task variables with this parameter. You can add several parameters at once to the command line, each starting with "-var". Used right before -runTask. Template: -var variableName=variableValue-var film=sakila.film
-var actor=sakila.actor
-runTask "exportFromSakila"
PRO versions only.
-varsPath to a property file with variables-vars c:\path\to\file.properties
For more information see the main article
-runTask Executes specified task-runTask "@projectName:taskName".
PRO versions only. See Task Scheduler.
-license Path to the license file-license "/etc/licenses/dbeaver.txt".
PRO versions only.

System parameters

NameValueExample
-nlLocaleen_US
-dataWorkspace pathc:\ProgramData\MyWorkspace
-nosplashOmits splash screentrue
-cleanClears all Eclipse caches. Use it if DBeaver fails to start after it upgrades.
-vmargsVM parametersSee VM arguments table

VM arguments

You can pass any advanced Java parameters supported by your local JVM. Parameters supported by HotSpot JVM (17): https://docs.oracle.com/en/java/javase/17/docs/specs/man/java.html

Parameters supported by all JVMs:

NameValueExample
-XmsSets initial memory available for DBeaver-Xmx1000m
-XmxSets maximum memory available for DBeaver-Xmx4000m

Connection parameters

All connection parameters must be supplied as a single command line argument. The parameters are divided by pipe (|). The parameter name and value is divided by =.
Example: -con "driver=sqlite|database=C:\db\SQLite\Chinook.db|name=SQLiteChin|openConsole=true|folder=SQLite"

NameDescriptionExample
nameConnection nameTest connection
driverDriver name or IDdriver=sqlite, driver=mysql, etc
urlConnection URL. Optional (JDBC URL may be constructed by a driver from other parameters)url=jdbc:sqlite:C:\db\SQLite\Chinook.db
hostDatabase host name (optional)host=localhost
portDatabase port number (optional)port=1534
serverDatabase server name (optional)server=myserver
databaseDatabase name or path (optional)database=db-name
userUser name (optional)user=root
passwordUser password (optional)password=mysecret
authAuthentication model ID. See Auth models auth=postgres_pgpass
authProp.propNameCustom authentication parameters (depends on the driver and auth model)authProp.oracle.net.wallet_location=C:/temp/ora-wallet
savePasswordDoes not ask user for a password on connectionsavePassword=true
showSystemObjectsShows/Hides system schemas, tables ,etcshowSystemObjects=true
showUtilityObjectsShows/Hides utility schemas, tables ,etcshowUtilityObjects=true
folderPuts a new connection in a folderfolder=FolderName
autoCommitSets connection auto commit flag (default value depends on driver)autoCommit=true
prop.propNameAdvanced connection parameters (depend on driver)prop.connectTimeout=30
idConnection idoracle_thin-16a88e815bd-70598e648cedd28c (useful in conjunction with create=false)
connectConnects to this databaseconnect=false
openConsoleOpens the SQL console for this database (sets connect to true)openConsole=true
createCreates new connectioncreate=false (true by default). If it is set as false, then an existing connection configuration will be used. The name or id parameter must be specified.
saveSaves new connectionWhen create=true, then save=false (default) makes new connection temporary, save=true means that new connection will be saved and accessible between DBeaver launches.

Declare external variables in a file

See the main article

Did we resolve your issue?