[SERVER-60314] Investigate adding collMod command options and response fields Created: 29/Sep/21  Updated: 29/Oct/23  Resolved: 09/Nov/21

Status: Closed
Project: Core Server
Component/s: None
Affects Version/s: None
Fix Version/s: 5.2.0

Type: Task Priority: Major - P3
Reporter: Pavithra Vetriselvan Assignee: Yuhong Zhang
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Related
related to SERVER-60312 [POC] use collMod to change a non-uni... Closed
Backwards Compatibility: Fully Compatible
Sprint: Execution Team 2021-10-04, Execution Team 2021-10-18, Execution Team 2021-11-01, Execution Team 2021-11-15
Participants:

 Description   

Ideally, we would like to add fields to the collMod command as well as the response. However, we do not want any new options to be a part of API Version 1.

The collMod IDL currently uses "strict: true," so we should investigate how to add these new options/response fields. Perhaps, we should be using the "unstable" keyword?



 Comments   
Comment by Githook User [ 08/Nov/21 ]

Author:

{'name': 'Yuhong Zhang', 'email': 'danielzhangyh@gmail.com', 'username': 'YuhongZhang98'}

Message: SERVER-60314 Exclude collMod unique options from API V1
Branch: master
https://github.com/mongodb/mongo/commit/4944ff5e88a3bd9f1b884d8473a5fb41c71f115b

Comment by Yuhong Zhang [ 04/Oct/21 ]

Using the "unstable" keyword for the new command option indicates "an undocumented, unstable parameter of the command, and we will permit incompatible changes to it" according to the Versioned API design.

Not being a part of API v1, the new unstable option:

  1. can be used along with "--apiVersion 1" which allows non-api-v1 commands and options as well.
  2. cannot be used with "--apiVersion 1 --apiStrict" which only permit api-v1 commands and options.
  3. can be used if no api versions are specified.

PM-1804 built and enabled an automated testing process for any idl changes of the commands in API v1, so no extra tests will be needed. 

Note when backported to earlier versions than 5.0, "unstable" will need to be removed as Versioned API was not introduced back then and the keyword cannot be parsed.

Generated at Thu Feb 08 05:49:29 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.