Skip to content

Commit d67fb49

Browse files
qingyang-huqingyang-hu
committed
update comments
1 parent 0f8c6bd commit d67fb49

3 files changed

Lines changed: 54 additions & 36 deletions

File tree

‎source/crud/bulk-write.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -310,9 +310,10 @@ class BulkWriteOptions {
310310
comment: Optional<BSON value>;
311311

312312
/**
313-
* This option allows operations to function on the bucket-level data while accessing the primary namespace (not system.buckets).
313+
* This option MAY be implemented by drivers that need to grant access to underlying namespaces
314+
* for time-series collections. Drivers SHOULD NOT implement this option unless asked to do so.
314315
*
315-
* @note This option will not be sent when connected to pre-9.0 servers.
316+
* @note This option MUST NOT be sent when connected to pre-8.2 servers.
316317
*
317318
* @since MongoDB 8.2
318319
*/

‎source/crud/crud.md‎

Lines changed: 42 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -321,9 +321,10 @@ class AggregateOptions {
321321
let: Optional<Document>;
322322
323323
/**
324-
* This option allows operations to function on the bucket-level data while accessing the primary namespace (not system.buckets).
324+
* This option MAY be implemented by drivers that need to grant access to underlying namespaces
325+
* for time-series collections. Drivers SHOULD NOT implement this option unless asked to do so.
325326
*
326-
* @note This option will not be sent when connected to pre-9.0 servers.
327+
* @note This option MUST NOT be sent when connected to pre-8.2 servers.
327328
*
328329
* @since MongoDB 8.2
329330
*/
@@ -382,9 +383,10 @@ class CountOptions {
382383
comment: Optional<any>;
383384
384385
/**
385-
* This option allows operations to function on the bucket-level data while accessing the primary namespace (not system.buckets).
386+
* This option MAY be implemented by drivers that need to grant access to underlying namespaces
387+
* for time-series collections. Drivers SHOULD NOT implement this option unless asked to do so.
386388
*
387-
* @note This option will not be sent when connected to pre-9.0 servers.
389+
* @note This option MUST NOT be sent when connected to pre-8.2 servers.
388390
*
389391
* @since MongoDB 8.2
390392
*/
@@ -415,9 +417,10 @@ class EstimatedDocumentCountOptions {
415417
comment: Optional<any>;
416418
417419
/**
418-
* This option allows operations to function on the bucket-level data while accessing the primary namespace (not system.buckets).
420+
* This option MAY be implemented by drivers that need to grant access to underlying namespaces
421+
* for time-series collections. Drivers SHOULD NOT implement this option unless asked to do so.
419422
*
420-
* @note This option will not be sent when connected to pre-9.0 servers.
423+
* @note This option MUST NOT be sent when connected to pre-8.2 servers.
421424
*
422425
* @since MongoDB 8.2
423426
*/
@@ -468,9 +471,10 @@ class DistinctOptions {
468471
hint: Optional<(String | Document)>;
469472
470473
/**
471-
* This option allows operations to function on the bucket-level data while accessing the primary namespace (not system.buckets).
474+
* This option MAY be implemented by drivers that need to grant access to underlying namespaces
475+
* for time-series collections. Drivers SHOULD NOT implement this option unless asked to do so.
472476
*
473-
* @note This option will not be sent when connected to pre-9.0 servers.
477+
* @note This option MUST NOT be sent when connected to pre-8.2 servers.
474478
*
475479
* @since MongoDB 8.2
476480
*/
@@ -751,9 +755,10 @@ class FindOptions {
751755
let: Optional<Document>;
752756
753757
/**
754-
* This option allows operations to function on the bucket-level data while accessing the primary namespace (not system.buckets).
758+
* This option MAY be implemented by drivers that need to grant access to underlying namespaces
759+
* for time-series collections. Drivers SHOULD NOT implement this option unless asked to do so.
755760
*
756-
* @note This option will not be sent when connected to pre-9.0 servers.
761+
* @note This option MUST NOT be sent when connected to pre-8.2 servers.
757762
*
758763
* @since MongoDB 8.2
759764
*/
@@ -1032,9 +1037,10 @@ class BulkWriteOptions {
10321037
let: Optional<Document>;
10331038

10341039
/**
1035-
* This option allows operations to function on the bucket-level data while accessing the primary namespace (not system.buckets).
1040+
* This option MAY be implemented by drivers that need to grant access to underlying namespaces
1041+
* for time-series collections. Drivers SHOULD NOT implement this option unless asked to do so.
10361042
*
1037-
* @note This option will not be sent when connected to pre-9.0 servers.
1043+
* @note This option MUST NOT be sent when connected to pre-8.2 servers.
10381044
*
10391045
* @since MongoDB 8.2
10401046
*/
@@ -1063,9 +1069,10 @@ class InsertOneOptions {
10631069
comment: Optional<any>;
10641070

10651071
/**
1066-
* This option allows operations to function on the bucket-level data while accessing the primary namespace (not system.buckets).
1072+
* This option MAY be implemented by drivers that need to grant access to underlying namespaces
1073+
* for time-series collections. Drivers SHOULD NOT implement this option unless asked to do so.
10671074
*
1068-
* @note This option will not be sent when connected to pre-9.0 servers.
1075+
* @note This option MUST NOT be sent when connected to pre-8.2 servers.
10691076
*
10701077
* @since MongoDB 8.2
10711078
*/
@@ -1101,9 +1108,10 @@ class InsertManyOptions {
11011108
comment: Optional<any>;
11021109

11031110
/**
1104-
* This option allows operations to function on the bucket-level data while accessing the primary namespace (not system.buckets).
1111+
* This option MAY be implemented by drivers that need to grant access to underlying namespaces
1112+
* for time-series collections. Drivers SHOULD NOT implement this option unless asked to do so.
11051113
*
1106-
* @note This option will not be sent when connected to pre-9.0 servers.
1114+
* @note This option MUST NOT be sent when connected to pre-8.2 servers.
11071115
*
11081116
* @since MongoDB 8.2
11091117
*/
@@ -1201,9 +1209,10 @@ class UpdateOptions {
12011209
sort: Optional<Document>;
12021210

12031211
/**
1204-
* This option allows operations to function on the bucket-level data while accessing the primary namespace (not system.buckets).
1212+
* This option MAY be implemented by drivers that need to grant access to underlying namespaces
1213+
* for time-series collections. Drivers SHOULD NOT implement this option unless asked to do so.
12051214
*
1206-
* @note This option will not be sent when connected to pre-9.0 servers.
1215+
* @note This option MUST NOT be sent when connected to pre-8.2 servers.
12071216
*
12081217
* @since MongoDB 8.2
12091218
*/
@@ -1289,9 +1298,10 @@ class ReplaceOptions {
12891298
sort: Optional<Document>;
12901299

12911300
/**
1292-
* This option allows operations to function on the bucket-level data while accessing the primary namespace (not system.buckets).
1301+
* This option MAY be implemented by drivers that need to grant access to underlying namespaces
1302+
* for time-series collections. Drivers SHOULD NOT implement this option unless asked to do so.
12931303
*
1294-
* @note This option will not be sent when connected to pre-9.0 servers.
1304+
* @note This option MUST NOT be sent when connected to pre-8.2 servers.
12951305
*
12961306
* @since MongoDB 8.2
12971307
*/
@@ -1348,9 +1358,10 @@ class DeleteOptions {
13481358
comment: Optional<any>;
13491359

13501360
/**
1351-
* This option allows operations to function on the bucket-level data while accessing the primary namespace (not system.buckets).
1361+
* This option MAY be implemented by drivers that need to grant access to underlying namespaces
1362+
* for time-series collections. Drivers SHOULD NOT implement this option unless asked to do so.
13521363
*
1353-
* @note This option will not be sent when connected to pre-9.0 servers.
1364+
* @note This option MUST NOT be sent when connected to pre-8.2 servers.
13541365
*
13551366
* @since MongoDB 8.2
13561367
*/
@@ -2110,9 +2121,10 @@ class FindOneAndDeleteOptions {
21102121
comment: Optional<any>;
21112122

21122123
/**
2113-
* This option allows operations to function on the bucket-level data while accessing the primary namespace (not system.buckets).
2124+
* This option MAY be implemented by drivers that need to grant access to underlying namespaces
2125+
* for time-series collections. Drivers SHOULD NOT implement this option unless asked to do so.
21142126
*
2115-
* @note This option will not be sent when connected to pre-9.0 servers.
2127+
* @note This option MUST NOT be sent when connected to pre-8.2 servers.
21162128
*
21172129
* @since MongoDB 8.2
21182130
*/
@@ -2227,9 +2239,10 @@ class FindOneAndReplaceOptions {
22272239
comment: Optional<any>;
22282240

22292241
/**
2230-
* This option allows operations to function on the bucket-level data while accessing the primary namespace (not system.buckets).
2242+
* This option MAY be implemented by drivers that need to grant access to underlying namespaces
2243+
* for time-series collections. Drivers SHOULD NOT implement this option unless asked to do so.
22312244
*
2232-
* @note This option will not be sent when connected to pre-9.0 servers.
2245+
* @note This option MUST NOT be sent when connected to pre-8.2 servers.
22332246
*
22342247
* @since MongoDB 8.2
22352248
*/
@@ -2353,9 +2366,10 @@ class FindOneAndUpdateOptions {
23532366
comment: Optional<any>;
23542367

23552368
/**
2356-
* This option allows operations to function on the bucket-level data while accessing the primary namespace (not system.buckets).
2369+
* This option MAY be implemented by drivers that need to grant access to underlying namespaces
2370+
* for time-series collections. Drivers SHOULD NOT implement this option unless asked to do so.
23572371
*
2358-
* @note This option will not be sent when connected to pre-9.0 servers.
2372+
* @note This option MUST NOT be sent when connected to pre-8.2 servers.
23592373
*
23602374
* @since MongoDB 8.2
23612375
*/

‎source/index-management/index-management.md‎

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -215,9 +215,10 @@ interface CreateIndexOptions {
215215
maxTimeMS: Optional<Int64>;
216216

217217
/**
218-
* This option allows operations to function on the bucket-level data while accessing the primary namespace (not system.buckets).
218+
* This option MAY be implemented by drivers that need to grant access to underlying namespaces
219+
* for time-series collections. Drivers SHOULD NOT implement this option unless asked to do so.
219220
*
220-
* @note This option will not be sent when connected to pre-9.0 servers.
221+
* @note This option MUST NOT be sent when connected to pre-8.2 servers.
221222
*
222223
* @since MongoDB 8.2
223224
*/
@@ -247,9 +248,10 @@ interface DropIndexOptions {
247248
maxTimeMS: Optional<Int64>;
248249

249250
/**
250-
* This option allows operations to function on the bucket-level data while accessing the primary namespace (not system.buckets).
251+
* This option MAY be implemented by drivers that need to grant access to underlying namespaces
252+
* for time-series collections. Drivers SHOULD NOT implement this option unless asked to do so.
251253
*
252-
* @note This option will not be sent when connected to pre-9.0 servers.
254+
* @note This option MUST NOT be sent when connected to pre-8.2 servers.
253255
*
254256
* @since MongoDB 8.2
255257
*/
@@ -823,9 +825,10 @@ interface ListIndexesOptions {
823825
batchSize: Optional<Int32>;
824826

825827
/**
826-
* This option allows operations to function on the bucket-level data while accessing the primary namespace (not system.buckets).
828+
* This option MAY be implemented by drivers that need to grant access to underlying namespaces
829+
* for time-series collections. Drivers SHOULD NOT implement this option unless asked to do so.
827830
*
828-
* @note This option will not be sent when connected to pre-9.0 servers.
831+
* @note This option MUST NOT be sent when connected to pre-8.2 servers.
829832
*
830833
* @since MongoDB 8.2
831834
*/

0 commit comments

Comments
 (0)