Connection Options

Table of contents

• Ways to connect
  • --datasource
  • --datasource-specification
  • --driver
    • --host
    • --port
    • --database
    • --server
    • --url
    • --auth-model
    • --save-password
    • --folder
    • --name
• Authentication options
  • --user
  • --password
  • --auth-property
• Network options
  • --network-handler-param
  • --network-handler-save-password
  • --network-handler-delete
• Driver-specific parameters
  • --property
  • --extended-property

Use connection options to tell dbvr which datasource a command should use.

Ways to connect

Connect to a database in one of these ways:

• use an existing datasource with -ds or --datasource
• provide a full connection specification with -con, -ds-spec, -connect, or -datasource-specification
• define a connection inline with --driver and connection parameters

Include credentials, network handlers, and driver-specific parameters if required.

--datasource

--datasource, -ds=<existDataSourceIdOrName>

Use an existing datasource by ID or name.

Use datasource list to see available datasources.

Example:

dbvr sql \
  -ds=pg-local \
  "select current_database();"

--datasource-specification

-con, -connect, -ds-spec, --datasource-specification=<connectionSpec>

Provide a full datasource specification string. The specification is a list of key=value pairs separated by |.

Example:

dbvr sql \
  -con="driver=sqlite_ee|url=jdbc:sqlite:/path/to/Chinook.db" \
  "select count(*) from Album;"

--driver

--driver=<driver>

Define a connection inline instead of using an existing datasource. Use driver list to see available driver IDs.

Combine with the connection parameters below and authentication options to fully specify the connection.

Example:

dbvr sql \
  --driver=postgres-jdbc \
  --host=localhost \
  --port=5432 \
  --database=testdb \
  -u=admin \
  -p=password \
  "select * from public.orders limit 10;"

--host

--host=<host>

Set the database host name or IP address.

Ignored if --url is specified.

--port

--port=<port>

Set the database port number. Must be a valid integer.

Ignored if --url is specified.

--database

--database=<dbName>

Set the database name. For some drivers, this may represent a schema, service name, or logical database.

Ignored if --url is specified.

--server

--server=<server>

Set the logical server name required by certain drivers.

Ignored if --url is specified.

--url

--url=<url>

Provide the full JDBC connection URL.

Note: When specified, it overrides --host, --port, --database, and --server.

--auth-model

--auth-model=<authModel>

Specify the authentication model supported by the selected driver.

Authentication models define how credentials are provided - for example, username/password, Kerberos, IAM, OAuth, or key-based authentication.

Tip: Run auth-models to see all available authentication models and their parameters. Not every model is supported by every driver. Use only the models applicable to your selected driver.

--save-password

--save-password=<savePassword>

Control whether the database password is stored in the workspace configuration. Accepts a boolean value.

--folder

--folder=<folder>

Place the datasource into a folder within the project.

--name

--name=<dataSourceName>

Set the name of the datasource as it appears in the workspace.

Authentication options

--user

-u, --user=<dbUser>

Set the database username used for authentication.

--password

-p, --password=<dbPassword>

Set the database password.

--auth-property

-auth, --auth-property=<authParams>

Add a driver-specific authentication parameter in key=value format. May be specified multiple times.

Example:

dbvr sql \
  --driver=postgres-jdbc \
  --host=localhost \
  --database=testdb \
  --auth-model=ssl \
  -auth=ssl=true \
  -auth=sslmode=require \
  "select 1;"

Example:

dbvr datasource create \
  --driver=postgres-jdbc \
  --name="PostgreSQL SSL" \
  --host=localhost \
  --database=testdb \
  --auth-model=ssl \
  -auth=ssl=true \
  -auth=sslmode=require

Network options

--network-handler-param

-net, --network-handler-param=<handlerParams>

Configure a network handler parameter in key=value format. Used for SSH tunnels, proxies, or other network configurations. May be specified multiple times.

Parameter names must match the properties defined by the selected network handler. Use network-handlers to see available handler IDs and supported parameters.

Example:

dbvr sql \
  --driver=postgres-jdbc \
  --host=localhost \
  --port=5432 \
  --database=testdb \
  -u=admin \
  -p=password \
  -net=ssh.host=example.com \
  -net=ssh.port=22 \
  -net=ssh.user=app \
  -net=ssh.authType=PASSWORD \
  -net=ssh.password=secret \
  "select * from public.orders limit 10;"

Example:

dbvr datasource create \
  --driver=postgres-jdbc \
  --name="PostgreSQL via SSH" \
  --host=remote-db \
  --database=testdb \
  --user=app \
  --password=secret \
  -net=ssh.host=example.com \
  -net=ssh.port=22 \
  -net=ssh.user=sshuser \
  -net=ssh.authType=password \
  -net=ssh.password=sshpass

Each -net defines one property of the network handler configuration.

Tip: Network handler configuration in dbvr follows the same model as in DBeaver. For SSH tunnel setup details, see SSH configuration.

--network-handler-save-password

-net-save-pwd, --network-handler-save-password=<savePassword>

Control whether passwords defined in network handlers - such as SSH tunnels or proxy configurations - are stored in the workspace configuration. Accepts a boolean value. Default: true.

--network-handler-delete

-net-delete, --network-handler-delete=<handlersToDelete>

Remove one or more configured network handlers from the datasource.

Example:

dbvr datasource update <datasourceIdOrName> \
  --network-handler-delete=ssh

This removes the configured SSH network handler from the datasource.

Driver-specific parameters

--property

-prop, --property=<connectionParams>

Add a driver connection property in key=value format. Passed directly to the JDBC driver for this connection. May be specified multiple times.

Use it to override or set driver-specific settings for the current datasource instead of relying on global driver defaults.

Example:

dbvr sql \
  --driver=postgres-jdbc \
  --host=localhost \
  --database=testdb \
  -u=admin \
  -p=password \
  --property=ssl=true \
  --property=applicationName=dbvr-cli \
  "select current_user;"

Example:

dbvr datasource create \
  --driver=postgres-jdbc \
  --name="PostgreSQL local" \
  --host=localhost \
  --database=testdb \
  -u=admin \
  -p=password \
  --property=ssl=true \
  --property=applicationName=dbvr-cli

--extended-property

-ext, --extended-property=<providerParams>

Add a driver-specific parameter in key=value format. May be specified multiple times.

Used for additional driver properties that are not part of the authentication model. These parameters may affect authentication or other driver-specific behavior.

Example:

dbvr sql \
  --driver=snowflake-jdbc \
  --host=account.snowflakecomputing.com \
  --database=TESTDB \
  -u=app \
  -p=secret \
  --extended-property=warehouse=COMPUTE_WH \
  "select current_warehouse();"

Example:

dbvr datasource create \
  --driver=snowflake-jdbc \
  --name="Snowflake prod" \
  --host=account.snowflakecomputing.com \
  --database=TESTDB \
  -u=app \
  -p=secret \
  --extended-property=warehouse=COMPUTE_WH