diff options
author | Huayu Ouyang <huayu.ouyang@mongodb.com> | 2021-11-16 20:20:04 +0000 |
---|---|---|
committer | Evergreen Agent <no-reply@evergreen.mongodb.com> | 2021-11-22 22:17:16 +0000 |
commit | e818cd876ed3b492517400a3da3f687fbe13d8aa (patch) | |
tree | 949699278df951eadbc45da35c2ee7da424e7ff0 /src/mongo/db/pipeline/aggregate_command.idl | |
parent | 337e43030afb6de83a2e3ed25575ec8874a70d20 (diff) | |
download | mongo-e818cd876ed3b492517400a3da3f687fbe13d8aa.tar.gz |
SERVER-60814 Require 'unstable' field to avoid accidental additions to the stable API
Diffstat (limited to 'src/mongo/db/pipeline/aggregate_command.idl')
-rw-r--r-- | src/mongo/db/pipeline/aggregate_command.idl | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/src/mongo/db/pipeline/aggregate_command.idl b/src/mongo/db/pipeline/aggregate_command.idl index 41cad7e5d17..d4910565117 100644 --- a/src/mongo/db/pipeline/aggregate_command.idl +++ b/src/mongo/db/pipeline/aggregate_command.idl @@ -135,6 +135,7 @@ commands: pipeline: description: "An unparsed version of the pipeline." type: pipeline + unstable: false explain: description: "Specifies to return the information on the processing of the pipeline." type: explainVerbosity @@ -143,45 +144,56 @@ commands: allowDiskUse: description: "Enables writing to temporary files." type: optionalBool + unstable: false cursor: description: "To indicate a cursor with a non-default batch size." type: aggregateCursor default: SimpleCursorOptions() + unstable: false maxTimeMS: description: "Specifies a time limit in milliseconds for processing operations on a cursor. If you do not specify a value for maxTimeMS, operations will not time out." type: safeInt64 validator: { gte: 0 } optional: true + unstable: false bypassDocumentValidation: description: "True if this should bypass the document validation." type: safeBool optional: true + unstable: false readConcern: description: "Specifies the read concern." type: object_owned optional: true + unstable: false collation: description: "Specifies the collation to use for the operation." type: object_owned optional: true + unstable: false hint: description: "The index name to use or the index specification document." type: indexHint optional: true + unstable: false writeConcern: description: "A document that expresses the write concern to use with the $out or $merge stage." type: WriteConcern optional: true + unstable: false let: description: "A document containing user-specified let parameter constants; i.e. values that do not change once computed." type: object_owned optional: true + unstable: false needsMerge: description: "True if this request represents the shards part of a split pipeline, and should produce mergeable output." type: optionalBool + unstable: false fromMongos: description: "True if this request originated from a mongoS." type: optionalBool + unstable: false $queryOptions: description: "The unwrapped readPreference object, if one was given to us by the mongos command processor. This object will be empty when no readPreference is specified or if the request does not originate from mongos." cpp_name: unwrappedReadPref @@ -197,6 +209,7 @@ commands: description: "An optional exchange specification for this request. If set it means that the request represents a producer running as a part of the exchange machinery. This is an internal option; we do not expect it to be set on requests from users or drivers." type: ExchangeSpec optional: true + unstable: false runtimeConstants: description: "A legacy way to specify constant variables available during execution. 'let' is now preferred." type: LegacyRuntimeConstants |