Session.UpdateSchemaAsync(CancellationToken) Method

Asynchronously updates the storage schema according to the class descriptions that are listed in the assemblies that have been loaded into the application domain.

Namespace: DevExpress.Xpo

Assembly: DevExpress.Xpo.v24.1.dll

NuGet Packages: DevExpress.Win.PivotGrid, DevExpress.Win.TreeMap, DevExpress.Xpo

NuGet Package: DevExpress.Xpo

Declaration

C#

public Task UpdateSchemaAsync(
    CancellationToken cancellationToken = default(CancellationToken)
)

VB.NET

Public Function UpdateSchemaAsync(
    cancellationToken As CancellationToken = Nothing
) As Task

Optional Parameters

Name	Type	Default	Description
cancellationToken	CancellationToken	null	A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Type	Description
Task	A Task that updates the storage schema according to the class descriptions that are listed in the assemblies that have been loaded into the application domain.

Remarks

C#

using System.Threading;
using System.Threading.Tasks;
using DevExpress.Xpo;
using DevExpress.Xpo.DB;
// ...
public async Task CreateDatabase(string connectionString) {
    using(IDataLayer dal = XpoDefault.GetDataLayer(connectionString, AutoCreateOption.DatabaseAndSchema)) {
        UnitOfWork uow = new UnitOfWork(dal);
        await uow.UpdateSchemaAsync(CancellationToken.None);
        await uow.CreateObjectTypeRecordsAsync(CancellationToken.None);
    }
}

VB.NET

Imports System.Threading
Imports System.Threading.Tasks
Imports DevExpress.Xpo
Imports DevExpress.Xpo.DB
' ...
Public Async Function CreateDatabase(ByVal connectionString As String) As Task
    Using dal As IDataLayer = XpoDefault.GetDataLayer(connectionString, AutoCreateOption.DatabaseAndSchema)
        Dim uow As New UnitOfWork(dal)
        Await uow.UpdateSchemaAsync(CancellationToken.None)
        Await uow.CreateObjectTypeRecordsAsync(CancellationToken.None)
    End Using
End Function