XpoDefault.GetConnectionPoolString(String) Method

Gets a connection pool’s connection string based on a specified standard connection string. The pool’s capacity and connection limit are set to default values.

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 string GetConnectionPoolString(
    string connectionString
)

VB.NET

Public Shared Function GetConnectionPoolString(
    connectionString As String
) As String

Parameters

Name	Type	Description
connectionString	String	A String value which specifies the parameters required to establish a connection.

Returns

Type	Description
String	A String value which specifies the parameters needed to establish a connection pool’s connection.

Remarks

DataStorePool Component

A regular Data Access Layer (DAL) configuration shares a single IDataStore instance between all Session and UnitOfWork objects. When several threads simultaneously execute a read or write operation on Data Access Layer, the first thread executes a query immediately, while the remaining threads have to wait. In high-load applications, such as web sites and web services, use DataStorePool to reduce the waiting time.

Unlike a regular data store, DataStorePool maintains a set of initialized, ready-to-use IDataStore objects. This configuration can serve concurrent read/write operations without delays.

If an application creates a new DAL for every user, they do not have to wait for each other. Note that this approach has a drawback: in a simple configuration, a data layer acquires a database connection and keeps it open, and other threads cannot use this connection object until the application releases it when the user’s session expires. To save SQL server resources and untie database connections from user sessions, change the data layer configuration so that all IDataLayer objects use the same DataStorePool instance.

Activate DataStorePool

The GetConnectionPoolString method returns a connection string with a set of options for DataStorePool. Use this connection string with the GetDataLayer or GetConnectionProvider methods to activate the DataStorePool component.

DataStorePool Options

DataStorePool has the following configuration options:

poolSize

Specifies how many IDataStore instances to keep in a pool. The number of IDataStore instances in use may exceed the poolSize. In this case, DataStorePool destroys redundant instances when clients release them. The poolSize value should be nearly the same as the expected number of simultaneous requests. When the poolSize is small, DataStorePool acquires new connections at the moments of high user activity and releases unused connections when the number of active users is low. Note that the IDataStore instantiation takes some time. You may want to increase the poolSize value to minimize time to instantiate additional IDataStore objects. The default poolSize value is 8. You do not need to change this value in most cases.

maxConnections

Specifies the maximum number of IDataStore instances in use. If the number of IDataStore instances reaches the maxConnections value, DataStorePool suspends subsequent requests and resumes their execution as soon as previous requests release IDataStore instances. The default maxConnections value (-1) allows the DataStorePool to create up to Int32.MaxValue IDataStore instances. You can change the maxConnections value to improve the database performance with many concurrent users.

Example

C#

string connectionString = "Your connection string";

// Here 2 is the number of connections in a pool; 1 connection is not pooled.
// Total is 3 - the maximum number of connections to be established.
string connectionPoolString = XpoDefault.GetConnectionPoolString(connectionString, 2, 3);

IDataStore dataStore = XpoDefault.GetConnectionProvider(connectionPoolString, 
    AutoCreateOption.DatabaseAndSchema);
XPDictionary dictionary = new ReflectionDictionary();

// ...

XpoDefault.DataLayer = new ThreadSafeDataLayer(dictionary, dataStore);
XpoDefault.Session = null;

VB.NET

Dim connectionString As String = "Your connection string"

' Here, 2 is the number of connections in a pool; 1 connection is not pooled.
' Total is 3 - the maximum number of connections to be established.
Dim connectionPoolString As String = XpoDefault.GetConnectionPoolString(connectionString, 2, 3)

Dim dataStore As IDataStore = XpoDefault.GetConnectionProvider(connectionPoolString, _
AutoCreateOption.DatabaseAndSchema)
Dim dictionary As XPDictionary = New ReflectionDictionary()

' ...

XpoDefault.DataLayer = New ThreadSafeDataLayer(dictionary, dataStore)
XpoDefault.Session = Nothing

Related GitHub Examples

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

xaf-win-web-open-detail-view-when-grid-row-is-clicked-in-the-dashboard/CS/ShowDetailViewFromDashboard.Web/WebApplication.cs#L38

if(!String.IsNullOrEmpty(connectionString)) {
    connectionString = DevExpress.Xpo.XpoDefault.GetConnectionPoolString(connectionString);
    dataStoreProvider = new ConnectionStringDataStoreProvider(connectionString, true);

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

string connectionString = ConfigurationManager.ConnectionStrings[connectionName].ConnectionString;
connectionString = XpoDefault.GetConnectionPoolString(connectionString);
return XpoDefault.GetConnectionProvider(connectionString, AutoCreateOption.SchemaAlreadyExists);

XPO_how-to-implement-odata4-service-with-xpo/CS/ODataService/Helpers/ConnectionHelper.cs#L38

if(threadSafe) {
    var provider = XpoDefault.GetConnectionProvider(XpoDefault.GetConnectionPoolString(ConnectionString), autoCreationOption);
    return new ThreadSafeDataLayer(dictionary, provider);

VB.NET

xaf-win-web-open-detail-view-when-grid-row-is-clicked-in-the-dashboard/VB/ShowDetailViewFromDashboard.Web/WebApplication.vb#L39

If Not String.IsNullOrEmpty(connectionString) Then
    connectionString = DevExpress.Xpo.XpoDefault.GetConnectionPoolString(connectionString)
    dataStoreProvider = New ConnectionStringDataStoreProvider(connectionString, True)

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

Dim connectionString As String = ConfigurationManager.ConnectionStrings(connectionName).ConnectionString
connectionString = XpoDefault.GetConnectionPoolString(connectionString)
Return XpoDefault.GetConnectionProvider(connectionString, AutoCreateOption.SchemaAlreadyExists)