MRangeExample.cs

using System;
using System.Collections.Generic;
using StackExchange.Redis;
using NRedisTimeSeries.Commands.Enums;
using NRedisTimeSeries.DataTypes;

namespace NRedisTimeSeries.Example
{
    /// <summary>
    /// Examples for NRedisTimeSeries API for MRANGE queries.
    /// </summary>
    internal class MRangeExample
    {
        /// <summary>
        /// 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.
        /// </summary>
        public static void BasicMRangeExample()
        {
            ConnectionMultiplexer redis = ConnectionMultiplexer.Connect("localhost");
            IDatabase db = redis.GetDatabase();
            var filter = new List<string> { "MRANGEkey=MRANGEvalue" };
            var results = db.TimeSeriesMRange("-", "+", filter);
            // Values extraction example. No lables in this case.
            foreach (var result in results)
            {
                Console.WriteLine(result.key);
                IReadOnlyList<TimeSeriesTuple> values = result.values;
                foreach(TimeSeriesTuple val in values){
                    Console.WriteLine(val);
                }
            }
            redis.Close();
        }

        /// <summary>
        /// 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 (collection) of (string key, IReadOnlyList(TimeSeriesLabel) labels, IReadOnlyList(TimeSeriesTuple) values).
        /// </summary>
        public static void CountMRangeExample()
        {
            ConnectionMultiplexer redis = ConnectionMultiplexer.Connect("localhost");
            IDatabase db = redis.GetDatabase();
            var filter = new List<string> { "MRANGEkey=MRANGEvalue" };
            var results = db.TimeSeriesMRange("-", "+", filter, count: 50);
            // Values extraction example. No lables in this case.
            foreach (var result in results)
            {
                Console.WriteLine(result.key);
                IReadOnlyList<TimeSeriesTuple> values = result.values;
                foreach(TimeSeriesTuple val in values){
                    Console.WriteLine(val);
                }
            }
            redis.Close();
        }

        /// <summary>
        /// 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 (collection) of (string key, IReadOnlyList(TimeSeriesLabel) labels, IReadOnlyList(TimeSeriesTuple) values).
        /// </summary>
        public static void MRangeAggregationExample()
        {
            ConnectionMultiplexer redis = ConnectionMultiplexer.Connect("localhost");
            IDatabase db = redis.GetDatabase();
            var filter = new List<string> { "MRANGEkey=MRANGEvalue" };
            var results = db.TimeSeriesMRange("-", "+", filter, aggregation: TsAggregation.Min, timeBucket: 50);
            // Values extraction example. No lables in this case.
            foreach (var result in results)
            {
                Console.WriteLine(result.key);
                IReadOnlyList<TimeSeriesTuple> values = result.values;
                foreach(TimeSeriesTuple val in values){
                    Console.WriteLine(val);
                }
            }
            redis.Close();
        }

        /// <summary>
        /// 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 (collection) of (string key, IReadOnlyList(TimeSeriesLabel) labels, IReadOnlyList(TimeSeriesTuple) values).
        /// </summary>
        public static void MRangeWithLabelsExample()
        {
            ConnectionMultiplexer redis = ConnectionMultiplexer.Connect("localhost");
            IDatabase db = redis.GetDatabase();
            var filter = new List<string> { "MRANGEkey=MRANGEvalue" };
            var results = db.TimeSeriesMRange("-", "+", filter, withLabels: true);
            // Values extraction example.
            foreach (var result in results)
            {
                Console.WriteLine(result.key);
                IReadOnlyList<TimeSeriesLabel> labels = result.labels;
                foreach(TimeSeriesLabel label in labels){
                    Console.WriteLine(label);
                } 
                IReadOnlyList<TimeSeriesTuple> values = result.values;
                foreach(TimeSeriesTuple val in values){
                    Console.WriteLine(val);
                }                
            }
            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)
            {
                Console.WriteLine(result.key);
                IReadOnlyList<TimeSeriesLabel> labels = result.labels;
                foreach(TimeSeriesLabel label in labels){
                    Console.WriteLine(label);
                }                 
                IReadOnlyList<TimeSeriesTuple> values = result.values;
                foreach(TimeSeriesTuple val in values){
                    Console.WriteLine(val);
                }                  
            }
            redis.Close();
        }

        /// <summary>
        /// Example for basic usage of RedisTimeSeries RANGE command with "-" and "+" as range boundreis, and a FILTER_BY 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 MRangeWithFilterbyExample()
        {
            ConnectionMultiplexer redis = ConnectionMultiplexer.Connect("localhost");
            IDatabase db = redis.GetDatabase();
            var filter = new List<string> { "MRANGEkey=MRANGEvalue" };
            var results = db.TimeSeriesMRange("-", "+", filter, filterByTs: new List<TimeStamp> {0}, filterByValue: (0, 2));
            // Values extraction example. No lables in this case.
            foreach (var result in results)
            {
                Console.WriteLine(result.key);                 
                IReadOnlyList<TimeSeriesTuple> values = result.values;
                foreach(TimeSeriesTuple val in values){
                    Console.WriteLine(val);
                }   
            }
            redis.Close();
        }        
    }
}