Add redis database selection (#101)

* Add redis database selection

* Add db selection for queue

* Rename DbId property to Database
Database property is no longer nullable and its default value is set to -1
The UseDatabase methods checks if the database identifier is valid
Remove _dbId and replace it with _options.Database

* Add database identifier validation in cluster mode

* Forget the files 😅

* Remove check for cluster mode config related to database identifier.

Author: TeddyAlbina

src/Foundatio.Redis/Cache/RedisCacheClient.cs

@@ -35,15 +35,17 @@ public RedisCacheClient(RedisCacheClientOptions options)
         _timeProvider = options.TimeProvider ?? TimeProvider.System;
         options.Serializer ??= DefaultSerializer.Instance;
         _logger = options.LoggerFactory?.CreateLogger(typeof(RedisCacheClient)) ?? NullLogger.Instance;
+
         options.ConnectionMultiplexer.ConnectionRestored += ConnectionMultiplexerOnConnectionRestored;
     }
 
     public RedisCacheClient(Builder<RedisCacheClientOptionsBuilder, RedisCacheClientOptions> config)
         : this(config(new RedisCacheClientOptionsBuilder()).Build())
     {
+
     }
 
-    public IDatabase Database => _options.ConnectionMultiplexer.GetDatabase();
+    public IDatabase Database => _options.ConnectionMultiplexer.GetDatabase(_options.Database);
 
     public Task<bool> RemoveAsync(string key)
     {
@@ -84,8 +86,8 @@ public async Task<int> RemoveAllAsync(IEnumerable<string> keys = null)
 
                 try
                 {
-                    long dbSize = await server.DatabaseSizeAsync().AnyContext();
-                    await server.FlushDatabaseAsync().AnyContext();
+                    long dbSize = await server.DatabaseSizeAsync(_options.Database).AnyContext();
+                    await server.FlushDatabaseAsync(_options.Database).AnyContext();
                     deleted += dbSize;
                     continue;
                 }
@@ -100,7 +102,7 @@ public async Task<int> RemoveAllAsync(IEnumerable<string> keys = null)
                     // A Performance win could be had if we are sure dbSize didn't fail and we know nothing was changing
                     // keys while we were deleting.
                     var seen = new HashSet<RedisKey>();
-                    await foreach (var key in server.KeysAsync().ConfigureAwait(false))
+                    await foreach (var key in server.KeysAsync(_options.Database).ConfigureAwait(false))
                         seen.Add(key);
 
                     foreach (var batch in seen.Batch(batchSize))

src/Foundatio.Redis/Cache/RedisCacheClientOptions.cs

@@ -1,4 +1,5 @@
-using StackExchange.Redis;
+using System;
+using StackExchange.Redis;
 
 namespace Foundatio.Caching;
 
@@ -16,6 +17,10 @@ public class RedisCacheClientOptions : SharedOptions
     /// </summary>
     public CommandFlags ReadMode { get; set; } = CommandFlags.None;
 
+    /// <summary>
+    /// The database to use
+    /// </summary>
+    public int Database { get; set; } = -1;
 }
 
 public class RedisCacheClientOptionsBuilder : SharedOptionsBuilder<RedisCacheClientOptions, RedisCacheClientOptionsBuilder>
@@ -37,4 +42,15 @@ public RedisCacheClientOptionsBuilder ReadMode(CommandFlags commandFlags)
         Target.ReadMode = commandFlags;
         return this;
     }
+
+    public RedisCacheClientOptionsBuilder UseDatabase(int database)
+    {
+        if (database < -1)  // We consider -1 as a valid value in respect for the default behaviour of stack exchange redis
+        {
+            throw new ArgumentOutOfRangeException(nameof(database), "database number cannot be less than -1.");
+        }
+
+        Target.Database = database;
+        return this;
+    }
 }

src/Foundatio.Redis/Cache/RedisHybridCacheClient.cs

@@ -9,7 +9,8 @@ public RedisHybridCacheClient(RedisHybridCacheClientOptions options, InMemoryCac
                 .Serializer(options.Serializer)
                 .LoggerFactory(options.LoggerFactory)
                 .ShouldThrowOnSerializationError(options.ShouldThrowOnSerializationError)
-                .ReadMode(options.ReadMode)),
+                .ReadMode(options.ReadMode)
+                .UseDatabase(options.Database)),
             new RedisMessageBus(o => o
                 .Subscriber(options.ConnectionMultiplexer.GetSubscriber())
                 .Topic(options.RedisChannelName)

src/Foundatio.Redis/Cache/RedisHybridCacheClientOptions.cs

@@ -1,4 +1,5 @@
-using StackExchange.Redis;
+using System;
+using StackExchange.Redis;
 
 namespace Foundatio.Caching;
 
@@ -28,4 +29,15 @@ public RedisHybridCacheClientOptionsBuilder ShouldThrowOnSerializationError(bool
         Target.ShouldThrowOnSerializationError = shouldThrow;
         return this;
     }
+
+    public RedisHybridCacheClientOptionsBuilder UseDatabase(int database)
+    {
+        if (database < -1)  // We consider -1 as a valid value in respect for the default behaviour of stack exchange redis
+        {
+            throw new ArgumentOutOfRangeException(nameof(database), "database number cannot be less than 0.");
+        }
+
+        Target.Database = database;
+        return this;
+    }
 }

src/Foundatio.Redis/Queues/RedisQueue.cs

@@ -44,6 +44,7 @@ public RedisQueue(RedisQueueOptions<T> options) : base(options)
             throw new ArgumentException("ConnectionMultiplexer is required.");
 
         options.ConnectionMultiplexer.ConnectionRestored += ConnectionMultiplexerOnConnectionRestored;
+
         _cache = new RedisCacheClient(new RedisCacheClientOptions { ConnectionMultiplexer = options.ConnectionMultiplexer, Serializer = _serializer });
 
         _payloadTimeToLive = GetPayloadTtl();
@@ -65,7 +66,7 @@ public RedisQueue(RedisQueueOptions<T> options) : base(options)
     public RedisQueue(Builder<RedisQueueOptionsBuilder<T>, RedisQueueOptions<T>> config)
         : this(config(new RedisQueueOptionsBuilder<T>()).Build()) { }
 
-    public IDatabase Database => _options.ConnectionMultiplexer.GetDatabase();
+    public IDatabase Database => _options.ConnectionMultiplexer.GetDatabase(_options.Database);
 
     protected override Task EnsureQueueCreatedAsync(CancellationToken cancellationToken = default) => Task.CompletedTask;
 

src/Foundatio.Redis/Queues/RedisQueueOptions.cs

@@ -12,6 +12,7 @@ public class RedisQueueOptions<T> : SharedQueueOptions<T> where T : class
     public TimeSpan DeadLetterTimeToLive { get; set; } = TimeSpan.FromDays(1);
     public int DeadLetterMaxItems { get; set; } = 100;
     public bool RunMaintenanceTasks { get; set; } = true;
+    public int Database { get; set; } = -1;
 }
 
 public class RedisQueueOptionsBuilder<T> : SharedQueueOptionsBuilder<T, RedisQueueOptions<T>, RedisQueueOptionsBuilder<T>> where T : class
@@ -51,4 +52,15 @@ public RedisQueueOptionsBuilder<T> RunMaintenanceTasks(bool runMaintenanceTasks)
         Target.RunMaintenanceTasks = runMaintenanceTasks;
         return this;
     }
+
+    public RedisQueueOptionsBuilder<T> UseDatabase(int database)
+    {
+        if (database < -1) // We consider -1 as a valid value in respect for the default behaviour of stack exchange redis
+        {
+            throw new ArgumentOutOfRangeException(nameof(database), "database number cannot be less than 0.");
+        }
+
+        Target.Database = database;
+        return this;
+    }
 }