SchemaProvisioningService<TKey> class

Namespace: Tenantry.Pro.EfCore.Npgsql.Strategies.SchemaPerTenant · Package: Tenantry.Pro.EfCore.Npgsql · API reference

Creates a dedicated PostgreSQL schema for a tenant when called explicitly.

Inject this service in the code path that creates new tenants and call SchemaProvisioningServiceBase<TKey>.ProvisionAsync explicitly.

public sealed class SchemaProvisioningService<TKey> : SchemaProvisioningServiceBase<TKey>, ITenantInfrastructureProvisioner<TKey> where TKey : IEquatable<TKey>, IParsable<TKey>

Type parametersCopy Anchor Link

• TKey: The tenant identifier type.

Inherits SchemaProvisioningServiceBase<TKey>.

Implements ITenantInfrastructureProvisioner<TKey>.

ConstructorsCopy Anchor Link

SchemaProvisioningService(ITenantStoreAccessor<TKey>, IOptions<SchemaPerTenantOptions<TKey>>, string, ILicenseGuard, ILogger<SchemaProvisioningService<TKey>>)Copy Anchor Link

Creates the provisioning service. Resolved automatically by the DI container when you call pro.AddSchemaProvisioning(...); you do not normally construct it yourself.

public SchemaProvisioningService(ITenantStoreAccessor<TKey> storeAccessor, IOptions<SchemaPerTenantOptions<TKey>> options, string connectionString, ILicenseGuard licenseGuard, ILogger<SchemaProvisioningService<TKey>> logger)

Parameters:

• storeAccessor ITenantStoreAccessor<TKey>: Resolves tenant descriptors.
• options IOptions<SchemaPerTenantOptions<TKey>>: Schema-per-tenant options (supplies the schema name).
• connectionString string: The shared-database connection string in which schemas are created.
• licenseGuard ILicenseGuard: Guards provisioning behind a valid Tenantry.Pro licence.
• logger ILogger<SchemaProvisioningService<TKey>>: The logger.

MethodsCopy Anchor Link

CreateSchemaIfNotExistsAsync(string, string, CancellationToken)Copy Anchor Link

Issues the provider-specific, idempotent CREATE SCHEMA against connectionString. Implementations are responsible for identifier escaping.

protected override Task CreateSchemaIfNotExistsAsync(string connectionString, string schemaName, CancellationToken cancellationToken)

Parameters:

• connectionString string: A connection string for the shared database.
• schemaName string: The name of the tenant's schema, unescaped.
• cancellationToken CancellationToken: Cancels the operation.

Returns: Task