Struct rustis::commands::TsAddOptions

pub struct TsAddOptions { /* private fields */ }

Available on crate feature redis-time-series only.

Options for the ts_add command.

Notes

• You can use this command to add data to a nonexisting time series in a single command. This is why retention, encoding, chunk_size, on_duplicate, and labels are optional arguments.
• Setting retention and labels introduces additional time complexity.

Implementations

impl TsAddOptions

pub fn retention(self, retention_period: u64) -> Self

maximum retention period, compared to the maximum existing 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.

pub fn encoding(self, encoding: TsEncoding) -> Self

specifies the series sample’s encoding format.

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.

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.

pub fn on_duplicate(self, policy: TsDuplicatePolicy) -> Self

overwrite key and database configuration for DUPLICATE_POLICY

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.

The ts_mget, ts_mrange, and ts_mrevrange commands operate on multiple time series based on their labels. The ts_queryindex command returns all time series keys matching a given filter based on their labels.

Trait Implementations

impl Default for TsAddOptions

fn default() -> TsAddOptions

Returns the “default value” for a type.

impl ToArgs for TsAddOptions

fn write_args(&self, args: &mut CommandArgs)

Write this Rust type as one ore multiple args into CommandArgs.

fn num_args(&self) -> usize

Number arguments generated by this Rust type