README.md

Connecting Python and SingleStore with ADBC

Instructions

Tip

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

Prerequisites

1. Install uv

2. Install dbc

Set up SingleStore

1. Install Docker

2. Start a SingleStore instance:

   docker run \
       -d --rm --name singlestoredb-dev \
       -e ROOT_PASSWORD="YOUR_ROOT_PASSWORD" \
       -p 3306:3306 -p 8080:8080 -p 9000:9000 \
       ghcr.io/singlestore-labs/singlestoredb-dev:latest

Important

To run the container on Apple Silicon, add the --platform linux/amd64 option.

Connect to SingleStore

1. Install the SingleStore ADBC driver:

   dbc install --pre singlestore

2. Customize the Python script main.py as needed

   • Change the connection arguments in db_kwargs
     • Format uri according to the DSN (Data Source Name) format used by Go-MySQL-Driver
   • 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 SingleStore:

docker stop singlestoredb-dev