Skip to content

Commit 1081a74

Browse files
authored
DOCSP-27956 Add bucketMaxSpanSeconds and bucketRoundingSeconds (#463)
* DOCSP-27956 Add bucketMaxSpanSeconds and bucketRounding Seconds * fix build error * fix manual links * change ref text * JA edits * JA edits pt 2 * HS suggestions
1 parent e1e59d9 commit 1081a74

File tree

1 file changed

+33
-9
lines changed

1 file changed

+33
-9
lines changed

source/collections/time-series-collection.txt

Lines changed: 33 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -41,29 +41,53 @@ Procedure
4141

4242
.. list-table::
4343
:header-rows: 1
44-
:widths: 50 50
44+
:widths: 20 20 60
4545

4646
* - Field
47+
- Type
4748
- Description
4849

4950
* - ``metaField``
50-
- The name of the field which contains metadata in each time series
51+
- string
52+
- The name of the field that contains metadata in each time series
5153
document. The metadata in the specified field should be data that
5254
is used to label a unique series of documents.
5355

5456
* - ``granularity``
55-
- The ``granularity`` field allows specifying a coarser granularity so
56-
measurements over a longer time span can be more efficiently stored
57-
and queried.
57+
- string
58+
- Specifies a coarser granularity so measurements over a
59+
longer time span can be more efficiently stored and queried.
5860

59-
The default value is set to ``seconds``.
61+
The default value is ``"seconds"``.
62+
63+
If you set the ``granularity`` parameter, you can't set the
64+
``bucketMaxSpanSeconds`` and ``bucketRoundingSeconds`` parameters.
6065

6166
* - ``expireAfterSeconds``
62-
- The ``expireAfterSeconds`` field enables automatic deletion of
63-
documents older than the specified number of seconds.
67+
- number
68+
- Enables the automatic deletion of documents that are older than
69+
the specified number of seconds.
70+
71+
* - ``bucketMaxSpanSeconds``
72+
- number
73+
- Specifies the maximum time span between measurements in a bucket.
74+
75+
The value of ``bucketMaxSpanSeconds`` must be the same as
76+
``bucketRoundingSeconds``. If you set the ``bucketMaxSpanSeconds``,
77+
parameter, you can't set the ``granularity`` parameter.
78+
79+
* - ``bucketRoundingSeconds``
80+
- number
81+
- Specifies the time interval that determines the starting timestamp
82+
for a new bucket.
83+
84+
The value of ``bucketRoundingSeconds`` must be the same as
85+
``bucketMaxSpanSeconds``. If you set the ``bucketRoundingSeconds``,
86+
parameter, you can't set the ``granularity`` parameter.
6487

6588
For more information on time series fields, see
66-
:manual:`Time Series Collections </core/timeseries-collections/>`.
89+
:manual:`Time Series Object Fields
90+
</core/timeseries/timeseries-procedures/#timeseries-object-fields>`.
6791

6892
.. step:: Click :guilabel:`Create Collection` to create the collection.
6993

0 commit comments

Comments
 (0)