Interface IDataLayerAsync

Namespace

DevExpress.Xpo

Assembly

DevExpress.Xpo.v24.1.dll

Declares asynchronous methods for data access layers.

public interface IDataLayerAsync : IDataLayer, IDisposable, IDataLayerProvider, IXPDictionaryProvider

Inherited Members

IDataLayer.UpdateSchema(bool, params XPClassInfo[])

IDataLayer.SelectData(params SelectStatement[])

IDataLayer.ModifyData(params ModificationStatement[])

IDataLayer.CreateCommand()

IDataLayer.SetDataLayerWideData(object, object)

IDataLayer.GetDataLayerWideData(object)

IDataLayer.Connection

IDataLayer.AutoCreateOption

IDataLayer.SchemaInit

IDisposable.Dispose()

IDataLayerProvider.DataLayer

IXPDictionaryProvider.Dictionary

Extension Methods

XPQueryExtensions.Query<T>(IDataLayer)

Methods

ModifyDataAsync(CancellationToken, params ModificationStatement[])

Asynchronously updates data in a data store, according to specified modification statements.

Task<ModificationResult> ModifyDataAsync(CancellationToken cancellationToken, params ModificationStatement[] dmlStatements)

Parameters

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

dmlStatements ModificationStatement[]

An array of data modification statements.

Returns

Task<ModificationResult>

The data modification result.

SelectDataAsync(CancellationToken, params SelectStatement[])

Asynchronously retrieves data from a data store, according to specified query statements.

Task<SelectedData> SelectDataAsync(CancellationToken cancellationToken, params SelectStatement[] selects)

Parameters

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

selects SelectStatement[]

An array of query statements.

Returns

Task<SelectedData>

Data retrieved from the data store.

UpdateSchemaAsync(CancellationToken, bool, params XPClassInfo[])

When implemented by a class, asynchronously updates the storage schema according to the specified class descriptions.

Task<UpdateSchemaResult> UpdateSchemaAsync(CancellationToken cancellationToken, bool doNotCreateIfFirstTableNotExist, params XPClassInfo[] types)

Parameters

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

doNotCreateIfFirstTableNotExist bool

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

types XPClassInfo[]

An array of XPClassInfo objects that specify object metadata for which the schema should be created in storage.

Returns

Task<UpdateSchemaResult>

A Task<TResult> that returns an DevExpress.Xpo.DB.UpdateSchemaResult value that specifies the result of the update operation.