README.md

Connecting JavaScript and Citus with ADBC

Instructions

Tip

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

Prerequisites

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

   • Alternatively, you can use Bun or Deno

2. Install dbc

Set up Citus

1. Install Docker

2. Start a Citus instance:

   docker run -d --rm --name citus_standalone -p 5432:5432 -e POSTGRES_PASSWORD=password citusdata/citus

Connect to Citus

1. Install the PostgreSQL ADBC driver:

   dbc install postgresql

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 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 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 Citus:

docker stop citus_standalone