XpoDefault.GetDataLayer(String, XPDictionary, AutoCreateOption) Method

Creates a data access layer.

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 static IDataLayer GetDataLayer(
    string connectionString,
    XPDictionary dictionary,
    AutoCreateOption defaultAutoCreateOption
)

VB.NET

Public Shared Function GetDataLayer(
    connectionString As String,
    dictionary As XPDictionary,
    defaultAutoCreateOption As AutoCreateOption
) As IDataLayer

Parameters

Name	Type	Description
connectionString	String	A connection string.
dictionary	XPDictionary	A persistent classes metadata provider.
defaultAutoCreateOption	AutoCreateOption	Specifies whether XPO can create a database or update its schema.

Returns

Type	Description
IDataLayer	An IDataLayer object.

Remarks

If the value passed to the connectionString parameter is a reference to Data Store Service (URL), the method connects SimpleDataLayer to a Data Store Service client.

The GetDataLayer method throws CannotFindAppropriateConnectionProviderException in the following situations:

A connection string does not contain the XpoProvider attribute and XPO cannot infer the provider name from other attributes.	To get a fully qualified connection string, use the GetConnectionString method of a corresponding connection provider.
A connection string references a Data Store Service and a target platform is .NET Core.	To connect a .NET Core project to a Data Store Service, create and configure DataStoreClientAsync or CachedDataStoreClient. For additional information, see WCF Client in .NET Core.

Tip

Dispose of a data layer instance when it is no longer in use to release the resources it holds.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the GetDataLayer(String, XPDictionary, AutoCreateOption) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

XPO_how-to-read-and-manipulate-xpo-objects-stored-in-multiple-databases-simultaneously-t475838/CS/ConsoleApplication/Program.cs#L64

dict.CollectClassInfos(typeof(Contact));
IDataLayer dal = XpoDefault.GetDataLayer(connString, dict, AutoCreateOption.DatabaseAndSchema);
using (UnitOfWork uow = new UnitOfWork(dal)) {

asp-net-mvc-grid-custom-binding-and-xpo/CS/XPCustomBindingExample/XPO/StartupHelper.cs#L15

XPDictionary dict = DatabaseSchemaHelper.GetDefaultDatabaseSchema();
IDataLayer dal = XpoDefault.GetDataLayer(conn, dict, AutoCreateOption.DatabaseAndSchema);
UnitOfWork uow = new UnitOfWork(dal);

VB.NET

XPO_how-to-read-and-manipulate-xpo-objects-stored-in-multiple-databases-simultaneously-t475838/VB/ConsoleApplication/Program.vb#L64

dict.CollectClassInfos(GetType(Contact))
Dim dal As IDataLayer = XpoDefault.GetDataLayer(connString, dict, AutoCreateOption.DatabaseAndSchema)
Using uow As New UnitOfWork(dal)

asp-net-mvc-grid-custom-binding-and-xpo/VB/XPCustomBindingExample/XPO/StartupHelper.vb#L19

Dim dict As XPDictionary = DatabaseSchemaHelper.GetDefaultDatabaseSchema()
Dim dal As IDataLayer = XpoDefault.GetDataLayer(conn, dict, AutoCreateOption.DatabaseAndSchema)
Dim uow As New UnitOfWork(dal)