#122 - Partitioned option

matteobortolazzo · matteobortolazzo · commit ff691b2ca5e2 · 2021-03-18T23:28:06.000+01:00
diff --git a/src/CouchDB.Driver/CouchClient.cs b/src/CouchDB.Driver/CouchClient.cs
@@ -117,11 +117,11 @@ public ICouchDatabase<TSource> GetDatabase<TSource>(string database, string? dis
 
         /// <inheritdoc />
         public async Task<ICouchDatabase<TSource>> CreateDatabaseAsync<TSource>(string database, 
-            int? shards = null, int? replicas = null, string? discriminator = null, CancellationToken cancellationToken = default)
+            int? shards = null, int? replicas = null, bool? partitioned = null, string? discriminator = null, CancellationToken cancellationToken = default)
             where TSource : CouchDocument
         {
             QueryContext queryContext = NewQueryContext(database);
-            IFlurlResponse response = await CreateDatabaseAsync(queryContext, shards, replicas, cancellationToken)
+            IFlurlResponse response = await CreateDatabaseAsync(queryContext, shards, replicas, partitioned, cancellationToken)
                 .ConfigureAwait(false);
             
             if (response.IsSuccessful())
@@ -139,11 +139,11 @@ public async Task<ICouchDatabase<TSource>> CreateDatabaseAsync<TSource>(string d
 
         /// <inheritdoc />
         public async Task<ICouchDatabase<TSource>> GetOrCreateDatabaseAsync<TSource>(string database,
-            int? shards = null, int? replicas = null, string? discriminator = null, CancellationToken cancellationToken = default)
+            int? shards = null, int? replicas = null, bool? partitioned = null, string? discriminator = null, CancellationToken cancellationToken = default)
             where TSource : CouchDocument
         {
             QueryContext queryContext = NewQueryContext(database);
-            IFlurlResponse response = await CreateDatabaseAsync(queryContext, shards, replicas, cancellationToken)
+            IFlurlResponse response = await CreateDatabaseAsync(queryContext, shards, replicas, partitioned, cancellationToken)
                 .ConfigureAwait(false);
 
             if (response.IsSuccessful() || response.StatusCode == (int)HttpStatusCode.PreconditionFailed)
@@ -173,21 +173,26 @@ public async Task DeleteDatabaseAsync(string database, CancellationToken cancell
         }
 
         private Task<IFlurlResponse> CreateDatabaseAsync(QueryContext queryContext,
-            int? shards = null, int? replicas = null, CancellationToken cancellationToken = default)
+            int? shards = null, int? replicas = null, bool? partitioned = null, CancellationToken cancellationToken = default)
         {
             IFlurlRequest request = NewRequest()
                 .AppendPathSegment(queryContext.EscapedDatabaseName);
 
-            if (shards.HasValue)
+            if (shards.HasValue && shards.Value != 8)
             {
                 request = request.SetQueryParam("q", shards.Value);
             }
 
-            if (replicas.HasValue)
+            if (replicas.HasValue && replicas.Value != 3)
             {
                 request = request.SetQueryParam("n", replicas.Value);
             }
 
+            if (partitioned.HasValue && partitioned.Value)
+            {
+                request = request.SetQueryParam("partitioned", "true");
+            }
+
             return request
                 .AllowHttpStatus(HttpStatusCode.PreconditionFailed)
                 .PutAsync(null, cancellationToken)
@@ -205,17 +210,17 @@ public ICouchDatabase<TSource> GetDatabase<TSource>() where TSource : CouchDocum
         }
 
         /// <inheritdoc />
-        public Task<ICouchDatabase<TSource>> CreateDatabaseAsync<TSource>(int? shards = null, int? replicas = null, string? discriminator = null,
+        public Task<ICouchDatabase<TSource>> CreateDatabaseAsync<TSource>(int? shards = null, int? replicas = null, bool? partitioned = null, string? discriminator = null,
             CancellationToken cancellationToken = default) where TSource : CouchDocument
         {
-            return CreateDatabaseAsync<TSource>(GetClassName<TSource>(), shards, replicas, discriminator, cancellationToken);
+            return CreateDatabaseAsync<TSource>(GetClassName<TSource>(), shards, replicas, partitioned, discriminator, cancellationToken);
         }
 
         /// <inheritdoc />
-        public Task<ICouchDatabase<TSource>> GetOrCreateDatabaseAsync<TSource>(int? shards = null, int? replicas = null, string? discriminator = null,
+        public Task<ICouchDatabase<TSource>> GetOrCreateDatabaseAsync<TSource>(int? shards = null, int? replicas = null, bool? partitioned = null, string? discriminator = null,
             CancellationToken cancellationToken = default) where TSource : CouchDocument
         {
-            return GetOrCreateDatabaseAsync<TSource>(GetClassName<TSource>(), shards, replicas, discriminator, cancellationToken);
+            return GetOrCreateDatabaseAsync<TSource>(GetClassName<TSource>(), shards, replicas, partitioned, discriminator, cancellationToken);
         }
 
         /// <inheritdoc />
@@ -243,13 +248,13 @@ public ICouchDatabase<TUser> GetUsersDatabase<TUser>() where TUser : CouchUser
         /// <inheritdoc />
         public Task<ICouchDatabase<CouchUser>> GetOrCreateUsersDatabaseAsync(CancellationToken cancellationToken = default)
         {
-            return GetOrCreateDatabaseAsync<CouchUser>(null, null, null, cancellationToken);
+            return GetOrCreateDatabaseAsync<CouchUser>(null, null, null, null, cancellationToken);
         }
 
         /// <inheritdoc />
         public Task<ICouchDatabase<TUser>> GetOrCreateUsersDatabaseAsync<TUser>(CancellationToken cancellationToken = default) where TUser : CouchUser
         {
-            return GetOrCreateDatabaseAsync<TUser>(null, null, null, cancellationToken);
+            return GetOrCreateDatabaseAsync<TUser>(null, null, null, null, cancellationToken);
         }
 
         #endregion
diff --git a/src/CouchDB.Driver/CouchContext.cs b/src/CouchDB.Driver/CouchContext.cs
@@ -99,7 +99,7 @@ private async Task InitDatabaseAsync<TSource>(PropertyInfo propertyInfo, CouchOp
                 var documentBuilder = (CouchDocumentBuilder<TSource>)databaseBuilder.DocumentBuilders[documentType];
                 var databaseName = documentBuilder.Database ?? Client.GetClassName(documentType);
                 database = options.CheckDatabaseExists
-                    ? await Client.GetOrCreateDatabaseAsync<TSource>(databaseName, documentBuilder.Shards, documentBuilder.Replicas, documentBuilder.Discriminator).ConfigureAwait(false)
+                    ? await Client.GetOrCreateDatabaseAsync<TSource>(databaseName, documentBuilder.Shards, documentBuilder.Replicas, documentBuilder.Partitioned, documentBuilder.Discriminator).ConfigureAwait(false)
                     : Client.GetDatabase<TSource>(databaseName, documentBuilder.Discriminator);
             }
             else
diff --git a/src/CouchDB.Driver/ICouchClient.cs b/src/CouchDB.Driver/ICouchClient.cs
@@ -26,11 +26,12 @@ public interface ICouchClient: IAsyncDisposable
         /// <param name="database">The database name.</param>
         /// <param name="shards">The number of range partitions. Default is 8, unless overridden in the cluster config.</param>
         /// <param name="replicas">The number of copies of the database in the cluster. The default is 3, unless overridden in the cluster config.</param>
+        /// <param name="partitioned">Whether to create a partitioned database. Default is <c>False</c>.</param>
         /// <param name="discriminator">Filters documents by the given discriminator.</param>
         /// <param name="cancellationToken">A <see cref="CancellationToken" /> to observe while waiting for the task to complete.</param>
         /// <returns>A task that represents the asynchronous operation. The task result contains the newly created CouchDB database.</returns>
         Task<ICouchDatabase<TSource>> CreateDatabaseAsync<TSource>(string database,
-            int? shards = null, int? replicas = null, string? discriminator = null, CancellationToken cancellationToken = default)
+            int? shards = null, int? replicas = null, bool? partitioned = null, string? discriminator = null, CancellationToken cancellationToken = default)
             where TSource : CouchDocument;
 
         /// <summary>
@@ -42,11 +43,12 @@ Task<ICouchDatabase<TSource>> CreateDatabaseAsync<TSource>(string database,
         /// <param name="database">The database name.</param>
         /// <param name="shards">Used when creating. The number of range partitions. Default is 8, unless overridden in the cluster config.</param>
         /// <param name="replicas">Used when creating. The number of copies of the database in the cluster. The default is 3, unless overridden in the cluster config.</param>
+        /// <param name="partitioned">Whether to create a partitioned database. Default is <c>False</c>.</param>
         /// <param name="discriminator">Filters documents by the given discriminator.</param>
         /// <param name="cancellationToken">A <see cref="CancellationToken" /> to observe while waiting for the task to complete.</param>
         /// <returns>A task that represents the asynchronous operation. The task result contains the newly created CouchDB database.</returns>
         Task<ICouchDatabase<TSource>> GetOrCreateDatabaseAsync<TSource>(string database,
-            int? shards = null, int? replicas = null, string? discriminator = null, CancellationToken cancellationToken = default)
+            int? shards = null, int? replicas = null, bool? partitioned = null, string? discriminator = null, CancellationToken cancellationToken = default)
             where TSource : CouchDocument;
 
         /// <summary>
@@ -72,10 +74,11 @@ Task<ICouchDatabase<TSource>> GetOrCreateDatabaseAsync<TSource>(string database,
         /// <typeparam name="TSource">The type of database documents.</typeparam>
         /// <param name="shards">The number of range partitions. Default is 8, unless overridden in the cluster config.</param>
         /// <param name="replicas">The number of copies of the database in the cluster. The default is 3, unless overridden in the cluster config.</param>
+        /// <param name="partitioned">Whether to create a partitioned database. Default is <c>False</c>.</param>
         /// <param name="discriminator">Filters documents by the given discriminator.</param>
         /// <param name="cancellationToken">A <see cref="CancellationToken" /> to observe while waiting for the task to complete.</param>
         /// <returns>A task that represents the asynchronous operation. The task result contains the newly created CouchDB database.</returns>
-        Task<ICouchDatabase<TSource>> CreateDatabaseAsync<TSource>(int? shards = null, int? replicas = null, string? discriminator = null, CancellationToken cancellationToken = default) where TSource : CouchDocument;
+        Task<ICouchDatabase<TSource>> CreateDatabaseAsync<TSource>(int? shards = null, int? replicas = null, bool? partitioned = null, string? discriminator = null, CancellationToken cancellationToken = default) where TSource : CouchDocument;
 
         /// <summary>
         /// Returns an instance of the CouchDB database with the name type <see cref="TSource"/>.
@@ -84,10 +87,11 @@ Task<ICouchDatabase<TSource>> GetOrCreateDatabaseAsync<TSource>(string database,
         /// <typeparam name="TSource">The type of database documents.</typeparam>
         /// <param name="shards">Used when creating. The number of range partitions. Default is 8, unless overridden in the cluster config.</param>
         /// <param name="replicas">Used when creating. The number of copies of the database in the cluster. The default is 3, unless overridden in the cluster config.</param>
+        /// <param name="partitioned">Whether to create a partitioned database. Default is <c>False</c>.</param>
         /// <param name="discriminator">Filters documents by the given discriminator.</param>
         /// <param name="cancellationToken">A <see cref="CancellationToken" /> to observe while waiting for the task to complete.</param>
         /// <returns>A task that represents the asynchronous operation. The task result contains the newly created CouchDB database.</returns>
-        Task<ICouchDatabase<TSource>> GetOrCreateDatabaseAsync<TSource>(int? shards = null, int? replicas = null, string? discriminator = null, CancellationToken cancellationToken = default)
+        Task<ICouchDatabase<TSource>> GetOrCreateDatabaseAsync<TSource>(int? shards = null, int? replicas = null, bool? partitioned = null, string? discriminator = null, CancellationToken cancellationToken = default)
             where TSource : CouchDocument;
 
         /// <summary>
diff --git a/src/CouchDB.Driver/Options/CouchDocumentBuilder.cs b/src/CouchDB.Driver/Options/CouchDocumentBuilder.cs
@@ -5,6 +5,7 @@ public abstract class CouchDocumentBuilder
         internal string? Database { get; set; }
         internal int? Shards { get; set; }
         internal int? Replicas { get; set; }
+        internal bool Partitioned { get; set; }
         internal string? Discriminator { get; set; }
     }    
 }
diff --git a/src/CouchDB.Driver/Options/CouchDocumentBuilder`.cs b/src/CouchDB.Driver/Options/CouchDocumentBuilder`.cs
@@ -33,6 +33,12 @@ public CouchDocumentBuilder<TSource> WithReplicas(int replicas)
             return this;
         }
 
+        public CouchDocumentBuilder<TSource> IsPartitioned()
+        {
+            Partitioned = true;
+            return this;
+        }
+
         public CouchDocumentBuilder<TSource> HasIndex(string name, Action<IIndexBuilder<TSource>> indexBuilderAction,
             IndexOptions? options = null)
         {
diff --git a/tests/CouchDB.Driver.UnitTests/Client_Tests.cs b/tests/CouchDB.Driver.UnitTests/Client_Tests.cs
@@ -166,6 +166,41 @@ public async Task CreateDatabase_402_ThrowsException()
             await Assert.ThrowsAsync<CouchException>(action);
         }
 
+        [Fact]
+        public async Task CreateDatabaseAsync_Params()
+        {
+            using var httpTest = new HttpTest();
+            // Logout
+            httpTest.RespondWithJson(new { ok = true });
+
+            await using var client = new CouchClient("http://localhost");
+            httpTest.RespondWithJson(new { ok = true });
+            var rebels = await client.CreateDatabaseAsync<Rebel>(9, 2, true);
+            httpTest
+                .ShouldHaveCalled("http://localhost/rebels*")
+                .WithQueryParam("q", 9)
+                .WithQueryParam("n", 2)
+                .WithQueryParam("partitioned", "true")
+                .WithVerb(HttpMethod.Put);
+            Assert.Equal("rebels", rebels.Database);
+        }
+
+        [Fact]
+        public async Task CreateDatabaseAsync_Params_Default()
+        {
+            using var httpTest = new HttpTest();
+            // Logout
+            httpTest.RespondWithJson(new { ok = true });
+
+            await using var client = new CouchClient("http://localhost");
+            httpTest.RespondWithJson(new { ok = true });
+            var rebels = await client.CreateDatabaseAsync<Rebel>(8, 3, false);
+            httpTest
+                .ShouldHaveCalled("http://localhost/rebels")
+                .WithVerb(HttpMethod.Put);
+            Assert.Equal("rebels", rebels.Database);
+        }
+
         #endregion
 
         #region Delete

Original file line number	Diff line number	Diff line change
`@@ -117,11 +117,11 @@ public ICouchDatabase<TSource> GetDatabase<TSource>(string database, string? dis`
`117`	`117`
`118`	`118`	`/// <inheritdoc />`
`119`	`119`	`public async Task<ICouchDatabase<TSource>> CreateDatabaseAsync<TSource>(string database,`
`120`		`- int? shards = null, int? replicas = null, string? discriminator = null, CancellationToken cancellationToken = default)`
	`120`	`+ int? shards = null, int? replicas = null, bool? partitioned = null, string? discriminator = null, CancellationToken cancellationToken = default)`
`121`	`121`	`where TSource : CouchDocument`
`122`	`122`	`{`
`123`	`123`	`QueryContext queryContext = NewQueryContext(database);`
`124`		`- IFlurlResponse response = await CreateDatabaseAsync(queryContext, shards, replicas, cancellationToken)`
	`124`	`+ IFlurlResponse response = await CreateDatabaseAsync(queryContext, shards, replicas, partitioned, cancellationToken)`
`125`	`125`	`.ConfigureAwait(false);`
`126`	`126`
`127`	`127`	`if (response.IsSuccessful())`
`@@ -139,11 +139,11 @@ public async Task<ICouchDatabase<TSource>> CreateDatabaseAsync<TSource>(string d`
`139`	`139`
`140`	`140`	`/// <inheritdoc />`
`141`	`141`	`public async Task<ICouchDatabase<TSource>> GetOrCreateDatabaseAsync<TSource>(string database,`
`142`		`- int? shards = null, int? replicas = null, string? discriminator = null, CancellationToken cancellationToken = default)`
	`142`	`+ int? shards = null, int? replicas = null, bool? partitioned = null, string? discriminator = null, CancellationToken cancellationToken = default)`
`143`	`143`	`where TSource : CouchDocument`
`144`	`144`	`{`
`145`	`145`	`QueryContext queryContext = NewQueryContext(database);`
`146`		`- IFlurlResponse response = await CreateDatabaseAsync(queryContext, shards, replicas, cancellationToken)`
	`146`	`+ IFlurlResponse response = await CreateDatabaseAsync(queryContext, shards, replicas, partitioned, cancellationToken)`
`147`	`147`	`.ConfigureAwait(false);`
`148`	`148`
`149`	`149`	`if (response.IsSuccessful() \|\| response.StatusCode == (int)HttpStatusCode.PreconditionFailed)`
`@@ -173,21 +173,26 @@ public async Task DeleteDatabaseAsync(string database, CancellationToken cancell`
`173`	`173`	`}`
`174`	`174`
`175`	`175`	`private Task<IFlurlResponse> CreateDatabaseAsync(QueryContext queryContext,`
`176`		`- int? shards = null, int? replicas = null, CancellationToken cancellationToken = default)`
	`176`	`+ int? shards = null, int? replicas = null, bool? partitioned = null, CancellationToken cancellationToken = default)`
`177`	`177`	`{`
`178`	`178`	`IFlurlRequest request = NewRequest()`
`179`	`179`	`.AppendPathSegment(queryContext.EscapedDatabaseName);`
`180`	`180`
`181`		`- if (shards.HasValue)`
	`181`	`+ if (shards.HasValue && shards.Value != 8)`
`182`	`182`	`{`
`183`	`183`	`request = request.SetQueryParam("q", shards.Value);`
`184`	`184`	`}`
`185`	`185`
`186`		`- if (replicas.HasValue)`
	`186`	`+ if (replicas.HasValue && replicas.Value != 3)`
`187`	`187`	`{`
`188`	`188`	`request = request.SetQueryParam("n", replicas.Value);`
`189`	`189`	`}`
`190`	`190`
	`191`	`+ if (partitioned.HasValue && partitioned.Value)`
	`192`	`+ {`
	`193`	`+ request = request.SetQueryParam("partitioned", "true");`
	`194`	`+ }`
	`195`	`+`
`191`	`196`	`return request`
`192`	`197`	`.AllowHttpStatus(HttpStatusCode.PreconditionFailed)`
`193`	`198`	`.PutAsync(null, cancellationToken)`
`@@ -205,17 +210,17 @@ public ICouchDatabase<TSource> GetDatabase<TSource>() where TSource : CouchDocum`
`205`	`210`	`}`
`206`	`211`
`207`	`212`	`/// <inheritdoc />`
`208`		`- public Task<ICouchDatabase<TSource>> CreateDatabaseAsync<TSource>(int? shards = null, int? replicas = null, string? discriminator = null,`
	`213`	`+ public Task<ICouchDatabase<TSource>> CreateDatabaseAsync<TSource>(int? shards = null, int? replicas = null, bool? partitioned = null, string? discriminator = null,`
`209`	`214`	`CancellationToken cancellationToken = default) where TSource : CouchDocument`
`210`	`215`	`{`
`211`		`- return CreateDatabaseAsync<TSource>(GetClassName<TSource>(), shards, replicas, discriminator, cancellationToken);`
	`216`	`+ return CreateDatabaseAsync<TSource>(GetClassName<TSource>(), shards, replicas, partitioned, discriminator, cancellationToken);`
`212`	`217`	`}`
`213`	`218`
`214`	`219`	`/// <inheritdoc />`
`215`		`- public Task<ICouchDatabase<TSource>> GetOrCreateDatabaseAsync<TSource>(int? shards = null, int? replicas = null, string? discriminator = null,`
	`220`	`+ public Task<ICouchDatabase<TSource>> GetOrCreateDatabaseAsync<TSource>(int? shards = null, int? replicas = null, bool? partitioned = null, string? discriminator = null,`
`216`	`221`	`CancellationToken cancellationToken = default) where TSource : CouchDocument`
`217`	`222`	`{`
`218`		`- return GetOrCreateDatabaseAsync<TSource>(GetClassName<TSource>(), shards, replicas, discriminator, cancellationToken);`
	`223`	`+ return GetOrCreateDatabaseAsync<TSource>(GetClassName<TSource>(), shards, replicas, partitioned, discriminator, cancellationToken);`
`219`	`224`	`}`
`220`	`225`
`221`	`226`	`/// <inheritdoc />`
`@@ -243,13 +248,13 @@ public ICouchDatabase<TUser> GetUsersDatabase<TUser>() where TUser : CouchUser`
`243`	`248`	`/// <inheritdoc />`
`244`	`249`	`public Task<ICouchDatabase<CouchUser>> GetOrCreateUsersDatabaseAsync(CancellationToken cancellationToken = default)`
`245`	`250`	`{`
`246`		`- return GetOrCreateDatabaseAsync<CouchUser>(null, null, null, cancellationToken);`
	`251`	`+ return GetOrCreateDatabaseAsync<CouchUser>(null, null, null, null, cancellationToken);`
`247`	`252`	`}`
`248`	`253`
`249`	`254`	`/// <inheritdoc />`
`250`	`255`	`public Task<ICouchDatabase<TUser>> GetOrCreateUsersDatabaseAsync<TUser>(CancellationToken cancellationToken = default) where TUser : CouchUser`
`251`	`256`	`{`
`252`		`- return GetOrCreateDatabaseAsync<TUser>(null, null, null, cancellationToken);`
	`257`	`+ return GetOrCreateDatabaseAsync<TUser>(null, null, null, null, cancellationToken);`
`253`	`258`	`}`
`254`	`259`
`255`	`260`	`#endregion`
Original file line number	Diff line number	Diff line change
`@@ -99,7 +99,7 @@ private async Task InitDatabaseAsync<TSource>(PropertyInfo propertyInfo, CouchOp`
`99`	`99`	`var documentBuilder = (CouchDocumentBuilder<TSource>)databaseBuilder.DocumentBuilders[documentType];`
`100`	`100`	`var databaseName = documentBuilder.Database ?? Client.GetClassName(documentType);`
`101`	`101`	`database = options.CheckDatabaseExists`
`102`		`- ? await Client.GetOrCreateDatabaseAsync<TSource>(databaseName, documentBuilder.Shards, documentBuilder.Replicas, documentBuilder.Discriminator).ConfigureAwait(false)`
	`102`	`+ ? await Client.GetOrCreateDatabaseAsync<TSource>(databaseName, documentBuilder.Shards, documentBuilder.Replicas, documentBuilder.Partitioned, documentBuilder.Discriminator).ConfigureAwait(false)`
`103`	`103`	`: Client.GetDatabase<TSource>(databaseName, documentBuilder.Discriminator);`
`104`	`104`	`}`
`105`	`105`	`else`
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@ public abstract class CouchDocumentBuilder`
`5`	`5`	`internal string? Database { get; set; }`
`6`	`6`	`internal int? Shards { get; set; }`
`7`	`7`	`internal int? Replicas { get; set; }`
	`8`	`+ internal bool Partitioned { get; set; }`
`8`	`9`	`internal string? Discriminator { get; set; }`
`9`	`10`	`}`
`10`	`11`	`}`
Original file line number	Diff line number	Diff line change
`@@ -33,6 +33,12 @@ public CouchDocumentBuilder<TSource> WithReplicas(int replicas)`
`33`	`33`	`return this;`
`34`	`34`	`}`
`35`	`35`
	`36`	`+ public CouchDocumentBuilder<TSource> IsPartitioned()`
	`37`	`+ {`
	`38`	`+ Partitioned = true;`
	`39`	`+ return this;`
	`40`	`+ }`
	`41`	`+`
`36`	`42`	`public CouchDocumentBuilder<TSource> HasIndex(string name, Action<IIndexBuilder<TSource>> indexBuilderAction,`
`37`	`43`	`IndexOptions? options = null)`
`38`	`44`	`{`