XpoDefault.GetConnectionProvider(String, AutoCreateOption) Method

Creates a data store provider (an IDataStore instance).

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 IDataStore GetConnectionProvider(
    string connectionString,
    AutoCreateOption defaultAutoCreateOption
)

VB.NET

Public Shared Function GetConnectionProvider(
    connectionString As String,
    defaultAutoCreateOption As AutoCreateOption
) As IDataStore

Parameters

Name	Type	Description
connectionString	String	A connection string.
defaultAutoCreateOption	AutoCreateOption	Specifies whether XPO can update the database schema or create a new database.

Returns

Type	Description
IDataStore	A data store provider.

Remarks

The GetConnectionProvider method uses the ActiveConnectionString property if the connectionString parameter value is null (Nothing in Visual Basic).

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

The GetConnectionProvider 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.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the GetConnectionProvider(String, 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#

how-to-bind-wpf-grid-to-data/CS/CodeBehind/XPO/InfiniteAsyncSource/Issues/ConnectionHelper.cs#L29

AutoCreateOption autoCreateOption = AutoCreateOption.DatabaseAndSchema;
IDataStore provider = XpoDefault.GetConnectionProvider(connStr, autoCreateOption);
return threadSafe ? (IDataLayer)new ThreadSafeDataLayer(dictionary, provider) : new SimpleDataLayer(dictionary, provider);

wpf-data-grid-implement-crud-operations/CS/CodeBehind/XPO/InfiniteAsyncSource/Issues/ConnectionHelper.cs#L29

AutoCreateOption autoCreateOption = AutoCreateOption.DatabaseAndSchema;
IDataStore provider = XpoDefault.GetConnectionProvider(connStr, autoCreateOption);
return threadSafe ? (IDataLayer)new ThreadSafeDataLayer(dictionary, provider) : new SimpleDataLayer(dictionary, provider);

XPO_how-to-create-a-data-caching-service-that-helps-improve-performance-in-distributed-e4932/CS/WcfService1/Service1.svc.cs#L15

string connectionString = MSSqlConnectionProvider.GetConnectionString("localhost", "ServiceDB");
IDataStore dataStore = XpoDefault.GetConnectionProvider(connectionString, AutoCreateOption.DatabaseAndSchema);
DataCacheRoot dataCacheRoot = new DataCacheRoot(dataStore);

xaf-how-to-prevent-altering-the-legacy-database-schema-when-creating-an-xaf-application/CS/WinWebSolution.Module/XpoDataStoreProxy.cs#L37

}
legacyDataStore = XpoDefault.GetConnectionProvider(legacyConnectionString, AutoCreateOption.DatabaseAndSchema);
legacyDataLayer = new SimpleDataLayer(legacyDictionary, legacyDataStore);

winforms-reporting-create-report-bound-to-xpobjectsource/CS/ORMDataModel1Code/ConnectionHelper.cs#L30

if (threadSafe) {
    var provider = XpoDefault.GetConnectionProvider(ConnectionString, autoCreateOption);
    var dictionary = new DevExpress.Xpo.Metadata.ReflectionDictionary();

VB.NET

how-to-bind-wpf-grid-to-data/VB/CodeBehind/XPO/InfiniteAsyncSource/Issues/ConnectionHelper.vb#L25

Dim autoCreateOption As AutoCreateOption = AutoCreateOption.DatabaseAndSchema
Dim provider As IDataStore = XpoDefault.GetConnectionProvider(connStr, autoCreateOption)
Return If(threadSafe, CType(New ThreadSafeDataLayer(dictionary, provider), IDataLayer), New SimpleDataLayer(dictionary, provider))

XPO_how-to-create-a-data-caching-service-that-helps-improve-performance-in-distributed-e4932/VB/WcfService2/Service1.svc.vb#L13

Dim connectionString As String = MSSqlConnectionProvider.GetConnectionString("localhost", "ServiceDB")
Dim dataStore As MSSqlConnectionProvider = CType(XpoDefault.GetConnectionProvider(connectionString, AutoCreateOption.DatabaseAndSchema), MSSqlConnectionProvider)
Dim objectsToDispose() As IDisposable

xaf-how-to-prevent-altering-the-legacy-database-schema-when-creating-an-xaf-application/VB/WinWebSolution.Module/XpoDataStoreProxy.vb#L38

Next ci
legacyDataStore = XpoDefault.GetConnectionProvider(legacyConnectionString, AutoCreateOption.DatabaseAndSchema)
legacyDataLayer = New SimpleDataLayer(legacyDictionary, legacyDataStore)

winforms-reporting-create-report-bound-to-xpobjectsource/VB/ORMDataModel1Code/ConnectionHelper.vb#L31

If threadSafe Then
    Dim provider = XpoDefault.GetConnectionProvider(ConnectionString, autoCreateOption)
    Dim dictionary = New DevExpress.Xpo.Metadata.ReflectionDictionary()

XPO_how-to-prevent-xpo-from-making-any-changes-to-a-legacy-database-e849/VB/Program.vb#L19

Dim conn As String = MSSqlConnectionProvider.GetConnectionString("(local)", "AdventureWorks")
Dim readOnlyStore As New ReadOnlyDataStore(XpoDefault.GetConnectionProvider(conn, AutoCreateOption.SchemaAlreadyExists))
XpoDefault.DataLayer = New SimpleDataLayer(readOnlyStore)