yugabytedb

Connecting Ruby 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 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 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 --level user postgresql

2. Customize the Ruby script main.rb as needed

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

3. Run the Ruby script:

   bundle exec ruby main.rb

Clean up

Stop the Docker container running YugabyteDB:

docker stop yugabyte