Skip to main content

ADBC: Arrow Database Connectivity

ADBC is a set of APIs and libraries for Arrow-native access to databases.

Spice supports ADBC clients using the FlightSQL driver.

Quickstart​

Get started with ADBC using Python.

Installation​

Start a Python environment.

python

Install the ADBC driver manager, FlightSQL driver, and PyArrow.

pip install adbc_driver_manager adbc_driver_flightsql pyarrow

Create a connection to Spice over ADBC​

>>> import adbc_driver_flightsql.dbapi
>>> conn = adbc_driver_flightsql.dbapi.connect('grpc://localhost:50051')

Create a cursor​

>>> cursor = conn.cursor()

Executing a query​

DBAPI interface:

>>> cursor.execute("SELECT 1, 2.0, 'Hello, world!'")
>>> cursor.fetchone()
(1, 2.0, 'Hello, world!')
>>> cursor.execute("SHOW TABLES")
>>> cursor.fetchall()
[('spice', 'public', 'messages', 'BASE TABLE'), ('spice', 'runtime', 'task_history', 'BASE TABLE'), ('spice', 'information_schema', 'tables', 'VIEW'), ('spice', 'information_schema', 'views', 'VIEW'), ('spice', 'information_schema', 'columns', 'VIEW'), ('spice', 'information_schema', 'df_settings', 'VIEW'), ('spice', 'information_schema', 'schemata', 'VIEW')]

Arrow:

>>> cursor.execute("SELECT 1, 2.0, 'Hello, world!'")
>>> cursor.fetch_arrow_table()
pyarrow.Table
1: int64
2.0: double
'Hello, world!': string
----
1: [[1]]
2.0: [[2]]
'Hello, world!': [["Hello, world!"]]

Parameterized Queries​

Spice supports parameterized queries when using ADBC clients. Parameterized queries help prevent SQL injection and improve code clarity by separating query logic from data values. The following example demonstrates how to use parameterized queries with the Python ADBC FlightSQL driver:

from adbc_driver_flightsql import DatabaseOptions
from adbc_driver_flightsql.dbapi import connect

with connect(
    "grpc://127.0.0.1:50051",
) as conn:
    with conn.cursor() as cur:
        cur.execute("SELECT $1 + 1 AS the_answer", parameters=(41,))
        table = cur.fetch_arrow_table()
        print(table)

        cur.execute("SELECT 1 AS one")
        table = cur.fetch_arrow_table()
        print(table)

    conn.close()