SqlCacheDependencySection Class

Configures the SQL cache dependencies for an ASP.NET application. This class cannot be inherited.

Namespace:  System.Web.Configuration
Assembly:  System.Web (in System.Web.dll)

public sealed class SqlCacheDependencySection : ConfigurationSection

The SqlCacheDependencySection allows you to programmatically access and modify the sqlCacheDependency element of the cache configuration section.

The SQL cache dependency allows the cached data to be synchronized with the original source. After you configure the relationship between an item stored in an ASP.NET application's cache and a specific SQL Server database table, an instance of the SqlCacheDependency class monitors the table so that when an item in the table changes, the item is automatically removed from the cache.

The settings in this element only affect the table-based version of the SqlCacheDependency object. The row-level SqlCacheDependency objects used with SQL Server 2005 and above are not affected by these settings.

NoteNote:

The SqlCacheDependencySection can write information into the related section of the configuration file according to the restrictions defined by the section property AllowDefinition whose value is MachineToApplication. Any attempt to write in a configuration file at a level not allowed in the hierarchy will result in an error message generated by the parser. However, you can use this class to read configuration information at any level in the hierarchy.

The following code example shows how to obtain the SqlCacheDependencySection object from the configuration file of an existing Web application.

// Get the Web application configuration.
System.Configuration.Configuration webConfig = 
WebConfigurationManager.OpenWebConfiguration("/aspnetTest");


// Get the section.
string configPath = "system.web/cache/sqlCacheDependency";
System.Web.Configuration.SqlCacheDependencySection sqlDs = 
(System.Web.Configuration.SqlCacheDependencySection)webConfig.GetSection(
configPath);

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft