Navigation

    Navigate Your Data

    Info With Circle IconCreated with Sketch.Note
    Preview

    MongoDB for VS Code is currently available as a Preview in the Visual Studio Marketplace. The product, its features, and the corresponding documentation may change during the Preview stage.

    Once you connect to your deployment using MongoDB for VS Code, use the left navigation to:

    • Explore your databases, collections, read-only views, and documents.
    • Create new databases and collections.
    • Drop databases and collections.
    Image showing deployment navigation
    Info With Circle IconCreated with Sketch.Note

    If your deployment requires authentication, your database user privileges may affect the actions you can perform using MongoDB for VS Code.

    When you expand an active connection, MongoDB for VS Code shows the databases in that deployment.

    • Click the name of a database to view the collections it contains.
    • Click the name of a collection to view its documents, schema, and indexes.
    Info With Circle IconCreated with Sketch.Note

    MongoDB for VS Code closes all documents when you close Visual Studio Code.

    When you expand a collection, MongoDB for VS Code displays the number of documents next to the :guilabel:Documents label in the navigation panel.

    When you expand a collection's documents, MongoDB for VS Code lists the _id of each document in the collection. Click an _id value to open that document in Visual Studio Code and view its contents.

    You may edit this single document:

    1. At the top of this document, click Edit Document. MongoDB for VS Code opens it as an editable EJSON document titled <database>.<collection>:"<_id>".json.
    2. Make any edits you require.
    3. Press Ctrl + S (Windows/Linux) or Cmd + S to save the edited document to the MongoDB database.

      • If the update succeeds, MongoDB for VS Code confirms that the database has stored the change.
      • If the update results in an error, MongoDB for VS Code displays it.

    To view all of the collection's documents in an array, you can:

    1. Right-click a collection.
    2. Click View Documents.
    Info With Circle IconCreated with Sketch.Note

    You can open a JavaScript Playground pre-configured to search a collection by hovering over the Documents label in the navigation panel and clicking the icon that appears.

    Your collection's schema defines the fields and data types within the collection. Due to MongoDB's flexible schema model, different documents in a collection may contain different fields, and data types may vary within a field. MongoDB can enforce schema validation to ensure your collection documents have the same shape.

    When you expand a collection's schema, MongoDB for VS Code lists the fields which appear in that collection's documents. If a field exists in all documents and its type is consistent throughout the collection, MongoDB for VS Code displays an icon indicating that field's data type. Hover over the field name for a text description of the field's data type.

    Your collections's indexes are listed under the Indexes heading. When you expand an index, each index key appears with an icon designating its type. Index key types include:

    • Ascending
    • Descending
    • Geospatial (2d, 2dsphere, geoHaystack)
    • Text
    • Hashed
    Info With Circle IconCreated with Sketch.Note

    You can open a MongoDB Playground pre-configured to create an index by hovering over the Indexes label in the navigation panel and clicking the icon that appears.

    Bulb IconTip
    See also:

    To learn more about MongoDB indexes, see the server manual.

    When you create a new database, you must populate it with an initial collection.

    To create a new database:

    1. Hover over the connection for the deployment where you want your database to exist.
    2. Click the icon that appears.
    3. In the prompt, enter a name for your new database.
    4. Press the enter key.
    5. Enter a name for the first collection in your new database.
    6. Press the enter key.

    To create a new collection:

    1. Hover over the database where you want your collection to exist.
    2. Click the Plus icon that appears.
    3. In the prompt, enter a name for your new collection.
    4. Press the enter key to confirm your new collection.
    Important With Circle IconCreated with Sketch.Important

    Dropping data from MongoDB is an irreversible process. Take caution to only drop data you are sure you want to delete, and backup your data as necessary.

    Dropping a database also drops all collections and documents within that database.

    To drop a database or collection:

    1. Right-click the target database or collection.
    2. Click Drop Database or Drop Collection.
    3. In the prompt, type the name of the target database or collection.
    4. Press the enter key.

    You can refresh a deployment, database, or collection at any time to re-query your deployment and populate MongoDB for VS Code with the most up-to-date data.

    To refresh:

    1. Right-click the target deployment, database, or collection.
    2. Click Refresh.
    Give Feedback