Docs Home → MongoDB for VS Code
Connect to Your MongoDB Deployment
On this page
This page outlines how to use MongoDB for VS Code to connect to a MongoDB host. You can connect to a standalone, replica set, or sharded cluster host.
Note
MongoDB Atlas
If you need to create a MongoDB host, consider using MongoDB Atlas. Atlas is a cloud-hosted database-as-a-service which requires no installation, offers a free tier to get started, and provides a copyable URI to easily connect MongoDB for VS Code to your deployment.
To create a cluster on the Atlas free tier, run the command
MongoDB: Open Overview Page in the Visual Studio Code Command
Palette and then click Create free cluster.
To create an Atlas cluster using a Terraform template included with MongoDB for VS Code, see Create an Atlas Cluster from a Template using Terraform.
If you need to install MongoDB for VS Code, see Install MongoDB for VS Code for instructions.
Considerations
When connecting MongoDB for VS Code to a replica set, use either the replica set SRV record or Replica Set Name when filling in your connection information. It is not recommended to connect directly to an individual replica set member.
You can't connect MongoDB for VS Code directly to an analytics node.
MongoDB for VS Code appends the
appNameconnection string option with a value ofmongodb-vscode <version>for all deployment connections.
Create a Connection to a Deployment
MongoDB for VS Code provides two methods to create a connection to a deployment. You can:
Provide a deployment connection string, or
Fill in a deployment information in specific fields.
Providing a connection string is faster and easier than filling in a deployment's details. Use this option if Atlas hosts your deployment or if you have a connection string for a deployment available.
Define how your connection is saved with the Default Connection Saving Location setting:
Setting | Description |
|---|---|
Global | Save your connection globally in VS Code, so it can be accessed
from any workspace. |
Workspace | Save your connection in your workspace. You cannot
access the connection from a different workspace. |
Session | Save the connection for only this VS Code session. The connection
is lost when you close VS Code. |
Activate a Connection
You can connect MongoDB for VS Code to only one deployment at a time. To change the active connection to a different deployment, or to connect to a deployment from which you were disconnected:
In Visual Studio Code, click the MongoDB view in the Activity Bar.
Right-click the connection you want to activate, then click Connect.
Launch MongoDB Shell
You can connect the MongoDB Shell or legacy
mongo shell to your active deployment.
Considerations
The shell that MongoDB for VS Code uses to connect to your deployment is determined by the Shell setting in your extension settings. You can choose either the MongoDB Shell or the legacy
mongoshell.The path to your selected shell must exist in your system's
PATH. If it does not exist in yourPATH, the operation errors.
Procedure
To connect the shell to your active deployment:
In the MongoDB for VS Code Connections list, right-click your active deployment.
Select Launch MongoDB Shell.
MongoDB for VS Code opens the Terminal window in VS Code and launches the shell connected to your selected deployment.
Tip
Rename a Connection
To rename a connection to a deployment in MongoDB for VS Code:
In Visual Studio Code, click the MongoDB view in the Activity Bar.
Right-click the connection you want to activate, then click Rename Connection.
Rename the connection.
In the Command Palette, type a new name for the connection.
Press the Enter or Return key to rename the connection.
Disconnect from a Deployment
MongoDB for VS Code provides two methods to disconnect from a deployment. You can:
Disconnect with the Command Palette, or
Disconnect from the MongoDB view in the Activity Bar.
Disconnecting from a MongoDB instance closes the MongoDB for VS Code connection to the active instance. You must reconnect to interact with data in your deployment again.
Remove a Connection
MongoDB for VS Code provides two methods to remove a connection to a deployment from Visual Studio Code. You can:
Remove a connection with the Command Palette, or
Remove a connection from the MongoDB view in the Activity Bar.
Important
Removing a connection from Visual Studio Code removes it both from the current workspace and from Visual Studio Code globally.