io.valkey.timeseries

Interface RedisTimeSeriesCommands

All Known Subinterfaces:

RedisModuleCommands

All Known Implementing Classes:

JedisCluster, JedisPooled, JedisSentineled, JedisSharding, UnifiedJedis

public interface RedisTimeSeriesCommands

Method Summary

Modifier and Type	Method and Description
long	tsAdd(String key, double value) TS.ADD key * value
long	tsAdd(String key, long timestamp, double value) TS.ADD key timestamp value
long	tsAdd(String key, long timestamp, double value, TSCreateParams createParams) TS.ADD key timestamp value [RETENTION retentionTime] [ENCODING [COMPRESSED|UNCOMPRESSED]] [CHUNK_SIZE size] [ON_DUPLICATE policy] [LABELS label value..]
String	tsAlter(String key, TSAlterParams alterParams) TS.ALTER key [RETENTION retentionTime] [LABELS label value..]
String	tsCreate(String key) TS.CREATE key
String	tsCreate(String key, TSCreateParams createParams) TS.CREATE key [RETENTION retentionTime] [ENCODING [UNCOMPRESSED|COMPRESSED]] [CHUNK_SIZE size] [DUPLICATE_POLICY policy] [LABELS label value..]
String	tsCreateRule(String sourceKey, String destKey, AggregationType aggregationType, long timeBucket) TS.CREATERULE sourceKey destKey AGGREGATION aggregationType timeBucket
String	tsCreateRule(String sourceKey, String destKey, AggregationType aggregationType, long bucketDuration, long alignTimestamp) TS.CREATERULE sourceKey destKey AGGREGATION aggregationType bucketDuration [alignTimestamp]
long	tsDecrBy(String key, double value)
long	tsDecrBy(String key, double value, long timestamp)
long	tsDel(String key, long fromTimestamp, long toTimestamp) TS.DEL key fromTimestamp toTimestamp
String	tsDeleteRule(String sourceKey, String destKey) TS.DELETERULE sourceKey destKey
TSElement	tsGet(String key) TS.GET key
TSElement	tsGet(String key, TSGetParams getParams) TS.GET key [LATEST]
long	tsIncrBy(String key, double value)
long	tsIncrBy(String key, double value, long timestamp)
TSInfo	tsInfo(String key)
TSInfo	tsInfoDebug(String key)
List<Long>	tsMAdd(Map.Entry<String,TSElement>... entries) TS.MADD key timestamp value [key timestamp value ...]
Map<String,TSMGetElement>	tsMGet(TSMGetParams multiGetParams, String... filters) TS.MGET [LATEST] [ WITHLABELS | SELECTED_LABELS label...] FILTER filter...
Map<String,TSMRangeElements>	tsMRange(long fromTimestamp, long toTimestamp, String... filters) TS.MRANGE fromTimestamp toTimestamp FILTER filter...
Map<String,TSMRangeElements>	tsMRange(TSMRangeParams multiRangeParams) {@code TS.MRANGE fromTimestamp toTimestamp [LATEST] [FILTER_BY_TS ts...] [FILTER_BY_VALUE min max] [WITHLABELS | SELECTED_LABELS label...] [COUNT count] [[ALIGN value] AGGREGATION aggregator bucketDuration [BUCKETTIMESTAMP bt] [EMPTY]] FILTER filter...
Map<String,TSMRangeElements>	tsMRevRange(long fromTimestamp, long toTimestamp, String... filters) TS.MREVRANGE fromTimestamp toTimestamp FILTER filter...
Map<String,TSMRangeElements>	tsMRevRange(TSMRangeParams multiRangeParams) {@code TS.MREVRANGE fromTimestamp toTimestamp [LATEST] [FILTER_BY_TS TS...] [FILTER_BY_VALUE min max] [WITHLABELS | SELECTED_LABELS label...] [COUNT count] [[ALIGN value] AGGREGATION aggregator bucketDuration [BUCKETTIMESTAMP bt] [EMPTY]] FILTER filter...
List<String>	tsQueryIndex(String... filters) TS.QUERYINDEX filter...
List<TSElement>	tsRange(String key, long fromTimestamp, long toTimestamp) TS.RANGE key fromTimestamp toTimestamp
List<TSElement>	tsRange(String key, TSRangeParams rangeParams) TS.RANGE key fromTimestamp toTimestamp [LATEST] [FILTER_BY_TS ts...] [FILTER_BY_VALUE min max] [COUNT count] [[ALIGN value] AGGREGATION aggregator bucketDuration [BUCKETTIMESTAMP bt] [EMPTY]]
List<TSElement>	tsRevRange(String key, long fromTimestamp, long toTimestamp) TS.REVRANGE key fromTimestamp toTimestamp
List<TSElement>	tsRevRange(String key, TSRangeParams rangeParams) TS.REVRANGE key fromTimestamp toTimestamp [LATEST] [FILTER_BY_TS TS...] [FILTER_BY_VALUE min max] [COUNT count] [[ALIGN value] AGGREGATION aggregator bucketDuration [BUCKETTIMESTAMP bt] [EMPTY]]

Method Detail

tsCreate

String tsCreate(String key)

TS.CREATE key

Parameters:

key -

tsCreate

String tsCreate(String key,
                TSCreateParams createParams)

TS.CREATE key [RETENTION retentionTime] [ENCODING [UNCOMPRESSED|COMPRESSED]] [CHUNK_SIZE size] [DUPLICATE_POLICY policy] [LABELS label value..]

Parameters:

key -

createParams -

tsDel

long tsDel(String key,
           long fromTimestamp,
           long toTimestamp)

TS.DEL key fromTimestamp toTimestamp

Parameters:

key -

fromTimestamp -

toTimestamp -

Returns:

The number of samples that were removed

tsAlter

String tsAlter(String key,
               TSAlterParams alterParams)

TS.ALTER key [RETENTION retentionTime] [LABELS label value..]

Parameters:

key -

alterParams -

Returns:

OK

tsAdd

long tsAdd(String key,
           double value)

TS.ADD key * value

Parameters:

key -

value -

Returns:

timestamp

tsAdd

long tsAdd(String key,
           long timestamp,
           double value)

TS.ADD key timestamp value

Parameters:

key -

timestamp -

value -

Returns:

timestamp

tsAdd

long tsAdd(String key,
           long timestamp,
           double value,
           TSCreateParams createParams)

TS.ADD key timestamp value [RETENTION retentionTime] [ENCODING [COMPRESSED|UNCOMPRESSED]] [CHUNK_SIZE size] [ON_DUPLICATE policy] [LABELS label value..]

Parameters:

key -

timestamp -

value -

createParams -

Returns:

timestamp

tsMAdd

List<Long> tsMAdd(Map.Entry<String,TSElement>... entries)

TS.MADD key timestamp value [key timestamp value ...]

Parameters:

entries - key, timestamp, value

Returns:

timestamps

tsIncrBy

long tsIncrBy(String key,
              double value)

tsIncrBy

long tsIncrBy(String key,
              double value,
              long timestamp)

tsDecrBy

long tsDecrBy(String key,
              double value)

tsDecrBy

long tsDecrBy(String key,
              double value,
              long timestamp)

tsRange

List<TSElement> tsRange(String key,
                        long fromTimestamp,
                        long toTimestamp)

TS.RANGE key fromTimestamp toTimestamp

Parameters:

key -

fromTimestamp -

toTimestamp -

Returns:

range elements

tsRange

List<TSElement> tsRange(String key,
                        TSRangeParams rangeParams)

TS.RANGE key fromTimestamp toTimestamp [LATEST] [FILTER_BY_TS ts...] [FILTER_BY_VALUE min max] [COUNT count] [[ALIGN value] AGGREGATION aggregator bucketDuration [BUCKETTIMESTAMP bt] [EMPTY]]

Parameters:

key -

rangeParams -

Returns:

range elements

tsRevRange

List<TSElement> tsRevRange(String key,
                           long fromTimestamp,
                           long toTimestamp)

TS.REVRANGE key fromTimestamp toTimestamp

Parameters:

key -

fromTimestamp -

toTimestamp -

Returns:

range elements

tsRevRange

List<TSElement> tsRevRange(String key,
                           TSRangeParams rangeParams)

TS.REVRANGE key fromTimestamp toTimestamp [LATEST] [FILTER_BY_TS TS...] [FILTER_BY_VALUE min max] [COUNT count] [[ALIGN value] AGGREGATION aggregator bucketDuration [BUCKETTIMESTAMP bt] [EMPTY]]

Parameters:

key -

rangeParams -

Returns:

range elements

tsMRange

Map<String,TSMRangeElements> tsMRange(long fromTimestamp,
                                      long toTimestamp,
                                      String... filters)

TS.MRANGE fromTimestamp toTimestamp FILTER filter...

Parameters:

fromTimestamp -

toTimestamp -

filters -

Returns:

multi range elements

tsMRange

Map<String,TSMRangeElements> tsMRange(TSMRangeParams multiRangeParams)

TS.MRANGE fromTimestamp toTimestamp [LATEST] [FILTER_BY_TS ts...] [FILTER_BY_VALUE min max] [WITHLABELS | SELECTED_LABELS label...] [COUNT count] [[ALIGN value] AGGREGATION aggregator bucketDuration [BUCKETTIMESTAMP bt] [EMPTY]] FILTER filter... [GROUPBY label REDUCE reducer]

Parameters:

multiRangeParams -

Returns:

multi range elements

tsMRevRange

Map<String,TSMRangeElements> tsMRevRange(long fromTimestamp,
                                         long toTimestamp,
                                         String... filters)

TS.MREVRANGE fromTimestamp toTimestamp FILTER filter...

Parameters:

fromTimestamp -

toTimestamp -

filters -

Returns:

multi range elements

tsMRevRange

Map<String,TSMRangeElements> tsMRevRange(TSMRangeParams multiRangeParams)

TS.MREVRANGE fromTimestamp toTimestamp [LATEST] [FILTER_BY_TS TS...] [FILTER_BY_VALUE min max] [WITHLABELS | SELECTED_LABELS label...] [COUNT count] [[ALIGN value] AGGREGATION aggregator bucketDuration [BUCKETTIMESTAMP bt] [EMPTY]] FILTER filter... [GROUPBY label REDUCE reducer]

Parameters:

multiRangeParams -

Returns:

multi range elements

tsGet

TSElement tsGet(String key)

TS.GET key

Parameters:

key - the key

Returns:

the element

tsGet

TSElement tsGet(String key,
                TSGetParams getParams)

TS.GET key [LATEST]

Parameters:

key - the key

getParams - optional arguments

Returns:

the element

tsMGet

Map<String,TSMGetElement> tsMGet(TSMGetParams multiGetParams,
                                 String... filters)

TS.MGET [LATEST] [ WITHLABELS | SELECTED_LABELS label...] FILTER filter...

Parameters:

multiGetParams - optional arguments

filters - secondary indexes

Returns:

multi get elements

tsCreateRule

String tsCreateRule(String sourceKey,
                    String destKey,
                    AggregationType aggregationType,
                    long timeBucket)

TS.CREATERULE sourceKey destKey AGGREGATION aggregationType timeBucket

Parameters:

sourceKey -

destKey -

aggregationType -

timeBucket -

tsCreateRule

String tsCreateRule(String sourceKey,
                    String destKey,
                    AggregationType aggregationType,
                    long bucketDuration,
                    long alignTimestamp)

TS.CREATERULE sourceKey destKey AGGREGATION aggregationType bucketDuration [alignTimestamp]

Parameters:

sourceKey -

destKey -

aggregationType -

bucketDuration -

alignTimestamp -

tsDeleteRule

String tsDeleteRule(String sourceKey,
                    String destKey)

TS.DELETERULE sourceKey destKey

Parameters:

sourceKey -

destKey -

tsQueryIndex

List<String> tsQueryIndex(String... filters)

TS.QUERYINDEX filter...

Parameters:

filters -

Returns:

list of timeseries keys

tsInfo

TSInfo tsInfo(String key)

tsInfoDebug

TSInfo tsInfoDebug(String key)