summaryrefslogtreecommitdiff
path: root/src/mongo/db/commands/validate.cpp
diff options
context:
space:
mode:
authorGregory Wlodarek <gregory.wlodarek@mongodb.com>2019-10-02 21:05:39 +0000
committerevergreen <evergreen@mongodb.com>2019-10-02 21:05:39 +0000
commit112ba53f3aed53d1ca9ae3171117007ccd6118bd (patch)
tree38c8fb873ff9c7aace85b56f0d0476ac1bd79cf5 /src/mongo/db/commands/validate.cpp
parent8621e2f2406746fee3520d8c61f523e6d3520ba5 (diff)
downloadmongo-112ba53f3aed53d1ca9ae3171117007ccd6118bd.tar.gz
SERVER-43644 Update 'validate' command help message
Diffstat (limited to 'src/mongo/db/commands/validate.cpp')
-rw-r--r--src/mongo/db/commands/validate.cpp9
1 files changed, 6 insertions, 3 deletions
diff --git a/src/mongo/db/commands/validate.cpp b/src/mongo/db/commands/validate.cpp
index 9d670291a6b..fc2b660b953 100644
--- a/src/mongo/db/commands/validate.cpp
+++ b/src/mongo/db/commands/validate.cpp
@@ -69,6 +69,7 @@ stdx::condition_variable _validationNotifier;
* {
* validate: "collectionNameWithoutTheDBPart",
* full: <bool> // If true, a more thorough (and slower) collection validation is performed.
+ * background: <bool> // If true, performs validation on the checkpoint of the collection.
* }
*/
class ValidateCmd : public BasicCommand {
@@ -80,9 +81,11 @@ public:
}
std::string help() const override {
- return "Validate contents of a namespace by scanning its data structures for correctness. "
- "Slow.\n"
- "Add full:true option to do a more thorough check";
+ return str::stream() << "Validate contents of a namespace by scanning its data structures "
+ << "for correctness.\nThis is a slow operation.\n"
+ << "\tAdd {full: true} option to do a more thorough check.\n"
+ << "\tAdd {background: true} to validate in the background.\n"
+ << "Cannot specify both {full: true, background: true}.";
}
virtual bool supportsWriteConcern(const BSONObj& cmd) const override {