WebApiDataStoreService.UpdateSchemaAsync(Boolean, DBTable[], CancellationToken) Method

Calls the UpdateSchemaAsync method of the underlying IDataStore with error handling.

Namespace: DevExpress.Xpo.DB

Assembly: DevExpress.Xpo.v24.1.dll

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

NuGet Package: DevExpress.Xpo

Declaration

C#

public Task<OperationResult<UpdateSchemaResult>> UpdateSchemaAsync(
    bool doNotCreateIfFirstTableNotExist,
    DBTable[] tables,
    CancellationToken cancellationToken = default(CancellationToken)
)

VB.NET

Public Function UpdateSchemaAsync(
    doNotCreateIfFirstTableNotExist As Boolean,
    tables As DBTable(),
    cancellationToken As CancellationToken = Nothing
) As Task(Of OperationResult(Of UpdateSchemaResult))

Parameters

Name	Type	Description
doNotCreateIfFirstTableNotExist	Boolean	true, if the schema should not be created when the table that corresponds to the first item in the types array does not exist in the storage.
tables	DBTable[]	An array of DBTable objects that specify tables for which the schema should be created in the data store.

Optional Parameters

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

Returns

Type	Description
Task<OperationResult<UpdateSchemaResult>>	A task that returns an UpdateSchemaResult value that specifies the result of the update operation.