Session.CreateObjectTypeRecordsAsync(Boolean, CancellationToken) Method

Asynchronously stores valid persistent types for all the types which are defined within the assemblies that have been loaded in the current application domain.

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(
    bool createOnlyNecessary,
    CancellationToken cancellationToken
)

VB.NET

Public Function CreateObjectTypeRecordsAsync(
    createOnlyNecessary As Boolean,
    cancellationToken As CancellationToken
) As Task

Parameters

Name	Type	Description
createOnlyNecessary	Boolean	true, to create object type records only for types that require this to function properly, such as types from inheritance chains, or types utilizing deferred deletion; false, to create object type records for all persistent types.
cancellationToken	CancellationToken	A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Type	Description
Task	A Task that stores valid persistent types for all the types which are defined within the assemblies that have been loaded in the current application domain.

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 to store valid persistent types for all the class types which are defined within the assemblies that are passed as the assemblies parameter. This creates all the necessary records within a special table called XPObjectType which is used to support object polymorphism.

C#

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

VB.NET

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