[DOCS-14492] Investigate changes in SERVER-56934: Improve collMod API for time-series expireAfterSeconds Created: 24/May/21  Updated: 13/Nov/23  Resolved: 30/Sep/21

Status: Closed
Project: Documentation
Component/s: manual, Server
Affects Version/s: None
Fix Version/s: 5.0.0-rc0, 5.1.0-rc0, Server_Docs_20231030, Server_Docs_20231106, Server_Docs_20231105, Server_Docs_20231113

Type: Task Priority: Major - P3
Reporter: Backlog - Core Eng Program Management Team Assignee: Naomi Pentrel (Inactive)
Resolution: Gone away Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Backports
Documented
documents SERVER-56934 Improve collMod API for time-series e... Closed
Participants:
Days since reply: 2 years, 18 weeks, 6 days ago
Epic Link: DOCSP-14300

 Description   

Description

Downstream Change Summary

For time-series collections, the `expireAfterSeconds` options is now specified as a part of the top-level collection options, rather than being nested inside the `timeseries` subobject. i.e.

{create: "coll", timeseries:

Unknown macro: {timeField}

, expireAfterSeconds: 10}

When manually creating a time-series buckets collection, the `clusteredIndex` option now takes a boolean, rather than an object. i.e.

Unknown macro: {create}

When using collMod to change the `expireAfterSeconds` of a time-series collection, `expireAfterSeconds` is now a top-level option and the previous `clusteredIndex` option has been removed. i.e.

Unknown macro: {collMod}

Description of Linked Ticket

The API for specifying TTL on a time-series collection looks like this:

db.createCollection('ts', {timeseries: {timeField: 't', expireAfterSeconds: 3600}}); 

However, to change the "expireAfterSeconds" value, users have to specify a completely different "clusteredIndex" option:

db.runCommand({collMod: 'ts', clusteredIndex: {expireAfterSeconds: 10}}) 

This is confusing and we should make the API consistent between operations.

Scope of changes

Impact to Other Docs

MVP (Work and Date)

Resources (Scope or Design Docs, Invision, etc.)



 Comments   
Comment by Naomi Pentrel (Inactive) [ 30/Sep/21 ]

Already addressed in the documetnation

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