Skip to content

Installation

Install in one line

One script per platform. It downloads the driver, installs it per-user by default and registers the ADBC manifest so any client can load it by name.

1. Run the installer

Replace arrowtds with arrowfebe or arrowttc as needed. Use --system (with sudo or an elevated shell) for a machine-wide installation.

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

2. Load the driver by name

Because the installer registers an ADBC manifest, clients find the driver from its name alone — no path, no LD_LIBRARY_PATH.

query.py
import adbc_driver_manager.dbapi as dbapi

with dbapi.connect(driver="arrowtds",
                   db_kwargs={"uri": "sqlserver://dbuser:<password>@host:1433/?database=appdb&encrypt=true"}) as conn:
    cur = conn.cursor()
    cur.execute("SELECT * FROM dbo.orders")
    table = cur.fetch_arrow_table()   # ready as Arrow

Where things land

By default the installer places files per-user. The ADBC driver manager looks for manifests in the standard per-platform location.

PlatformDriver filesADBC manifest search path
Linux~/.local/lib/arpeio-adbc/~/.config/adbc/drivers
macOS~/.local/lib/arpeio-adbc/~/Library/Application Support/ADBC/Drivers
Windows%LOCALAPPDATA%\arpeio-adbc\%LOCALAPPDATA%\ADBC\Drivers

Point the driver at your licence

The installer accepts the licence three ways:

  • A file path: --license /path/to/your.lic
  • Inline text: --license-content "<licence text>"
  • Environment variables: ARPEIO_ADBC_LICENCE_FILE or ARPEIO_ADBC_LICENCE

At runtime, drivers resolve the licence in this order:

  1. 1ADBC database options — arpeio.adbc.license or arpeio.adbc.license_file
  2. 2Environment variables
  3. 3An arpeio_adbc.lic file next to the driver

Useful commands

List the available drivers

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

Show what is already installed

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

Uninstall a driver

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

Supported platforms

The installers run on Linux (x64) and Windows (x64). macOS binaries are staged but not yet published.