Adding more commands, Tests for TimeSeries and arrangements

Author: shacharPash

src/NRedisStack.Core/RedisStackCommands/Bloom.cs renamed to src/NRedisStack.Core/Bloom/BloomCommands.cs

@@ -1,5 +1,5 @@
 using StackExchange.Redis;
-namespace NRedisStack.Core.RedisStackCommands
+namespace NRedisStack.Core
 {
 
     public class BloomCommands

src/NRedisStack.Core/RedisStackCommands/Json.cs renamed to src/NRedisStack.Core/Json/JsonCommands.cs

@@ -2,7 +2,7 @@
 using System.Text.Json;
 using System.Text.Json.Serialization;
 
-namespace NRedisStack.Core.RedisStackCommands;
+namespace NRedisStack.Core;
 
 public class JsonCommands
 {

src/NRedisStack.Core/RedisStackCommands/Search.cs renamed to src/NRedisStack.Core/Search/SearchCommands.cs

@@ -1,5 +1,5 @@
 using StackExchange.Redis;
-namespace NRedisStack.Core.RedisStackCommands
+namespace NRedisStack.Core
 {
     public class SearchCommands
     {

src/NRedisStack.Core/TimeSeries/Commands/CommandArgs.cs

@@ -1,4 +1,4 @@
-namespace NRedisStack.Core.TimeSeries.Commands
+namespace NRedisStack.Core.Commands
 {
     internal class CommandArgs
     {
@@ -19,5 +19,6 @@ internal class CommandArgs
         public static string REDUCE => "REDUCE";
         public static string FILTER_BY_TS => "FILTER_BY_TS";
         public static string FILTER_BY_VALUE => "FILTER_BY_VALUE";
+
     }
-}
+}

src/NRedisStack.Core/RedisStackCommands/ TimeSeries.cs renamed to src/NRedisStack.Core/TimeSeries/Commands/Commands.cs

@@ -1,20 +1,14 @@
-using StackExchange.Redis;
-namespace NRedisStack.Core.RedisStackCommands
+namespace NRedisStack.Core.Commands
 {
-    public  class TimeSeriesCommands
+    internal class TS
     {
-        IDatabase _db;
-        public TimeSeriesCommands(IDatabase db)
-        {
-            _db = db;
-        }
-        //TODO: INFO, CREATE, ALTER
-        /*public static string CREATE => "TS.CREATE";
+        public static string CREATE => "TS.CREATE";
         public static string ALTER => "TS.ALTER";
         public static string ADD => "TS.ADD";
         public static string MADD => "TS.MADD";
         public static string INCRBY => "TS.INCRBY";
         public static string DECRBY => "TS.DECRBY";
+        public static string DEL => "TS.DEL";
         public static string CREATERULE => "TS.CREATERULE";
         public static string DELETERULE => "TS.DELETERULE";
         public static string RANGE => "TS.RANGE";
@@ -24,6 +18,6 @@ public TimeSeriesCommands(IDatabase db)
         public static string GET => "TS.GET";
         public static string MGET => "TS.MGET";
         public static string INFO => "TS.INFO";
-        public static string QUERYINDEX => "TS.QUERYINDEX";*/
+        public static string QUERYINDEX => "TS.QUERYINDEX";
     }
-}
+}

src/NRedisStack.Core/TimeSeries/Commands/Enums/Aggregation.cs

@@ -0,0 +1,73 @@
+namespace NRedisStack.Core.Commands.Enums
+{
+    /// <summary>
+    /// An aggregation type to be used with a time bucket.
+    /// </summary>
+    public enum TsAggregation
+    {
+        /// <summary>
+        /// The average of all samples in the aggregation
+        /// </summary>
+        Avg,
+
+        /// <summary>
+        /// A sum of all samples in the aggregation
+        /// </summary>
+        Sum,
+
+        /// <summary>
+        /// A minimum sample of all samples in the aggregation
+        /// </summary>
+        Min,
+
+        /// <summary>
+        /// A maximum sample of all samples in the aggregation
+        /// </summary>
+        Max,
+
+        /// <summary>
+        /// A range of the min and max sample of all samples in the aggregation (range r = max-min)
+        /// For example if the min sample was 100 and the max was 400, the range aggregation would return 300
+        /// </summary>
+        Range,
+
+        /// <summary>
+        /// The total number of all samples in the aggregation
+        /// </summary>
+        Count,
+
+        /// <summary>
+        /// The first sample in the aggregation
+        /// </summary>
+        First,
+
+        /// <summary>
+        /// The last sample in the aggregation
+        /// </summary>
+        Last,
+
+        /// <summary>
+        /// The standard deviation based on the entire population
+        /// The standard deviation is a measure of how widely values are dispersed from the average sample in the aggregation
+        /// </summary>
+        StdP,
+
+        /// <summary>
+        /// The standard deviation based on a sample of the population
+        /// The standard deviation is a measure of how widely values are dispersed from the average sample in the aggregation
+        /// </summary>
+        StdS,
+
+        /// <summary>
+        /// The variance based on the entire population
+        /// The variance is the average of the squared differences from the mean
+        /// </summary>
+        VarP,
+
+        /// <summary>
+        /// The variance based on a sample of the population
+        /// The variance is the average of the squared differences from the mean
+        /// </summary>
+        VarS,
+    }
+}

src/NRedisStack.Core/TimeSeries/Commands/Enums/DuplicatePolicy.cs

@@ -0,0 +1,41 @@
+namespace NRedisStack.Core.Commands.Enums
+{
+    /// <summary>
+    /// Policy to handle duplicate samples.
+    /// The default policy for database-wide is BLOCK.
+    /// </summary>
+    public enum TsDuplicatePolicy
+    {
+        /// <summary>
+        /// An error will occur for any out of order sample.
+        /// </summary>
+        BLOCK,
+
+        /// <summary>
+        /// Ignore the new value.
+        /// </summary>
+        FIRST,
+
+        /// <summary>
+        /// Override with latest value.
+        /// </summary>
+        LAST,
+
+        /// <summary>
+        /// Only override if the value is lower than the existing value.
+        /// </summary>
+        MIN,
+
+        /// <summary>
+        /// Only override if the value is higher than the existing value.
+        /// </summary>
+        MAX,
+
+        /// <summary>
+        /// If a previous sample exists, add the new sample to it so that the updated value is equal to (previous + new).
+        /// If no previous sample exists, set the updated value equal to the new value.
+        /// </summary>
+        SUM
+    }
+}
+

src/NRedisStack.Core/TimeSeries/Commands/Enums/Reduce.cs

@@ -0,0 +1,23 @@
+namespace NRedisStack.Core.Commands.Enums
+{
+    /// <summary>
+    /// TODO: Add description
+    /// </summary>
+    public enum TsReduce
+    {
+        /// <summary>
+        /// A sum of all samples in the group
+        /// </summary>
+        Sum,
+
+        /// <summary>
+        /// A minimum sample of all samples in the group
+        /// </summary>
+        Min,
+
+        /// <summary>
+        /// A maximum sample of all samples in the group
+        /// </summary>
+        Max,
+    }
+}

src/NRedisStack.Core/TimeSeries/DataTypes/TimeSeriesInformation.cs

@@ -0,0 +1,100 @@
+using System;
+using System.Text.Json;
+using System.Collections.Generic;
+using NRedisStack.Core.Commands.Enums;
+
+
+namespace NRedisStack.Core.DataTypes
+{
+    /// <summary>
+    /// This class represents the response for TS.INFO command.
+    /// This object has Read-only properties and cannot be generated outside a TS.INFO response.
+    /// </summary>
+    public class TimeSeriesInformation
+    {
+        /// <summary>
+        /// Total samples in the time-series.
+        /// </summary>
+        public long TotalSamples { get; private set; }
+
+        /// <summary>
+        /// Total number of bytes allocated for the time-series.
+        /// </summary>
+        public long MemoryUsage { get; private set; }
+
+        /// <summary>
+        /// First timestamp present in the time-series.
+        /// </summary>
+        public TimeStamp FirstTimeStamp { get; private set; }
+
+        /// <summary>
+        /// Last timestamp present in the time-series.
+        /// </summary>
+        public TimeStamp LastTimeStamp { get; private set; }
+
+        /// <summary>
+        /// Retention time, in milliseconds, for the time-series.
+        /// </summary>
+        public long RetentionTime { get; private set; }
+
+        /// <summary>
+        /// Number of Memory Chunks used for the time-series.
+        /// </summary>
+        public long ChunkCount { get; private set; }
+
+        /// <summary>
+        /// Maximum Number of samples per Memory Chunk.
+        /// </summary>
+        [ObsoleteAttribute("This method has been deprecated. Use ChunkSize instead.")]
+        public long MaxSamplesPerChunk { get; private set; }
+
+        /// <summary>
+        /// Memory Chunk size in Bytes.
+        /// </summary>
+        public long ChunkSize { get; private set; }
+
+        /// <summary>
+        /// A readonly list of TimeSeriesLabel that represent metadata labels of the time-series.
+        /// </summary>
+        public IReadOnlyList<TimeSeriesLabel> Labels { get; private set; }
+
+        /// <summary>
+        /// Source key for the queries time series key.
+        /// </summary>
+        public string SourceKey { get; private set; }
+
+        /// <summary>
+        /// A readonly list of TimeSeriesRules that represent compaction Rules of the time-series.
+        /// </summary>
+        public IReadOnlyList<TimeSeriesRule> Rules { get; private set; }
+
+        /// <summary>
+        /// The policy will define handling of duplicate samples.
+        /// </summary>
+        public TsDuplicatePolicy? DuplicatePolicy {  get; private set; }
+
+        internal TimeSeriesInformation(long totalSamples, long memoryUsage, TimeStamp firstTimeStamp, TimeStamp lastTimeStamp, long retentionTime, long chunkCount, long chunkSize, IReadOnlyList<TimeSeriesLabel> labels, string sourceKey, IReadOnlyList<TimeSeriesRule> rules, TsDuplicatePolicy? policy)
+        {
+            TotalSamples = totalSamples;
+            MemoryUsage = memoryUsage;
+            FirstTimeStamp = firstTimeStamp;
+            LastTimeStamp = lastTimeStamp;
+            RetentionTime = retentionTime;
+            ChunkCount = chunkCount;
+            Labels = labels;
+            SourceKey = sourceKey;
+            Rules = rules;
+            // backwards compatible with RedisTimeSeries < v1.4
+            MaxSamplesPerChunk = chunkSize/16;
+            ChunkSize = chunkSize;
+            // configure what to do on duplicate sample > v1.4
+            DuplicatePolicy = policy;
+        }
+
+        /// <summary>
+        /// Implicit cast from TimeSeriesInformation to string.
+        /// </summary>
+        /// <param name="info">TimeSeriesInformation</param>
+        public static implicit operator string(TimeSeriesInformation info) => JsonSerializer.Serialize(info);
+    }
+}

src/NRedisStack.Core/TimeSeries/DataTypes/TimeSeriesLabel.cs

@@ -0,0 +1,55 @@
+using System.Collections.Generic;
+
+namespace NRedisStack.Core.DataTypes
+{
+    /// <summary>
+    /// A key-value pair class represetns metadata label of time-series.
+    /// </summary>
+    public class TimeSeriesLabel
+    {
+        /// <summary>
+        /// Label key
+        /// </summary>
+        public string Key { get; }
+
+        /// <summary>
+        /// Label value
+        /// </summary>
+        public string Value { get; }
+
+        /// <summary>
+        /// Create a new TimeSeriesLabel out of key and value strings.
+        /// </summary>
+        /// <param name="key">Key string</param>
+        /// <param name="value">Value string</param>
+        public TimeSeriesLabel(string key, string value) => (Key, Value) = (key, value);
+
+        /// <summary>
+        /// Equality of TimeSeriesLabel objects
+        /// </summary>
+        /// <param name="obj">Object to compare</param>
+        /// <returns>If two TimeSeriesLabel objects are equal</returns>
+        public override bool Equals(object obj) =>
+            obj is TimeSeriesLabel label &&
+            Key == label.Key &&
+            Value == label.Value;
+
+        /// <summary>
+        /// Implicit cast from TimeSeriesLabel to string.
+        /// </summary>
+        /// <param name="tsl">TimeSeriesLabel</param>
+        public static implicit operator string(TimeSeriesLabel tsl) => string.Format("Key: {0}, Val:{1}", tsl.Key, tsl.Value);
+
+        /// <summary>
+        /// TimeSeriesLabel object hash code.
+        /// </summary>
+        /// <returns>TimeSeriesLabel object hash code.</returns>
+        public override int GetHashCode()
+        {
+            var hashCode = 206514262;
+            hashCode = (hashCode * -1521134295) + EqualityComparer<string>.Default.GetHashCode(Key);
+            hashCode = (hashCode * -1521134295) + EqualityComparer<string>.Default.GetHashCode(Value);
+            return hashCode;
+        }
+    }
+}