neon

Connecting Python and Neon with ADBC

Instructions

Tip

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

Prerequisites

1. Install uv

2. Install dbc

Set up Neon

1. Install Docker

2. Install git

3. Clone the Neon repository:

   git clone https://github.com/neondatabase/neon.git

4. Start a Neon instance:

   docker compose --project-directory neon/docker-compose -p neon up -d

Connect to Neon

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. For cloud-hosted Neon, the connection string can be found at Project dashboard > Connect > Connection string
   • 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

1. Stop the Docker project running Neon:

   docker compose -p neon down

2. Remove the Neon repository:

   rm -rf neon