Usage Examples

Overview

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

• An explanation of the operation in the example showing the purpose and a sample use case for the method

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

• A full Java class that you can copy and paste to run the example in your own environment

How to Use the Usage Examples

These examples use the sample datasets provided by Atlas. You can load them into your database 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 the MongoDB Java driver. Once you've copied a usage example, you must edit the connection URI to get the example connected to your MongoDB instance:

// Replace the following with your MongoDB deployment's connection string.
String uri = "<connection string uri>";

You can use the Atlas Connectivity Guide to learn how to allow connections to your instance of Atlas and to find the connection string you use to replace the uri variable in usage examples. If your instance uses SCRAM authentication, you can replace <db_username> with your database username, <db_password> with your database password, and <cluster-url> with the IP address or URL of your instance.

For more information about connecting to your MongoDB instance, see our Connection Guide.