NRediSearch => SE.Redis.Modules; implement CL.THROTTLE

Author: mgravell

NRediSearch/NRediSearch.csproj

@@ -4,7 +4,7 @@
     <TargetFrameworks>$(LibraryTargetFrameworks)</TargetFrameworks>
     <VersionPrefix>0.1</VersionPrefix>
     <GenerateDocumentationFile>false</GenerateDocumentationFile>
-    <PackageTags>Redis;Search;RediSearch</PackageTags>
+    <PackageTags>Redis;Search;Modules;RediSearch</PackageTags>
   </PropertyGroup>
   <ItemGroup>
     <ProjectReference Include="..\StackExchange.Redis\StackExchange.Redis.csproj" />

StackExchange.Redis.Modules/RediSearch/Client.cs

@@ -0,0 +1,51 @@
+// .NET port of https://github.com/RedisLabs/JRediSearch/
+
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using StackExchange.Redis;
+
+namespace StackExchange.Redis.Modules.RediSearch
+{
+    /// <summary>
+    /// Document represents a single indexed document or entity in the engine
+    /// </summary>
+    public class Document
+    {
+
+        public string Id { get; }
+        public double Score { get; }
+        public byte[] Payload { get; }
+        private Dictionary<String, RedisValue> properties = new Dictionary<string, RedisValue>();
+
+        public Document(string id, double score, byte[] payload)
+        {
+            Id = id;
+            Score = score;
+            Payload = payload;
+        }
+
+        public static Document Load(string id, double score, byte[] payload, RedisValue[] fields)
+        {
+            Document ret = new Document(id, score, payload);
+            if (fields != null)
+            {
+                for (int i = 0; i < fields.Length; i += 2)
+                {
+                    ret[(string)fields[i]] = fields[i + 1];
+                }
+            }
+            return ret;
+        }
+
+        public RedisValue this[string key]
+        {
+            get { return properties.TryGetValue(key, out var val) ? val : default(RedisValue); }
+            internal set { properties[key] = value; }
+        }
+
+        public bool HasProperty(string key) => properties.ContainsKey(key);
+    }
+}

StackExchange.Redis.Modules/RediSearch/Document.cs

@@ -0,0 +1,36 @@
+using StackExchange.Redis;
+using System.Collections;
+namespace StackExchange.Redis.Modules.RediSearch
+{
+    /// <summary>
+    /// Cache to ensure we encode and box literals once only
+    /// </summary>
+    internal static class Literals
+    {
+        private static Hashtable _boxed = new Hashtable();
+        private static object _null = RedisValue.Null;
+        /// <summary>
+        /// Obtain a lazily-cached pre-encoded and boxed representation of a string
+        /// </summary>
+        /// <remarks>This shoul donly be used for fixed values, not user data (the cache is never reclaimed, so it will be a memory leak)</remarks>
+        public static object Literal(this string value)
+        {
+            if (value == null) return _null;
+
+            object boxed = _boxed[value];
+            if (boxed == null)
+            {
+                lock (_boxed)
+                {
+                    boxed = _boxed[value];
+                    if (boxed == null)
+                    {
+                        boxed = (RedisValue)value;
+                        _boxed.Add(value, boxed);
+                    }
+                }
+            }
+            return boxed;
+        }
+    }
+}

StackExchange.Redis.Modules/RediSearch/Literals.cs

@@ -0,0 +1,264 @@
+// .NET port of https://github.com/RedisLabs/JRediSearch/
+
+using StackExchange.Redis;
+using System;
+using System.Collections.Generic;
+using System.Globalization;
+
+namespace StackExchange.Redis.Modules.RediSearch
+{
+    /// <summary>
+    ///  Query represents query parameters and filters to load results from the engine
+    /// </summary>
+    public class Query
+    {
+        /// <summary>
+        /// Filter represents a filtering rules in a query 
+        /// </summary>
+        public abstract class Filter
+        {
+
+            public string Property { get; }
+
+            internal abstract void SerializeRedisArgs(List<object> args);
+
+            internal Filter(string property)
+            {
+                Property = property;
+            }
+
+        }
+
+        /// <summary>
+        /// NumericFilter wraps a range filter on a numeric field. It can be inclusive or exclusive
+        /// </summary>
+        public class NumericFilter : Filter
+        {
+
+            private readonly double min, max;
+            private readonly bool exclusiveMin, exclusiveMax;
+
+            public NumericFilter(string property, double min, bool exclusiveMin, double max, bool exclusiveMax) : base(property)
+            {
+                this.min = min;
+                this.max = max;
+                this.exclusiveMax = exclusiveMax;
+                this.exclusiveMin = exclusiveMin;
+            }
+
+            public NumericFilter(string property, double min, double max) : this(property, min, false, max, false) { }
+
+
+            internal override void SerializeRedisArgs(List<object> args)
+            {
+                RedisValue FormatNum(double num, bool exclude)
+                {
+                    if (!exclude || double.IsInfinity(num))
+                    {
+                        return (RedisValue)num; // can use directly
+                    }
+                    // need to add leading bracket
+                    return "(" + num.ToString("G17", NumberFormatInfo.InvariantInfo);
+                }
+                args.Add("FILTER".Literal());
+                args.Add(Property);
+                args.Add(FormatNum(min, exclusiveMin));
+                args.Add(FormatNum(max, exclusiveMax));
+            }
+        }
+
+        /// <summary>
+        /// GeoFilter encapsulates a radius filter on a geographical indexed fields 
+        /// </summary>
+        public class GeoFilter : Filter
+        {
+
+            private readonly double lon, lat, radius;
+            private GeoUnit unit;
+
+            public GeoFilter(string property, double lon, double lat, double radius, GeoUnit unit) : base(property)
+            {
+                this.lon = lon;
+                this.lat = lat;
+                this.radius = radius;
+                this.unit = unit;
+            }
+
+            internal override void SerializeRedisArgs(List<object> args)
+            {
+                args.Add("GEOFILTER".Literal());
+                args.Add(Property);
+                args.Add(lon);
+                args.Add(lat);
+                args.Add(radius);
+
+                switch (unit)
+                {
+                    case GeoUnit.Feet: args.Add("ft".Literal()); break;
+                    case GeoUnit.Kilometers: args.Add("km".Literal()); break;
+                    case GeoUnit.Meters: args.Add("m".Literal()); break;
+                    case GeoUnit.Miles: args.Add("mi".Literal()); break;
+                    default: throw new InvalidOperationException($"Unknown unit: {unit}");
+                }
+            }
+        }
+
+        private struct Paging
+        {
+            public int Offset { get; }
+            public int Count { get; }
+
+            public Paging(int offset, int count)
+            {
+                Offset = offset;
+                Count = count;
+            }
+        }
+
+        /// <summary>
+        /// The query's filter list. We only support AND operation on all those filters 
+        /// </summary>
+        List<Filter> _filters = new List<Filter>();
+
+        /// <summary>
+        /// The textual part of the query 
+        /// </summary>
+        public string QueryString { get; }
+        
+        /// <summary>
+        /// The sorting parameters 
+        /// </summary>
+        Paging _paging = new Paging(0, 10);
+
+        /// <summary>
+        /// Set the query to verbatim mode, disabling stemming and query expansion
+        /// </summary>
+        public bool Verbatim { get; set; }
+        /// <summary>
+        /// Set the query not to return the contents of documents, and rather just return the ids
+        /// </summary>
+        public bool NoContent { get; set; }
+        /// <summary>
+        /// Set the query not to filter for stopwords. In general this should not be used
+        /// </summary>
+        public bool NoStopwords { get; set; }
+        /// <summary>
+        /// Set the query to return a factored score for each results. This is useful to merge results from multiple queries.
+        /// </summary>
+        public bool WithScores { get; set; }
+        /// <summary>
+        /// Set the query to return object payloads, if any were given
+        /// </summary>
+        public bool WithPayloads { get; set; }
+
+        /// <summary>
+        /// Set the query language, for stemming purposes; see http://redisearch.io for documentation on languages and stemming
+        /// </summary>
+        public string Language { get; set; }
+        protected String[] _fields = null;
+        /// <summary>
+        /// Set the query payload to be evaluated by the scoring function
+        /// </summary>
+        public byte[] Payload { get; set; }
+
+        /// <summary>
+        /// Create a new index
+        /// </summary>
+        public Query(String queryString)
+        {
+            QueryString = queryString;
+        }
+
+        internal void SerializeRedisArgs(List<object> args)
+        {
+            args.Add(QueryString);
+
+            if (Verbatim)
+            {
+                args.Add("VERBATIM".Literal());
+            }
+            if (NoContent)
+            {
+                args.Add("NOCONTENT".Literal());
+            }
+            if (NoStopwords)
+            {
+                args.Add("NOSTOPWORDS".Literal());
+            }
+            if (WithScores)
+            {
+                args.Add("WITHSCORES".Literal());
+            }
+            if (WithPayloads)
+            {
+                args.Add("WITHPAYLOADS".Literal());
+            }
+            if (Language != null)
+            {
+                args.Add("LANGUAGE".Literal());
+                args.Add(Language);
+            }
+            if (_fields != null && _fields.Length > 0)
+            {
+                args.Add("INFIELDS".Literal());
+                args.Add(_fields.Length);
+                args.AddRange(_fields);
+            }
+
+            if (Payload != null)
+            {
+                args.Add("PAYLOAD".Literal());
+                args.Add(Payload);
+            }
+
+            if (_paging.Offset != 0 || _paging.Count != 10)
+            {
+                args.Add("LIMIT".Literal());
+                args.Add(_paging.Offset);
+                args.Add(_paging.Count);
+            }
+
+            if (_filters != null && _filters.Count > 0)
+            {
+                foreach (var f in _filters)
+                {
+                    f.SerializeRedisArgs(args);
+                }
+            }
+        }
+        
+        /// <summary>
+        /// Limit the results to a certain offset and limit
+        /// </summary>
+        /// <param name="offset">the first result to show, zero based indexing</param>
+        /// <param name="limit">how many results we want to show</param>
+        /// <returns>the query itself, for builder-style syntax</returns>
+        public Query Limit(int offset, int count)
+        {
+            _paging = new Paging(offset, count);
+            return this;
+        }
+
+        /// <summary>
+        /// Add a filter to the query's filter list
+        /// </summary>
+        /// <param name="f">either a numeric or geo filter object</param>
+        /// <returns>the query itself</returns>
+        public Query AddFilter(Filter f)
+        {
+            _filters.Add(f);
+            return this;
+        }
+
+        /// <summary>
+        /// Limit the query to results that are limited to a specific set of fields
+        /// </summary>
+        /// <param name="fields">a list of TEXT fields in the schemas</param>
+        /// <returns>the query object itself</returns>
+        public Query LimitFields(params string[] fields)
+        {
+            this._fields = fields;
+            return this;
+        }
+    }
+}