Skip to main content

Installation

One-line installers download a driver, verify it, and register it so any ADBC client can load it by name. The installers run on Linux (x64) and Windows (x64).

Install​

curl -fsSL https://raw.githubusercontent.com/arpe-io/adbc-drivers/main/install.sh \
| sh -s -- arpemssql --license /path/to/your.lic

Swap arpemssql for the load name of the driver you need (arpepgsql, arpeoracle, arpenz).

List what's available and the latest published version of each:

curl -fsSL https://raw.githubusercontent.com/arpe-io/adbc-drivers/main/install.sh | sh -s -- --list

List every published version (all drivers, or a single one), newest first:

curl -fsSL https://raw.githubusercontent.com/arpe-io/adbc-drivers/main/install.sh | sh -s -- --versions arpemssql
note

The --list output is the authoritative, always-current source of truth for which drivers and versions are downloadable today.

What the installer does​

  1. Downloads the driver's shared library for your OS/arch from the adbc-drivers Releases (tag <driver>-v<version>, e.g. arpemssql-v0.5.24) and verifies it against the release SHA256SUMS.

  2. Installs the library — by default per-user, under ~/.local/lib/arpeio-adbc/ on Unix / %LOCALAPPDATA%\arpeio-adbc\ on Windows (--system / -Scope system for a machine-wide install).

  3. Writes an ADBC driver manifest (<driver>.toml) into the ADBC driver manager's search path, so the driver loads by name:

    Python
    import adbc_driver_manager.dbapi as dbapi
    with dbapi.connect(driver="arpemssql",
    db_kwargs={"uri": "sqlserver://sa:<pw>@host:1433/?database=db&encrypt=true"}) as conn:
    ...
  4. If you pass --license <path>, copies your licence next to the library as arpeio_adbc.lic (where the driver looks for it by default).

Download only​

To manage the deployment yourself — a custom path, a container image, an air-gapped copy, your own licence handling — use --download-only / -DownloadOnly. It downloads and checksum-verifies the driver binary and writes a ready-to-use <driver>.toml manifest next to it, into the directory you choose with --dir / -Dir (default: the current directory). Nothing else is touched: no system directory, no licence file, no environment variable.

curl -fsSL https://raw.githubusercontent.com/arpe-io/adbc-drivers/main/install.sh \
| sh -s -- arpemssql --download-only --dir ./drivers

To load the driver by name afterwards, point the ADBC driver manager at that directory (export ADBC_DRIVER_PATH=./drivers, or setx ADBC_DRIVER_PATH on Windows) and supply a licence yourself (see Supplying the licence).

Listing and removing​

See what's installed on this machine (scans both the user and system locations, showing each driver's version, scope, library path, and whether a licence is in place):

curl -fsSL https://raw.githubusercontent.com/arpe-io/adbc-drivers/main/install.sh \
| sh -s -- --installed

Remove a driver — its library, the copied licence, and its manifest:

curl -fsSL https://raw.githubusercontent.com/arpe-io/adbc-drivers/main/install.sh \
| sh -s -- --uninstall arpemssql

Uninstall acts on your per-user install by default; add --system (with sudo) to remove a machine-wide one. On Windows, use -Installed and -Uninstall arpemssql (an elevated shell for -Scope system).

Options​

install.shinstall.ps1Meaning
--version X.Y.Z-Version X.Y.ZInstall a specific version (default: latest).
--user (default)-Scope userPer-user install (no admin).
--system-Scope systemMachine-wide install (needs sudo/admin).
--license <path>-License <path>Install your .lic file next to the driver.
--license-content <text>-LicenseContent <text>Install the licence from inline text.
--prefix <dir>-Prefix <dir>Override the library install directory.
--download-only-DownloadOnlyJust download the binary + manifest into a dir; no managed install.
--dir <dir>-Dir <dir>Destination directory for --download-only (default: current dir).
--list-ListList available drivers + latest published versions.
--versions [<driver>]-Versions [<driver>]List every published version (all drivers, or one).
--installed-InstalledList the drivers installed on this machine.
--uninstall <driver>-Uninstall <driver>Remove an installed driver.

Supplying the licence​

The installer does not bundle a licence — you provide your own. It writes it next to the driver as arpeio_adbc.lic.

At install time​

Give the installer the licence in any of these ways; it uses the first one it finds, in this order:

Orderinstall.shinstall.ps1Source
1--license <path>-License <path>Copy an existing .lic file.
2--license-content <text>-LicenseContent <text>The licence text itself, written verbatim.
3ARPEIO_ADBC_LICENCE_FILEARPEIO_ADBC_LICENCE_FILEEnv var holding a path to a .lic file.
4ARPEIO_ADBC_LICENCEARPEIO_ADBC_LICENCEEnv var holding the licence content.

Passing both --license and --license-content is an error. The env-var forms are the safest for CI/secrets; a licence passed inline on the command line is visible in the shell history and process list.

# from a file
... install.sh arpemssql --license /path/to/your.lic
# from a secret in CI (bash)
ARPEIO_ADBC_LICENCE="$MY_LICENCE_SECRET" ... install.sh arpemssql

At runtime​

Alternatively, don't install a licence file and let the driver find one at connect time. It checks, in order:

  1. the arpeio.adbc.license / arpeio.adbc.license_file ADBC database option;
  2. the ARPEIO_ADBC_LICENCE / ARPEIO_ADBC_LICENCE_FILE environment variable;
  3. a file named arpeio_adbc.lic next to the installed driver library.

Each driver's Licensing page has the full resolution order — see for example ArpeMSSQL → Licensing.

Manifest search paths (advanced)​

The installer writes <driver>.toml where the ADBC driver manager searches: ~/.config/adbc/drivers (Linux) · %LOCALAPPDATA%\ADBC\Drivers (Windows), or the system equivalents with --system. If your client can't find it, point ADBC_DRIVER_PATH at the directory the installer reports.

Troubleshooting​

Checksum verification failed. The download did not match the release SHA256SUMS — usually a truncated download or a proxy rewriting the response. Re-run the installer; if it persists, download the release asset manually from the Releases page and compare with sha256sum.

Client can't find the driver / "driver not found". The ADBC driver manager did not see the manifest. Confirm the install with … install.sh --installed, then point ADBC_DRIVER_PATH at the directory the installer reports (see Manifest search paths). Make sure the client loads by the exact load name (arpemssql, arpepgsql, arpeoracle).

Connection fails with an ARROW_LIC_* error. The driver loaded but found no valid licence at runtime. Install one next to the driver (--license), or set ARPEIO_ADBC_LICENCE_FILE / ARPEIO_ADBC_LICENCE — see Supplying the licence. Each driver's Licensing page has the full resolution order.

Permission denied during --system install. System-wide installs write to /opt/arpeio-adbc and the system ADBC directory — run with sudo (Unix) or an elevated shell (-Scope system on Windows). Or drop --system for a per-user install that needs no admin.

macOS is not supported yet. Only Linux x64 and Windows x64 binaries are published; use one of those for now.