Connect via Driver¶
The Connect dialog for a cluster provides the details to connect to a cluster with an application using a MongoDB driver.
Prerequisites¶
Driver Version¶
Your driver version must be compatible with your version of the MongoDB server. We recommend choosing the latest driver that is compatible with your MongoDB server version to utilize the latest database features and prepare for future version upgrades.
For a list of driver versions that contain the full set of functionality for your version of the MongoDB server, check the compatibility matrix for your MongoDB driver.
When you upgrade your driver version, some commands, methods or options may be deprecated and removed. Check your MongoDB driver API documentation to ensure a smooth transition.
The drivers recommended for MongoDB 3.6 in the driver compatibility matrices are tested against MongoDB 4.4. Check the MongoDB driver documentation page for the driver compatibility matrix for your language.
Applications running with 3.6-series drivers will work against MongoDB clusters running MongoDB 4.4 as long as:
- No functionality new to MongoDB 4.0, MongoDB 4.2, or MongoDB 4.4 is being used, and
- No commands, methods, or options removed in
MongoDB 4.0,
MongoDB 4.2
(including
db.collection.geoNear(),db.collection.group(), anddb.eval()), or MongoDB 4.4 are being used, and - Other compatibility changes in
MongoDB 4.4 to
projections(including$slice projections),$sort,text search, andmapReducedo not impact them.
We still recommend using MongoDB 4.4-series drivers with MongoDB 4.4 to utilize newer database features and better prepare for future version upgrades.
TLS¶
Clients must support TLS to connect to an Atlas cluster.
Clients must support the SNI TLS extension to
connect to an Atlas M0 Free Tier or M2/M5 shared starter
cluster. To verify that your MongoDB driver supports the
SNI TLS extension, refer to the Compatibility section of your
driver's documentation. If the driver is compatible with MongoDB 3.4
and later, it supports the SNI TLS extension.
IP Access List¶
To access a cluster, you must connect from an IP address on the Atlas project's IP access list. If you need to add an IP address to the IP access list, you can do so in the Connect dialog. You can also add the IP address from the Network Access tab.
Database User¶
To access a cluster, you must create a database user with access to the desired database(s) on your Atlas cluster. Database users are separate from Atlas users. Database users have access to MongoDB databases, while Atlas users have access to the Atlas application itself.
You can create a database user to access to your Atlas cluster in the Connect dialog. You can also add the database user from the Clusters view.
Connect Your Application¶
Click Connect.¶
In the Clusters view, click Connect for the cluster to which you want to connect.
Choose your Connection Security.¶
Choose Connection Type from the set of available buttons.
Atlas displays the connection type options after you enable Private IP for Peering, Private Endpoint, or both. If you haven't enabled either feature, no buttons display and Connection Type defaults to Standard.
Use this connection type for allowed public IP addresses.
Choose how you want to limit connections to your cluster.¶
Add a Connection IP Address
Skip this step if Atlas indicates in the Setup connection security step that you have already configured an IP access list entry in your cluster. To manage the IP access list, see Add Entries to the Access List.
Atlas allows standard client connections to the cluster from entries in the project's IP access list. The project IP access list differs from the API access list, which restricts API access to specific IP or CIDR addresses.
If the IP access list is empty, Atlas prompts you to add an IP address to the project's IP access list. You can either:
- Click Add Your Current IP Address to allow access from your current IP address.
- Click Add an IP Address to add a single IP address or a CIDR -notated range of addresses.
Provide an optional description for the newly added IP address or CIDR range. Click Add IP Address to add the address to the IP access list.
Create a Database User.¶
Skip this step if Atlas indicates in the Setup connection security step that you have at least one database user configured in your project. To manage existing database users, see Configure Database Users.
To access the cluster, you need a MongoDB user with access to the desired database or databases on the cluster in your project. If your project has no MongoDB users, Atlas prompts you to create a new user with the Atlas Admin role.
- Enter the new user's Username
- Enter a Password for this new user or click Autogenerate Secure Password.
- Click Create Database User to save the user.
Use this user to connect to your cluster in the following step.
Once you have added an IP address to your IP access list and added a database user, click Choose Your Connection Method.
Select Connect your application.¶
In the Choose a connection method step, select Connect your application.
Select Your Driver and Version.¶
Select your driver and version from the dropdown menus. The code sample containing a connection string displays.
- Replace
<password>with the password specified when you created your database user. - Replace
<myFirstDatabase>with the name of the database that connections will use by default. If you omit the database, thetestdatabase is used by default. If you configured the user on a different database, specify that database in the connection string.
If the password or database names contain reserved URI characters, you must
escape the characters. For example,
if your password is @bc123, you must escape the @
character when specifying the password in the connection
string, such as %40bc123. To learn
more, see Special Characters in Connection String Password.
To learn more, see Driver Compatibility.
Driver Examples¶
In this example
URI connection strings, the
user kay provides their password myRealPassword to
authenticate and connect to an Atlas cluster.
Select your driver from the following options:
To connect to an Atlas M0 (Free Tier) or M2/M5 shared
tier cluster, you must use a C driver version that supports
MongoDB 3.6. For complete documentation on compatibility between the
C driver and MongoDB, see the MongoDB compatibility matrix.
client = mongoc_client_new ("mongodb+srv://kay:myRealPassword@cluster0.mongodb.net/?serverSelectionTryOnce=false&serverSelectionTimeoutMS=15000&w=majority"); db = mongoc_client_get_database (client, "test");
MongoDB Version | Recommended Driver Version(s) |
|---|---|
All | See the MongoDB compatibility matrix for the
latest recommended driver versions. |
MongoDB 4.0 | Version 1.11 or later. |
MongoDB 3.6 | Version 1.9 or later. |
Behavior¶
The following configuration options only apply if running the C driver in single-threaded mode.
MongoDB drivers automatically attempt server selection following a cluster election or failover event. By default, the C driver immediately raises an error if its first attempt to select a server fails. The following configuration settings may improve application connectivity to an Atlas cluster at the expense of spending more time in a server selection loop:
- Set serverSelectionTryOnce
to
falseto direct the C driver to perform server selection up to the time limit defined byserverSelectionTimeoutMS. - Lower the serverSelectionTimeoutMS
to
15000from the default of30000. MongoDB elections typically take 10 seconds, but can be as fast as 5 seconds on Atlas. Setting this value to 15 seconds (15000milliseconds) covers the upper bound of election plus additional time for latency.
Troubleshooting¶
If you are experiencing issues connecting to your cluster, see Troubleshoot Connection Issues.