README.md

Connecting JavaScript and Neon with ADBC

Instructions

Tip

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

Prerequisites

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

   • Alternatively, you can use Bun or Deno

2. Install dbc

Set up Neon

1. Install Docker

2. Install git

3. Clone the Neon repository:

   git clone https://github.com/neondatabase/neon.git

4. Start a Neon instance:

   docker compose --project-directory neon/docker-compose -p neon up -d

Connect to Neon

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. For cloud-hosted Neon, the connection string can be found at Project dashboard > Connect > Connection string
   • 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

1. Stop the Docker project running Neon:

   docker compose -p neon down

2. Remove the Neon repository:

   rm -rf neon