title: 'Arrow Flight SQL API'
sidebar_label: 'Arrow Flight SQL'
sidebar_position: 4
desired_sidebar: api
description: 'Query Spice using JDBC/ODBC/ADBC'
tags:
- api
- arrow-flight-sql
- sql
- jdbc
- odbc
Arrow Flight SQL (opens in a new tab) is a protocol for interacting with SQL databases using the Arrow in-memory format and the Flight RPC framework.
Spice implements the Flight SQL protocol, enabling querying of the datasets configured in Spice via tools that support connecting via one of the Arrow Flight SQL drivers, such as DBeaver (opens in a new tab), Tableau (opens in a new tab), or Power BI (opens in a new tab).
Authentication
API Key authentication is supported for the Arrow Flight SQL endpoint. For more details, see API Key Authentication (opens in a new tab).
Correlation IDs
Send a spice-trace-id gRPC metadata entry with a 32-character hexadecimal ID to set the trace ID for a query. The runtime records it in the trace_id column of runtime.task_history (opens in a new tab), and returns the query's trace ID in spice-trace-id response metadata.
With ADBC, set the header through the adbc.flight.sql.rpc.call_header. option prefix:
import adbc_driver_flightsql.dbapi as flightsql
conn = flightsql.connect("grpc://localhost:50051", db_kwargs={
"adbc.flight.sql.rpc.call_header.spice-trace-id": "7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c",
})
cur = conn.cursor()
cur.execute("SELECT count(*) FROM taxi_trips")
print(cur.fetchall())
import adbc_driver_flightsql.dbapi as flightsql
conn = flightsql.connect("grpc://localhost:50051", db_kwargs={
"adbc.flight.sql.rpc.call_header.spice-trace-id": "7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c",
})
cur = conn.cursor()
cur.execute("SELECT count(*) FROM taxi_trips")
print(cur.fetchall())
With PyArrow Flight, pass it as a call header:
import pyarrow.flight as flight
client = flight.FlightClient("grpc://localhost:50051")
options = flight.FlightCallOptions(headers=[(b"spice-trace-id", b"5a5a5a5a5a5a5a5a5a5a5a5a5a5a5a5a")])
info = client.get_flight_info(flight.FlightDescriptor.for_command(b"SELECT count(*) FROM taxi_trips"), options)
print(client.do_get(info.endpoints[0].ticket, options).read_all())
import pyarrow.flight as flight
client = flight.FlightClient("grpc://localhost:50051")
options = flight.FlightCallOptions(headers=[(b"spice-trace-id", b"5a5a5a5a5a5a5a5a5a5a5a5a5a5a5a5a")])
info = client.get_flight_info(flight.FlightDescriptor.for_command(b"SELECT count(*) FROM taxi_trips"), options)
print(client.do_get(info.endpoints[0].ticket, options).read_all())
