Interface IDataLayer

Namespace

DevExpress.Xpo

Assembly

DevExpress.Xpo.v24.1.dll

The interface to which data access layers should conform.

public interface IDataLayer : IDisposable, IDataLayerProvider, IXPDictionaryProvider

Inherited Members

IDisposable.Dispose()

IDataLayerProvider.DataLayer

IXPDictionaryProvider.Dictionary

Extension Methods

XPQueryExtensions.Query<T>(IDataLayer)

Properties

AutoCreateOption

When implemented by a class, returns which operations are performed when a session is connected to storage.

AutoCreateOption AutoCreateOption { get; }

Property Value

AutoCreateOption

An DevExpress.Xpo.DB.AutoCreateOption value that specifies which operations are performed when a session is connected to storage.

Connection

When implemented by a class, returns the connection if it is provided by storage.

IDbConnection Connection { get; }

Property Value

IDbConnection

A IDbConnection object that specifies the connection to storage if the storage allows commands to be created.

Methods

CreateCommand()

When implemented by a class, creates a command if storage allows commands to be created.

IDbCommand CreateCommand()

Returns

IDbCommand

A IDbCommand command that is executed when connected to storage.

GetDataLayerWideData(object)

This member supports the internal infrastructure and is not intended to be used directly from your code.

object GetDataLayerWideData(object key)

Parameters

key object

Returns

object

ModifyData(params ModificationStatement[])

When implemented, updates data in a data store using the specified modification statements.

ModificationResult ModifyData(params ModificationStatement[] dmlStatements)

Parameters

dmlStatements ModificationStatement[]

An array of data modification statements.

Returns

ModificationResult

The result of the data modifications.

SelectData(params SelectStatement[])

When implemented by a class, fetches data from a data store using the specified query statements.

SelectedData SelectData(params SelectStatement[] selects)

Parameters

selects SelectStatement[]

An array of statements to obtain data from the data store.

Returns

SelectedData

Data retrieved from the data store.

SetDataLayerWideData(object, object)

This member supports the internal infrastructure and is not intended to be used directly from your code.

void SetDataLayerWideData(object key, object data)

Parameters

key object

data object

UpdateSchema(bool, params XPClassInfo[])

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

UpdateSchemaResult UpdateSchema(bool doNotCreateIfFirstTableNotExist, params XPClassInfo[] types)

Parameters

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

UpdateSchemaResult

A DevExpress.Xpo.DB.UpdateSchemaResult value that specifies the result of the update operation.

Events

SchemaInit

When implemented by a class, this event will occur when the data schema is initialized or updated.

event SchemaInitEventHandler SchemaInit

Event Type

SchemaInitEventHandler