DOCSP-28039 add doc for bucketMaxSpanSeconds & bucketRoundingSeconds (#81)

kanchana-mongodb · web-flow · commit 742804a93329 · 2024-02-26T09:39:29.000-08:00
diff --git a/source/time-series-collections.txt b/source/time-series-collections.txt
@@ -84,7 +84,9 @@ template.
     {
        timeseries: {
           timeField: "timestamp",
-          granularity: "hours"
+          granularity: "hours",
+          bucketMaxSpanSeconds: 60,
+          bucketRoundingSeconds: 60
        }
     }
   )
@@ -101,6 +103,12 @@ In the example:
   - ``granularity: "hours"`` defines the time scale by which the documents
     are stored. 
 
+  - ``bucketMaxSpanSeconds`` defines a maximum time span of 60 seconds
+    for each bucket.
+
+  - ``bucketRoundingSeconds`` specifies the time interval that
+    determines the starting timestamp for a new bucket. 
+
 When you press the :guilabel:`Play Button`, MongoDB for VS Code splits your 
 Playground and outputs the following result in the Playground Results.json 
 pane to confirm the creation of the time series collection. 

Original file line number	Diff line number	Diff line change
`@@ -84,7 +84,9 @@ template.`
`84`	`84`	`{`
`85`	`85`	`timeseries: {`
`86`	`86`	`timeField: "timestamp",`
`87`		`- granularity: "hours"`
	`87`	`+ granularity: "hours",`
	`88`	`+ bucketMaxSpanSeconds: 60,`
	`89`	`+ bucketRoundingSeconds: 60`
`88`	`90`	`}`
`89`	`91`	`}`
`90`	`92`	`)`
`@@ -101,6 +103,12 @@ In the example:`
`101`	`103`	- ``granularity: "hours"`` defines the time scale by which the documents
`102`	`104`	`are stored.`
`103`	`105`
	`106`	+ - ``bucketMaxSpanSeconds`` defines a maximum time span of 60 seconds
	`107`	`+ for each bucket.`
	`108`	`+`
	`109`	+ - ``bucketRoundingSeconds`` specifies the time interval that
	`110`	`+ determines the starting timestamp for a new bucket.`
	`111`	`+`
`104`	`112`	When you press the :guilabel:`Play Button`, MongoDB for VS Code splits your
`105`	`113`	`Playground and outputs the following result in the Playground Results.json`
`106`	`114`	`pane to confirm the creation of the time series collection.`