Reference

dbvr - command line interface for database access and automation.

Quick reference

• Cheat sheet
• List of all commands

Synopsis

dbvr [-hV] [--debug-logs] [--stateless] [-data=<path>] [license=<path>] [COMMAND]

Description

dbvr is the main entry point for all command line operations, including connection management, driver configuration, and SQL execution.

Global options

• -h, -help, --help

  Show the help message and exit

• -V, --version

  Print the dbvr version and exit

• --debug-logs

  Enable debug logging. Logs are printed to the console

• -data=<path>

  Specify the workspace directory

• -license, license=<path>

  Use an external license file for the current command - useful in portable or containerized environments.

  The license file must contain the full license text exactly as received after purchase. Learn more

  Important

  The license is not imported into the workspace and is not stored permanently. It is applied only for the current process.

• --stateless

  Run in stateless mode. Disables functionality that depends on persistent state storage:

  • Query history is not recorded (QMDB database is not used).
  • Driver updates are not downloaded automatically in the background.

  Use this flag in temporary or read-only environments, such as containers or CI pipelines, where dbvr shouldn’t write state to disk.

Commands

SQL

Run queries and scripts.

• sql

Licensing

Manage product licenses.

• import-license
• list-license
• delete-license

Metadata

Browse database object hierarchy and retrieve DDL.

• meta

• meta database

  • meta database list
  • meta database ddl

• meta schema

  • meta schema list
  • meta schema ddl

• meta table

  • meta table list
  • meta table ddl

Projects

Organize datasources inside a workspace.

• project

  • project list
  • project create
  • project rename
  • project delete

Cloud

Manage cloud providers.

• cloud

  • cloud list
  • cloud test

Drivers

Inspect supported database drivers.

• driver

  • driver list

Secret managers

Connect to external secrets services to retrieve credentials at runtime.

• secret-manager

  • secret-manager create
  • secret-manager update
  • secret-manager delete
  • secret-manager list
  • secret-manager view

Datasources

Create and manage connection definitions.

• datasource

  • datasource create
  • datasource update
  • datasource delete
  • datasource list
  • datasource view
  • datasource move

MCP

Expose a database connection to AI tools via the Model Context Protocol (MCP).

• mcp

  • mcp start
  • mcp configuration

Authentication and network

Inspect authentication models and network handlers.

• auth-models
• network-handlers

Exit codes

dbvr returns a process exit code after execution. Use it in scripts and CI pipelines to detect success or failure.

• 0 - command completed successfully
• 1 - execution error, such as invalid arguments, connection failure, or SQL error
• 2 - command usage error, such as missing required parameters or incorrect syntax

Non-zero exit codes indicate that the operation did not complete successfully.