In Neon, you can provision Postgres databases in < 1s. Don't believe us? Check out this demo
Getting Started/Language quickstarts/Javascript

Connect a Node.js application to Neon

Set up a Neon project in seconds and connect from a Node.js application

This guide describes how to create a Neon project and connect to it from a Node.js application. Examples are provided for using the node-postgres and Postgres.js clients. Use the client you prefer.

note

The same configuration steps can be used for Express and Next.js applications.

To connect to Neon from a Node.js application:

  1. Create a Neon Project
  2. Create a NodeJS project and add dependencies
  3. Store your Neon credentials
  4. Configure the Postgres client
  5. Run app.js

Create a Neon project

If you do not have one already, create a Neon project.

  1. Navigate to the Projects page in the Neon Console.
  2. Click New Project.
  3. Specify your project settings and click Create Project.

Create a NodeJS project and add dependencies

  1. Create a NodeJS project and change to the newly created directory.

    mkdir neon-nodejs-example
    cd neon-nodejs-example
    npm init -y
  2. Add project dependencies using one of the following commands:

    Neon serverless driver
    node-postgres
    postgres.js
    npm install @neondatabase/serverless dotenv

Store your Neon credentials

Add a .env file to your project directory and add your Neon connection details to it. You can find the connection details for your database in the Connection Details widget on the Neon Dashboard. Please select Node.js from the Connection string dropdown. For more information, see Connect from any application.

PGHOST='[neon_hostname]'
PGDATABASE='[dbname]'
PGUSER='[user]'
PGPASSWORD='[password]'
ENDPOINT_ID='[endpoint_id]'

note

A special ENDPOINT_ID variable is included in the .env file above. This variable can be used with older Postgres clients that do not support Server Name Indication (SNI), which Neon relies on to route incoming connections. If you are using a newer node-postgres or postgres.js client, you won't need it. For more information, see Endpoint ID variable.

important

To ensure the security of your data, never expose your Neon credentials to the browser.

Configure the Postgres client

Add an app.js file to your project directory and add the following code snippet to connect to your Neon database:

Neon serverless driver
node-postgres
postgres.js
require('dotenv').config();

const { neon } = require('@neondatabase/serverless');

const { PGHOST, PGDATABASE, PGUSER, PGPASSWORD } = process.env;

const sql = neon(`postgresql://${PGUSER}:${PGPASSWORD}@${PGHOST}/${PGDATABASE}?sslmode=require`)

async function getPgVersion() {
    const result = await sql`SELECT version()`;
    console.log(result[0]);
}

getPgVersion();

Run app.js

Run node app.js to view the result.

{
  version: 'PostgreSQL 16.0 on x86_64-pc-linux-gnu, compiled by gcc (Debian 10.2.1-6) 10.2.1 20210110, 64-bit'
}

Endpoint ID variable

For older clients that do not support Server Name Indication (SNI), the postgres.js example below shows how to include the ENDPOINT_ID variable in your application's connection configuration. This is a workaround that is not required if you are using a newer node-postgres or postgres.js client. For more information about this workaround and when it is required, see The endpoint ID is not specified in our connection errors documentation.

// app.js

require('dotenv').config();

const postgres = require('postgres');

const { PGHOST, PGDATABASE, PGUSER, PGPASSWORD, ENDPOINT_ID } = process.env;

const sql = postgres({
  host: PGHOST,
  database: PGDATABASE,
  username: PGUSER,
  password: PGPASSWORD,
  port: 5432,
  ssl: 'require',
  connection: {
    options: `project=${ENDPOINT_ID}`,
  },
});

async function getPgVersion() {
  const result = await sql`select version()`;
  console.log(result);
}

getPgVersion();

Source code

You can find the source code for the application described in this guide on GitHub.

Community resources

Need help?

Join our Discord Server to ask questions or see what others are doing with Neon. Users on paid plans can open a support ticket from the console. For more detail, see Getting Support.

Last updated on

Edit this page
Was this page helpful?