io.quarkus.redis.datasource.timeseries.ReactiveTransactionalTimeSeriesCommands Maven / Gradle / Ivy
Show all versions of quarkus-redis-client Show documentation
package io.quarkus.redis.datasource.timeseries;
import java.time.Duration;
import io.quarkus.redis.datasource.ReactiveTransactionalRedisCommands;
import io.smallrye.mutiny.Uni;
/**
* Allows executing commands from the {@code time series} group (requires the Redis Time Series module from Redis stack).
* See the time series command list for further information
* about these commands.
*
* This API is intended to be used in a Redis transaction ({@code MULTI}), thus, all command methods return {@code Uni}.
*
* @param the type of the key
*/
public interface ReactiveTransactionalTimeSeriesCommands extends ReactiveTransactionalRedisCommands {
/**
* Execute the command TS.CREATE.
* Summary: Create a new time series
* Group: time series
*
* @param key the key name for the time series must not be {@code null}
* @param args the creation arguments.
* @return A {@code Uni} emitting {@code null} when the command has been enqueued successfully in the transaction, a failure
* otherwise. In the case of failure, the transaction is discarded.
*/
Uni tsCreate(K key, CreateArgs args);
/**
* Execute the command TS.CREATE.
* Summary: Create a new time series
* Group: time series
*
* @param key the key name for the time series must not be {@code null}
* @return A {@code Uni} emitting {@code null} when the command has been enqueued successfully in the transaction, a failure
* otherwise. In the case of failure, the transaction is discarded.
*/
Uni tsCreate(K key);
/**
* Execute the command TS.ADD.
* Summary: Append a sample to a time series
* Group: time series
*
* @param key the key name for the time series must not be {@code null}
* @param timestamp the (long) UNIX sample timestamp in milliseconds or {@code -1} to set the timestamp according
* to the server clock.
* @param value the numeric data value of the sample.
* @param args the creation arguments.
* @return A {@code Uni} emitting {@code null} when the command has been enqueued successfully in the transaction, a failure
* otherwise. In the case of failure, the transaction is discarded.
*/
Uni tsAdd(K key, long timestamp, double value, AddArgs args);
/**
* Execute the command TS.ADD.
* Summary: Append a sample to a time series
* Group: time series
*
* @param key the key name for the time series, must not be {@code null}
* @param timestamp the (long) UNIX sample timestamp in milliseconds
* @param value the numeric data value of the sample
* @return A {@code Uni} emitting {@code null} when the command has been enqueued successfully in the transaction, a failure
* otherwise. In the case of failure, the transaction is discarded.
*/
Uni tsAdd(K key, long timestamp, double value);
/**
* Execute the command TS.ADD.
* Summary: Append a sample to a time series
* Group: time series
*
* Unlike {@link #tsAdd(Object, long, double)}, set the timestamp according to the server clock.
*
* @param key the key name for the time series. must not be {@code null}
* @param value the numeric data value of the sample, must not be {@code null}
* @return A {@code Uni} emitting {@code null} when the command has been enqueued successfully in the transaction, a failure
* otherwise. In the case of failure, the transaction is discarded.
*/
Uni tsAdd(K key, double value);
/**
* Execute the command TS.ALTER.
* Summary: Update the retention, chunk size, duplicate policy, and labels of an existing time series
* Group: time series
*
* @param key the key name for the time series, must not be {@code null}
* @param args the alter parameters, must not be {@code null}
* @return A {@code Uni} emitting {@code null} when the command has been enqueued successfully in the transaction, a failure
* otherwise. In the case of failure, the transaction is discarded.
*/
Uni tsAlter(K key, AlterArgs args);
/**
* Execute the command TS.CREATERULE.
* Summary: Create a compaction rule
* Group: time series
*
* @param key the key name for the time series, must not be {@code null}
* @param destKey the key name for destination (compacted) time series. It must be created before TS.CREATERULE
* is called. Must not be {@code null}.
* @param aggregation the aggregation function, must not be {@code null}
* @param bucketDuration the duration of each bucket, must not be {@code null}
* @return A {@code Uni} emitting {@code null} when the command has been enqueued successfully in the transaction, a failure
* otherwise. In the case of failure, the transaction is discarded.
*/
Uni tsCreateRule(K key, K destKey, Aggregation aggregation, Duration bucketDuration);
/**
* Execute the command TS.CREATERULE.
* Summary: Create a compaction rule
* Group: time series
*
* @param key the key name for the time series, must not be {@code null}
* @param destKey the key name for destination (compacted) time series. It must be created before TS.CREATERULE
* is called. Must not be {@code null}.
* @param aggregation the aggregation function, must not be {@code null}
* @param bucketDuration the duration of each bucket, must not be {@code null}
* @param alignTimestamp when set, ensures that there is a bucket that starts exactly at alignTimestamp and aligns
* all other buckets accordingly. It is expressed in milliseconds. The default value is 0 aligned
* with the epoch. For example, if bucketDuration is 24 hours (24 * 3600 * 1000), setting
* alignTimestamp to 6 hours after the epoch (6 * 3600 * 1000) ensures that each bucket’s
* timeframe is [06:00 .. 06:00).
* @return A {@code Uni} emitting {@code null} when the command has been enqueued successfully in the transaction, a failure
* otherwise. In the case of failure, the transaction is discarded.
*/
Uni tsCreateRule(K key, K destKey, Aggregation aggregation, Duration bucketDuration, long alignTimestamp);
/**
* Execute the command TS.DECRBY.
* Summary: Decrease the value of the sample with the maximum existing timestamp, or create a new sample with a
* value equal to the value of the sample with the maximum existing timestamp with a given decrement
* Group: time series
*
*
* @param key the key name for the time series. must not be {@code null}
* @param value the numeric data value of the sample, must not be {@code null}
* @return A {@code Uni} emitting {@code null} when the command has been enqueued successfully in the transaction, a failure
* otherwise. In the case of failure, the transaction is discarded.
*/
Uni tsDecrBy(K key, double value);
/**
* Execute the command TS.DECRBY.
* Summary: Decrease the value of the sample with the maximum existing timestamp, or create a new sample with a
* value equal to the value of the sample with the maximum existing timestamp with a given decrement
* Group: time series
*
*
* @param key the key name for the time series. must not be {@code null}
* @param value the numeric data value of the sample, must not be {@code null}
* @param args the extra command parameters
* @return A {@code Uni} emitting {@code null} when the command has been enqueued successfully in the transaction, a failure
* otherwise. In the case of failure, the transaction is discarded.
*/
Uni tsDecrBy(K key, double value, IncrementArgs args);
/**
* Execute the command TS.DEL.
* Summary: Delete all samples between two timestamps for a given time series
* Group: time series
*
* The given timestamp interval is closed (inclusive), meaning that samples whose timestamp equals the fromTimestamp
* or toTimestamp are also deleted.
*
* @param key the key name for the time series. must not be {@code null}
* @param fromTimestamp the start timestamp for the range deletion.
* @param toTimestamp the end timestamp for the range deletion.
* @return A {@code Uni} emitting {@code null} when the command has been enqueued successfully in the transaction, a failure
* otherwise. In the case of failure, the transaction is discarded.
*/
Uni tsDel(K key, long fromTimestamp, long toTimestamp);
/**
* Execute the command TS.DELETERULE.
* Summary: Delete a compaction rule
* Group: time series
*
*
* @param key the key name for the time series. must not be {@code null}
* @param destKey the key name for destination (compacted) time series. Note that the command does not delete the
* compacted series. Must not be {@code null}
* @return A {@code Uni} emitting {@code null} when the command has been enqueued successfully in the transaction, a failure
* otherwise. In the case of failure, the transaction is discarded.
*/
Uni tsDeleteRule(K key, K destKey);
/**
* Execute the command TS.GET.
* Summary: Get the last sample
* Group: time series
*
*
* @param key the key name for the time series. must not be {@code null}
* @return A {@code Uni} emitting {@code null} when the command has been enqueued successfully in the transaction, a failure
* otherwise. In the case of failure, the transaction is discarded.
*/
Uni tsGet(K key);
/**
* Execute the command TS.GET.
* Summary: Get the last sample
* Group: time series
*
*
* @param key the key name for the time series. must not be {@code null}
* @param latest used when a time series is a compaction. With LATEST set to {@code true}, TS.MRANGE also reports
* the compacted value of the latest possibly partial bucket, given that this bucket's start time
* falls within [fromTimestamp, toTimestamp]. Without LATEST, TS.MRANGE does not report the latest
* possibly partial bucket. When a time series is not a compaction, LATEST is ignored.
* @return A {@code Uni} emitting {@code null} when the command has been enqueued successfully in the transaction, a failure
* otherwise. In the case of failure, the transaction is discarded.
*/
Uni tsGet(K key, boolean latest);
/**
* Execute the command TS.INCRBY.
* Summary: Increase the value of the sample with the maximum existing timestamp, or create a new sample with a
* value equal to the value of the sample with the maximum existing timestamp with a given increment.
* Group: time series
*
*
* @param key the key name for the time series. must not be {@code null}
* @param value the numeric data value of the sample, must not be {@code null}
* @return A {@code Uni} emitting {@code null} when the command has been enqueued successfully in the transaction, a failure
* otherwise. In the case of failure, the transaction is discarded.
*/
Uni tsIncrBy(K key, double value);
/**
* Execute the command TS.INCRBY.
* Summary: Increase the value of the sample with the maximum existing timestamp, or create a new sample with a
* value equal to the value of the sample with the maximum existing timestamp with a given increment.
* Group: time series
*
*
* @param key the key name for the time series. must not be {@code null}
* @param value the numeric data value of the sample, must not be {@code null}
* @param args the extra command parameters
* @return A {@code Uni} emitting {@code null} when the command has been enqueued successfully in the transaction, a failure
* otherwise. In the case of failure, the transaction is discarded.
*/
Uni tsIncrBy(K key, double value, IncrementArgs args);
/**
* Execute the command TS.MADD.
* Summary: Append new samples to one or more time series
* Group: time series
*
* @param samples the set of samples to add to the time series.
* @return A {@code Uni} emitting {@code null} when the command has been enqueued successfully in the transaction, a failure
* otherwise. In the case of failure, the transaction is discarded.
*/
Uni tsMAdd(SeriesSample... samples);
/**
* Execute the command TS.MGET.
* Summary: Get the last samples matching a specific filter
* Group: time series
*
*
* @param args the extra command parameter, must not be {@code null}
* @param filters the filters. Instanced are created using the static methods from {@link Filter}. Must not be
* {@code null}, or contain a {@code null} value.
* @return A {@code Uni} emitting {@code null} when the command has been enqueued successfully in the transaction, a failure
* otherwise. In the case of failure, the transaction is discarded.
*/
Uni tsMGet(MGetArgs args, Filter... filters);
/**
* Execute the command TS.MGET.
* Summary: Get the last samples matching a specific filter
* Group: time series
*
*
* @param filters the filters. Instanced are created using the static methods from {@link Filter}. Must not be
* {@code null}, or contain a {@code null} value.
* @return A {@code Uni} emitting {@code null} when the command has been enqueued successfully in the transaction, a failure
* otherwise. In the case of failure, the transaction is discarded.
*/
Uni tsMGet(Filter... filters);
/**
* Execute the command TS.MRANGE.
* Summary: Query a range across multiple time series by filters in forward direction
* Group: time series
*
*
* @param range the range, must not be {@code null}
* @param filters the filters. Instanced are created using the static methods from {@link Filter}. Must not be
* {@code null}, or contain a {@code null} value.
* @return A {@code Uni} emitting {@code null} when the command has been enqueued successfully in the transaction, a failure
* otherwise. In the case of failure, the transaction is discarded.
*/
Uni tsMRange(TimeSeriesRange range, Filter... filters);
/**
* Execute the command TS.MRANGE.
* Summary: Query a range across multiple time series by filters in forward direction
* Group: time series
*
*
* @param range the range, must not be {@code null}
* @param args the extra command parameters
* @param filters the filters. Instanced are created using the static methods from {@link Filter}. Must not be
* {@code null}, or contain a {@code null} value.
* @return A {@code Uni} emitting {@code null} when the command has been enqueued successfully in the transaction, a failure
* otherwise. In the case of failure, the transaction is discarded.
*/
Uni tsMRange(TimeSeriesRange range, MRangeArgs args, Filter... filters);
/**
* Execute the command TS.MREVRANGE.
* Summary: Query a range across multiple time series by filters in reverse direction
* Group: time series
*
*
* @param range the range, must not be {@code null}
* @param filters the filters. Instanced are created using the static methods from {@link Filter}. Must not be
* {@code null}, or contain a {@code null} value.
* @return A {@code Uni} emitting {@code null} when the command has been enqueued successfully in the transaction, a failure
* otherwise. In the case of failure, the transaction is discarded.
*/
Uni tsMRevRange(TimeSeriesRange range, Filter... filters);
/**
* Execute the command TS.MREVRANGE.
* Summary: Query a range across multiple time series by filters in reverse direction
* Group: time series
*
*
* @param range the range, must not be {@code null}
* @param args the extra command parameters
* @param filters the filters. Instanced are created using the static methods from {@link Filter}. Must not be
* {@code null}, or contain a {@code null} value.
* @return A {@code Uni} emitting {@code null} when the command has been enqueued successfully in the transaction, a failure
* otherwise. In the case of failure, the transaction is discarded.
*/
Uni tsMRevRange(TimeSeriesRange range, MRangeArgs args, Filter... filters);
/**
* Execute the command TS.QUERYINDEX.
* Summary: Get all time series keys matching a filter list
* Group: time series
*
* @param filters the filter, created from the {@link Filter} class. Must not be {@code null}, must not contain
* {@code null}
* @return A {@code Uni} emitting {@code null} when the command has been enqueued successfully in the transaction, a failure
* otherwise. In the case of failure, the transaction is discarded.
*/
Uni tsQueryIndex(Filter... filters);
/**
* Execute the command TS.RANGE.
* Summary: Query a range in forward direction
* Group: time series
*
*
* @param key the key name for the time series, must not be {@code null}
* @param range the range, must not be {@code null}
* @return A {@code Uni} emitting {@code null} when the command has been enqueued successfully in the transaction, a failure
* otherwise. In the case of failure, the transaction is discarded.
*/
Uni tsRange(K key, TimeSeriesRange range);
/**
* Execute the command TS.RANGE.
* Summary: Query a range in forward direction
* Group: time series
*
*
* @param key the key name for the time series, must not be {@code null}
* @param range the range, must not be {@code null}
* @param args the extra command parameters
* @return A {@code Uni} emitting {@code null} when the command has been enqueued successfully in the transaction, a failure
* otherwise. In the case of failure, the transaction is discarded.
*/
Uni tsRange(K key, TimeSeriesRange range, RangeArgs args);
/**
* Execute the command TS.REVRANGE.
* Summary: Query a range in reverse direction
* Group: time series
*
*
* @param key the key name for the time series, must not be {@code null}
* @param range the range, must not be {@code null}
* @return A {@code Uni} emitting {@code null} when the command has been enqueued successfully in the transaction, a failure
* otherwise. In the case of failure, the transaction is discarded.
*/
Uni tsRevRange(K key, TimeSeriesRange range);
/**
* Execute the command TS.REVRANGE.
* Summary: Query a range in reverse direction
* Group: time series
*
*
* @param key the key name for the time series, must not be {@code null}
* @param range the range, must not be {@code null}
* @param args the extra command parameters
* @return A {@code Uni} emitting {@code null} when the command has been enqueued successfully in the transaction, a failure
* otherwise. In the case of failure, the transaction is discarded.
*/
Uni tsRevRange(K key, TimeSeriesRange range, RangeArgs args);
}