Connect to MongoDB and Atlas and directly from your VS Code environment, navigate your databases and collections, inspect your schema and use playgrounds to prototype queries and aggregations.
MongoDB for VS Code makes it easy to work with MongoDB, whether your own instance or in MongoDB Atlas.
MongoDB Playgrounds are the most convenient way to prototype and execute CRUD operations and other MongoDB commands directly inside VS Code.
Make sure you are connected to a server or cluster before using a playground. You can't run a playground and you won't get completions if you are not connected.
MongoDB for VS Code makes it extremely easy to make changes to documents in your collections. You can open documents in an editor tab, edit them and save the changes back to MongoDB.
Launch the MongoDB Shell from the command palette to quickly connect to the same cluster you have active in VS Code.
The shell binary needs to be in your
$PATH. The shell binary can be either the
mongoshell or the new MongoDB Shell (
mongosh). In the extension's settings you can switch between the two.
If you use Terraform to manage your infrastructure, MongoDB for VS Code helps you get started with the MongoDB Atlas Provider. Just open a Terraform file, type
atlasand you are good to go.
mdb.shell: The MongoDB shell to use (
mongoor the new
mongosh).
mdb.show: Show or hide the MongoDB view.
mdb.defaultLimit: The number of documents to fetch when viewing documents from a collection.
mdb.confirmRunAll: Show a confirmation message before running commands in a playground.
mdb.excludeFromPlaygroundsSearch: Exclude files and folders while searching for playground in the the current workspace.
mdb.connectionSaving.hideOptionToChooseWhereToSaveNewConnections: When a connection is added, a prompt is shown that let's the user decide where the new connection should be saved. When this setting is checked, the prompt is not shown and the default connection saving location setting is used.
mdb.connectionSaving.defaultConnectionSavingLocation: When the setting that hides the option to choose where to save new connections is checked, this setting sets if and where new connections are saved.
mdb.useDefaultTemplateForPlayground: Choose whether to use the default template for playground files or to start with an empty playground editor.
mdb.sendTelemetry: Opt-in and opt-out for diagnostic and telemetry collection.
These global settings affect how MongoDB for VS Code provides intelligent autocomplete inside snippets and string literals (off by default). Changing the default configuration may affect the behavior and performance of other extensions and of VS Code itself. If you do not change the default settings, you can still trigger intelligent autocomplete inside a snippet or string literal with
Ctrl+Space.
editor.suggest.snippetsPreventQuickSuggestions: By default, VS Code prevents code completion in snippet mode (editing placeholders in inserted code). Setting this to
falseallows snippet (eg.
$match,
$addFields) and field completion based on the document schema for the
db.collection.aggregate()expressions.
editor.quickSuggestions: By default, VS Code prevents code completion inside string literals. To enable database names completions for
use('dbName')expression use this configuration:
"editor.quickSuggestions": { "other": true, "comments": false, "strings": true }
MongoDB for VS Code collects usage data and sends it to MongoDB to help improve our products and services. Read our privacy policy to learn more. If you don’t wish to send usage data to MongoDB, you can opt-out by setting
mdb.sendTelemetryto
falsein the extension settings.
For issues, please create a ticket in our JIRA Project.
For contributing, please refer to CONTRIBUTING.md.
Is there anything else you’d like to see in MongoDB for VS Code? Let us know by submitting suggestions in our feedback forum.
You can clone this repository and install the extension in your VS Code with:
npm install npm run local-install
This will compile and package MongoDB for VS Code into a
.vsixfile and add the extension to your VS Code.
To install this locally on windows:
npm install .\node_modules\.bin\vsce.cmd package code --install-extension ./mongodb-vscode-*.vsix
This will compile and package MongoDB for VS Code into a
.vsixfile and add the extension to your VS Code.
If you get an error because the
codecommand is not found, you need to install it in your
$PATH.
Open VS Code, launch the Commmand Palette (⌘+Shift+P on MacOS, Ctrl+Shift+P on Windows and Linux), type
codeand select "Install code command in \$PATH".