IRedisConnectionProvider interface (#250)

Author: jcreus1

README.md

@@ -359,6 +359,7 @@ We'd love your contributions! If you want to contribute please read our [Contrib
 * [@Zulander1](https://github.com/zulander1)
 * [@Jeevananthan](https://github.com/Jeevananthan-23)
 * [@mariusmuntean](https://github.com/mariusmuntean)
+* [@jcreus1](https://github.com/jcreus1)
 
 <!-- Logo -->
 [Logo]: images/logo.svg

src/Redis.OM.AspNetCore/ServiceCollectionExtensions.cs

@@ -1,7 +1,8 @@
-using Microsoft.AspNetCore.Builder;
+using Microsoft.AspNetCore.Builder;
 using Microsoft.Extensions.Configuration;
 using Redis.OM;
 using Microsoft.Extensions.DependencyInjection;
+using Redis.OM.Contracts;
 
 namespace Redis.OM.AspNetCore
 {
@@ -11,13 +12,13 @@ public static IServiceCollection AddRedis(this IServiceCollection services,
             string connectionString)
         {
             var provider = new RedisConnectionProvider(connectionString);
-            return services.AddSingleton(provider);
+            return services.AddSingleton<IRedisConnectionProvider>(provider);
         }
 
         public static IServiceCollection AddRedis(this IServiceCollection services, IConfiguration configuration)
         {
             var connectionString = configuration["REDIS_CONNECTION_STRING"];
-            return services.AddSingleton(new RedisConnectionProvider(connectionString));
+            return services.AddSingleton<IRedisConnectionProvider>(new RedisConnectionProvider(connectionString));
         }
     }
-}
+}

src/Redis.OM/Contracts/IRedisConnectionProvider.cs

@@ -0,0 +1,43 @@
+using Redis.OM.Aggregation;
+using Redis.OM.Searching;
+
+namespace Redis.OM.Contracts
+{
+    /// <summary>
+    /// Provides a connection to redis.
+    /// </summary>
+    public interface IRedisConnectionProvider
+    {
+        /// <summary>
+        /// Gets a command level interface to redis.
+        /// </summary>
+        IRedisConnection Connection { get; }
+
+        /// <summary>
+        /// Gets an aggregation set for redis.
+        /// </summary>
+        /// <typeparam name="T">The indexed type to run aggregations on.</typeparam>
+        /// <param name="chunkSize">Size of chunks to use during pagination, larger chunks = larger payloads returned but fewer round trips.</param>
+        /// <returns>the aggregation set.</returns>
+        RedisAggregationSet<T> AggregationSet<T>(int chunkSize = 100);
+
+        /// <summary>
+        /// Gets a redis collection.
+        /// </summary>
+        /// <typeparam name="T">The type the collection will be retrieving.</typeparam>
+        /// <param name="chunkSize">Size of chunks to use during pagination, larger chunks = larger payloads returned but fewer round trips.</param>
+        /// <returns>A RedisCollection.</returns>
+        IRedisCollection<T> RedisCollection<T>(int chunkSize = 100)
+          where T : notnull;
+
+        /// <summary>
+        /// Gets a redis collection.
+        /// </summary>
+        /// <typeparam name="T">The type the collection will be retrieving.</typeparam>
+        /// <param name="saveState">Whether or not the RedisCollection should maintain the state of documents it enumerates.</param>
+        /// <param name="chunkSize">Size of chunks to use during pagination, larger chunks = larger payloads returned but fewer round trips.</param>
+        /// <returns>A RedisCollection.</returns>
+        IRedisCollection<T> RedisCollection<T>(bool saveState, int chunkSize = 100)
+          where T : notnull;
+    }
+}

src/Redis.OM/RedisConnectionProvider.cs

@@ -8,7 +8,7 @@ namespace Redis.OM
     /// <summary>
     /// Provides a connection to redis.
     /// </summary>
-    public class RedisConnectionProvider
+    public class RedisConnectionProvider : IRedisConnectionProvider
     {
         private readonly IConnectionMultiplexer _mux;