Skip to main content

ArpeOracle — Licensing

ArpeOracle is a proprietary Arpeio driver. The binary validates an Arpeio licence at connection time, and on ArpeOracle the gate is always enforced — there is no report-only mode. This page is about supplying your licence — where to put it and how to check it. To obtain a licence, contact sales@arpe.io or see https://www.arpe.io.

The same licence mechanism and the shared ARPEIO_ADBC_* environment variables are used by every driver in the family (ArpeMSSQL, ArpePGSQL, ArpeOracle, ArpeDb2), so one licence setup carries across them.

Where the driver looks for a licence​

At AdbcDatabaseInit the driver resolves a licence from the following sources, in order — the first present source wins:

  1. arpeio.adbc.license — ADBC database option, the licence blob inline.
  2. arpeio.adbc.license_file — ADBC database option, path to a .lic file.
  3. ARPEIO_ADBC_LICENCE — environment variable, the licence blob inline.
  4. ARPEIO_ADBC_LICENCE_FILE — environment variable, path to a .lic file.
  5. arpeio_adbc.lic — a file placed next to the driver library (libarpeoracle_adbc_driver-linux-x64.so / arpeoracle_adbc_driver-win-x64.dll).

Note the British spelling LICENCE in the environment-variable names.

If none of these yields a valid licence, the connection fails with an ARROW_LIC_* error (see Troubleshooting). The token is an ECDSA P-256 / SHA-256 signature validated against the driver family's production key; a copy of the .so/.dll lifted out of a host bundle is inert on its own.

Supplying it yourself​

As an ADBC option (keeps it out of the environment):

Python
import adbc_driver_manager.dbapi as dbapi

conn = dbapi.connect(driver="arpeoracle", db_kwargs={
    "adbc.arpeoracle.server":       "localhost",
    "adbc.arpeoracle.service_name": "orclpdb1",
    "adbc.arpeoracle.username":     "scott",
    "adbc.arpeoracle.password":     "tiger",
    "arpeio.adbc.license_file":   "/etc/arpeio/arpeio_adbc.lic",
})

As an environment variable (one setting for every Arpeio driver in the process):

export ARPEIO_ADBC_LICENCE_FILE=/etc/arpeio/arpeio_adbc.lic
# or the blob inline:
export ARPEIO_ADBC_LICENCE="$(cat /etc/arpeio/arpeio_adbc.lic)"

A file next to the library — drop arpeio_adbc.lic in the same directory as the loaded .so/.dll (source #5), and no option or environment variable is needed at runtime. The installer's --license flag places the file for you (see Install).

Embedding tools (FastBCP, FastTransfer, …) forward their own licence into one of these sources automatically — you normally do not configure the driver licence separately when using them.

Checking the licence state​

Read the current state with the read-only arpeio.adbc.license.status database option (via GetOption). It never fails and never opens a connection:

<state>;code=<ARROW_LIC_*>;tier=<tier>;expires=<epoch>

The value reports the state (valid, grace, expired, none or invalid), the result code, the licence tier, and the expiry as a Unix epoch.

A licence past its expiry date but still inside its grace period keeps working: the connection opens and the driver prints a warning to standard error with the expiry date and the days left. Once the grace period ends, connections fail.

Troubleshooting​

Connection fails with ARROW_LIC_*. No valid licence was found by any of the five sources above, or the licence has expired / does not cover this driver.

  • Confirm the file exists and is readable at the path you configured.
  • If you rely on the file-next-to-the-library fallback, confirm arpeio_adbc.lic really sits in the same directory as the loaded .so/.dll (the loaded one — a stale copy elsewhere on the path won't count).
  • Check expiry and tier via arpeio.adbc.license.status.
  • Contact sales@arpe.io for a renewal or a licence covering additional drivers.

See also​