Try our conversational search powered by Generative AI!

Interface IDatabaseSchemaUpdater

Signature for component that gets called during startup where the component can detect if the database has correct version as application and possibly execute update scripts.

Namespace: EPiServer.Data.SchemaUpdates
Assembly: EPiServer.Data.dll
Version: 8.11.0
Syntax
public interface IDatabaseSchemaUpdater

Methods

GetStatus(ConnectionStringsSection)

Called during startup to collect status of the databases.

Declaration
DatabaseSchemaStatus GetStatus(ConnectionStringsSection connectionStrings)
Parameters
Type Name Description
System.Configuration.ConnectionStringsSection connectionStrings

The current configured connection strings.

Returns
Type Description
DatabaseSchemaStatus

The handled database and the current version of the database.

Update(ConnectionStringSettings)

Called during startup if result from GetStatus(ConnectionStringsSection) has DatabaseVersion lower than ApplicationRequiredVersion and setting UpdateDatabaseSchema is true and no implemenation of IsDatabaseUpdateAllowed(ConnectionStringSettings) prevents automatic update.

Declaration
void Update(ConnectionStringSettings connectionStringSettings)
Parameters
Type Name Description
System.Configuration.ConnectionStringSettings connectionStringSettings

The connection string settings returned from GetStatus(ConnectionStringsSection)

Extension Methods