Skip to content

Latest commit

 

History

History
113 lines (71 loc) · 6.22 KB

README.md

File metadata and controls

113 lines (71 loc) · 6.22 KB
Raw

MongoDB for VS Code PREVIEW

Build Status

MongoDB for VS Code makes it easy to work with MongoDB, whether your own instance or in MongoDB Atlas.

Features

Navigate your MongoDB Data

  • Navigate your database, collections and read-only views
  • See the documents in your collections
  • Edit documents and save changes to the database
  • Get a quick overview of your schema and your indexes

Explore data with MongoDB for VS Code

MongoDB Playgrounds

MongoDB Playgrounds are the most convenient way to prototype and execute CRUD operations and other MongoDB commands directly inside VS Code.

  • Prototype your queries, aggregations, and MongoDB commands with MongoDB syntax highlighting and intelligent autocomplete for MongoDB shell API, MongoDB operators, and for database, collection, and field names.
  • Run your playgrounds and see the results instantly. Click the play button in the tab bar to see the output.
  • Save your playgrounds in your workspace and use them to document how your application interacts with MongoDB
  • Build aggregations quickly with helpful and well-commented stage snippets

Playgrounds

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.

Quick access to the MongoDB Shell

Launch the MongoDB Shell from the command palette to quickly connect to the same cluster you have active in VS Code.

MongoDB Shell

The shell binary needs to be in your $PATH. The shell binary can be either the mongo shell or the new MongoDB Shell (mongosh). In the extension's settings you can switch between the two.

Terraform snippet for MongoDB Atlas

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 atlas and you are good to go.

Terraform snippet

Extension Settings

  • mdb.shell: The MongoDB shell to use (mongo or 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.

Settings

Additional Settings

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 false allows 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
}

Telemetry

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.sendTelemetry to false in the extension settings.

Contributing

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.

Building and Installing from Source

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 .vsix file 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 .vsix file and add the extension to your VS Code.

If you get an error because the code command 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 code and select "Install code command in $PATH".

License

Apache 2.0