diff --git a/docs/guides/installing.md b/docs/guides/installing.md index bf3d3041..08b918a4 100644 --- a/docs/guides/installing.md +++ b/docs/guides/installing.md @@ -203,6 +203,26 @@ Installed mysql 0.1.0 to /opt/homebrew/Caskroom/miniforge/base/envs/my-adbc-proj [`ADBC_DRIVER_PATH`](#adbc_driver_path) and/or an activated Python virtual environment will take precedence over a Conda environment. dbc (and [ADBC driver managers](../concepts/driver_manager.md)) use the following precedence hierarchy: `ADBC_DRIVER_PATH` before virtual environments before Conda environments. +## From Local Archive + +dbc can install drivers from local archives as an alternative for users who can't or don't want to install from a [Driver Registry](../concepts/driver_registry.md). This is meant for advanced use cases and requires understanding the [ADBC Driver Manifests](https://arrow.apache.org/adbc/current/format/driver_manifests.html) spec and loading process. + +To install from a local archive, pass the path to a local archive insted of a name and set the `--no-verify` flag to skip signature verification: + +```console +$ dbc install --no-verify some_driver.tar.gz +Installing from local package: some_driver.tar.gz + +[✓] installing +[✓] verifying signature + +Installed some_driver 1.0.0 to /Users/user/Library/Application Support/ADBC/Drivers +``` + +!!! note + + Make note of the name "some_driver" printed above as this will be the name to use when loading the driver with a [Driver Manager](../concepts/driver_manager.md). i.e., `dbapi.connect(driver="some_driver")`. + ## Uninstalling Drivers You can uninstall a driver with the `dbc uninstall` subcommand. diff --git a/docs/reference/cli.md b/docs/reference/cli.md index 4ac5f054..62e6fd99 100644 --- a/docs/reference/cli.md +++ b/docs/reference/cli.md @@ -94,7 +94,7 @@ $ dbc install [OPTIONS] `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`. +: 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`. Can also be a path to a local driver archive, see [Installing Drivers: From Local Archive](../guides/installing.md#from-local-archive) for more information.

Options