db.collection.validate()¶

On this page

Description
Syntax
Behavior
Examples

Description¶

db.collection.validate(<documents>)¶

mongo Shell Method

This page documents the mongo shell method, and does not refer to the MongoDB Node.js driver (or any other driver) method. For corresponding MongoDB driver API, refer to your specific MongoDB driver documentation instead.

Validates a collection. The method scans a collection data and indexes for correctness and returns the result. For details of the output, see Validate Output.

The db.collection.validate() method is a wrapper around the validate command.

Syntax¶

Changed in version 4.4

db.collection.validate() no longer accepts just a boolean parameter. See db.collection.validate() Parameter Change.

The db.collection.validate() method has the following syntax:

copy

db.collection.validate( {
   full: <boolean>          // Optional
} )

Parameters¶

The db.collection.validate() method can take the following optional document parameter with the fields:

Field Type Description

full

boolean

Optional. A flag that determines whether the command performs a slower but more thorough check or a faster but less thorough check.

If true, performs a more thorough check with the following exception:
- Starting in MongoDB 4.4, full validation on the oplog for WiredTiger skips the more thorough check.
If false, omits some checks for a faster but less thorough check.

The default is false.

Starting in MongoDB 3.6, for the WiredTiger storage engine, only the full validation process will force a checkpoint and flush all in-memory data to disk before verifying the on-disk data.

In previous versions, the data validation process for the WT storage engine always forces a checkpoint.

Behavior¶

The db.collection.validate() method is potentially resource intensive and may impact the performance of your MongoDB instance.

The db.collection.validate() method obtains an exclusive lock on the collection. This will block all reads and writes on the collection until the operation finishes. When run on a secondary, the operation can block all other operations on that secondary until it finishes.

The db.collection.validate() method can be slow, particularly on larger data sets.

Starting in version MongoDB 4.4,

The $currentOp and the currentOp command include dataThroughputAverage and dataThroughputLastSecond information for validate operations in progress.
The log messages for validate operations include dataThroughputAverage and dataThroughputLastSecond information.

Examples¶

To validate a collection myCollection using the default settings (i.e. { full: false )

copy

db.myCollection.validate()

db.myCollection.validate({ })

db.myCollection.validate( { full: false } )

To perform a full validation of collection myCollection, specify full: true.

copy

db.myCollection.validate( { full: true } )

For details of the output, see Validate Output.

← db.collection.watch() Cursor Methods →