Session.UpdateSchemaAsync(CancellationToken, XPClassInfo[]) Method

Asynchronously updates the database schema to support the persistence of the objects with the specified metadata information.

Namespace: DevExpress.Xpo

Assembly: DevExpress.Xpo.v23.2.dll

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

NuGet Package: DevExpress.Xpo

Declaration

C#

public Task UpdateSchemaAsync(
    CancellationToken cancellationToken,
    params XPClassInfo[] types
)

VB.NET

Public Function UpdateSchemaAsync(
    cancellationToken As CancellationToken,
    ParamArray types As XPClassInfo()
) As Task

Parameters

Name	Type	Description
cancellationToken	CancellationToken	A CancellationToken object that delivers a cancellation notice to the running operation.
types	XPClassInfo[]	An array of XPClassInfo objects that specify the types of objects for which schema should be created in the data store.

Returns

Type	Description
Task	A Task that updates the database schema to support the persistence of the objects with the specified metadata information.

Remarks

C#

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

VB.NET

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