Docs Menu
Docs Home
/
Languages
/
Javascript
/
Node.js Driver

Usage Examples

On this page

  • Overview
  • How to Use the Usage Examples
  • Available Usage Examples

Overview

Usage examples provide convenient starting points for popular MongoDB operations. Each example provides the following information:

  • Explanation of the operation in the example, including the purpose and a sample use case for the method

  • Explanation of how to use the operation, including parameters, return values, and common exceptions you might encounter

  • Full Node.js program that you can copy and paste to run the example in your own environment

How to Use the Usage Examples

These examples use the MongoDB Atlas sample data database. You can use this sample data on the free tier of MongoDB Atlas by following the Get Started with Atlas guide or you can import the sample dataset into a local MongoDB instance.

Once you have imported the dataset, you can copy and paste a usage example into your development environment of choice. You can follow the quick start guide to learn more about getting started with Node.js, npm, and the Node.js driver. Once you've copied a usage example, you must edit one line to get the example running with your instance of MongoDB:

// Replace the following with your MongoDB deployment's connection string.
const uri =
   "mongodb+srv://<user>:<password>@<cluster-url>?retryWrites=true&writeConcern=majority";

All examples use ES module imports. You can enable ES module imports by adding the following key-value pair to your package.json file:

"type": "module"

Note

CommonJS

You can use any usage example with CommonJS require. To use CommonJS require, you must swap out the ES module import statement for your CommonJS require statement.

Click on the tabs to see the syntax for importing the driver with ES module import and CommonJS require:

import { MongoClient } from 'mongodb'
const { MongoClient } = require('mongodb')

You can use the Atlas Connectivity Guide to enable connectivity to your instance of Atlas and find the connection string to replace the uri variable in the usage example. If your instance uses SCRAM authentication, you can replace <user> with your username, <password> with your password, and <cluster-url> with the IP address or URL of your instance. Consult the Connection Guide for more information about getting connected to your MongoDB instance.

Available Usage Examples

Back

What's New

Next

Find Operations