Merge pull request #7526 from abpframework/dbcontext-tenancy-side

Infrastructure to allow to not create host-only tables in a tenant-only database.

framework/src/Volo.Abp.EntityFrameworkCore/Microsoft/EntityFrameworkCore/AbpModelBuilderExtensions.cs

@@ -1,10 +1,72 @@
 using Volo.Abp.EntityFrameworkCore;
+using Volo.Abp.MultiTenancy;
 
 namespace Microsoft.EntityFrameworkCore
 {
     public static class AbpModelBuilderExtensions
     {
         private const string ModelDatabaseProviderAnnotationKey = "_Abp_DatabaseProvider";
+        private const string ModelMultiTenancySideAnnotationKey = "_Abp_MultiTenancySide";
+
+        #region MultiTenancySide
+
+        public static void SetMultiTenancySide(
+            this ModelBuilder modelBuilder,
+            MultiTenancySides side)
+        {
+            modelBuilder.Model.SetAnnotation(ModelMultiTenancySideAnnotationKey, side);
+        }
+
+        public static MultiTenancySides GetMultiTenancySide(this ModelBuilder modelBuilder)
+        {
+            var value = modelBuilder.Model[ModelMultiTenancySideAnnotationKey];
+            if (value == null)
+            {
+                return MultiTenancySides.Both;
+            }
+
+            return (MultiTenancySides) value;
+        }
+
+        /// <summary>
+        /// Returns true if this is a database schema that is used by the host
+        /// but can also be shared with the tenants.
+        /// </summary>
+        public static bool IsHostDatabase(this ModelBuilder modelBuilder)
+        {
+            return modelBuilder.GetMultiTenancySide().HasFlag(MultiTenancySides.Host);
+        }
+
+        /// <summary>
+        /// Returns true if this is a database schema that is used by the tenants
+        /// but can also be shared with the host.
+        /// </summary>
+        public static bool IsTenantDatabase(this ModelBuilder modelBuilder)
+        {
+            return modelBuilder.GetMultiTenancySide().HasFlag(MultiTenancySides.Tenant);
+        }
+
+        /// <summary>
+        /// Returns true if this is a database schema that is only used by the host
+        /// and should not contain tenant-only tables.
+        /// </summary>
+        public static bool IsHostOnlyDatabase(this ModelBuilder modelBuilder)
+        {
+            return modelBuilder.GetMultiTenancySide() == MultiTenancySides.Host;
+        }
+
+        /// <summary>
+        /// Returns true if this is a database schema that is only used by tenants.
+        /// and should not contain host-only tables.
+        /// </summary>
+        public static bool IsTenantOnlyDatabase(this ModelBuilder modelBuilder)
+        {
+            return modelBuilder.GetMultiTenancySide() == MultiTenancySides.Tenant;
+        }
+
+        #endregion
+
+        #region DatabaseProvider
 
         public static void SetDatabaseProvider(
             this ModelBuilder modelBuilder,
@@ -91,5 +153,7 @@ namespace Microsoft.EntityFrameworkCore
         {
             return modelBuilder.GetDatabaseProvider() == EfCoreDatabaseProvider.Firebird;
         }
+
+        #endregion
     }
 }

modules/background-jobs/src/Volo.Abp.BackgroundJobs.EntityFrameworkCore/Volo/Abp/BackgroundJobs/EntityFrameworkCore/BackgroundJobsDbContextModelCreatingExtensions.cs

@@ -12,6 +12,11 @@ namespace Volo.Abp.BackgroundJobs.EntityFrameworkCore
         {
             Check.NotNull(builder, nameof(builder));
 
+            if (builder.IsTenantOnlyDatabase())
+            {
+                return;
+            }
+
             var options = new BackgroundJobsModelBuilderConfigurationOptions(
                 BackgroundJobsDbProperties.DbTablePrefix,
                 BackgroundJobsDbProperties.DbSchema

modules/blogging/src/Volo.Blogging.EntityFrameworkCore/Volo/Blogging/EntityFrameworkCore/BloggingDbContextModelBuilderExtensions.cs

@@ -20,6 +20,11 @@ namespace Volo.Blogging.EntityFrameworkCore
         {
             Check.NotNull(builder, nameof(builder));
 
+            if (builder.IsTenantOnlyDatabase())
+            {
+                return;
+            }
+
             var options = new BloggingModelBuilderConfigurationOptions(
                 BloggingDbProperties.DbTablePrefix,
                 BloggingDbProperties.DbSchema

modules/docs/src/Volo.Docs.EntityFrameworkCore/Volo/Docs/EntityFrameworkCore/DocsDbContextModelBuilderExtensions.cs

@@ -16,6 +16,11 @@ namespace Volo.Docs.EntityFrameworkCore
         {
             Check.NotNull(builder, nameof(builder));
 
+            if (builder.IsTenantOnlyDatabase())
+            {
+                return;
+            }
+
             var options = new DocsModelBuilderConfigurationOptions(
                 DocsDbProperties.DbTablePrefix,
                 DocsDbProperties.DbSchema

modules/feature-management/src/Volo.Abp.FeatureManagement.EntityFrameworkCore/Volo/Abp/FeatureManagement/EntityFrameworkCore/FeatureManagementDbContextModelCreatingExtensions.cs

@@ -12,6 +12,11 @@ namespace Volo.Abp.FeatureManagement.EntityFrameworkCore
         {
             Check.NotNull(builder, nameof(builder));
 
+            if (builder.IsTenantOnlyDatabase())
+            {
+                return;
+            }
+
             var options = new FeatureManagementModelBuilderConfigurationOptions(
                 FeatureManagementDbProperties.DbTablePrefix,
                 FeatureManagementDbProperties.DbSchema

modules/identity/src/Volo.Abp.Identity.EntityFrameworkCore/Volo/Abp/Identity/EntityFrameworkCore/IdentityDbContextModelBuilderExtensions.cs

@@ -152,6 +152,8 @@ namespace Volo.Abp.Identity.EntityFrameworkCore
                 b.HasIndex(uc => uc.RoleId);
             });
 
+            if (builder.IsHostDatabase())
+            {
                 builder.Entity<IdentityClaimType>(b =>
                 {
                     b.ToTable(options.TablePrefix + "ClaimTypes", options.Schema);
@@ -164,6 +166,7 @@ namespace Volo.Abp.Identity.EntityFrameworkCore
                     b.Property(uc => uc.RegexDescription).HasMaxLength(IdentityClaimTypeConsts.MaxRegexDescriptionLength);
                     b.Property(uc => uc.Description).HasMaxLength(IdentityClaimTypeConsts.MaxDescriptionLength);
                 });
+            }
 
             builder.Entity<OrganizationUnit>(b =>
             {
@@ -233,6 +236,8 @@ namespace Volo.Abp.Identity.EntityFrameworkCore
                 b.HasIndex(x => new { x.TenantId, x.UserId });
             });
 
+            if (builder.IsHostDatabase())
+            {
                 builder.Entity<IdentityLinkUser>(b =>
                 {
                     b.ToTable(options.TablePrefix + "LinkUsers", options.Schema);
@@ -247,8 +252,7 @@ namespace Volo.Abp.Identity.EntityFrameworkCore
                         LinkedTenantId = x.TargetTenantId
                     }).IsUnique();
                 });
-
-
+            }
         }
     }
 }

modules/identityserver/src/Volo.Abp.IdentityServer.EntityFrameworkCore/Volo/Abp/IdentityServer/EntityFrameworkCore/IdentityServerDbContextModelCreatingExtensions.cs

@@ -19,6 +19,11 @@ namespace Volo.Abp.IdentityServer.EntityFrameworkCore
         {
             Check.NotNull(builder, nameof(builder));
 
+            if (builder.IsTenantOnlyDatabase())
+            {
+                return;
+            }
+
             var options = new IdentityServerModelBuilderConfigurationOptions(
                 AbpIdentityServerDbProperties.DbTablePrefix,
                 AbpIdentityServerDbProperties.DbSchema

modules/setting-management/src/Volo.Abp.SettingManagement.EntityFrameworkCore/Volo/Abp/SettingManagement/EntityFrameworkCore/SettingManagementDbContextModelBuilderExtensions.cs

@@ -27,6 +27,11 @@ namespace Volo.Abp.SettingManagement.EntityFrameworkCore
         {
             Check.NotNull(builder, nameof(builder));
 
+            if (builder.IsTenantOnlyDatabase())
+            {
+                return;
+            }
+
             var options = new SettingManagementModelBuilderConfigurationOptions(
                 AbpSettingManagementDbProperties.DbTablePrefix,
                 AbpSettingManagementDbProperties.DbSchema

modules/tenant-management/src/Volo.Abp.TenantManagement.EntityFrameworkCore/Volo/Abp/TenantManagement/EntityFrameworkCore/AbpTenantManagementDbContextModelCreatingExtensions.cs

@@ -13,6 +13,11 @@ namespace Volo.Abp.TenantManagement.EntityFrameworkCore
         {
             Check.NotNull(builder, nameof(builder));
 
+            if (builder.IsTenantOnlyDatabase())
+            {
+                return;
+            }
+
             var options = new AbpTenantManagementModelBuilderConfigurationOptions(
                 AbpTenantManagementDbProperties.DbTablePrefix,
                 AbpTenantManagementDbProperties.DbSchema