SessionObjectLayer.UpdateSchemaAsync(CancellationToken, Boolean, XPClassInfo[]) Method

Asynchronously performs object layer specific operations that are required to update a data store’s schema according to the class descriptions of the specified types.

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 specifying 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.

Implements

UpdateSchemaAsync(CancellationToken, Boolean, XPClassInfo[])