Connect an Express application to Neon
This guide describes how to create a Neon project and connect to it from an Express application to query a Lakebase Postgres database. Choose a driver. @neondatabase/serverless connects over HTTP or W...
Pre-built prompt for connecting ExpressJS applications to Lakebase Postgres
This guide describes how to create a Neon project and connect to it from an Express application to query a Lakebase Postgres database.
Choose a driver
Section titled “Choose a driver”@neondatabase/serverlessconnects over HTTP or WebSockets instead of TCP. Use it for serverless and edge platforms without built-in connection pooling (Vercel, Netlify Functions, Deno Deploy, Cloudflare Workers without Hyperdrive).postgres(postgres.js) is a fast, full-featured client for both serverless and traditional Node.js server environments.pg(node-postgres) is the classic, widely-used driver for traditional, long-running Node.js servers. Also the standard choice for Vercel Fluid compute and Cloudflare with Hyperdrive.
For a detailed comparison including all platforms, see Choosing your connection method.
Create a Neon project
If you do not have one already, create a Neon project.
- Navigate to the Projects page in the Neon Console.
- Click New Project.
- Specify your project settings and click Create Project.
Create an Express project and add dependencies
- Create an Express project and change to the newly created directory.
Bash mkdir neon-express-example cd neon-express-example npm init -y npm install express - Add project dependencies using one of the following commands:npm install @neondatabase/serverless dotenvnpm install pg dotenvnpm install postgres dotenv
- Create an Express project and change to the newly created directory.
Store your Neon credentials
Add a
.envfile to your project directory and add your Neon connection details to it. Find your database connection details by clicking the Connect button in the Console nav to open the Connect to your branch modal. Select Node.js from the Connection string dropdown. For more information, see Connect from any application.Bash DATABASE_URL="postgresql://<user>:<password>@<endpoint_hostname>.neon.tech:<port>/<dbname>?sslmode=require&channel_binding=require"Configure the Postgres client
Add an
index.jsfile to your project directory and add the following code snippet to connect to your Neon database:Neon serverless driver require('dotenv').config(); const express = require('express'); const { neon } = require('@neondatabase/serverless'); const app = express(); const PORT = process.env.PORT || 4242; const sql = neon(process.env.DATABASE_URL); app.get('/', async (req, res) => { try { const [result] = await sql`SELECT version()`; const version = result?.version || 'No version found'; res.json({ version }); } catch (error) { console.error('Database query failed:', error); res.status(500).json({ error: 'Failed to connect to the database.' }); } }); app.listen(PORT, () => { console.log(`Listening to http://localhost:${PORT}`); });node-postgres require('dotenv').config(); const express = require('express'); const { Pool } = require('pg'); const app = express(); const PORT = process.env.PORT || 4242; const pool = new Pool({ connectionString: process.env.DATABASE_URL, }); app.get('/', async (req, res) => { let client; try { client = await pool.connect(); const { rows } = await client.query('SELECT version()'); const version = rows[0]?.version || 'No version found'; res.json({ version }); } catch (error) { console.error('Database query failed:', error); res.status(500).json({ error: 'Failed to connect to the database.' }); } finally { client?.release(); } }); app.listen(PORT, () => { console.log(`Listening to http://localhost:${PORT}`); });postgres.js require('dotenv').config(); const express = require('express'); const postgres = require('postgres'); const app = express(); const PORT = process.env.PORT || 4242; const sql = postgres(process.env.DATABASE_URL); app.get('/', async (req, res) => { try { const [result] = await sql`SELECT version()`; const version = result?.version || 'No version found'; res.json({ version }); } catch (error) { console.error('Database query failed:', error); res.status(500).json({ error: 'Failed to connect to the database.' }); } }); app.listen(PORT, () => { console.log(`Listening to http://localhost:${PORT}`); });Run index.js
Run
node index.jsto view the result on localhost:4242 as follows:Bash { version: 'PostgreSQL 16.0 on x86_64-pc-linux-gnu, compiled by gcc (Debian 10.2.1-6) 10.2.1 20210110, 64-bit' }
Connection issues
Section titled “Connection issues”- If you see an
endpoint ID is not specifiederror, the TLS client your Postgres driver depends on doesn't support Server Name Indication (SNI), which Neon uses to route connections. Forpg(node-postgres), this means an outdatedlibpq-compatible TLS stack; upgradingpgusually resolves it. - If you encounter an
SSL SYSCALL error: EOF detected(or a similar connection-reset error), this typically happens when an application tries to reuse a connection after the Neon compute has been suspended due to inactivity. This mainly affects long-running servers that keep a connection pool open, like thepgexample above — closing and recreating idle connections, or reconnecting on error, resolves it.
Notes for AI-assisted setup
- Do not hardcode credentials or connection strings in any
.jssource file. Always use environment variables viaprocess.envanddotenv. - Wrap all database queries in a
try...catchblock. Return a500status with an error message on failure. - When using
pg(node-postgres), declarelet clientbefore thetryblock and callclient?.release()in thefinallyblock. This safely handles cases wherepool.connect()itself fails. - Initialize the connection pool or client outside the route handler, not inside it. Creating a new pool on every request wastes resources.
- Choose the right driver for your platform.
@neondatabase/serverlessis for serverless/edge platforms without TCP support. For long-running Express servers, usepgorpostgres. See Choosing your connection method.
Next steps
Section titled “Next steps”- Set up Managed Better Auth: Add managed authentication that branches with your database
- Add Object Storage: S3-compatible file storage that branches with your database
- Deploy a Function: Run backend compute next to your database, no separate hosting needed
- Call an LLM with AI Gateway: Access foundation models from Anthropic, OpenAI, Google, and more with one credential
Need help?
Section titled “Need help?”Join our Discord Server to ask questions or see what others are doing with Neon. For paid plan support options, see Support.