Connect a Next.js application to Neon

Next.js by Vercel is an open-source web development framework that enables React-based web applications. This topic describes how to create a Neon project and access it from a Next.js application.

To create a Neon project and access it from a Next.js application:

1. Create a Neon project

   If you do not have one already, create a Neon project. Save your connection details including your password. They are required when defining connection settings.

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

2. Create a Next.js project and add dependencies

   1. Create a Next.js project if you do not have one. For instructions, see Create a Next.js App, in the Vercel documentation.

   2. Add project dependencies using one of the following commands:

      Neon serverless driver

      postgres.js

      node-postgres

      npm install @neondatabase/serverless

3. Store your Neon credentials

   Add a .env file to your project directory and add your Neon connection string to it. You can find your Neon database connection string by clicking the Connect button on your Project Dashboard to open the Connect to your database modal. For more information, see Connect from any application.

   DATABASE_URL="postgresql://<user>:<password>@<endpoint_hostname>.neon.tech:<port>/<dbname>?sslmode=require"

4. Configure the Postgres client

   There are multiple ways to make server side requests with Next.js. See below for the different implementations.

   App Router

   There are two methods for fetching and mutating data using server-side requests in Next.js App Router, they are:

   1. Server Components fetches data at runtime on the server.
   2. Server Actions functions executed on the server to perform data mutations.

   Server Components

   In your server components using the App Router, add the following code snippet to connect to your Neon database:

   Neon serverless driver

   postgres.js

   node-postgres

   import { neon } from '@neondatabase/serverless';
   
   async function getData() {
     const sql = neon(process.env.DATABASE_URL);
     const response = await sql`SELECT version()`;
     return response[0].version;
   }
   
   export default async function Page() {
     const data = await getData();
     return <>{data}</>;
   }

   Server Actions

   In your server actions using the App Router, add the following code snippet to connect to your Neon database:

   Neon serverless driver

   postgres.js

   node-postgres

   import { neon } from '@neondatabase/serverless';
   
   export default async function Page() {
     async function create(formData: FormData) {
       "use server";
       const sql = neon(process.env.DATABASE_URL);
       await sql`CREATE TABLE IF NOT EXISTS comments (comment TEXT)`;
       const comment = formData.get("comment");
       await sql("INSERT INTO comments (comment) VALUES ($1)", [comment]);
     }
     return (
       <form action={create}>
         <input type="text" placeholder="write a comment" name="comment" />
         <button type="submit">Submit</button>
       </form>
     );
   }

   Pages Router

   There are two methods for fetching data using server-side requests in Next.js Pages Router, they are:

   1. getServerSideProps fetches data at runtime so that content is always fresh.
   2. getStaticProps pre-renders pages at build time for data that is static or changes infrequently.

   getServerSideProps

   From getServerSideProps using the Pages Router, add the following code snippet to connect to your Neon database:

   Neon serverless driver

   postgres.js

   node-postgres

   import { neon } from '@neondatabase/serverless';
   
   export async function getServerSideProps() {
     const sql = neon(process.env.DATABASE_URL);
     const response = await sql`SELECT version()`;
     return { props: { data: response[0].version } };
   }
   
   export default function Page({ data }) {
     return <>{data}</>;
   }

   getStaticProps

   From getStaticProps using the Pages Router, add the following code snippet to connect to your Neon database:

   Neon serverless driver

   postgres.js

   node-postgres

   import { neon } from '@neondatabase/serverless';
   
   export async function getStaticProps() {
     const sql = neon(process.env.DATABASE_URL);
     const response = await sql`SELECT version()`;
     return { props: { data: response[0].version } };
   }
   
   export default function Page({ data }) {
     return <>{data}</>;
   }

   Serverless Functions

   From your Serverless Functions, add the following code snippet to connect to your Neon database:

   Neon serverless driver

   postgres.js

   node-postgres

   import { neon } from '@neondatabase/serverless';
   
   const sql = neon(process.env.DATABASE_URL);
   
   export default async function handler(req, res) {
     const response = await sql`SELECT version()`;
     const { version } = response[0];
     res.status(200).json({ version });
   }

   Edge Functions

   From your Edge Functions, add the following code snippet and connect to your Neon database using the Neon serverless driver:

   export const config = {
     runtime: 'edge',
   };
   
   import { neon } from '@neondatabase/serverless';
   
   const sql = neon(process.env.DATABASE_URL);
   
   export default async function handler(req, res) {
     const response = await sql`SELECT version()`;
     const { version } = response[0];
     return Response.json({ version });
   }

5. Run the app

   When you run npm run dev you can expect to see the following on localhost:3000:

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

Source code

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

• Get started with Next.js Edge Functions and Neon

  Get started with Next.js Edge Functions and Neon

• Get started with Next.js Serverless Functions and Neon

  Get started with Next.js Serverless Functions and Neon

• Get started with Next.js getServerSideProps and Neon

  Get started with Next.js getServerSideProps and Neon

• Get started with Next.js getStaticProps and Neon

  Get started with Next.js getStaticProps and Neon

• Get started with Next.js Server Actions and Neon

  Get started with Next.js Server Actions and Neon

• Get started with Next.js Server Components and Neon

  Get started with Next.js Server Components and Neon