XafApplication.DatabaseUpdateMode Property

Specifies the database update mode.

Namespace: DevExpress.ExpressApp

Assembly: DevExpress.ExpressApp.v24.1.dll

NuGet Package: DevExpress.ExpressApp

Declaration

C#

[Browsable(false)]
[DefaultValue(DatabaseUpdateMode.UpdateOldDatabase)]
public DatabaseUpdateMode DatabaseUpdateMode { get; set; }

VB.NET

<Browsable(False)>
<DefaultValue(DatabaseUpdateMode.UpdateOldDatabase)>
Public Property DatabaseUpdateMode As DatabaseUpdateMode

Property Value

Type	Default	Description
DatabaseUpdateMode	UpdateOldDatabase	A DatabaseUpdateMode enumeration value.

Available values:

Name	Description
Never	Specifies that the database is never updated. In this instance, update of the database should be performed manually on the database server.
UpdateDatabaseAlways	Specifies that the database is updated at every application run. Do not choose this mode when the Application Server is in use.
UpdateOldDatabase	Specifies that the database is updated when its version is older than the application version.

Remarks

Use this property to specify the mode for application database update. The DatabaseUpdateMode.UpdateOldDatabase value is set for this property (the default setting). However, the DatabaseUpdateMode.UpdateDatabaseAlways value is set in VB solution templates in debug mode. This is done because it is difficult to increment versions in VB projects.

The following example demonstrates how to specify this property:

Files: MySolution.Win\Program.cs(.vb), MySolution.Web\Global.asax.cs(.vb), or _MySolution.Blazor.Server\BlazorApplication.cs.

C#

using System.Diagnostics;
using DevExpress.ExpressApp;
// ...
static class Program {
    static void Main() {
        // ...
        MySolutionWindowsFormsApplication winApplication = new MySolutionWindowsFormsApplication();
        if(Debugger.IsAttached && winApplication.CheckCompatibilityType == CheckCompatibilityType.DatabaseSchema) {
            winApplication.DatabaseUpdateMode = DatabaseUpdateMode.UpdateDatabaseAlways;
        }
        // ...
    }
}

VB.NET

Imports DevExpress.ExpressApp
' ...
Public Class Program
   Public Shared Sub Main()
      ' ...
      Dim _application As MySolutionWindowsFormsApplication = New MySolutionWindowsFormsApplication()
      If Debugger.IsAttached AndAlso _application.CheckCompatibilityType = CheckCompatibilityType.DatabaseSchema Then
          _application.DatabaseUpdateMode = DatabaseUpdateMode.UpdateDatabaseAlways
      End If
      ' ...
    End Sub
End Class

Note

Do not set the DatabaseUpdateMode property to DatabaseUpdateMode.UpdateDatabaseAlways when the Application Server is in use.

For details on the database update process, refer to the following topic: Update Application and Database Versions using the ModuleInfo Table.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the DatabaseUpdateMode property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

xaf-win-web-open-detail-view-when-grid-row-is-clicked-in-the-dashboard/CS/ShowDetailViewFromDashboard.Web/Global.asax.cs#L39

if(System.Diagnostics.Debugger.IsAttached && WebApplication.Instance.CheckCompatibilityType == CheckCompatibilityType.DatabaseSchema) {
    WebApplication.Instance.DatabaseUpdateMode = DatabaseUpdateMode.UpdateDatabaseAlways;
}

xaf-how-to-access-the-master-detailview-information-from-a-nested-listview-controller/CS/WinWebSolution.Web/Global.asax.cs#L39

if(System.Diagnostics.Debugger.IsAttached && WebApplication.Instance.CheckCompatibilityType == CheckCompatibilityType.DatabaseSchema) {
    WebApplication.Instance.DatabaseUpdateMode = DatabaseUpdateMode.UpdateDatabaseAlways;
}

XAF_how-to-allow-a-user-to-select-the-authentication-type-at-runtime-e2371/CS/E2371.Web/Global.asax.cs#L40

if(System.Diagnostics.Debugger.IsAttached && WebApplication.Instance.CheckCompatibilityType == CheckCompatibilityType.DatabaseSchema) {
    WebApplication.Instance.DatabaseUpdateMode = DatabaseUpdateMode.UpdateDatabaseAlways;
}

xaf-how-to-extend-the-application-model/CS/ExtendModel.Web/Global.asax.cs#L39

if(System.Diagnostics.Debugger.IsAttached && WebApplication.Instance.CheckCompatibilityType == CheckCompatibilityType.DatabaseSchema) {
    WebApplication.Instance.DatabaseUpdateMode = DatabaseUpdateMode.UpdateDatabaseAlways;
}

XAF_Non-Persistent-Objects-Reloading-Demo/CS/NonPersistentObjectsDemo.Web/Global.asax.cs#L45

if(System.Diagnostics.Debugger.IsAttached && WebApplication.Instance.CheckCompatibilityType == CheckCompatibilityType.DatabaseSchema) {
    WebApplication.Instance.DatabaseUpdateMode = DatabaseUpdateMode.UpdateDatabaseAlways;
}

VB.NET

xaf-win-web-open-detail-view-when-grid-row-is-clicked-in-the-dashboard/VB/ShowDetailViewFromDashboard.Web/Global.asax.vb#L41

If System.Diagnostics.Debugger.IsAttached AndAlso WebApplication.Instance.CheckCompatibilityType = CheckCompatibilityType.DatabaseSchema Then
    WebApplication.Instance.DatabaseUpdateMode = DatabaseUpdateMode.UpdateDatabaseAlways
End If

xaf-how-to-access-the-master-detailview-information-from-a-nested-listview-controller/VB/WinWebSolution.Web/Global.asax.vb#L41

If System.Diagnostics.Debugger.IsAttached AndAlso WebApplication.Instance.CheckCompatibilityType = CheckCompatibilityType.DatabaseSchema Then
    WebApplication.Instance.DatabaseUpdateMode = DatabaseUpdateMode.UpdateDatabaseAlways
End If

XAF_how-to-allow-a-user-to-select-the-authentication-type-at-runtime-e2371/VB/E2371.Web/Global.asax.vb#L42

If System.Diagnostics.Debugger.IsAttached AndAlso WebApplication.Instance.CheckCompatibilityType = CheckCompatibilityType.DatabaseSchema Then
    WebApplication.Instance.DatabaseUpdateMode = DatabaseUpdateMode.UpdateDatabaseAlways
End If

xaf-how-to-extend-the-application-model/VB/ExtendModel.Web/Global.asax.vb#L41

If System.Diagnostics.Debugger.IsAttached AndAlso WebApplication.Instance.CheckCompatibilityType = CheckCompatibilityType.DatabaseSchema Then
    WebApplication.Instance.DatabaseUpdateMode = DatabaseUpdateMode.UpdateDatabaseAlways
End If

XAF_Non-Persistent-Objects-Reloading-Demo/VB/NonPersistentObjectsDemo.Win/Program.vb#L46

If System.Diagnostics.Debugger.IsAttached AndAlso winApplication.CheckCompatibilityType = CheckCompatibilityType.DatabaseSchema Then
    winApplication.DatabaseUpdateMode = DatabaseUpdateMode.UpdateDatabaseAlways
End If