Session.UpdateSchemaAsync(CancellationToken, Boolean, 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.v24.1.dll

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

NuGet Package: DevExpress.Xpo

Declaration

C#

public Task<UpdateSchemaResult> UpdateSchemaAsync(
    CancellationToken cancellationToken,
    bool doNotCreateIfFirstTableNotExist,
    params XPClassInfo[] types
)

VB.NET

Public Function UpdateSchemaAsync(
    cancellationToken As CancellationToken,
    doNotCreateIfFirstTableNotExist As Boolean,
    ParamArray types As XPClassInfo()
) As Task(Of UpdateSchemaResult)

Parameters

Name	Type	Description
cancellationToken	CancellationToken	A CancellationToken object that delivers a cancellation notice to the running operation.
doNotCreateIfFirstTableNotExist	Boolean	true if the schema should not be created when the table that corresponds to the first item in the types array doesn’t exist in the data store; otherwise, false.
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<UpdateSchemaResult>	A Task<TResult> that returns an UpdateSchemaResult enumeration value which specifies the result of the update operation.

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, true, 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, True, persistentClasses)
    End Using
End Function