Jupyter / JupyterLab

All integration guides. Run Flight SQL reads and writes in a notebook kernel. The tested route executes notebooks programmatically; JupyterLab browser rendering remains untested.

Install

Start with the server and sample table. Run from the repository root, using Python 3.12 in a separate environment:

python3.12 -m venv .venv-jupyter
. .venv-jupyter/bin/activate
python -m pip install -r requirements/integrations/workflows.txt
python -m pip install jupyterlab
python -m ipykernel install --user --name flight-guide
jupyter lab

The profile pins the versions used in the November 3 run. It may install other tools in the same profile. Use a client-reachable FLIGHT_URI if the endpoint is elsewhere; the default below is a local unauthenticated development server.

Read, write and verify

Create a notebook, select the flight-guide kernel and run this entire cell. The code reads flight_tool_sample, writes the tool's output to a unique SQL table, verifies it with a fresh ordered SELECT and drops only that output table. Keep the shared input table until you finish the guides.

import os
import uuid
import pyarrow as pa
import adbc_driver_flightsql.dbapi as sql

uri = os.environ.get("FLIGHT_URI", "grpc://localhost:8815")
with sql.connect(uri, autocommit=True) as conn, conn.cursor() as cur:
    cur.execute("SELECT id, label, amount FROM flight_tool_sample ORDER BY id")
    source = cur.fetch_arrow_table()

# Run this cell in the Python kernel installed in the active environment.
frame = source.to_pandas()
display(frame)
frame["amount"] = frame["amount"] * 2
output = pa.Table.from_pandas(frame, schema=source.schema, preserve_index=False)

# Write the tool's output through Flight SQL, then verify the stored values.
name = "guide_" + uuid.uuid4().hex
with sql.connect(uri, autocommit=True) as conn, conn.cursor() as cur:
    try:
        cur.adbc_ingest(name, output, mode="create")
        cur.execute(f'SELECT * FROM "{name}" ORDER BY id')
        received = cur.fetch_arrow_table()
        assert received.equals(output)
        print(received)
    finally:
        cur.execute(f'DROP TABLE IF EXISTS "{name}"')
        cur.fetch_arrow_table()

Pandas may choose Arrow large_string for text. Supplying the SQL source schema keeps the write/read-back comparison on the same logical types.

Validation and limits

The live guide recipe run passed this example's remote read, output write, fresh ordered read-back and cleanup. The report records runtime versions and the precise scope. Writes use Arrow ingestion through Flight SQL; native writer API support is not implied.

SQL uses autocommit. Client results are materialized in memory; these examples do not establish distributed execution, Enterprise qualification or TLS/auth. Remove the shared input with the fixture cleanup.