-
Type: Spec Change
-
Resolution: Done
-
Priority: Major - P3
-
None
-
Component/s: Change Streams, CRUD, Index Management, listCollections, listDatabases, listIndexes
-
None
Summary
This change allows users to specify a 'comment' field. The 'comment' has to be a top level field and can be of any type. The 'comment' field will be visible in profiler, logs and $currentOp for that command.
Note that some commands (like find, aggregate) previously supported 'comment' field. But they could only be a string. With this change, the comment can be any valid BSON object. This will require changing the existing docs and possibly the drivers.
Motivation
Cast of Characters
Lead:
 Author:
 POCs:
 Product Owner:
 Â
Documentation
Â
[Scope Document]
[Spec Document]
- causes
-
DRIVERS-2290 No error raised for bulkWrite with comment on <= 3.2
- Closed
- depends on
-
SERVER-29794 Adding a comment to all commands
- Closed
- is related to
-
DRIVERS-2192 Fix comment helper specification tests
- Closed
-
DRIVERS-2243 Inherited comment causes OperationFailure on MongoDB <4.4.0
- Closed
-
DRIVERS-2178 Remove redundant command docs and examples for find, getMore, and killCursors
- Closed
-
DRIVERS-2244 Test getMore with comment on all topologies
- Closed
-
DRIVERS-2685 Add unified spec tests for comments with index operations
- Backlog
-
CSHARP-1541 Add support for $comment for profiling
- Closed
-
DRIVERS-2189 getMore helper should explicitly send inherited comment
- Closed
- related to
-
GODRIVER-2063 Comment field is missing
- Closed
-
DRIVERS-2634 Add tests to verify Comment option is applied in index management commands
- Backlog
-
JAVA-4537 Consider grouping update and replace bulk operations
- Backlog
-
DRIVERS-2237 Fix find-comment specs
- Closed
-
DRIVERS-2351 Support comment option for GridFS APIs
- Backlog
-
DRIVERS-2334 Add comment option tests for distinct helper
- Closed
-
DRIVERS-2270 Use $$unsetOrMatches for upsert and multi in update command expectations
- Implementing
- split to
-
JAVA-4369 Add support for the comment field to all helpers
- Closed
-
NODE-3699 Add support for the comment field to all helpers
- Closed
-
PHPC-2049 BulkWrite and Query support comment option of any type
- Closed
-
PHPLIB-749 Support comment option on command helpers
- Closed
-
PYTHON-2682 Add support for the comment field to all helpers
- Closed
-
CDRIVER-4199 Add support for the comment field to all helpers
- Closed
-
CSHARP-3929 Add support for the comment field to all helpers
- Closed
-
CXX-2400 Add support for the comment field to all helpers
- Closed
-
GODRIVER-2199 Add support for the comment field to all helpers
- Closed
-
MOTOR-843 Add support for the comment field to all helpers
- Closed
-
RUBY-2822 Add support for the comment field to all helpers
- Closed
-
RUST-1071 Add support for the comment field to all helpers
- Closed
- mentioned in
-
Page Loading...