IDataSourceCacheKey Interface

Defines members for data source cache keys.

Namespace: DevExpress.DashboardCommon

Assembly: DevExpress.Dashboard.v24.1.Core.dll

NuGet Package: DevExpress.Dashboard.Core

Declaration

C#

public interface IDataSourceCacheKey

VB.NET

Public Interface IDataSourceCacheKey

Related API Members

The following members return IDataSourceCacheKey objects:

• DataSourceCacheKeyCreatedEventArgs.Key

Remarks

Data source cache keys in the Web Dashboard Control store the following data:

• Dashboard identifier
• Data Source identifier
• Name of the query used in the data source
• Column names available in the data source
• Dashboard parameters

Together these fields form a unique cache identifier. Every time the control needs data, it builds such a key/identifier and raises DashboardConfigurator.DataSourceCacheKeyCreated and ASPxDashboard.DataSourceCacheKeyCreated events. Handle these event to modify the key. Any modifications (for example, a parameter value change) result in the creation of a new data source instance in the cache, unless the corresponding instance already exists.

If the control creates a new cached data source instance, it raises the DataLoading or ConfigureDataConnection event.

For more information on the caching mechanism in the Web Dashboard Control, refer to the following topic: Manage an In-Memory Data Cache.