Session.CreateObjectTypeRecordsAsync(CancellationToken, Type[]) Method

Asynchronously stores valid persistent types for the specified class 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 CreateObjectTypeRecordsAsync(
    CancellationToken cancellationToken,
    params Type[] types
)

VB.NET

Public Function CreateObjectTypeRecordsAsync(
    cancellationToken As CancellationToken,
    ParamArray types As Type()
) As Task

Parameters

Name	Type	Description
cancellationToken	CancellationToken	A CancellationToken object that delivers a cancellation notice to the running operation.
types	Type[]	An array of class types for which the persistent types will be stored in the metadata information.

Returns

Type	Description
Task	A Task that stores valid persistent types for the specified class types.

Remarks

For thread-safe data access layers (see ThreadSafeDataLayer) to function correctly, it’s necessary to provide complete metadata information on the persistent objects in a data store before performing any operations with persistent objects. Call the CreateObjectTypeRecordsAsync method and pass class types as the types parameter to store valid persistent types for the corresponding persistent objects. This creates all the necessary records within a special table called XPObjectType which is used to support object polymorphism.

C#

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

VB.NET

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