Package io.quarkus.redis.datasource.timeseries

Class AlterArgs

java.lang.Object
io.quarkus.redis.datasource.timeseries.AlterArgs
All Implemented Interfaces:
RedisCommandExtraArguments
public class AlterArgs extends Object implements RedisCommandExtraArguments
Represents the extra arguments of the ts.alter command.

  • Constructor Details

    • AlterArgs

      public AlterArgs()

  • Method Details

    • setRetention

      public AlterArgs setRetention(Duration retention)
      Set the maximum age for samples compared to the highest reported timestamp, in milliseconds. Samples are expired based solely on the difference between their timestamp and the timestamps passed to subsequent TS.ADD, TS.MADD, TS.INCRBY, and TS.DECRBY calls.

      When set to 0, samples never expire. When not specified, the option is set to the global RETENTION_POLICY configuration of the database, which by default is 0.

      Parameters:
      retention - the retention, must not be null
      Returns:
      the current AlterArgs

    • forever

      public AlterArgs forever()
      Set the retention duration so the samples never expire.
      Returns:
      the current AlterArgs
      See Also:

    • chunkSize

      public AlterArgs chunkSize(int size)
      Sets the initial allocation size, in bytes, for the data part of each new chunk. Actual chunks may consume more memory. Changing chunkSize (using TS.ALTER) does not affect existing chunks.

      Must be a multiple of 8 in the range [48 .. 1048576]. When not specified, it is set to 4096 bytes (a single memory page).

      Parameters:
      size - the chunk size, between 48 and 1048576
      Returns:
      the current AlterArgs

    • duplicatePolicy

      public AlterArgs duplicatePolicy(DuplicatePolicy policy)
      Set the policy for handling insertion (TS.ADD and TS.MADD) of multiple samples with identical timestamps.

      When not specified: set to the global DUPLICATE_POLICY configuration of the database (which, by default, is BLOCK).

      Parameters:
      policy - the policy, must not be null
      Returns:
      the current AlterArgs

    • label

      public AlterArgs label(String label, Object value)
      Set a label-value pairs that represent metadata labels of the key and serve as a secondary index.

      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.

      Parameters:
      label - the label, must not be null
      value - the value, must not be null
      Returns:
      the current AlterArgs

    • toArgs

      public List<Object> toArgs()
      Specified by:
      toArgs in interface RedisCommandExtraArguments
      Returns:
      the list of arguments.