This will walk you through what a scan is and how to configure it for your MongoDB Instance

What is a Scan?

Scans will analyze documents in your collection and provide you with a detailed look into the consistency of your data by pinpointing fields and the variance of types in them.

Configuration Options

Once you select your MongoDB instance from the ObjectRocket UI and select Schedule scan, you’ll be presented with the following fields:

  • Source Database: The source database that the collection resides on. Choosing a database will auto populate source collections with all available collections. This is a required field.
  • Source Collection: The source collection that will be scanned. The options here are based on all available collections in the specified database. This is a required field.
  • Max Depth: This is the number of sub-docs deep that will be scanned. By default this option is 0, which will recursively traverse and scan all documents in the collection. If you have a very deeply nested object structure, consider changing this value to limit the documents to be scanned. This is a required field.
  • Limit: This will limit the number of documents scanned. If you have a really large collection, this is useful to speed up your scan and drill down to only the data you care about. By default, unless a sort is applied, this will analyze the newest documents in the collection up to that limit. This is a required field.
  • Query: This will allow you to analyze a subset of documents. This takes a standard Mongo query object and filters the documents before scanning. This is not a required field, and will not filter any documents if not provided.
query = {'someValue':true}
  • Sort: This will allow you to scan documents in an order other than creation order. This takes a standard Mongo sort and if not supplied will sort on creation order. This is not a required field.
sort = { updated_at : -1 }
  • SlaveOk: This will allow the scan to read from secondary if necessary.

If you have any further questions about scans feel free to let us know by sending a ticket to!