singlestore

Connecting Ruby 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 Ruby

2. Install dbc

3. Ensure the native Arrow GLib and ADBC GLib libraries required by red-adbc are installed and discoverable. If bundle install reports missing arrow, arrow-glib, or adbc-glib, use the platform-specific commands below.

   macOS with Homebrew

   brew install apache-arrow-glib apache-arrow-adbc-glib

   Debian/Ubuntu

   sudo apt install libarrow-glib-dev libadbc-glib-dev

   RHEL-compatible distributions

   sudo dnf install arrow-glib-devel adbc-glib-devel

   Windows with RubyInstaller/MSYS2 UCRT64

   pacman -S --needed mingw-w64-ucrt-x86_64-arrow mingw-w64-ucrt-x86_64-arrow-adbc-glib

   If you use a different MSYS2 environment, adjust the package prefix to match it; for example, use mingw-w64-x86_64-* from the MINGW64 shell.

4. Install Ruby dependencies:

   bundle install

   If you have multiple Ruby installations, ensure ruby and bundle resolve to the same installation before running this command.

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 --level user --pre singlestore

2. Customize the Ruby script main.rb as needed

   • Change the connection arguments in database.set_option()
     • 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 connection.query()

3. Run the Ruby script:

   bundle exec ruby main.rb

Clean up

Stop the Docker container running SingleStore:

docker stop singlestoredb-dev