Skip to content

Commit b0e7663

Browse files
committed
add docs for install from local archive
1 parent c059db3 commit b0e7663

File tree

2 files changed

+21
-1
lines changed

2 files changed

+21
-1
lines changed

docs/guides/installing.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -203,6 +203,26 @@ Installed mysql 0.1.0 to /opt/homebrew/Caskroom/miniforge/base/envs/my-adbc-proj
203203

204204
[`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.
205205

206+
## From Local Archive
207+
208+
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.
209+
210+
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:
211+
212+
```console
213+
$ dbc install --no-verify some_driver.tar.gz
214+
Installing from local package: some_driver.tar.gz
215+
216+
[✓] installing
217+
[✓] verifying signature
218+
219+
Installed some_driver 1.0.0 to /Users/user/Library/Application Support/ADBC/Drivers
220+
```
221+
222+
!!! note
223+
224+
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")`.
225+
206226
## Uninstalling Drivers
207227

208228
You can uninstall a driver with the `dbc uninstall` subcommand.

docs/reference/cli.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ $ dbc install [OPTIONS] <DRIVER>
9494

9595
`DRIVER`
9696

97-
: 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`.
97+
: 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.
9898

9999
<h3>Options</h3>
100100

0 commit comments

Comments
 (0)