README.md

Connecting Python and YugabyteDB with ADBC

Instructions

Tip

If you already have a YugabyteDB instance running, skip the steps to set up and clean up YugabyteDB.

Prerequisites

1. Install uv

2. Install dbc

Set up YugabyteDB

1. Install Docker

2. Start a YugabyteDB instance:

   docker run -d --rm --name yugabyte \
       -p 9999:9999 -p 9000:9000 -p 15433:15433 -p 5433:5433 -p 9042:9042 \
       yugabytedb/yugabyte:2025.2.0.0-b131 bin/yugabyted start --master_webserver_port=9999 \
       --background=false

Connect to YugabyteDB

1. Install the PostgreSQL ADBC driver:

   dbc install postgresql

2. Customize the Python script main.py as needed

   • Change the connection arguments in db_kwargs
     • Format uri according to the connection URI format used by PostgreSQL, or keep it as is
   • If you changed which database you're connecting to, also change the SQL SELECT statement in cursor.execute()

3. Run the Python script:

   uv run main.py

Clean up

Stop the Docker container running YugabyteDB:

docker stop yugabyte