Struct rustis::commands::TsIncrByDecrByOptions
source · pub struct TsIncrByDecrByOptions { /* private fields */ }
redis-time-series
only.Expand description
Options for the ts_incrby
and ts_decrby
commands.
§Notes
- You can use this command to add data to a nonexisting time series in a single command.
This is why
retention
,uncompressed
,chunk_size
, andlabels
are optional arguments. - When specified and the key doesn’t exist, a new time series is created.
Setting the
retention
andlabels
options introduces additional time complexity.
Implementations§
source§impl TsIncrByDecrByOptions
impl TsIncrByDecrByOptions
sourcepub fn timestamp(self, timestamp: impl SingleArg) -> Self
pub fn timestamp(self, timestamp: impl SingleArg) -> Self
is (integer) UNIX sample timestamp in milliseconds or * to set the timestamp according to the server clock.
timestamp must be equal to or higher than the maximum existing timestamp. When equal, the value of the sample with the maximum existing timestamp is decreased. If it is higher, a new sample with a timestamp set to timestamp is created, and its value is set to the value of the sample with the maximum existing timestamp minus value.
If the time series is empty, the value is set to value.
When not specified, the timestamp is set according to the server clock.
sourcepub fn retention(self, retention_period: u64) -> Self
pub fn retention(self, retention_period: u64) -> Self
maximum age for samples compared to the highest reported timestamp, in milliseconds.
Use it only if you are creating a new time series. It is ignored if you are adding samples to an existing time series
See retention
.
sourcepub fn uncompressed(self) -> Self
pub fn uncompressed(self) -> Self
changes data storage from compressed (default) to uncompressed.
Use it only if you are creating a new time series.
It is ignored if you are adding samples to an existing time series.
See encoding
.
sourcepub fn chunk_size(self, chunk_size: usize) -> Self
pub fn chunk_size(self, chunk_size: usize) -> Self
memory size, in bytes, allocated for each data chunk.
Use it only if you are creating a new time series.
It is ignored if you are adding samples to an existing time series.
See chunk_size
.
sourcepub fn labels<L: SingleArg, V: SingleArg, LL: KeyValueArgsCollection<L, V>>(
self,
labels: LL
) -> Self
pub fn labels<L: SingleArg, V: SingleArg, LL: KeyValueArgsCollection<L, V>>( self, labels: LL ) -> Self
set of label-value pairs that represent metadata labels of the time series.
Use it only if you are creating a new time series.
It is ignored if you are adding samples to an existing time series.
See labels
.