How do you connect MongoDB with a Next.js API route?

To connect MongoDB with your Next.js API routes efficiently, you should avoid opening a new connection on every request. Instead, you can reuse an existing MongoDB connection, especially because serverless functions in Next.js can trigger multiple API calls in quick succession. This can result in too many open connections if you don't handle connection reuse.

Here’s how you can manage the MongoDB connection efficiently: Install MongoDB Node.js driver: First, you need to install the official MongoDB client to your project:

1npm install mongodb

1npm install mongodb

Create a reusable MongoDB connection utility: You should create a utility to handle the connection. This will ensure that you don’t open a new connection on every API request. Here’s an example of what this utility (lib/mongodb.js) might look like:

1// lib/mongodb.js
2import { MongoClient } from 'mongodb';
3
4const uri = process.env.MONGODB_URI;
5const options = {};
6
7let client;
8let clientPromise;
9
10if (!process.env.MONGODB_URI) {
11  throw new Error('Please define the MONGODB_URI environment variable');
12}
13
14// In development, use a global variable to preserve the MongoClient across hot reloads
15if (process.env.NODE_ENV === 'development') {
16  if (!global._mongoClientPromise) {
17    client = new MongoClient(uri, options);
18    global._mongoClientPromise = client.connect();
19  }
20  clientPromise = global._mongoClientPromise;
21} else {
22  client = new MongoClient(uri, options);
23  clientPromise = client.connect();
24}
25
26export default clientPromise;

1// lib/mongodb.js
2import { MongoClient } from 'mongodb';
3
4const uri = process.env.MONGODB_URI;
5const options = {};
6
7let client;
8let clientPromise;
9
10if (!process.env.MONGODB_URI) {
11  throw new Error('Please define the MONGODB_URI environment variable');
12}
13
14// In development, use a global variable to preserve the MongoClient across hot reloads
15if (process.env.NODE_ENV === 'development') {
16  if (!global._mongoClientPromise) {
17    client = new MongoClient(uri, options);
18    global._mongoClientPromise = client.connect();
19  }
20  clientPromise = global._mongoClientPromise;
21} else {
22  client = new MongoClient(uri, options);
23  clientPromise = client.connect();
24}
25
26export default clientPromise;

Use the MongoDB connection in your API route: Now, you can use this utility in your API routes. Here’s an example of how you might interact with MongoDB in an API route (pages/api/posts.js):

1// pages/api/posts.js
2import clientPromise from '../../lib/mongodb';
3
4export default async function handler(req, res) {
5  try {
6    const client = await clientPromise;
7    const db = client.db(process.env.MONGODB_DB);
8    const posts = await db.collection('posts').find({}).toArray();
9
10    res.status(200).json(posts);
11  } catch (error) {
12    console.error('MongoDB connection error:', error);
13    res.status(500).json({ message: 'Internal Server Error' });
14  }
15}

1// pages/api/posts.js
2import clientPromise from '../../lib/mongodb';
3
4export default async function handler(req, res) {
5  try {
6    const client = await clientPromise;
7    const db = client.db(process.env.MONGODB_DB);
8    const posts = await db.collection('posts').find({}).toArray();
9
10    res.status(200).json(posts);
11  } catch (error) {
12    console.error('MongoDB connection error:', error);
13    res.status(500).json({ message: 'Internal Server Error' });
14  }
15}

Secure Your Credentials: Use environment variables for your MongoDB URI and database name. Make sure to add them to a .env.local file:

1MONGODB_URI=mongodb+srv://<username>:<password>@cluster0.mongodb.net/myDatabase?retryWrites=true&w=majority
2MONGODB_DB=myDatabase
3

1MONGODB_URI=mongodb+srv://<username>:<password>@cluster0.mongodb.net/myDatabase?retryWrites=true&w=majority
2MONGODB_DB=myDatabase
3

By following this approach, you avoid the performance pitfalls of creating a new MongoDB connection on every request. Instead, the connection is reused across different requests, ensuring that your app runs efficiently in both development and production environments.

How do you connect MongoDB with a Next.js API route?

1 Answer

Write your answer here

Top Questions

Popular Tags