Session.CreateObjectTypeRecordsAsync(CancellationToken, Boolean, XPClassInfo[]) Method

Asynchronously stores valid persistent types for the specified persistent class metadata information.

Namespace: DevExpress.Xpo

Assembly: DevExpress.Xpo.v23.2.dll

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

NuGet Package: DevExpress.Xpo

Declaration

C#

public Task CreateObjectTypeRecordsAsync(
    CancellationToken cancellationToken,
    bool createOnlyNecessary,
    params XPClassInfo[] types
)

VB.NET

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

Parameters

Name	Type	Description
cancellationToken	CancellationToken	A CancellationToken object that delivers a cancellation notice to the running operation.
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.
types	XPClassInfo[]	An array of the XPClassInfo objects 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 persistent class metadata information.

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 persistent class metadata information 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.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