summaryrefslogtreecommitdiff
path: root/src/mongo/db/coll_mod.idl
diff options
context:
space:
mode:
authorBenety Goh <benety@mongodb.com>2021-11-11 20:38:01 -0500
committerEvergreen Agent <no-reply@evergreen.mongodb.com>2021-11-12 02:04:13 +0000
commit8289d8a886a1926156e19314f2f68badd1dbc754 (patch)
tree1aa74084f0ef863f723ed39184e3c96999a2a0c3 /src/mongo/db/coll_mod.idl
parentde455570170e4e1c568a6c91bff8d317af141e41 (diff)
downloadmongo-8289d8a886a1926156e19314f2f68badd1dbc754.tar.gz
SERVER-61160 add dryRun to collMod request
This option directs collMod to attempt the requested modification without actually updating the database state. At this time, support is limited to the unique index conversion option.
Diffstat (limited to 'src/mongo/db/coll_mod.idl')
-rw-r--r--src/mongo/db/coll_mod.idl7
1 files changed, 7 insertions, 0 deletions
diff --git a/src/mongo/db/coll_mod.idl b/src/mongo/db/coll_mod.idl
index 90edf38c9dc..f9152f731a0 100644
--- a/src/mongo/db/coll_mod.idl
+++ b/src/mongo/db/coll_mod.idl
@@ -166,4 +166,11 @@ commands:
time-series buckets namespace before being sent to shards."
optional: true
type: bool
+ dryRun:
+ description: "Runs the requested modification without modifying any database state.
+ This can be used to determine in advance if a particular collMod
+ request can be completed without errors."
+ optional: true
+ type: safeBool
+ unstable: true
reply_type: CollModReply