Share via

Connect to and manage MongoDB in Microsoft Purview

  • Article

This article outlines how to register MongoDB, and how to authenticate and interact with MongoDB in Microsoft Purview. For more information about Microsoft Purview, read the introductory article.

Supported capabilities

Metadata Extraction Full Scan Incremental Scan Scoped Scan Classification Labeling Access Policy Lineage Data Sharing Live view
Yes Yes No Yes No No No No No No

The supported MongoDB versions are 3.6 to 7.0. You can use this connector to scan MongoDB Atlas as well.

When scanning MongoDB source, Microsoft Purview supports extracting technical metadata including:

  • Server
  • Databases
  • Collections including the schema
  • Views including the schema

During scan, Microsoft Purview retrieves and analyzes sample documents to infer the collection/view schema. The sample size is configurable.

When setting up scan, you can choose to scan one or more MongoDB database(s) entirely, or further scope the scan to a subset of collections matching the given name(s) or name pattern(s).

Known limitations

When object is deleted from the data source, currently the subsequent scan won't automatically remove the corresponding asset in Microsoft Purview.

Prerequisites

Register

This section describes how to register MongoDB in Microsoft Purview using the Microsoft Purview governance portal.

Steps to register

To register a new MongoDB source in Microsoft Purview Unified Catalog, do the following:

  1. Navigate to your Microsoft Purview account in the Microsoft Purview governance portal.
  2. Select Data Map on the left navigation.
  3. Select Register
  4. On Register sources, select MongoDB. Select Continue.

On the Register sources (MongoDB) screen, do the following:

  1. Enter a Name that the data source will be listed within the Catalog.

  2. Enter the server name. Specify a name to uniquely identify your MongoDB instance in your company. For example, host for standalone deployment, MyReplicaSetName for replica set, MyClusterName for sharded cluster. This value will be used in asset qualified name and cannot be changed.

  3. Select a collection from the list.

  4. Finish to register the data source.

    register sources options

Scan

Follow the steps below to scan MongoDB to automatically identify assets. For more information about scanning in general, see our introduction to scans and ingestion.

Authentication for a scan

The supported authentication type for a MongoDB source is Basic authentication.

Create and run scan

To create and run a new scan, do the following:

  1. In the Management Center, select Integration runtimes. Make sure a self-hosted integration runtime is set up. If it isn't set up, use the steps mentioned in prerequisites to create a self-hosted integration runtime.

  2. Navigate to Sources.

  3. Select the registered MongoDB source.

  4. Select + New scan.

  5. Provide the below details:

    1. Name: The name of the scan

    2. Connect via integration runtime: Select the self-hosted integration runtime used to perform scan.

    3. Credential: Select the credential to connect to your data source. Make sure to:

      • Select Basic Authentication while creating a credential.
      • Provide the user name used to connect to MongoDB in the User name input field.
      • Store the user password used to connect to MongoDB in the secret key.

    4. Connection string: Specify the MongoDB connection string used to connect to your MongoDB, excluding the username and password. For example, mongodb://mongodb0.example.com:27017,mongodb1.example.com:27017/?replicaSet=myRepl, mongodb+srv://mongodb0.example.com/?authSource=admin&replicaSet=myRepl.

    5. Databases: Specify a list of MongoDB databases to be imported. The list can have one or more database names separated by semicolon (;), e.g. database1; database2.

    6. Collections: The subset of collections to import expressed as a semicolon separated list of collections, e.g. collection1;collection2. All collections are imported if the list is empty.​

      Acceptable collection name patterns can be static names or contain wildcard %. For example: A%;%B;%C%;D:

      • Start with A or
      • End with B or
      • Contain C or
      • Equal D

      Usage of NOT and special characters aren't acceptable.

    7. Number of sample documents: Number of sample documents to be analyzed for schema extraction. Default is 10.

    8. Maximum memory available (applicable when using self-hosted integration runtime): Maximum memory (in GB) available on customer's VM to be used by scanning processes. It's dependent on the size of MongoDB source to be scanned.

      scan MongoDB

  6. Select Test connection to validate the configurations.

  7. Select Continue.

  8. Choose your scan trigger. You can set up a schedule or ran the scan once.

  9. Review your scan and select Save and Run.

View your scans and scan runs

To view existing scans:

  1. Go to the Microsoft Purview portal. On the left pane, select Data map.
  2. Select the data source. You can view a list of existing scans on that data source under Recent scans, or you can view all scans on the Scans tab.
  3. Select the scan that has results you want to view. The pane shows you all the previous scan runs, along with the status and metrics for each scan run.
  4. Select the run ID to check the scan run details.

Manage your scans

To edit, cancel, or delete a scan:

  1. Go to the Microsoft Purview portal. On the left pane, select Data Map.

  2. Select the data source. You can view a list of existing scans on that data source under Recent scans, or you can view all scans on the Scans tab.

  3. Select the scan that you want to manage. You can then:

    • Edit the scan by selecting Edit scan.
    • Cancel an in-progress scan by selecting Cancel scan run.
    • Delete your scan by selecting Delete scan.

Note

  • Deleting your scan does not delete catalog assets created from previous scans.

Next steps

Now that you've registered your source, follow the below guides to learn more about Microsoft Purview and your data.