CLI Reference

dbc

Usage

$ dbc [OPTIONS] <COMMAND>

Commands

dbc search: Search for a driver to install
dbc install: Install a driver
dbc uninstall: Uninstall a driver
dbc init: Create a driver list file
dbc add: Add a driver to the driver list
dbc remove: Remove a driver from the driver list
dbc sync: Install the drivers from the driver list

search

Search for a driver to install.

Usage

$ dbc search [FILTER]

Arguments

PATTERN: Optional. A pattern to restrict the list of drivers returned by. Driver names are matched by wildcard so substrings may be used.

Options

--verbose, -v: Enable verbose output
--namesonly, -n: Restrict search to names, ignoring descriptions

install

Install a driver.

To install multiple versions of the same driver on the same system, it's recommend to use ADBC_DRIVER_PATH. See Config Level.

Usage

$ dbc install [OPTIONS] <DRIVER>

Arguments

DRIVER: Name of the driver to install. Can be a short driver name or a driver name with version requirement. Examples: bigquery, bigquery=1.0.0, bigquery>1.

Options

--level: The configuration level to install the driver to (user, or system). See Config Level.
--no-verify: Allow installation of drivers without a signature file

uninstall

Uninstall a driver.

Usage

$ dbc uninstall [OPTIONS] <DRIVER>

Arguments

DRIVER: Name of the driver to uninstall.

Options

--level: The configuration level to uninstall the driver from (user, or system). See Config Level.

init

Create a driver list file.

Usage

$ dbc init [PATH]

Arguments

PATH: Optional. A path to create a driver list under. Defaults to the current working directory.

add

Add a driver to a current driver list.

Usage

$ dbc add <DRIVER>

Arguments

DRIVER: Name of the driver to add. Can be a short driver name or a driver name with version requirement. Examples: bigquery, bigquery=1.0.0, bigquery>1.

Options

--path FILE, -p FILE: Driver list to add to [default: ./dbc.toml]

remove

Remove a driver from the current driver list.

Usage

$ dbc remove <DRIVER>

Arguments

DRIVER: Name of the driver to remove.

Options

--path FILE, -p FILE: Driver list to add to [default: ./dbc.toml]

sync

Install drivers from a driver list. Also creates a dbc.lock file next to the driver list. If dbc.lock exists, driver versions from it will be used when this subcommand is run.

Usage

$ dbc sync
dbc sync --file dbc.toml

Options

--path: Path to a driver list file to sync. Defaults to dbc.toml in the current working directory.
--level: The configuration level to install drivers to (user, or system). See Config Level.
--no-verify: Allow installation of drivers without a signature file