Skip to content

README.md

Latest commit

 

History

History
82 lines (56 loc) · 3.08 KB

README.md

File metadata and controls

82 lines (56 loc) · 3.08 KB

Connecting Python and GizmoSQL with ADBC

Instructions

This example uses GizmoSQL, a lightweight, high-performance SQL server powered by DuckDB or SQLite that supports Arrow Flight SQL.

Tip

If you already have a GizmoSQL instance running, skip the steps to set up GizmoSQL.

Prerequisites

  1. Install uv

  2. Install dbc

Set up GizmoSQL server (if you don't already have one)

  1. Install Docker Engine

  2. Start the GizmoSQL server:

    docker run -d --rm -it --init -p 31337:31337 --name gizmosql -e DATABASE_FILENAME=adbc_quickstart.db -e TLS_ENABLED=0 -e GIZMOSQL_PASSWORD=gizmosql_password -e PRINT_QUERIES=1 -e INIT_SQL_COMMANDS='CALL dbgen(sf=0.01);' --pull always gizmodata/gizmosql:latest-slim

Connect to GizmoSQL

  1. Install the Flight SQL ADBC driver:

    dbc install flightsql

  2. Customize the Python script main.py as needed

    • Change the connection arguments in db_kwargs
      • uri is the URI of your GizmoSQL instance. The host and port will depend on your installation (the default port is 31337). The protocol scheme should be grpc or grpc+tcp if your GizmoSQL instance is not using TLS and should be grpc+tls otherwise.
      • username and password are the username and password of your GizmoSQL admin user (the one specified when starting the instance).
      • You can optionally use JWT token authentication with GizmoSQL server (see more here) - with username: token and a password value of the JWT token contents.

  3. Run the Python script:

    uv run main.py

    The output will look something like this:

    pyarrow.Table
r_regionkey: int32
r_name: string
r_comment: string
----
r_regionkey: [[0,1,2,3,4]]
r_name: [["AFRICA","AMERICA","ASIA","EUROPE","MIDDLE EAST"]]
r_comment: [["ar packages. regular excuses among the ironic requests cajole fluffily blithely final requests. fu (... 17 chars omitted)","s are. furiously even pinto bea","c, special dependencies around ","e dolphins are furiously about the carefully "," foxes boost furiously along the carefully dogged tithes. slyly regular orbits according to the sp (... 10 chars omitted)"]]

Clean up

  1. Stop and remove the Docker container running GizmoSQL:

    docker stop gizmosql