SqlCacheDependencyDatabase Class (System.Web.Configuration)

SqlCacheDependencyDatabase Class

.NET Framework Class Library

SqlCacheDependencyDatabase Class

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

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

Syntax

Visual Basic (Declaration)

Public NotInheritable Class SqlCacheDependencyDatabase _
    Inherits ConfigurationElement

Visual Basic (Usage)

Dim instance As SqlCacheDependencyDatabase

public sealed class SqlCacheDependencyDatabase : ConfigurationElement

Visual C++

public ref class SqlCacheDependencyDatabase sealed : public ConfigurationElement

JScript

public final class SqlCacheDependencyDatabase extends ConfigurationElement

Remarks

The SqlCacheDependencyDatabase allows you to programmatically access and modify the databases element of the sqlCacheDependency node within the caching 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 for possible changes.

Examples

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

Visual Basic

' Get the Web application configuration.
  Dim webConfig _
  As System.Configuration.Configuration = _
  WebConfigurationManager.OpenWebConfiguration("/aspnetTest")

' Get the section.
  Dim configPath As String = _
  "system.web/cache/sqlCacheDependency"
  Dim sqlDs _
  As System.Web.Configuration.SqlCacheDependencySection = _
  CType(webConfig.GetSection(configPath), System.Web.Configuration.SqlCacheDependencySection)

' Get the databases element at 0 index.
  Dim sqlCdd _
  As System.Web.Configuration.SqlCacheDependencyDatabase = _
  sqlDs.Databases(0)

// 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);

// Get the databases element at 0 index.
System.Web.Configuration.SqlCacheDependencyDatabase sqlCdd =
    sqlDs.Databases[0];

Inheritance Hierarchy

System..::.Object
System.Configuration..::.ConfigurationElement
System.Web.Configuration..::.SqlCacheDependencyDatabase

Thread Safety

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

Platforms

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.

Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0

Reference

SqlCacheDependencyDatabase Members

System.Web.Configuration Namespace

SqlCacheDependencySection

SqlCacheDependencyDatabaseCollection

SqlCacheDependency

Other Resources

ASP.NET Caching

caching Element (ASP.NET Settings Schema)

Administering ASP.NET Web Sites