DataCacheConfiguration Class

Contains configuration settings for cached data stores.

Namespace: DevExpress.Xpo.DB.Helpers

Assembly: DevExpress.Data.v18.1.dll

Declaration

C#

public class DataCacheConfiguration

VB.NET

Public Class DataCacheConfiguration

Related API Members

The following members accept/return DataCacheConfiguration objects:

• DataCacheConfiguration.Empty

Remarks

A DataCacheConfiguration object instance is used to configure a cached data store using a Root element’s DataCacheRoot.Configure method. For the MSSql2005SqlDependencyCacheRoot, call the corresponding MSSql2005SqlDependencyCacheRoot.CreateSqlDependencyCacheRoot overloaded method.

C#

using DevExpress.Xpo;
using DevExpress.Xpo.DB;
using DevExpress.Xpo.DB.Helpers;

// ...
string connectionString = MSSqlConnectionProvider.GetConnectionString("localhost", "SampleDB");
MSSqlConnectionProvider provider = (MSSqlConnectionProvider)XpoDefault.GetConnectionProvider(
    connectionString,
    AutoCreateOption.DatabaseAndSchema
);
DataCacheConfiguration cacheConfig = new DataCacheConfiguration(
    DataCacheConfigurationCaching.InList, "Customers", "Departments");

// Configuring DataCacheRoot
DataCacheRoot cacheRoot = new DataCacheRoot(provider);
cacheRoot.Configure(cacheConfig);

// Configuring MSSql2005SqlDependencyCacheRoot
IDisposable[] objectsToDispose;
ICachedDataStore cachedDataStore = 
    (ICachedDataStore)MSSql2005SqlDependencyCacheRoot.CreateSqlDependencyCacheRoot(
    provider,
    cacheConfig,
    out objectsToDispose
);

VB.NET

Imports DevExpress.Xpo
Imports DevExpress.Xpo.DB
Imports DevExpress.Xpo.DB.Helpers

' ...
Private connectionString As String = _
MSSqlConnectionProvider.GetConnectionString("localhost", "SampleDB")
Private provider As MSSqlConnectionProvider = CType( _
XpoDefault.GetConnectionProvider(connectionString, AutoCreateOption.DatabaseAndSchema), _
MSSqlConnectionProvider)
Private cacheConfig As New DataCacheConfiguration(DataCacheConfigurationCaching.InList, _
"Customers", "Departments")

' Configuring DataCacheRoot
Private cacheRoot As New DataCacheRoot(provider)
cacheRoot.Configure(cacheConfig)

' Configuring MSSql2005SqlDependencyCacheRoot
Dim objectsToDispose() As IDisposable
Dim cachedDataStore As ICachedDataStore = CType( _
MSSql2005SqlDependencyCacheRoot.CreateSqlDependencyCacheRoot( _
provider, cacheConfig, objectsToDispose), ICachedDataStore)

Tip

To cache all tables, pass the All enumeration value to the DataCacheConfiguration.Caching property. All tables will be cached in this instance, regardless of their inclusion in the configuration settings. To cache all tables except for the tables specified, use the NotInList value.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the DataCacheConfiguration class.

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-create-a-data-caching-service-that-helps-improve-performance-in-distributed-e4932/CS/WcfService1/Service1.svc.cs#L17

DataCacheRoot dataCacheRoot = new DataCacheRoot(dataStore);
dataCacheRoot.Configure(new DataCacheConfiguration(DataCacheConfigurationCaching.InList, "Customer"));
MainDataStore = dataCacheRoot;

VB.NET

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

    Dim objectsToDispose() As IDisposable
    MainDataStore = CType(MSSql2005SqlDependencyCacheRoot.CreateSqlDependencyCacheRoot(dataStore, New DataCacheConfiguration(DataCacheConfigurationCaching.InList, "Customer"), objectsToDispose), ICachedDataStore)
End Sub

Inheritance

Object

DataCacheConfiguration