Class DatabaseBuilder

Supports building and configuring the database.

Inheritance

object

Namespace: Umbraco.Cms.Infrastructure.Migrations.Install

Assembly: Umbraco.Infrastructure.dll

Syntax

public class DatabaseBuilder

Constructors

View Source

DatabaseBuilder(ICoreScopeProvider, IScopeAccessor, IUmbracoDatabaseFactory, IRuntimeState, ILoggerFactory, IKeyValueService, IDbProviderFactoryCreator, IConfigManipulator, IOptionsMonitor<GlobalSettings>, IOptionsMonitor<ConnectionStrings>, IMigrationPlanExecutor, DatabaseSchemaCreatorFactory, IEnumerable<IDatabaseProviderMetadata>, IEventAggregator)

Initializes a new instance of the DatabaseBuilder class.

Declaration

public DatabaseBuilder(ICoreScopeProvider scopeProvider, IScopeAccessor scopeAccessor, IUmbracoDatabaseFactory databaseFactory, IRuntimeState runtimeState, ILoggerFactory loggerFactory, IKeyValueService keyValueService, IDbProviderFactoryCreator dbProviderFactoryCreator, IConfigManipulator configManipulator, IOptionsMonitor<GlobalSettings> globalSettings, IOptionsMonitor<ConnectionStrings> connectionStrings, IMigrationPlanExecutor migrationPlanExecutor, DatabaseSchemaCreatorFactory databaseSchemaCreatorFactory, IEnumerable<IDatabaseProviderMetadata> databaseProviderMetadata, IEventAggregator aggregator)

Parameters

Type	Name	Description
ICoreScopeProvider	scopeProvider
IScopeAccessor	scopeAccessor
IUmbracoDatabaseFactory	databaseFactory
IRuntimeState	runtimeState
ILoggerFactory	loggerFactory
IKeyValueService	keyValueService
IDbProviderFactoryCreator	dbProviderFactoryCreator
IConfigManipulator	configManipulator
IOptionsMonitor<GlobalSettings>	globalSettings
IOptionsMonitor<ConnectionStrings>	connectionStrings
IMigrationPlanExecutor	migrationPlanExecutor
DatabaseSchemaCreatorFactory	databaseSchemaCreatorFactory
IEnumerable<IDatabaseProviderMetadata>	databaseProviderMetadata
IEventAggregator	aggregator

Properties

View Source

CanConnectToDatabase

Gets a value indicating whether it is possible to connect to the configured database. It does not necessarily mean that Umbraco is installed, nor up-to-date.

Declaration

public bool CanConnectToDatabase { get; }

Property Value

Type	Description
bool

View Source

IsDatabaseConfigured

Gets a value indicating whether the database is configured. It does not necessarily mean that it is possible to connect, nor that Umbraco is installed, nor up-to-date.

Declaration

public bool IsDatabaseConfigured { get; }

Property Value

Type	Description
bool

Methods

View Source

CanConnect(string?, string)

Verifies whether a it is possible to connect to a database.

Declaration

public bool CanConnect(string? connectionString, string providerName)

Parameters

Type	Name	Description
string	connectionString
string	providerName

Returns

Type	Description
bool

View Source

ConfigureDatabaseConnection(DatabaseModel, bool)

Declaration

public bool ConfigureDatabaseConnection(DatabaseModel databaseSettings, bool isTrialRun)

Parameters

Type	Name	Description
DatabaseModel	databaseSettings
bool	isTrialRun

Returns

Type	Description
bool

View Source

CreateDatabase()

Declaration

public void CreateDatabase()

View Source

CreateSchemaAndData()

Creates the database schema and inserts initial data.

Declaration

public DatabaseBuilder.Result? CreateSchemaAndData()

Returns

Type	Description
DatabaseBuilder.Result

Remarks

This assumes that the database exists and the connection string is configured and it is possible to connect to the database.

View Source

HasSomeNonDefaultUser()

Declaration

public bool HasSomeNonDefaultUser()

Returns

Type	Description
bool

View Source

UpgradeSchemaAndData(MigrationPlan)

Declaration

[Obsolete("Use UpgradeSchemaAndDataAsync instead. Scheduled for removal in Umbraco 18.")]
public DatabaseBuilder.Result? UpgradeSchemaAndData(MigrationPlan plan)

Parameters

Type	Name	Description
MigrationPlan	plan

Returns

Type	Description
DatabaseBuilder.Result

View Source

UpgradeSchemaAndData(UmbracoPlan)

Declaration

[Obsolete("Use UpgradeSchemaAndDataAsync instead. Scheduled for removal in Umbraco 18.")]
public DatabaseBuilder.Result? UpgradeSchemaAndData(UmbracoPlan plan)

Parameters

Type	Name	Description
UmbracoPlan	plan

Returns

Type	Description
DatabaseBuilder.Result

View Source

UpgradeSchemaAndDataAsync(MigrationPlan)

Upgrades the database schema and data by running migrations.

Declaration

public Task<DatabaseBuilder.Result?> UpgradeSchemaAndDataAsync(MigrationPlan plan)

Parameters

Type	Name	Description
MigrationPlan	plan

Returns

Type	Description
Task<DatabaseBuilder.Result>

Remarks

This assumes that the database exists and the connection string is configured and it is possible to connect to the database.

Runs whichever migrations need to run.

View Source

UpgradeSchemaAndDataAsync(UmbracoPlan)

Declaration

public Task<DatabaseBuilder.Result?> UpgradeSchemaAndDataAsync(UmbracoPlan plan)

Parameters

Type	Name	Description
UmbracoPlan	plan

Returns

Type	Description
Task<DatabaseBuilder.Result>

View Source

ValidateDatabaseConnectionAsync(DatabaseModel)

Declaration

public Task<Attempt<InstallOperationStatus>> ValidateDatabaseConnectionAsync(DatabaseModel databaseSettings)

Parameters

Type	Name	Description
DatabaseModel	databaseSettings

Returns

Type	Description
Task<Attempt<InstallOperationStatus>>

View Source

ValidateSchema()

Validates the database schema.

Declaration

public DatabaseSchemaResult? ValidateSchema()

Returns

Type	Description
DatabaseSchemaResult

Remarks

This assumes that the database exists and the connection string is configured and it is possible to connect to the database.