README.md

Connecting JavaScript and Vitess with ADBC

Instructions

Tip

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

Prerequisites

1. Install Node.js (version 22 or later)

   • Alternatively, you can use Bun or Deno

2. Install dbc

Set up Vitess

1. Install Docker

2. Start a Vitess instance:

   docker run -d --rm --name=vttestserver \
       -p 33574:33574 \
       -p 33575:33575 \
       -p 33577:33577 \
       -e PORT=33574 \
       -e KEYSPACES=test,unsharded \
       -e NUM_SHARDS=2,1 \
       -e MYSQL_MAX_CONNECTIONS=70000 \
       -e MYSQL_BIND_HOST=0.0.0.0 \
       -e VTCOMBO_BIND_HOST=0.0.0.0 \
       vitess/vttestserver:mysql80

   Wait a few moments before continuing to the next step to allow the Vitess container to fully initialize.

Connect to Vitess

1. Install the MySQL ADBC driver:

   dbc install mysql

2. Install dependencies:

   npm --prefix ../.. install

3. Customize the script main.js as needed

   • Change the connection arguments in databaseOptions
     • Format uri according to the DSN (Data Source Name) format used by Go-MySQL-Driver, or keep it as is
   • If you changed which database you're connecting to, also change the SQL SELECT statement in conn.query()

4. Run the script:

   Node.js:

   node main.js

   Bun:

   bun run main.js

   Deno:

   deno run --allow-ffi --allow-env main.js

Clean up

Stop the Docker container running Vitess:

docker stop vttestserver