[DRIVERS-742] Add support for the comment field to all helpers Created: 24/Sep/19  Updated: 26/Jul/23  Resolved: 30/Sep/22

Status: Closed
Project: Drivers
Component/s: Change Streams, CRUD, Index Management, listCollections, listDatabases, listIndexes
Fix Version/s: None

Type: Spec Change Priority: Major - P3
Reporter: Backlog - Core Eng Program Management Team Assignee: Dmitry Rybakov
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Depends
depends on SERVER-29794 Adding a comment to all commands Closed
Issue split
split to JAVA-4369 Add support for the comment field to ... Closed
split to NODE-3699 Add support for the comment field to ... Closed
split to PHPC-2049 BulkWrite and Query support comment o... Closed
split to PHPLIB-749 Support comment option on command hel... Closed
split to PYTHON-2682 Add support for the comment field to ... Closed
split to CDRIVER-4199 Add support for the comment field to ... Closed
split to CSHARP-3929 Add support for the comment field to ... Closed
split to CXX-2400 Add support for the comment field to ... Closed
split to GODRIVER-2199 Add support for the comment field to ... Closed
split to MOTOR-843 Add support for the comment field to ... Closed
split to RUBY-2822 Add support for the comment field to ... Closed
split to RUST-1071 Add support for the comment field to ... Closed
Problem/Incident
causes DRIVERS-2290 No error raised for bulkWrite with co... Closed
Related
related to GODRIVER-2063 Comment field is missing Closed
related to DRIVERS-2634 Add tests to verify Comment option is... Backlog
related to JAVA-4537 Consider grouping update and replace ... Backlog
related to DRIVERS-2237 Fix find-comment specs Closed
related to DRIVERS-2351 Support comment option for GridFS APIs Backlog
related to DRIVERS-2334 Add comment option tests for distinct... Closed
related to DRIVERS-2270 Use $$unsetOrMatches for upsert and m... Implementing
is related to DRIVERS-2192 Fix comment helper specification tests Closed
is related to DRIVERS-2243 Inherited comment causes OperationFai... Closed
is related to DRIVERS-2178 Remove redundant command docs and exa... Closed
is related to DRIVERS-2244 Test getMore with comment on all topo... Closed
is related to DRIVERS-2685 Add unified spec tests for comments w... Backlog
is related to CSHARP-1541 Add support for $comment for profiling Closed
is related to DRIVERS-2189 getMore helper should explicitly send... Closed
Driver Changes: Needed
Server Compat: 4.3
Quarter: FY22Q4
Upstream Changes Summary:

This change allows users to specific '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.

Downstream Changes Summary:

Drivers should add a new comment option to crud, change streams, index management, list databases and collection helper methods and add corresponding unified spec tests from mongodb/specifications@962fb5f.

Case:
Driver Compliance:
Key Status/Resolution FixVersion
CDRIVER-4199 Fixed 1.22.0, 1.22.0-beta0
CXX-2400 Fixed 3.7.0
CSHARP-3929 Duplicate
GODRIVER-2199 Done
JAVA-4369 Fixed 4.6.0
NODE-3699 Fixed 4.5.0
PHPLIB-749 Fixed 1.13.0-beta1, 1.13.0
MOTOR-843 Fixed 3.0
RUBY-2822 Fixed 2.18.0
RUST-1071 Fixed 2.4.0
SWIFT-1385 Fixed 1.4.0
PYTHON-2682 Fixed 4.1
PHPC-2049 Fixed 1.14.0-beta1, 1.14.0

 Description   
Useful Info

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]



 Comments   
Comment by Githook User [ 01/Feb/22 ]

Author:

{'name': 'Dmitry Rybakov', 'email': 'dmitry.rybakov@mongodb.com', 'username': 'comandeo'}

Message: DRIVERS-742 Add support for the comment field (#1117)
Branch: master
https://github.com/mongodb/specifications/commit/962fb5f20e9e31b528319fe245147928a3100411

Comment by Devin Hilly (Inactive) [ 02/Feb/21 ]

This is a blocker for MHOUSE-2311.

Generated at Thu Feb 08 08:22:15 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.