Skip to content

Commit 163b181

Browse files
authored
docs: document installing from local archives (#307)
Closes #304
1 parent 14e3c0b commit 163b181

2 files changed

Lines changed: 21 additions & 1 deletion

File tree

docs/guides/installing.md

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

250250
[`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.
251251

252+
## From Local Archive
253+
254+
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.
255+
256+
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:
257+
258+
```console
259+
$ dbc install --no-verify some_driver.tar.gz
260+
Installing from local package: some_driver.tar.gz
261+
262+
[✓] installing
263+
[✓] verifying signature
264+
265+
Installed some_driver 1.0.0 to /Users/user/Library/Application Support/ADBC/Drivers
266+
```
267+
268+
!!! note
269+
270+
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")`.
271+
252272
## Uninstalling Drivers
253273

254274
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
@@ -99,7 +99,7 @@ $ dbc install [OPTIONS] <DRIVER>
9999

100100
`DRIVER`
101101

102-
: 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`.
102+
: 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.
103103

104104
<h3>Options</h3>
105105

0 commit comments

Comments
 (0)