groupby_reduce (#48)

Support GROUPBY <label> REDUCE <reducer> #42

Author: AvitalFineRedis

NRedisTimeSeries.Example/MRangeExample.cs

@@ -37,7 +37,7 @@ public static void BasicMRangeExample()
         /// Example for basic usage of RedisTimeSeries RANGE command with "-" and "+" as range boundreis, a filter and the COUNT parameter.
         /// NRedisTimeSeris MRange is expecting two TimeStamps objects as the range boundries.
         /// In this case, the strings are implicitly casted into TimeStamp objects.
-        /// The TimeSeriesMRange command returns an IReadOnlyList<(string key, IReadOnlyList<TimeSeriesLabel> labels, IReadOnlyList<TimeSeriesTuple> values)>collection.
+        /// The TimeSeriesMRange command returns an IReadOnlyList (collection) of (string key, IReadOnlyList(TimeSeriesLabel) labels, IReadOnlyList(TimeSeriesTuple) values).
         /// </summary>
         public static void CountMRangeExample()
         {
@@ -58,7 +58,7 @@ public static void CountMRangeExample()
         /// Example for basic usage of RedisTimeSeries RANGE command with "-" and "+" as range boundreis, a filter and MIN aggregation.
         /// NRedisTimeSeris MRange is expecting two TimeStamps objects as the range boundries.
         /// In this case, the strings are implicitly casted into TimeStamp objects.
-        /// The TimeSeriesMRange command returns an IReadOnlyList<(string key, IReadOnlyList<TimeSeriesLabel> labels, IReadOnlyList<TimeSeriesTuple> values)>collection.
+        /// The TimeSeriesMRange command returns an IReadOnlyList (collection) of (string key, IReadOnlyList(TimeSeriesLabel) labels, IReadOnlyList(TimeSeriesTuple) values).
         /// </summary>
         public static void MRangeAggregationExample()
         {
@@ -79,7 +79,7 @@ public static void MRangeAggregationExample()
         /// Example for basic usage of RedisTimeSeries RANGE command with "-" and "+" as range boundreis, a filter and WITHLABELS flag.
         /// NRedisTimeSeris MRange is expecting two TimeStamps objects as the range boundries.
         /// In this case, the strings are implicitly casted into TimeStamp objects.
-        /// The TimeSeriesMRange command returns an IReadOnlyList<(string key, IReadOnlyList<TimeSeriesLabel> labels, IReadOnlyList<TimeSeriesTuple> values)>collection.
+        /// The TimeSeriesMRange command returns an IReadOnlyList (collection) of (string key, IReadOnlyList(TimeSeriesLabel) labels, IReadOnlyList(TimeSeriesTuple) values).
         /// </summary>
         public static void MRangeWithLabelsExample()
         {
@@ -96,5 +96,27 @@ public static void MRangeWithLabelsExample()
             }
             redis.Close();
         }
+
+        /// <summary>
+        /// Example for basic usage of RedisTimeSeries RANGE command with "-" and "+" as range boundreis, a filter and a Groupby concept.
+        /// NRedisTimeSeris MRange is expecting two TimeStamps objects as the range boundries.
+        /// In this case, the strings are implicitly casted into TimeStamp objects.
+        /// The TimeSeriesMRange command returns an IReadOnlyList (collection) of (string key, IReadOnlyList(TimeSeriesLabel) labels, IReadOnlyList(TimeSeriesTuple) values).
+        /// </summary>
+        public static void MRangeWithGroupbyExample()
+        {
+            ConnectionMultiplexer redis = ConnectionMultiplexer.Connect("localhost");
+            IDatabase db = redis.GetDatabase();
+            var filter = new List<string> { "MRANGEkey=MRANGEvalue" };
+            var results = db.TimeSeriesMRange("-", "+", filter, withLabels: true, groupbyTuple: ("labelName", TsReduce.Max));
+            // Values extraction example.
+            foreach (var result in results)
+            {
+                string group = result.key;
+                IReadOnlyList<TimeSeriesLabel> labels = result.labels;
+                IReadOnlyList<TimeSeriesTuple> values = result.values;
+            }
+            redis.Close();
+        }
     }
 }

NRedisTimeSeries.Example/MRangeExampleAsync.cs

@@ -16,7 +16,7 @@ internal class MRangeAsyncExample
         /// Example for basic usage of RedisTimeSeries RANGE command with "-" and "+" as range boundreis and a filter.
         /// NRedisTimeSeris MRange is expecting two TimeStamps objects as the range boundries.
         /// In this case, the strings are implicitly casted into TimeStamp objects.
-        /// The TimeSeriesMRange command returns an IReadOnlyList<(string key, IReadOnlyList<TimeSeriesLabel> labels, IReadOnlyList<TimeSeriesTuple> values)>collection.
+        /// The TimeSeriesMRange command returns an IReadOnlyList (collection) of (string key, IReadOnlyList(TimeSeriesLabel) labels, IReadOnlyList(TimeSeriesTuple) values).
         /// </summary>
         public static async Task BasicMRangeAsyncExample()
         {
@@ -37,7 +37,7 @@ public static async Task BasicMRangeAsyncExample()
         /// Example for basic usage of RedisTimeSeries RANGE command with "-" and "+" as range boundreis, a filter and the COUNT parameter.
         /// NRedisTimeSeris MRange is expecting two TimeStamps objects as the range boundries.
         /// In this case, the strings are implicitly casted into TimeStamp objects.
-        /// The TimeSeriesMRange command returns an IReadOnlyList<(string key, IReadOnlyList<TimeSeriesLabel> labels, IReadOnlyList<TimeSeriesTuple> values)>collection.
+        /// The TimeSeriesMRange command returns an IReadOnlyList (collection) of (string key, IReadOnlyList(TimeSeriesLabel) labels, IReadOnlyList(TimeSeriesTuple) values).
         /// </summary>
         public static async Task CountMRangeAsyncExample()
         {
@@ -58,7 +58,7 @@ public static async Task CountMRangeAsyncExample()
         /// Example for basic usage of RedisTimeSeries RANGE command with "-" and "+" as range boundreis, a filter and MIN aggregation.
         /// NRedisTimeSeris MRange is expecting two TimeStamps objects as the range boundries.
         /// In this case, the strings are implicitly casted into TimeStamp objects.
-        /// The TimeSeriesMRange command returns an IReadOnlyList<(string key, IReadOnlyList<TimeSeriesLabel> labels, IReadOnlyList<TimeSeriesTuple> values)>collection.
+        /// The TimeSeriesMRange command returns an IReadOnlyList (collection) of (string key, IReadOnlyList(TimeSeriesLabel) labels, IReadOnlyList(TimeSeriesTuple) values).
         /// </summary>
         public static async Task MRangeAggregationAsyncExample()
         {
@@ -79,7 +79,7 @@ public static async Task MRangeAggregationAsyncExample()
         /// Example for basic usage of RedisTimeSeries RANGE command with "-" and "+" as range boundreis, a filter and WITHLABELS flag.
         /// NRedisTimeSeris MRange is expecting two TimeStamps objects as the range boundries.
         /// In this case, the strings are implicitly casted into TimeStamp objects.
-        /// The TimeSeriesMRange command returns an IReadOnlyList<(string key, IReadOnlyList<TimeSeriesLabel> labels, IReadOnlyList<TimeSeriesTuple> values)>collection.
+        /// The TimeSeriesMRange command returns an IReadOnlyList (collection) of (string key, IReadOnlyList(TimeSeriesLabel) labels, IReadOnlyList(TimeSeriesTuple) values).
         /// </summary>
         public static async Task MRangeWithLabelsAsyncExample()
         {
@@ -96,5 +96,27 @@ public static async Task MRangeWithLabelsAsyncExample()
             }
             redis.Close();
         }
+
+        /// <summary>
+        /// Example for basic usage of RedisTimeSeries RANGE command with "-" and "+" as range boundreis, a filter and a Groupby concept.
+        /// NRedisTimeSeris MRange is expecting two TimeStamps objects as the range boundries.
+        /// In this case, the strings are implicitly casted into TimeStamp objects.
+        /// The TimeSeriesMRange command returns an IReadOnlyList (collection) of (string key, IReadOnlyList(TimeSeriesLabel) labels, IReadOnlyList(TimeSeriesTuple) values).
+        /// </summary>
+        public static async Task MRangeWithGroupbyAsyncExample()
+        {
+            ConnectionMultiplexer redis = ConnectionMultiplexer.Connect("localhost");
+            IDatabase db = redis.GetDatabase();
+            var filter = new List<string> { "MRANGEkey=MRANGEvalue" };
+            var results = await db.TimeSeriesMRangeAsync("-", "+", filter, withLabels: true, groupbyTuple: ("labelName", TsReduce.Max));
+            // Values extraction example.
+            foreach (var result in results)
+            {
+                string group = result.key;
+                IReadOnlyList<TimeSeriesLabel> labels = result.labels;
+                IReadOnlyList<TimeSeriesTuple> values = result.values;
+            }
+            redis.Close();
+        }
     }
 }

NRedisTimeSeries.Test/TestAPI/TestMRange.cs

@@ -174,7 +174,53 @@ public void TestMissingTimeBucket()
             var tuples = CreateData(db, 50);
             var ex = Assert.Throws<ArgumentException>(() => db.TimeSeriesMRange("-", "+", new List<string> { "key=MissingTimeBucket" }, aggregation: TsAggregation.Avg));
             Assert.Equal("RANGE Aggregation should have timeBucket value", ex.Message);
+        }
+
+        [Fact]
+        public void TestMRangeGroupby()
+        {
+            IDatabase db = redisFixture.Redis.GetDatabase();
+            for(int i = 0; i < keys.Length; i++) 
+            {
+                var label1 = new TimeSeriesLabel("key", "MRangeGroupby");
+                var label2 = new TimeSeriesLabel("group", i.ToString());
+                db.TimeSeriesCreate(keys[i], labels: new List<TimeSeriesLabel> { label1, label2 });
+            }
 
+            var tuples = CreateData(db, 50);
+            var results = db.TimeSeriesMRange("-", "+", new List<string> { "key=MRangeGroupby" }, withLabels: true, groupbyTuple: ("group", TsReduce.Min));
+            Assert.Equal(keys.Length, results.Count);
+            for (int i = 0; i < results.Count; i++)
+            {
+                Assert.Equal("group=" + i, results[i].key);
+                Assert.Equal(new TimeSeriesLabel("group", i.ToString()), results[i].labels[0]);
+                Assert.Equal(new TimeSeriesLabel("__reducer__", "min"), results[i].labels[1]);
+                Assert.Equal(new TimeSeriesLabel("__source__", keys[i]), results[i].labels[2]);
+                Assert.Equal(tuples, results[i].values);
+            }
+        }
+
+        [Fact]
+        public void TestMRangeReduce()
+        {
+            IDatabase db = redisFixture.Redis.GetDatabase();
+            foreach(var key in keys)
+            {
+                var label = new TimeSeriesLabel("key", "MRangeReduce");
+                db.TimeSeriesCreate(key, labels: new List<TimeSeriesLabel> { label });
+            }
+
+            var tuples = CreateData(db, 50);
+            var results = db.TimeSeriesMRange("-", "+", new List<string> { "key=MRangeReduce" }, withLabels: true, groupbyTuple: ("key", TsReduce.Sum));
+            Assert.Equal(1, results.Count);
+            Assert.Equal("key=MRangeReduce", results[0].key);
+            Assert.Equal(new TimeSeriesLabel("key", "MRangeReduce"), results[0].labels[0]);
+            Assert.Equal(new TimeSeriesLabel("__reducer__", "sum"), results[0].labels[1]);
+            Assert.Equal(new TimeSeriesLabel("__source__", string.Join(",", keys)), results[0].labels[2]);
+            for(int i = 0; i < results[0].values.Count; i++)
+            {
+                Assert.Equal(tuples[i].Val * 2, results[0].values[i].Val);
+            }
         }
     }
 }

NRedisTimeSeries.Test/TestAPI/TestMRangeAsync.cs

@@ -177,5 +177,54 @@ await db.TimeSeriesMRangeAsync("-", "+",
             });
             Assert.Equal("RANGE Aggregation should have timeBucket value", ex.Message);
         }
+
+        [Fact]
+        public async Task TestMRangeGroupby()
+        {
+            var keys = CreateKeyNames(2);
+            var db = redisFixture.Redis.GetDatabase();
+            for(int i = 0; i < keys.Length; i++) 
+            {
+                var label1 = new TimeSeriesLabel(keys[0], "value");
+                var label2 = new TimeSeriesLabel("group", i.ToString());
+                await db.TimeSeriesCreateAsync(keys[i], labels: new List<TimeSeriesLabel> { label1, label2 });
+            }
+
+            var tuples = await CreateData(db, keys, 50);
+            var results = await db.TimeSeriesMRangeAsync("-", "+", new List<string> { $"{keys[0]}=value" }, withLabels: true, groupbyTuple: ("group", TsReduce.Min));
+            Assert.Equal(keys.Length, results.Count);
+            for (int i = 0; i < results.Count; i++)
+            {
+                Assert.Equal("group=" + i, results[i].key);
+                Assert.Equal(new TimeSeriesLabel("group", i.ToString()), results[i].labels[0]);
+                Assert.Equal(new TimeSeriesLabel("__reducer__", "min"), results[i].labels[1]);
+                Assert.Equal(new TimeSeriesLabel("__source__", keys[i]), results[i].labels[2]);
+                Assert.Equal(tuples, results[i].values);
+            }
+        }
+
+        [Fact]
+        public async Task TestMRangeReduce()
+        {
+            var keys = CreateKeyNames(2);
+            var db = redisFixture.Redis.GetDatabase();
+            foreach(var key in keys)
+            {
+                var label = new TimeSeriesLabel(keys[0], "value");
+                await db.TimeSeriesCreateAsync(key, labels: new List<TimeSeriesLabel> { label });
+            }
+
+            var tuples = await CreateData(db, keys, 50);
+            var results = await db.TimeSeriesMRangeAsync("-", "+", new List<string> { $"{keys[0]}=value" }, withLabels: true, groupbyTuple: (keys[0], TsReduce.Sum));
+            Assert.Equal(1, results.Count);
+            Assert.Equal($"{keys[0]}=value", results[0].key);
+            Assert.Equal(new TimeSeriesLabel(keys[0], "value"), results[0].labels[0]);
+            Assert.Equal(new TimeSeriesLabel("__reducer__", "sum"), results[0].labels[1]);
+            Assert.Equal(new TimeSeriesLabel("__source__", string.Join(",", keys)), results[0].labels[2]);
+            for(int i = 0; i < results[0].values.Count; i++)
+            {
+                Assert.Equal(tuples[i].Val * 2, results[0].values[i].Val);
+            }
+        }
     }
 }

NRedisTimeSeries.Test/TestAPI/TestMRevRange.cs

@@ -171,7 +171,56 @@ public void TestMissingTimeBucket()
             var tuples = CreateData(db, keys, 50);
             var ex = Assert.Throws<ArgumentException>(() => db.TimeSeriesMRevRange("-", "+", new List<string> { "key=MissingTimeBucket" }, aggregation: TsAggregation.Avg));
             Assert.Equal("RANGE Aggregation should have timeBucket value", ex.Message);
+        }
 
+        [Fact]
+        public void TestMRevRangeGroupby()
+        {
+            var keys = CreateKeyNames(2);
+            var db = redisFixture.Redis.GetDatabase();
+            for(int i = 0; i < keys.Length; i++) 
+            {
+                var label1 = new TimeSeriesLabel(keys[0], "value");
+                var label2 = new TimeSeriesLabel("group", i.ToString());
+                db.TimeSeriesCreate(keys[i], labels: new List<TimeSeriesLabel> { label1, label2 });
+            }
+
+            var tuples = CreateData(db, keys, 50);
+            var results = db.TimeSeriesMRevRange("-", "+", new List<string> { $"{keys[0]}=value" }, withLabels: true, groupbyTuple: ("group", TsReduce.Min));
+            Assert.Equal(keys.Length, results.Count);
+            for (var i = 0; i < results.Count; i++)
+            {
+                Assert.Equal("group=" + i, results[i].key);
+                Assert.Equal(new TimeSeriesLabel("group", i.ToString()), results[i].labels[0]);
+                Assert.Equal(new TimeSeriesLabel("__reducer__", "min"), results[i].labels[1]);
+                Assert.Equal(new TimeSeriesLabel("__source__", keys[i]), results[i].labels[2]);
+                Assert.Equal(ReverseData(tuples), results[i].values);
+            }
         }
+
+        [Fact]
+        public void TestMRevRangeReduce()
+        {
+            var keys = CreateKeyNames(2);
+            var db = redisFixture.Redis.GetDatabase();
+            foreach(var key in keys)
+            {
+                var label = new TimeSeriesLabel(keys[0], "value");
+                db.TimeSeriesCreate(key, labels: new List<TimeSeriesLabel> { label });
+            }
+
+            var tuples = CreateData(db, keys, 50);
+            var results = db.TimeSeriesMRevRange("-", "+", new List<string> { $"{keys[0]}=value" }, withLabels: true, groupbyTuple: (keys[0], TsReduce.Sum));
+            Assert.Equal(1, results.Count);
+            Assert.Equal($"{keys[0]}=value", results[0].key);
+            Assert.Equal(new TimeSeriesLabel(keys[0], "value"), results[0].labels[0]);
+            Assert.Equal(new TimeSeriesLabel("__reducer__", "sum"), results[0].labels[1]);
+            Assert.Equal(new TimeSeriesLabel("__source__", string.Join(",", keys)), results[0].labels[2]);
+            tuples = ReverseData(tuples);
+            for(int i = 0; i < results[0].values.Count; i++)
+            {
+                Assert.Equal(tuples[i].Val * 2, results[0].values[i].Val);
+            }
+        }        
     }
 }

NRedisTimeSeries.Test/TestAPI/TestMRevRangeAsync.cs

@@ -177,5 +177,55 @@ await db.TimeSeriesMRevRangeAsync("-", "+",
             });
             Assert.Equal("RANGE Aggregation should have timeBucket value", ex.Message);
         }
+
+        [Fact]
+        public async Task TestMRevRangeGroupby()
+        {
+            var keys = CreateKeyNames(2);
+            var db = redisFixture.Redis.GetDatabase();
+            for(int i = 0; i < keys.Length; i++) 
+            {
+                var label1 = new TimeSeriesLabel(keys[0], "value");
+                var label2 = new TimeSeriesLabel("group", i.ToString());
+                await db.TimeSeriesCreateAsync(keys[i], labels: new List<TimeSeriesLabel> { label1, label2 });
+            }
+
+            var tuples = await CreateData(db, keys, 50);
+            var results = await db.TimeSeriesMRevRangeAsync("-", "+", new List<string> { $"{keys[0]}=value" }, withLabels: true, groupbyTuple: ("group", TsReduce.Min));
+            Assert.Equal(keys.Length, results.Count);
+            for (var i = 0; i < results.Count; i++)
+            {
+                Assert.Equal("group=" + i, results[i].key);
+                Assert.Equal(new TimeSeriesLabel("group", i.ToString()), results[i].labels[0]);
+                Assert.Equal(new TimeSeriesLabel("__reducer__", "min"), results[i].labels[1]);
+                Assert.Equal(new TimeSeriesLabel("__source__", keys[i]), results[i].labels[2]);
+                Assert.Equal(ReverseData(tuples), results[i].values);
+            }
+        }
+
+        [Fact]
+        public async Task TestMRevRangeReduce()
+        {
+            var keys = CreateKeyNames(2);
+            var db = redisFixture.Redis.GetDatabase();
+            foreach(var key in keys)
+            {
+                var label = new TimeSeriesLabel(keys[0], "value");
+                await db.TimeSeriesCreateAsync(key, labels: new List<TimeSeriesLabel> { label });
+            }
+
+            var tuples = await CreateData(db, keys, 50);
+            var results = await db.TimeSeriesMRevRangeAsync("-", "+", new List<string> { $"{keys[0]}=value" }, withLabels: true, groupbyTuple: (keys[0], TsReduce.Sum));
+            Assert.Equal(1, results.Count);
+            Assert.Equal($"{keys[0]}=value", results[0].key);
+            Assert.Equal(new TimeSeriesLabel(keys[0], "value"), results[0].labels[0]);
+            Assert.Equal(new TimeSeriesLabel("__reducer__", "sum"), results[0].labels[1]);
+            Assert.Equal(new TimeSeriesLabel("__source__", string.Join(",", keys)), results[0].labels[2]);
+            tuples = ReverseData(tuples);
+            for(int i = 0; i < results[0].values.Count; i++)
+            {
+                Assert.Equal(tuples[i].Val * 2, results[0].values[i].Val);
+            }
+        }           
     }
 }

NRedisTimeSeries/Commands/CommandArgs.cs

@@ -13,5 +13,7 @@ internal class CommandArgs
         public static string CHUNK_SIZE => "CHUNK_SIZE";
         public static string DUPLICATE_POLICY => "DUPLICATE_POLICY";
         public static string ON_DUPLICATE => "ON_DUPLICATE";
+        public static string GROPUBY => "GROUPBY";
+        public static string REDUCE => "REDUCE";
     }
 }