Azure Databases for VS Code (Preview)

Browse, manage, and query your Azure Cosmos DB databases both locally and in the cloud with support for Cosmos DB NoSQL, MongoDB (RU), MongoDB (vCore), and any other MongoDB API Database.

Sign up today for your free Azure account and receive 12 months of free popular services, $200 free credit and 25+ always free services 👉 Start Free.

Features

Azure Databases Explorer

The Azure Databases Explorer helps you find, view, and manage your Azure databases.

• Discover Database Servers: scan your Azure subscription for available database servers and get a structured list of your resources.

• Open in Azure Portal: Access database servers directly in the Azure portal.

• Manage Databases: View, create, and delete databases, collections, stored procedures, and documents.

• Edit Documents and Queries: Open documents, stored procedures, and queries in the editor.

• Save Changes: Make updates and persist them to the cloud.

• Workspace Support: Attach database servers to your workspace using connection strings. This is especially useful for teams working with shared resources from various subscriptions.

• MongoDB Connectivity: Connect to MongoDB databases on Azure and beyond using connection strings.

Query Editor

The Query Editor allows you to write and execute queries across your databases.

• Rich Syntax Highlighting: Highlights query syntax to make it more readable and help prevent errors.

• Query History: Automatically saves previously executed queries, allowing you to open and reuse them later.

• Run Queries: Execute queries and view results in Table, JSON, or Tree view.

• Export Results: Provides options to copy query results as JSON or CSV or to save them to a file for later use.

• Pagination: Adjust how many results are displayed at a time when working with large datasets.

• Query Insights and Index Advisor: Displays key details such as execution time, resource consumption, and indexing recommendations.

• Edit Documents: Open, update, and save individual documents.

• Create New Documents: Write and validate documents with syntax highlighting.

Universal MongoDB Support

The Azure Databases VS Code Extension supports MongoDB, making it easier to connect to and manage different types of MongoDB databases:

• Works with Azure Cosmos DB for MongoDB: Connect to Azure Cosmos DB for MongoDB, including both Request Units (RU) and vCore-based models. Browse, query, and modify data without leaving VS Code.

• Supports Any MongoDB Database: Connect to any MongoDB instance, whether it’s hosted on Azure, another cloud provider, or a local server.

• Different Ways to View Data: Explore collections using Table, Tree, or JSON views. Paging controls help manage large datasets.

• Enhanced Query Experience: Execute find queries with syntax highlighting and intelligent auto-completion, including field name suggestions, to reduce errors.

• Edit and Manage Documents: Open, edit, and delete individual documents directly in the extension.

• JSON Import and Export: Import data from JSON files or export documents as needed. You can even export entire collections or the result of a query, making data sharing simpler and more efficient.

For a step-by-step guide, check out the A Powerful, Open-Source MongoDB GUI for Everyone tutorial.

Import into Cosmos DB

The extension allows you to import documents into CosmosDB.

• Workspace Integration: Use the context menu of a collection or document file (JSON) to initiate import.

  

Attach to the Cosmos DB Emulator

Attach the Cosmos DB Emulator to work with a local instance of Cosmos DB for development and testing purposes.

• Emulator Installation: Install and run the Cosmos DB Emulator on your local machine.

• New Emulator Connection: Expand 'Attached Database Accounts', next expand 'Local Emulators', and select 'New Emulator Connection' to link the emulator to your workspace.

Prerequisites

• Mongo Shell Requirement (Optional): Some advanced commands in the Mongo scrapbook and use of the Mongo shell require installing Mongo DB and Mongo shell.

Known Issues

Here are some known issues and limitations to be aware of when using the Azure Databases extension:

• Gremlin Endpoint Limitation: Azure no longer supports Gremlin queries on pre-GA graph accounts. If you encounter an error like "Could not find a valid gremlin endpoint for graph", open the graph node in the portal and verify the "Gremlin Endpoint" format. If it does not match the expected form '...[graph-name].gremlin.cosmosdb.azure.com...', you may need to create a new graph account.

• Graphs Not Supported with Emulator: Graphs are not currently supported with the Cosmos DB Emulator.

• Table Viewing/Editing: Viewing and editing tables is not currently supported by the extension.

• Escaped Characters in Scrapbooks: Scrapbook support for escaped characters is preliminary. Use double escaping for newlines (\\n instead of \n). If you find issues, report them to #937.

Contributing

There are several ways you can contribute to the vscode-cosmosdb repository:

• Ideas, feature requests and bugs: We are open to all ideas, and we want to get rid of bugs! Use the Issues section to report a new issue, provide your ideas or contribute to existing threads.

• Documentation: Found a typo or strangely worded sentences? Submit a PR!

• Code: Contribute bug fixes, features or design changes:

  • Clone the repository and open it in VS Code.

  • Run Extensions: Show Recommended Extensions from the command palette and install all extensions listed under "Workspace Recommendations"

  • Open the terminal (press CTRL+`) and run npm install.

  • Build: press Ctrl+Shift+B, or press F1 and type Tasks: Run Build Task.

  • Debug: Select the Launch Extension (webpack) configuration in the Debug side bar and press F5 to start debugging the extension.

Legal

Before we can accept your pull request you will need to sign a Contribution License Agreement. All you need to do is to submit a pull request, then the PR will get appropriately labelled (e.g. cla-required, cla-norequired, cla-signed, cla-already-signed). If you already signed the agreement we will continue with reviewing the PR, otherwise system will tell you how you can sign the CLA. Once you sign the CLA all future PR's will be labeled as cla-signed.

Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Telemetry

VS Code collects usage data and sends it to Microsoft to help improve our products and services. Read our privacy statement to learn more. If you don’t wish to send usage data to Microsoft, you can set the telemetry.enableTelemetry setting to false. Learn more in our FAQ.

License

MIT